reek 6.0.2 → 6.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83760bf0344db6b8f65cd5bbb6e57f90ee4e1b54c10edb3920821a517e6649cd
-  data.tar.gz: 258214d9022fda0ecbe287c4313719472c30f056c1ff6ffd4f7ff023b255b199
+  metadata.gz: 75ed5064f626b7d8ae34f869ee17d53960804381fb73db707c866202bb71490a
+  data.tar.gz: 07f819f93d3ac3f84deb0a0a113dfbc3136e70f9b097f72e1c535f4352fb8b7f
 SHA512:
-  metadata.gz: 56c12a16cc200dd475d84a543fd9edf2ce888f550a5d4d22cbe813c3439ed0915263340d7c02654417666bcd728ee5e9ba976670cae46098293b58595589f36c
-  data.tar.gz: 0f012f16ec237bdece4f797ea2977c0db5fa083df32ac86ce57b14911777eec0d832aff8e861df67c5cc80b847b0c3caf801a157b759724cc9f858ae4236ace9
+  metadata.gz: 71313200963b12c5c2edb8cd84d5ee4ea8fd99241c1fa0f6c6329e332ba41538b5a11990b54f24a136a748bc2492fd87f5ffcd78ef358bdd4f1420970bd2915b
+  data.tar.gz: 2f39a6f2ea9cf9a4d8eb629bc5542883ecccfb8811c1fc062a2c0aa8deb41ceacd47de2a76a2f9cb8f6b0e6b56da63551f403edc14e55cd35ae7bac62822a2b3

data/.github/dependabot.yml

@@ -0,0 +1,13 @@
+# Documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "daily"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"

data/.github/workflows/ruby.yml

@@ -0,0 +1,57 @@
+# This workflow will download a prebuilt Ruby version, install dependencies and
+# run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+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:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby: ["2.6", "2.7", "3.0", "3.1", "3.2", "jruby-9.3", "jruby-9.4"]
+
+    steps:
+      - uses: actions/checkout@v3
+      - 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@v3
+      - 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:
@@ -46,7 +48,7 @@ Layout/MultilineOperationIndentation:
 Lint/AmbiguousBlockAssociation:
   Enabled: false
 
-# Some of our source examples include interpolation explicitely.
+# Some of our source examples include interpolation explicitly.
 Lint/InterpolationCheck:
   Exclude:
     - 'spec/**/*'

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-08-19 19:02:50 UTC using RuboCop version 0.89.1.
+# on 2021-01-03 18:17:11 UTC using RuboCop version 1.7.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -13,22 +13,24 @@ Lint/MissingSuper:
     - 'lib/reek/smell_detectors/base_detector.rb'
 
 # Offense count: 2
+# Configuration parameters: IgnoredPatterns.
+# IgnoredPatterns: (?-mix:(exactly|at_least|at_most)\(\d+\)\.times)
 Lint/UnreachableLoop:
   Exclude:
     - 'spec/reek/ast/node_spec.rb'
 
 # Offense count: 2
-# Configuration parameters: IgnoredMethods.
+# Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
   Max: 21
 
 # Offense count: 1
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 161
+  Max: 170
 
 # Offense count: 13
-# Configuration parameters: CountComments, CountAsOne, ExcludedMethods.
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
   Max: 16
 

data/CHANGELOG.md

@@ -1,5 +1,47 @@
 # Change log
 
+## 6.1.4 (2023-01-13)
+
+* (mvz) Update parser dependency to the 3.2.x series
+
+## 6.1.3 (2022-12-29)
+
+* (gonubana) Allow failing safely when trying to recursively find a configuration
+
+## 6.1.2 (2022-11-21)
+
+* (mvz) Add support for keyword nil arguments
+
+## 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
+* (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.2 (2020-10-17)
 
 * (mvz) Loosen dependency on psych. This should resolve installation problems on

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
@@ -139,7 +142,7 @@ Once you’re happy with your feature / fix – or want to
 share it as a work-in-progress and request comments – once
 again make sure all of the tests pass. This will also run
 [RuboCop](https://github.com/bbatsov/rubocop) – fix any
-offences RuboCop finds (or discuss them in the pull request):
+offenses RuboCop finds (or discuss them in the pull request):
 
 ```
 bundle exec rake

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.1'
   gem 'codeclimate-engine-rb', '~> 0.4.0'
-  gem 'cucumber',              ['>= 4.0', '< 6.0']
+  gem 'cucumber',              '~> 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',               '~> 0.93.0'
-  gem 'rubocop-performance',   '~> 1.8.0'
-  gem 'rubocop-rspec',         '~> 1.43.1'
-  gem 'simplecov',             ['>= 0.18.0', '< 0.20.0']
+  gem 'rubocop',               '~> 1.43.0'
+  gem 'rubocop-performance',   '~> 1.15.0'
+  gem 'rubocop-rspec',         '~> 2.17.0'
+  gem 'simplecov',             '>= 0.18.0', '< 0.23.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.
 
@@ -411,7 +411,7 @@ def smelly_method foo
 end
 ```
 
-This is an incredibly powerful feature and further explained under [Smell Suppresion](docs/Smell-Suppression.md).
+This is an incredibly powerful feature and further explained under [Smell Suppression](docs/Smell-Suppression.md).
 
 #### Debugging trouble with the configuration
 

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

@@ -60,7 +60,7 @@ module Reek
       #
       # Returns an array with all matching nodes.
       def each_node(target_types, ignoring = [], &blk)
-        return enum_for(:each_node, target_types, ignoring) unless block_given?
+        return enum_for(:each_node, target_types, ignoring) unless blk
 
         look_for(Array(target_types), ignoring, &blk)
       end

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

@@ -104,6 +104,26 @@ 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
+
+      # Utility methods for :kwnilarg nodes.
+      module KwnilargNode
+        include ArgNodeBase
+
+        def anonymous_splat?
+          true
+        end
+      end
     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

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

data/lib/reek/cli/options.rb

@@ -110,12 +110,12 @@ module Reek
         parser.on('--smell SMELL',
                   'Only look for a specific smell.',
                   'Call it like this: reek --smell MissingSafeMethod source.rb',
-                  "Check out #{DocumentationLink.build('Code Smells')} "\
+                  "Check out #{DocumentationLink.build('Code Smells')} " \
                   'for a list of smells') do |smell|
           smells_to_detect << smell
         end
         parser.on('--stdin-filename FILE',
-                  'When passing code in via pipe, assume this filename when '\
+                  'When passing code in via pipe, assume this filename when ' \
                   'checking file or directory rules in the config.') do |file|
           self.stdin_filename = file
         end
@@ -210,12 +210,12 @@ module Reek
       def set_exit_codes
         parser.separator "\nExit codes:"
         parser.on('--success-exit-code CODE',
-                  'The exit code when no smells are found '\
+                  'The exit code when no smells are found ' \
                   "(default: #{Status::DEFAULT_SUCCESS_EXIT_CODE})") do |option|
           self.success_exit_code = Integer(option)
         end
         parser.on('--failure-exit-code CODE',
-                  'The exit code when smells are found '\
+                  'The exit code when smells are found ' \
                   "(default: #{Status::DEFAULT_FAILURE_EXIT_CODE})") do |option|
           self.failure_exit_code = Integer(option)
         end
@@ -231,8 +231,8 @@ module Reek
         parser.on_tail('-l', '--list', 'List all available smell detectors') do
           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'
+          puts "\nCheck out #{DocumentationLink.build('Code Smells')} " \
+               '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/configuration/configuration_file_finder.rb

@@ -87,7 +87,8 @@ module Reek
         #
         # @quality :reek:FeatureEnvy
         def find_in_dir(dir)
-          dir.children.detect { |item| item.file? && item.basename.to_s == DEFAULT_FILE_NAME }
+          file = dir + DEFAULT_FILE_NAME
+          file if file.file?
         end
       end
     end

data/lib/reek/configuration/excluded_paths.rb

@@ -14,7 +14,8 @@ module Reek
       # @param paths [String]
       # @return [undefined]
       def add(paths)
-        paths.each { |path| self << Pathname(path) }
+        paths.flat_map { |path| Dir[path] }.
+          each { |path| self << Pathname(path) }
       end
     end
   end

data/lib/reek/context/code_context.rb

@@ -51,7 +51,7 @@ module Reek
       # @return [Enumerator]
       #
       def each(&block)
-        return enum_for(:each) unless block_given?
+        return enum_for(:each) unless block
 
         yield self
         children.each do |child|

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative 'module_context'
+
+module Reek
+  module Context
+    #
+    # A context wrapper for any refinement blocks found in a syntax tree.
+    #
+    class RefinementContext < ModuleContext
+      def full_name
+        exp.call.args.first.name
+      end
+    end
+  end
+end

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

@@ -5,6 +5,7 @@ require_relative 'context/class_context'
 require_relative 'context/ghost_context'
 require_relative 'context/method_context'
 require_relative 'context/module_context'
+require_relative 'context/refinement_context'
 require_relative 'context/root_context'
 require_relative 'context/send_context'
 require_relative 'context/singleton_attribute_context'
@@ -20,7 +21,7 @@ module Reek
   # counting. Ideally `ContextBuilder` would only build up the context tree and leave the
   # statement and reference counting to the contexts.
   #
-  # @quality :reek:TooManyMethods { max_methods: 31 }
+  # @quality :reek:TooManyMethods { max_methods: 32 }
   # @quality :reek:UnusedPrivateMethod { exclude: [ !ruby/regexp /process_/ ] }
   # @quality :reek:DataClump
   class ContextBuilder
@@ -263,9 +264,16 @@ module Reek
     #
     # Counts non-empty blocks as one statement.
     #
+    # A refinement block is handled differently and causes a RefinementContext
+    # to be opened.
+    #
     def process_block(exp, _parent)
       increase_statement_count_by(exp.block)
-      process(exp)
+      if exp.call.name == :refine
+        handle_refinement_block(exp)
+      else
+        process(exp)
+      end
     end
 
     # Handles `begin` and `kwbegin` nodes. `begin` nodes are created implicitly
@@ -414,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
 
@@ -508,6 +516,12 @@ module Reek
       end
     end
 
+    def handle_refinement_block(exp)
+      inside_new_context(Context::RefinementContext, exp) do
+        process(exp)
+      end
+    end
+
     def handle_send_for_modules(exp)
       arg_names = exp.args.map { |arg| arg.children.first }
       current_context.track_visibility(exp.name, arg_names)

data/lib/reek/rake/task.rb

@@ -69,15 +69,15 @@ module Reek
 
       # @public
       def initialize(name = :reek)
-        @config_file   = ENV['REEK_CFG']
+        @config_file   = ENV.fetch('REEK_CFG', nil)
         @name          = name
-        @reek_opts     = ENV['REEK_OPTS'] || ''
+        @reek_opts     = ENV.fetch('REEK_OPTS', '')
         @fail_on_error = true
         @verbose       = false
 
         yield self if block_given?
 
-        if (reek_src = ENV['REEK_SRC'])
+        if (reek_src = ENV.fetch('REEK_SRC', nil))
           @source_files = FileList[reek_src]
         end
         @source_files ||= FileList['lib/**/*.rb']
@@ -87,8 +87,8 @@ module Reek
       # @public
       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'"
+          raise ArgumentError, 'File list should be a FileList or a String that can contain ' \
+                               "a glob pattern, e.g. '{app,lib,spec}/**/*.rb'"
         end
         @source_files = FileList[files]
       end