Fix configuration loading on Ruby 3.1 (#771)

Author: sds

.github/workflows/lint.yml

@@ -21,9 +21,10 @@ jobs:
 
       - name: Prepare environment
         run: |
-          git config --local user.email "gh-actions@example.com"
-          git config --local user.name "GitHub Actions"
+          git config --global user.email "gh-actions@example.com"
+          git config --global user.name "GitHub Actions"
           bundle exec overcommit --sign
+          bundle exec overcommit --sign pre-commit
 
       - name: Run pre-commit checks
         run: bundle exec overcommit --run

.github/workflows/tests.yml

@@ -19,7 +19,6 @@ jobs:
           - '3.1'
         os:
           - ubuntu
-          - windows
 
     steps:
       - uses: actions/checkout@v2
@@ -31,7 +30,10 @@ jobs:
           bundler-cache: true
 
       - name: Run tests
-        run: bundle exec rspec
+        run: |
+          git config --global user.email "gh-actions@example.com"
+          git config --global user.name "GitHub Actions"
+          bundle exec rspec
 
       - name: Code coverage reporting
         uses: coverallsapp/github-action@master

.projections.json

@@ -8,8 +8,8 @@ gemspec
 
 gem 'rspec', '~> 3.0'
 
-# Generate coverage information in Travis builds
-gem 'coveralls', '~> 0.8'
+gem 'simplecov', '~> 0.21.0'
+gem 'simplecov-lcov', '~> 0.8.0'
 
 # Pin RuboCop for Travis builds.
 gem 'rubocop', '0.82.0'

.simplecov

@@ -94,7 +94,7 @@ def add_installation_options(opts)
         @options[:force] = true
       end
 
-      opts.on('-r [hook]', '--run [hook]', 'Run specified hook against all git tracked files. Defaults to `pre_commit`.') do |arg|
+      opts.on('-r [hook]', '--run [hook]', 'Run specified hook against all git tracked files. Defaults to `pre_commit`.') do |arg| # rubocop:disable Layout/LineLength
         @options[:action] = :run_all
         @options[:hook_to_run] = arg ? arg.to_s : 'run-all'
       end
@@ -200,7 +200,7 @@ def sign
 
     def run_all
       empty_stdin = File.open(File::NULL) # pre-commit hooks don't take input
-      context = Overcommit::HookContext.create(@options[:hook_to_run], config, @arguments, empty_stdin)
+      context = Overcommit::HookContext.create(@options[:hook_to_run], config, @arguments, empty_stdin) # rubocop:disable Layout/LineLength
       config.apply_environment!(context, ENV)
 
       printer = Overcommit::Printer.new(config, log, context)

Gemfile

@@ -4,9 +4,9 @@ module Overcommit::Hook::PreCommit
   # Runs `php -l` against any modified PHP files.
   class PhpLint < Base
     # Sample String
-    # rubocop:disable Metrics/LineLength
+    # rubocop:disable Layout/LineLength
     #   PHP Parse error:  syntax error, unexpected 'require_once' (T_REQUIRE_ONCE) in site/sumo.php on line 12
-    # rubocop:enable Metrics/LineLength
+    # rubocop:enable Layout/LineLength
     MESSAGE_REGEX = /^(?<type>.+)\:\s+(?<message>.+) in (?<file>.+) on line (?<line>\d+)/.freeze
 
     def run

appveyor.yml

@@ -4,7 +4,11 @@
 
 describe 'default configuration' do
   default_config =
-    YAML.load_file(Overcommit::ConfigurationLoader::DEFAULT_CONFIG_PATH).to_hash
+    begin
+      YAML.load_file(Overcommit::ConfigurationLoader::DEFAULT_CONFIG_PATH, aliases: true).to_hash
+    rescue ArgumentError
+      YAML.load_file(Overcommit::ConfigurationLoader::DEFAULT_CONFIG_PATH).to_hash
+    end
 
   Overcommit::Utils.supported_hook_types.each do |hook_type|
     hook_class = Overcommit::Utils.camel_case(hook_type)

lib/overcommit/cli.rb

@@ -26,13 +26,13 @@
   context 'when php lint exits unsuccessfully' do
     before do
       # php -l prints the same to both stdout and stderr
-      # rubocop:disable Metrics/LineLength
+      # rubocop:disable Layout/LineLength
       sample_output = [
         '',
         "Parse error: syntax error, unexpected '0' (T_LNUMBER), expecting variable (T_VARIABLE) or '{' or '$' in sample.php on line 3 ",
         'Errors parsing invalid.php',
       ].join("\n")
-      # rubocop:enable Metrics/LineLength
+      # rubocop:enable Layout/LineLength
 
       result = double('result')
       result.stub(:status).and_return(255)

lib/overcommit/hook/pre_commit/php_lint.rb

@@ -39,12 +39,12 @@
 
     context 'and it reports a warning' do
       before do
-        # rubocop:disable Metrics/LineLength
+        # rubocop:disable Layout/LineLength
         sample_output = [
           'File,Line,Column,Type,Message,Source,Severity,Fixable',
           '"/Users/craig/HelpScout/overcommit-testing/invalid.php",5,1,warning,"Possible parse error: FOREACH has no AS statement",Squiz.ControlStructures.ForEachLoopDeclaration.MissingAs,5,0'
         ].join("\n")
-        # rubocop:enable Metrics/LineLength
+        # rubocop:enable Layout/LineLength
         result.stub(:stdout).and_return(sample_output)
       end
 
@@ -53,12 +53,12 @@
 
     context 'and it reports an error' do
       before do
-        # rubocop:disable Metrics/LineLength
+        # rubocop:disable Layout/LineLength
         sample_output = [
           'File,Line,Column,Type,Message,Source,Severity,Fixable',
           '"/Users/craig/HelpScout/overcommit-testing/invalid.php",5,1,error,"Inline control structures are not allowed",Generic.ControlStructures.InlineControlStructure.NotAllowed,5,1'
         ].join("\n")
-        # rubocop:enable Metrics/LineLength
+        # rubocop:enable Layout/LineLength
         result.stub(:stdout).and_return(sample_output)
       end
 

spec/overcommit/default_configuration_spec.rb

@@ -119,17 +119,17 @@
   describe '.supported_hook_types' do
     subject { described_class.supported_hook_types }
 
-    # rubocop:disable Metrics/LineLength
+    # rubocop:disable Layout/LineLength
     it { should =~ %w[commit-msg pre-commit post-checkout post-commit post-merge post-rewrite pre-push pre-rebase prepare-commit-msg] }
-    # rubocop:enable Metrics/LineLength
+    # rubocop:enable Layout/LineLength
   end
 
   describe '.supported_hook_type_classes' do
     subject { described_class.supported_hook_type_classes }
 
-    # rubocop:disable Metrics/LineLength
+    # rubocop:disable Layout/LineLength
     it { should =~ %w[CommitMsg PreCommit PostCheckout PostCommit PostMerge PostRewrite PrePush PreRebase PrepareCommitMsg] }
-    # rubocop:enable Metrics/LineLength
+    # rubocop:enable Layout/LineLength
   end
 
   describe '.parent_command' do
@@ -190,7 +190,7 @@
       it 'invokes CommandSplitter.execute' do
         Overcommit::CommandSplitter.
           should_receive(:execute).
-          with(arguments, args: splittable_args).
+          with(arguments, { args: splittable_args }).
           and_return(double(status: 0, stdout: '', stderr: ''))
         subject
       end

spec/overcommit/hook/pre_commit/php_lint_spec.rb

@@ -1,13 +1,22 @@
 # frozen_string_literal: true
 
-if ENV['TRAVIS']
-  # When running in Travis, report coverage stats to Coveralls.
-  require 'coveralls'
-  Coveralls.wear!
-else
-  # Otherwise render coverage information in coverage/index.html and display
-  # coverage percentage in the console.
-  require 'simplecov'
+require 'simplecov'
+SimpleCov.start do
+  add_filter 'bin/'
+  add_filter 'libexec/'
+  add_filter 'spec/'
+  add_filter 'template-dir/'
+
+  if ENV['CI']
+    require 'simplecov-lcov'
+
+    SimpleCov::Formatter::LcovFormatter.config do |c|
+      c.report_with_single_file = true
+      c.single_report_path = 'coverage/lcov.info'
+    end
+
+    formatter SimpleCov::Formatter::LcovFormatter
+  end
 end
 
 require 'overcommit'

spec/overcommit/hook/pre_commit/phpcs_spec.rb

@@ -29,7 +29,14 @@ end
 # Check if Overcommit should invoke a Bundler context for loading gems
 require 'yaml'
 # rubocop:disable Style/RescueModifier
-if gemfile = YAML.load_file('.overcommit.yml')['gemfile'] rescue nil
+gemfile =
+  begin
+    YAML.load_file('.overcommit.yml', aliases: true)['gemfile']
+  rescue ArgumentError
+    YAML.load_file('.overcommit.yml')['gemfile']
+  end rescue nil
+
+if gemfile
   ENV['BUNDLE_GEMFILE'] = gemfile
   require 'bundler'
 

spec/overcommit/utils_spec.rb

@@ -29,7 +29,14 @@ end
 # Check if Overcommit should invoke a Bundler context for loading gems
 require 'yaml'
 # rubocop:disable Style/RescueModifier
-if gemfile = YAML.load_file('.overcommit.yml')['gemfile'] rescue nil
+gemfile =
+  begin
+    YAML.load_file('.overcommit.yml', aliases: true)['gemfile']
+  rescue ArgumentError
+    YAML.load_file('.overcommit.yml')['gemfile']
+  end rescue nil
+
+if gemfile
   ENV['BUNDLE_GEMFILE'] = gemfile
   require 'bundler'
 

spec/spec_helper.rb

@@ -29,7 +29,14 @@ end
 # Check if Overcommit should invoke a Bundler context for loading gems
 require 'yaml'
 # rubocop:disable Style/RescueModifier
-if gemfile = YAML.load_file('.overcommit.yml')['gemfile'] rescue nil
+gemfile =
+  begin
+    YAML.load_file('.overcommit.yml', aliases: true)['gemfile']
+  rescue ArgumentError
+    YAML.load_file('.overcommit.yml')['gemfile']
+  end rescue nil
+
+if gemfile
   ENV['BUNDLE_GEMFILE'] = gemfile
   require 'bundler'
 

template-dir/hooks/commit-msg

@@ -29,7 +29,14 @@ end
 # Check if Overcommit should invoke a Bundler context for loading gems
 require 'yaml'
 # rubocop:disable Style/RescueModifier
-if gemfile = YAML.load_file('.overcommit.yml')['gemfile'] rescue nil
+gemfile =
+  begin
+    YAML.load_file('.overcommit.yml', aliases: true)['gemfile']
+  rescue ArgumentError
+    YAML.load_file('.overcommit.yml')['gemfile']
+  end rescue nil
+
+if gemfile
   ENV['BUNDLE_GEMFILE'] = gemfile
   require 'bundler'
 

template-dir/hooks/overcommit-hook

@@ -29,7 +29,14 @@ end
 # Check if Overcommit should invoke a Bundler context for loading gems
 require 'yaml'
 # rubocop:disable Style/RescueModifier
-if gemfile = YAML.load_file('.overcommit.yml')['gemfile'] rescue nil
+gemfile =
+  begin
+    YAML.load_file('.overcommit.yml', aliases: true)['gemfile']
+  rescue ArgumentError
+    YAML.load_file('.overcommit.yml')['gemfile']
+  end rescue nil
+
+if gemfile
   ENV['BUNDLE_GEMFILE'] = gemfile
   require 'bundler'
 

template-dir/hooks/post-checkout

@@ -29,7 +29,14 @@ end
 # Check if Overcommit should invoke a Bundler context for loading gems
 require 'yaml'
 # rubocop:disable Style/RescueModifier
-if gemfile = YAML.load_file('.overcommit.yml')['gemfile'] rescue nil
+gemfile =
+  begin
+    YAML.load_file('.overcommit.yml', aliases: true)['gemfile']
+  rescue ArgumentError
+    YAML.load_file('.overcommit.yml')['gemfile']
+  end rescue nil
+
+if gemfile
   ENV['BUNDLE_GEMFILE'] = gemfile
   require 'bundler'
 

template-dir/hooks/post-commit

@@ -29,7 +29,14 @@ end
 # Check if Overcommit should invoke a Bundler context for loading gems
 require 'yaml'
 # rubocop:disable Style/RescueModifier
-if gemfile = YAML.load_file('.overcommit.yml')['gemfile'] rescue nil
+gemfile =
+  begin
+    YAML.load_file('.overcommit.yml', aliases: true)['gemfile']
+  rescue ArgumentError
+    YAML.load_file('.overcommit.yml')['gemfile']
+  end rescue nil
+
+if gemfile
   ENV['BUNDLE_GEMFILE'] = gemfile
   require 'bundler'