reek 6.0.5 → 6.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23929fdfa24a401c782d5390e43941b9a3829ed51083e2f1b7d6bcfe1280cd4e
-  data.tar.gz: 24ce8ccc73f1db8f7f2571d80d14ae95ba52060efd37f2d76af39a8bdaf0f177
+  metadata.gz: 2e1e79296b4eb0b93d7b6d7bc7b13704b6831765416cab19c729473d2fe135ea
+  data.tar.gz: f9a49ffd6ad47e308a617bafb0901d438617c863ff5279c867d5db8e9148c0e4
 SHA512:
-  metadata.gz: 147a1013216674c7ead0cea2299ccaa37ccd89d2f409f11f65cf64706f747b96bbe06364059391a8f252c05fba3c2a9f7b4f314f424e92af5673ecc8eae20b74
-  data.tar.gz: 2255554dbf2f7c1b3bb11daa8da1b7956c2ce1bb4a9c02da420f0db24fd285c8857dbbdf4b04616029ff1b0ed30bdd857012435d8557e6e1a7237d9c38887710
+  metadata.gz: 3ea8856c9c0f32543af3bb336790d9875cdf385ed45d2609af219f1857931d1b15de7802386954caff9c68f5753657f138e2eb304ef4ae94edc0e7a0e7e4e070
+  data.tar.gz: 407628086e04a8d2972f1343a34d299e77d462b0236f18e8b4570a9b9dfcd290dc6d690be56c67e06c0fff95326e764254b70c127962f5a90914a73bae115aed

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,5 +1,20 @@
 # Change log
 
+## 6.1.1 (2022-04-20)
+
+* (ydah) UnusedPrivateMethod to be detect use of methods via `Method#to_proc`
+
+## 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

data/Gemfile

@@ -5,17 +5,17 @@ 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', '< 7.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.12.0'
-  gem 'rubocop-performance',   '~> 1.10.1'
-  gem 'rubocop-rspec',         '~> 2.2.0'
+  gem 'rubocop',               '~> 1.27.0'
+  gem 'rubocop-performance',   '~> 1.13.1'
+  gem 'rubocop-rspec',         '~> 2.9.0'
   gem 'simplecov',             ['>= 0.18.0', '< 0.22.0']
   gem 'yard',                  '~> 0.9.5'
 

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/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/module_context.rb

@@ -55,6 +55,10 @@ module Reek
         end
       end
 
+      def instance_method_names_via_to_call
+        instance_method_calls.flat_map(&:method_name_called_to_call).compact
+      end
+
       #
       # @deprecated use `defined_instance_methods` instead
       #

data/lib/reek/context/send_context.rb

@@ -14,6 +14,12 @@ module Reek
         @name = name
         super exp
       end
+
+      def method_name_called_to_call
+        return unless @name == :method
+
+        local_nodes(:sym).map(&:name)
+      end
     end
   end
 end

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/smell_detectors/unused_private_method.rb

@@ -61,6 +61,7 @@ module Reek
       def unused_private_methods
         defined_private_methods = context.defined_instance_methods(visibility: :private)
         called_method_names     = context.instance_method_calls.map(&:name)
+        called_method_names.concat(context.instance_method_names_via_to_call)
 
         defined_private_methods.reject do |defined_method|
           called_method_names.include?(defined_method.name)

data/lib/reek/smell_warning.rb

@@ -59,7 +59,7 @@ module Reek
 
     # @public
     def to_hash
-      stringified_params = parameters.map { |key, val| [key.to_s, val] }.to_h
+      stringified_params = parameters.transform_keys(&:to_s)
       base_hash.merge(stringified_params)
     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.5'
+    STRING = '6.1.1'
   end
 end

data/reek.gemspec

@@ -1,37 +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 = Dir.chdir(File.expand_path(__dir__)) do
+  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.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.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'
 
-  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.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', '< 5.0'
-  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

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 6.0.5
+  version: 6.1.1
 platform: ruby
 authors:
 - Kevin Rutherford
 - Timo Roessner
 - Matijs van Zuijlen
 - Piotr Szotkowski
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-01 00:00:00.000000000 Z
+date: 2022-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kwalify
@@ -33,34 +33,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
-- !ruby/object:Gem::Dependency
-  name: psych
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
@@ -263,7 +243,8 @@ metadata:
   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
-post_install_message:
+  rubygems_mfa_required: 'true'
+post_install_message: 
 rdoc_options:
 - "--main"
 - README.md
@@ -275,15 +256,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: Code smell detector for Ruby
 test_files: []