reek 6.0.3 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 967e95555fe823e1924a78ff2a8c94c40bdb4d16d031bacd51b885d1475bce30
-  data.tar.gz: c9760389b64b3bb9f96f1896192a540a4de8b7f395808299b9a67e47238e8c42
+  metadata.gz: dbfc48f555eaab012cf855f620277247ab134517838fb4f36e608a7dce6c0f4c
+  data.tar.gz: 75770e4ea054b9a1f6450d43dd9b3580492e0e7de39c194b95ca4400dc15c54f
 SHA512:
-  metadata.gz: ea4c588166903c10bed44c2a459e43e4db479943f8f489ca1eaefbb6db375605e06ff678f5411def292e19ef8c2754245bca78eb24373532474091b0ab8eadbe
-  data.tar.gz: 9e0804841d54d4278149422d66c7e379597e3f99275ba8b9ab4aef6e7041bde6c928db5f3c62a3b5c3d1d6fc4da0216ba5d13aa5562f9e0b565ec31bb115d0fe
+  metadata.gz: ee11e3c7b674c7f520f329f2908f29b529d19671756f77c928e96b62b24e663528dbe7f2c33c669e59f9199cd1338b6e9c2071cf3d94984f1ae801efdabc0ef7
+  data.tar.gz: 41d34fe50259bae6f50675ba14ae0205d1348d6ae1a9e2b7716f87ee8f4afa773df7af6853a77af4865cf95d90dfccc0fdcc666a372957b9ade5bb1565d9b34f

data/.github/workflows/ruby.yml

@@ -2,14 +2,19 @@
 # run tests with Rake
 # For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
 
-name: Ruby
+name: CI
 
 on:
   push:
     branches: [ master ]
   pull_request:
     branches: [ master ]
+  schedule:
+    - cron: '16 4 12 * *'
 
+env:
+  CUCUMBER_PUBLISH_QUIET: true
+  RUBYOPTS: "--disable-did-you-mean"
 jobs:
   test:
 
@@ -17,36 +22,36 @@ jobs:
 
     strategy:
       matrix:
-        ruby: [2.4, 2.5, 2.6, 2.7, jruby-9.2]
+        ruby: [2.6, 2.7, "3.0", "3.1", jruby-9.3]
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby }}
-        bundler-cache: true
-    - name: Run specs
-      run: bundle exec rake test:spec
-    - name: Run performance tests
-      run: bundle exec rake test:performance
-    - name: Update default configuration
-      run: bundle exec rake configuration:update_default_configuration
-    - name: Run cucumber features
-      run: bundle exec rake test:features
-    - name: Run code quality specs
-      run: bundle exec rake test:quality
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run specs
+        run: bundle exec rake test:spec
+      - name: Run performance tests
+        run: bundle exec rake test:performance
+      - name: Update default configuration
+        run: bundle exec rake configuration:update_default_configuration
+      - name: Run cucumber features
+        run: bundle exec rake test:features
+      - name: Run code quality specs
+        run: bundle exec rake test:quality
 
   rubocop:
 
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 2.7
-        bundler-cache: true
-    - name: Run RuboCop
-      run: bundle exec rubocop -P
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+          bundler-cache: true
+      - name: Run RuboCop
+        run: bundle exec rubocop -P

data/.rubocop.yml

@@ -1,5 +1,9 @@
 inherit_from: .rubocop_todo.yml
 
+inherit_mode:
+  merge:
+    - Exclude
+
 require:
   - rubocop-rspec
   - rubocop-performance
@@ -7,10 +11,8 @@ require:
 AllCops:
   Exclude:
     - 'samples/**/*'
-    - 'tmp/**/*'
-    - 'vendor/**/*'
   NewCops: enable
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.6
 
 # Tables are nice
 Layout/HashAlignment:

data/CHANGELOG.md

@@ -1,11 +1,32 @@
 # Change log
 
+## 6.1.0 (2022-01-14)
+
+* (mvz) Drop support for Ruby 2.4 and 2.5
+* (mvz) Support Ruby 3.0 and 3.1
+* (mvz) Support argument forwarding after regular arguments
+
+## 6.0.6 (2021-08-12)
+
+* (mvz) Remove explicit dependency on psych. This fixes an issue where
+  installing Reek would unintentionally pull in psych 4.0
+
+## 6.0.5 (2021-08-01)
+
+* (dependabot) Loosen dependency on psych
+* (Nicolás Ferrari) Fix bugs when used by codeclimate 
+
+## 6.0.4 (2021-04-27)
+
+* (Nicolás Ferrari) Add build-base to Dockerfile
+* (Masataka Pocke Kuwabara and Daniel Santos Dantas) Reduce gem package size
+
 ## 6.0.3 (2021-01-11)
 
 * (mvz) Require parser 3.0
 * (mvz) In a refinement, assign smells to the refined module or class
 
-## 6.0.3 (2020-10-17)
+## 6.0.2 (2020-10-17)
 
 * (mvz) Loosen dependency on psych. This should resolve installation problems on
   mingw32

data/CONTRIBUTING.md

@@ -27,6 +27,9 @@ version, Ruby platform (MRI, JRuby, etc.), operating system.
 Try to provide a minimal example that reproduces the issue.
 Extra kudos if you can write it as a failing test. :)
 
+Make sure any code examples and output are properly formatted
+using [code blocks](https://github.github.com/gfm/#fenced-code-blocks).
+
 ## Contributing features, bugfixes, documentation
 
 ### Getting started

data/Dockerfile

@@ -11,7 +11,7 @@ ENV code_dir /code
 ENV app_dir /usr/src/app
 ENV user app
 
-RUN apk --update add git
+RUN apk --update add git build-base
 ADD . ${app_dir}
 
 RUN adduser -u 9000 -D ${user}

data/Gemfile

@@ -5,18 +5,18 @@ gemspec
 ruby RUBY_VERSION
 
 group :development do
-  gem 'aruba',                 '~> 1.0'
+  gem 'aruba',                 '~> 2.0'
   gem 'codeclimate-engine-rb', '~> 0.4.0'
-  gem 'cucumber',              ['>= 4.0', '< 6.0']
+  gem 'cucumber',              '>= 4.0', '< 8.0'
   gem 'kramdown',              '~> 2.1'
   gem 'kramdown-parser-gfm',   '~> 1.0'
   gem 'rake',                  '~> 13.0'
   gem 'rspec',                 '~> 3.0'
   gem 'rspec-benchmark',       '~> 0.6.0'
-  gem 'rubocop',               '~> 1.7.0'
-  gem 'rubocop-performance',   '~> 1.9.1'
-  gem 'rubocop-rspec',         '~> 2.1.0'
-  gem 'simplecov',             ['>= 0.18.0', '< 0.21.0']
+  gem 'rubocop',               '~> 1.24.0'
+  gem 'rubocop-performance',   '~> 1.13.1'
+  gem 'rubocop-rspec',         '~> 2.7.0'
+  gem 'simplecov',             ['>= 0.18.0', '< 0.22.0']
   gem 'yard',                  '~> 0.9.5'
 
   platforms :mri do
@@ -25,5 +25,5 @@ group :development do
 end
 
 group :debugging do
-  gem 'pry', '~> 0.13.0'
+  gem 'pry', '~> 0.14.0'
 end

data/README.md

@@ -94,7 +94,7 @@ demo.rb -- 2 warnings:
 
 ## Supported Ruby versions
 
-Reek is officially supported for CRuby 2.4 to 2.7 and for JRuby 9.2.
+Reek is officially supported for CRuby 2.6 through 3.1 and for JRuby 9.3.
 Other Ruby implementations (like Rubinius) are not officially supported but
 should work as well.
 

data/bin/code_climate_reek

@@ -14,15 +14,14 @@ class CodeClimateToReek
   # we have to exit with a zero for both failure and success.
   ENGINE_CONFIGURATION = [
     '--failure-exit-code', '0',
-    '--success-exit-code', '0',
-    '.'
+    '--success-exit-code', '0'
   ].freeze
 
   attr_reader :configuration_file_path, :include_paths_key, :include_paths_default
 
   def initialize(configuration_file_path: '/config.json',
                  include_paths_key: 'include_paths',
-                 include_paths_default: [])
+                 include_paths_default: ['.'])
     @configuration_file_path = configuration_file_path
     @include_paths_key       = include_paths_key
     @include_paths_default   = include_paths_default

data/lib/reek/ast/ast_node_class_map.rb

@@ -30,7 +30,7 @@ module Reek
                 SexpExtensions.const_get(const)
               ]
             end
-            Hash[assoc]
+            assoc.to_h
           end
       end
 

data/lib/reek/ast/sexp_extensions/arguments.rb

@@ -104,6 +104,17 @@ module Reek
         end
       end
       # rubocop:enable Naming/ClassAndModuleCamelCase
+
+      # Utility methods for :forward_arg nodes.
+      # rubocop:disable Naming/ClassAndModuleCamelCase
+      module Forward_ArgNode
+        include ArgNodeBase
+
+        def anonymous_splat?
+          true
+        end
+      end
+      # rubocop:enable Naming/ClassAndModuleCamelCase
     end
   end
 end

data/lib/reek/ast/sexp_extensions/case.rb

@@ -10,7 +10,7 @@ module Reek
         end
 
         def body_nodes(type, ignoring = [])
-          children[1..-1].compact.flat_map do |child|
+          children[1..].compact.flat_map do |child|
             child.each_node(type, ignoring | type).to_a
           end
         end

data/lib/reek/ast/sexp_extensions/if.rb

@@ -31,7 +31,7 @@ module Reek
 
         # @quality :reek:FeatureEnvy
         def body_nodes(type, ignoring = [])
-          children[1..-1].compact.flat_map do |child|
+          children[1..].compact.flat_map do |child|
             if ignoring.include? child.type
               []
             else

data/lib/reek/ast/sexp_extensions/send.rb

@@ -16,7 +16,7 @@ module Reek
         end
 
         def args
-          children[2..-1]
+          children[2..]
         end
 
         def participants

data/lib/reek/cli/command/todo_list_command.rb

@@ -24,7 +24,7 @@ module Reek
           else
             write_to_file
             puts "\n'#{DEFAULT_CONFIGURATION_FILE_NAME}' generated! "\
-              'You can now use this as a starting point.'
+                 'You can now use this as a starting point.'
           end
           options.success_exit_code
         end

data/lib/reek/cli/options.rb

@@ -232,7 +232,7 @@ module Reek
           puts "All available smell detectors:\n\n"
           puts DetectorRepository.available_detector_names
           puts "\nCheck out #{DocumentationLink.build('Code Smells')} "\
-                  'for a details on each detector'
+               'for a details on each detector'
           exit
         end
         parser.on_tail('-v', '--version', 'Show version') do

data/lib/reek/code_comment.rb

@@ -39,13 +39,13 @@ module Reek
 
       @original_comment.scan(CONFIGURATION_REGEX) do |detector_name, separator, options|
         escalate_legacy_separator separator
-        CodeCommentValidator.new(detector_name:    detector_name,
-                                 original_comment: original_comment,
-                                 line:             line,
-                                 source:           source,
-                                 options:          options).validate
-        @config.merge! detector_name => YAML.safe_load(options || DISABLE_DETECTOR_CONFIGURATION,
-                                                       permitted_classes: [Regexp])
+        validator = CodeCommentValidator.new(detector_name:    detector_name,
+                                             original_comment: original_comment,
+                                             line:             line,
+                                             source:           source,
+                                             options:          options)
+        validator.validate
+        @config.merge! detector_name => validator.parsed_options
       end
     end
 
@@ -115,6 +115,21 @@ module Reek
         escalate_unknown_configuration_key
       end
 
+      def parsed_options
+        @parsed_options ||=
+          if Psych::VERSION < '3.1.0'
+            YAML.safe_load(options || CodeComment::DISABLE_DETECTOR_CONFIGURATION, [Regexp])
+          else
+            YAML.safe_load(options || CodeComment::DISABLE_DETECTOR_CONFIGURATION,
+                           permitted_classes: [Regexp])
+          end
+      rescue Psych::SyntaxError
+        raise Errors::GarbageDetectorConfigurationInCommentError.new(detector_name: detector_name,
+                                                                     original_comment: original_comment,
+                                                                     source: source,
+                                                                     line: line)
+      end
+
       private
 
       attr_reader :detector_name,
@@ -124,16 +139,6 @@ module Reek
                   :separator,
                   :options
 
-      def parsed_options
-        @parsed_options ||= YAML.safe_load(options || CodeComment::DISABLE_DETECTOR_CONFIGURATION,
-                                           permitted_classes: [Regexp])
-      rescue Psych::SyntaxError
-        raise Errors::GarbageDetectorConfigurationInCommentError.new(detector_name: detector_name,
-                                                                     original_comment: original_comment,
-                                                                     source: source,
-                                                                     line: line)
-      end
-
       def escalate_unknown_configuration_key
         return if given_keys_legit?
 

data/lib/reek/context_builder.rb

@@ -422,7 +422,7 @@ module Reek
     # See `process_rescue` for additional reference.
     #
     def process_resbody(exp, _parent)
-      increase_statement_count_by(exp.children[1..-1].compact)
+      increase_statement_count_by(exp.children[1..].compact)
       process(exp)
     end
 

data/lib/reek/rake/task.rb

@@ -88,7 +88,7 @@ module Reek
       def source_files=(files)
         unless files.is_a?(String) || files.is_a?(FileList)
           raise ArgumentError, 'File list should be a FileList or a String that can contain'\
-            " a glob pattern, e.g. '{app,lib,spec}/**/*.rb'"
+                               " a glob pattern, e.g. '{app,lib,spec}/**/*.rb'"
         end
         @source_files = FileList[files]
       end

data/lib/reek/report/code_climate/code_climate_formatter.rb

@@ -57,9 +57,7 @@ module Reek
       end
 
       def configuration
-        @configuration ||= begin
-          CodeClimateConfiguration.load
-        end
+        @configuration ||= CodeClimateConfiguration.load
       end
     end
   end

data/lib/reek/smell_detectors/base_detector.rb

@@ -90,7 +90,7 @@ module Reek
 
       class << self
         def smell_type
-          @smell_type ||= name.split(/::/).last
+          @smell_type ||= name.split('::').last
         end
 
         def contexts

data/lib/reek/smell_warning.rb

@@ -59,7 +59,7 @@ module Reek
 
     # @public
     def to_hash
-      stringified_params = Hash[parameters.map { |key, val| [key.to_s, val] }]
+      stringified_params = parameters.transform_keys(&:to_s)
       base_hash.merge(stringified_params)
     end
 

data/lib/reek/source/source_locator.rb

@@ -62,10 +62,8 @@ module Reek
 
             false
           end
-        elsif path_excluded?(path)
-          true
         else
-          false
+          path_excluded?(path)
         end
       end
 

data/lib/reek/spec/should_reek_of.rb

@@ -70,18 +70,20 @@ module Reek
 
       def set_failure_messages_for_smell_type
         self.failure_message = "Expected #{origin} to reek of #{smell_type}, "\
-          'but it didn\'t'
+                               'but it didn\'t'
         self.failure_message_when_negated = "Expected #{origin} not to reek "\
-          "of #{smell_type}, but it did"
+                                            "of #{smell_type}, but it did"
       end
 
       def set_failure_messages_for_smell_details
-        self.failure_message = "Expected #{origin} to reek of #{smell_type} "\
+        self.failure_message =
+          "Expected #{origin} to reek of #{smell_type} "\
           "(which it did) with smell details #{smell_details}, which it didn't.\n"\
           "The number of smell details I had to compare with the given one was #{matching_smell_types.count} "\
           "and here they are:\n"\
           "#{all_relevant_smell_details_formatted}"
-        self.failure_message_when_negated = "Expected #{origin} not to reek of "\
+        self.failure_message_when_negated =
+          "Expected #{origin} not to reek of "\
           "#{smell_type} with smell details #{smell_details}, but it did"
       end
 

data/lib/reek/version.rb

@@ -3,11 +3,11 @@
 # @public
 module Reek
   #
-  # This module holds the Reek version informations
+  # This module holds the Reek version information
   #
   # @public
   module Version
     # @public
-    STRING = '6.0.3'
+    STRING = '6.1.0'
   end
 end

data/reek.gemspec

@@ -1,34 +1,37 @@
-require File.join(File.dirname(__FILE__), 'lib/reek/version')
+require_relative 'lib/reek/version'
 
-Gem::Specification.new do |s|
-  s.name = 'reek'
-  s.version = Reek::Version::STRING
+Gem::Specification.new do |spec|
+  spec.name = 'reek'
+  spec.version = Reek::Version::STRING
+  spec.authors = ['Kevin Rutherford', 'Timo Roessner', 'Matijs van Zuijlen', 'Piotr Szotkowski']
+  spec.email = ['timo.roessner@googlemail.com']
 
-  s.authors = ['Kevin Rutherford', 'Timo Roessner', 'Matijs van Zuijlen', 'Piotr Szotkowski']
-  s.description =
+  spec.summary = 'Code smell detector for Ruby'
+  spec.description =
     'Reek is a tool that examines Ruby classes, modules and methods and reports ' \
     'any code smells it finds.'
+  spec.homepage = 'https://github.com/troessner/reek'
+  spec.license = 'MIT'
 
-  s.license = 'MIT'
-  s.email = ['timo.roessner@googlemail.com']
-  s.extra_rdoc_files = ['CHANGELOG.md', 'License.txt']
-  s.files = `git ls-files -z`.split("\0")
-  s.executables = s.files.grep(%r{^bin/}).map { |path| File.basename(path) }
-  s.homepage = 'https://github.com/troessner/reek'
-  s.rdoc_options = %w(--main README.md -x assets/|bin/|config/|features/|spec/|tasks/)
-  s.required_ruby_version = '>= 2.4.0'
-  s.summary = 'Code smell detector for Ruby'
+  spec.extra_rdoc_files = ['CHANGELOG.md', 'License.txt']
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|samples|docs|tasks)/}) }
+  end
 
-  s.metadata = {
-    'homepage_uri'      => 'https://github.com/troessner/reek',
-    'source_code_uri'   => 'https://github.com/troessner/reek',
-    'bug_tracker_uri'   => 'https://github.com/troessner/reek/issues',
-    'changelog_uri'     => 'https://github.com/troessner/reek/CHANGELOG.md',
-    'documentation_uri' => 'https://www.rubydoc.info/gems/reek'
+  spec.executables = spec.files.grep(%r{^bin/}).map { |path| File.basename(path) }
+  spec.rdoc_options = %w(--main README.md -x assets/|bin/|config/|features/|spec/|tasks/)
+  spec.required_ruby_version = '>= 2.6.0'
+
+  spec.metadata = {
+    'homepage_uri'          => 'https://github.com/troessner/reek',
+    'source_code_uri'       => 'https://github.com/troessner/reek',
+    'bug_tracker_uri'       => 'https://github.com/troessner/reek/issues',
+    'changelog_uri'         => 'https://github.com/troessner/reek/CHANGELOG.md',
+    'documentation_uri'     => 'https://www.rubydoc.info/gems/reek',
+    'rubygems_mfa_required' => 'true'
   }
 
-  s.add_runtime_dependency 'kwalify', '~> 0.7.0'
-  s.add_runtime_dependency 'parser',  '~> 3.0.0'
-  s.add_runtime_dependency 'psych',   '~> 3.1'
-  s.add_runtime_dependency 'rainbow', '>= 2.0', '< 4.0'
+  spec.add_runtime_dependency 'kwalify', '~> 0.7.0'
+  spec.add_runtime_dependency 'parser',  '~> 3.1.0'
+  spec.add_runtime_dependency 'rainbow', '>= 2.0', '< 4.0'
 end