reek 6.0.2 → 6.2.0

data/bin/code_climate_reek

@@ -6,7 +6,8 @@
 
 require_relative '../lib/reek'
 require_relative '../lib/reek/cli/application'
-require_relative '../lib/reek/report/code_climate'
+require_relative '../lib/reek/code_climate'
+Reek::CLI::Silencer.silently { require 'parser/current' }
 
 # Map input coming from CodeClimate to Reek.
 class CodeClimateToReek
@@ -14,15 +15,16 @@ 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
+  CUSTOM_CONFIG_KEY = 'config'
+  CUSTOM_CONFIG_TARGET_RUBY_VERSION_KEY = 'target_ruby_version'
 
   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
@@ -32,6 +34,10 @@ class CodeClimateToReek
     include_paths + ENGINE_CONFIGURATION
   end
 
+  def target_ruby_version
+    config.dig(CUSTOM_CONFIG_KEY, CUSTOM_CONFIG_TARGET_RUBY_VERSION_KEY)
+  end
+
   private
 
   def configuration_file_exists?
@@ -46,11 +52,14 @@ class CodeClimateToReek
   #   ]
   # }
   def include_paths
+    config.fetch include_paths_key, include_paths_default
+  end
+
+  def config
     if configuration_file_exists?
-      config = JSON.parse File.read(configuration_file_path)
-      config.fetch include_paths_key, include_paths_default
+      JSON.parse File.read(configuration_file_path)
     else
-      include_paths_default
+      {}
     end
   end
 end
@@ -58,11 +67,50 @@ end
 # Override for ReportCommand to force the use of CodeClimateReport.
 module ReportClassOverride
   def report_class
-    Reek::Report::CodeClimateReport
+    Reek::CodeClimate::CodeClimateReport
+  end
+end
+
+# Override Reek::Source::SourceCode to use a parser version specified by the user
+module SourceCodeOverride
+  # override self.default_parser method
+  def default_parser
+    parser_class.new(Reek::AST::Builder.new).tap do |parser|
+      diagnostics = parser.diagnostics
+      diagnostics.all_errors_are_fatal = true
+      diagnostics.ignore_warnings      = true
+    end
+  end
+
+  # config.json file will look like this:
+  # {
+  #   "include_paths":[
+  #     "lib",
+  #     "spec"
+  #   ],
+  #   "config": {
+  #     "target_ruby_version": "3.1.0"
+  #   }
+  # }
+  def parser_class
+    # convert an X.Y.Z version number to an XY two digit number
+    requested_version = CodeClimateToReek.new.target_ruby_version
+    return Parser::CurrentRuby if requested_version.nil?
+
+    version_number = Gem::Version.new(requested_version).segments[0..1].join
+
+    begin
+      Reek::CLI::Silencer.silently { require "parser/ruby#{version_number}" }
+      Module.const_get("Parser::Ruby#{version_number}")
+    rescue LoadError, NameError
+      # use Parser::CurrentRuby when an invalid version number is provided
+      Parser::CurrentRuby
+    end
   end
 end
 
 Reek::CLI::Command::ReportCommand.prepend ReportClassOverride
+Reek::Source::SourceCode.singleton_class.prepend SourceCodeOverride
 
 application = Reek::CLI::Application.new(CodeClimateToReek.new.cli_arguments)
 

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
@@ -24,13 +24,10 @@ module Reek
         end
 
         def module_creation_call?
-          object_creation_call? && module_creation_receiver?
-        end
+          return true if object_creation_call? && module_creation_receiver?
+          return true if data_definition_call? && data_definition_receiver?
 
-        def module_creation_receiver?
-          receiver &&
-            receiver.type == :const &&
-            [:Class, :Struct].include?(receiver.simple_name)
+          false
         end
 
         def object_creation_call?
@@ -47,6 +44,24 @@ module Reek
         def attr_with_writable_flag?
           name == :attr && args.any? && args.last.type == :true
         end
+
+        private
+
+        def module_creation_receiver?
+          const_receiver? && [:Class, :Struct].include?(receiver.simple_name)
+        end
+
+        def data_definition_call?
+          name == :define
+        end
+
+        def data_definition_receiver?
+          const_receiver? && receiver.simple_name == :Data
+        end
+
+        def const_receiver?
+          receiver && receiver.type == :const
+        end
       end
 
       Op_AsgnNode = SendNode

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

@@ -13,7 +13,7 @@ module Reek
       #
       class TodoListCommand < BaseCommand
         HEADER = "# Auto generated by Reeks --todo flag\n"
-        EXISTING_FILE_MESSAGE = "\nExisting '#{DEFAULT_CONFIGURATION_FILE_NAME}' detected - aborting.\n"
+        EXISTING_FILE_MESSAGE = "\nExisting '#{DEFAULT_CONFIGURATION_FILE_NAME}' detected - aborting.\n".freeze
         NO_SMELLS_FOUND_MESSAGE = "\nNo smells found - nothing to do, exiting.\n"
 
         def execute
@@ -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/{report/code_climate → code_climate}/code_climate_configuration.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Reek
-  module Report
+  module CodeClimate
     # loads the smell type metadata to present in Code Climate
     module CodeClimateConfiguration
       def self.load

data/lib/reek/{report/code_climate → code_climate}/code_climate_configuration.yml

@@ -10,7 +10,7 @@ Attribute:
 
     Given:
 
-    ```Ruby
+    ```ruby
     class Klass
       attr_accessor :dummy
     end
@@ -33,7 +33,7 @@ BooleanParameter:
 
     Given
 
-    ```Ruby
+    ```ruby
     class Dummy
       def hit_the_switch(switch = true)
         if switch
@@ -63,7 +63,7 @@ BooleanParameter:
 
     * Move everything in the `if` branch into a separate method
     * Move everything in the `else` branch into a separate method
-    * Get rid of the `hit_the_switch` method alltogether
+    * Get rid of the `hit_the_switch` method altogether
     * Make the decision what method to call in the initial caller of `hit_the_switch`
 ClassVariable:
   remediation_points: 350_000
@@ -76,7 +76,7 @@ ClassVariable:
 
     Given
 
-    ```Ruby
+    ```ruby
     class Dummy
       @@class_variable = :whatever
     end
@@ -95,7 +95,7 @@ ClassVariable:
 
     You can use class-instance variable to mitigate the problem (as also suggested in the linked article above):
 
-    ```Ruby
+    ```ruby
     class Dummy
       @class_variable = :whatever
     end
@@ -109,7 +109,7 @@ ControlParameter:
 
     A simple example would be the "quoted" parameter in the following method:
 
-    ```Ruby
+    ```ruby
     def write(quoted)
       if quoted
         write_quoted @value
@@ -119,7 +119,7 @@ ControlParameter:
     end
     ```
 
-    Fixing those problems is out of the scope of this document but an easy solution could be to remove the "write" method alltogether and to move the calls to "write_quoted" / "write_unquoted" in the initial caller of "write".
+    Fixing those problems is out of the scope of this document but an easy solution could be to remove the "write" method altogether and to move the calls to "write_quoted" / "write_unquoted" in the initial caller of "write".
 DataClump:
   remediation_points: 250_000
   content: |
@@ -131,7 +131,7 @@ DataClump:
 
     Given
 
-    ```Ruby
+    ```ruby
     class Dummy
       def x(y1,y2); end
       def y(y1,y2); end
@@ -160,7 +160,7 @@ DuplicateMethodCall:
 
     Here's a very much simplified and contrived example. The following method will report a warning:
 
-    ```Ruby
+    ```ruby
     def double_thing()
       @other.thing + @other.thing
     end
@@ -168,7 +168,7 @@ DuplicateMethodCall:
 
     One quick approach to silence Reek would be to refactor the code thus:
 
-    ```Ruby
+    ```ruby
     def double_thing()
       thing = @other.thing
       thing + thing
@@ -177,7 +177,7 @@ DuplicateMethodCall:
 
     A slightly different approach would be to replace all calls of `double_thing` by calls to `@other.double_thing`:
 
-    ```Ruby
+    ```ruby
     class Other
       def double_thing()
         thing + thing
@@ -201,7 +201,7 @@ FeatureEnvy:
 
     Running Reek on:
 
-    ```Ruby
+    ```ruby
     class Warehouse
       def sale_price(item)
         (item.price - item.rebate) * @vat
@@ -211,13 +211,13 @@ FeatureEnvy:
 
     would report:
 
-    ```Bash
+    ```bash
     Warehouse#total_price refers to item more than self (FeatureEnvy)
     ```
 
     since this:
 
-    ```Ruby
+    ```ruby
     (item.price - item.rebate)
     ```
 
@@ -229,7 +229,7 @@ InstanceVariableAssumption:
 
     Good:
 
-    ```Ruby
+    ```ruby
     class Foo
       def initialize
         @bar = :foo
@@ -243,7 +243,7 @@ InstanceVariableAssumption:
 
     Good as well:
 
-    ```Ruby
+    ```ruby
     class Foo
       def foo?
         bar == :foo
@@ -257,7 +257,7 @@ InstanceVariableAssumption:
 
     Bad:
 
-    ```Ruby
+    ```ruby
     class Foo
       def go_foo!
         @bar = :foo
@@ -273,7 +273,7 @@ InstanceVariableAssumption:
 
     Running Reek on:
 
-    ```Ruby
+    ```ruby
     class Dummy
       def test
         @ivar
@@ -283,13 +283,13 @@ InstanceVariableAssumption:
 
     would report:
 
-    ```Bash
+    ```bash
       [1]:InstanceVariableAssumption: Dummy assumes too much for instance variable @ivar
     ```
 
     Note that this example would trigger this smell warning as well:
 
-    ```Ruby
+    ```ruby
     class Parent
       def initialize(omg)
         @omg = omg
@@ -305,7 +305,7 @@ InstanceVariableAssumption:
 
     The way to address the smell warning is that you should create an `attr_reader` to use `@omg` in the subclass and not access `@omg` directly like this:
 
-    ```Ruby
+    ```ruby
     class Parent
       attr_reader :omg
 
@@ -325,7 +325,7 @@ InstanceVariableAssumption:
 
     If you don't want to expose those methods as public API just make them private like this:
 
-    ```Ruby
+    ```ruby
     class Parent
       def initialize(omg)
         @omg = omg
@@ -360,7 +360,7 @@ IrresponsibleModule:
 
     Given
 
-    ```Ruby
+    ```ruby
     class Dummy
       # Do things...
     end
@@ -375,7 +375,7 @@ IrresponsibleModule:
 
     Fixing this is simple - just an explaining comment:
 
-    ```Ruby
+    ```ruby
     # The Dummy class is responsible for ...
     class Dummy
       # Do things...
@@ -390,7 +390,7 @@ LongParameterList:
 
     Given
 
-    ```Ruby
+    ```ruby
     class Dummy
       def long_list(foo,bar,baz,fling,flung)
         puts foo,bar,baz,fling,flung
@@ -413,7 +413,7 @@ LongYieldList:
 
     ## Example
 
-    ```Ruby
+    ```ruby
     class Dummy
       def yields_a_lot(foo,bar,baz,fling,flung)
         yield foo,bar,baz,fling,flung
@@ -436,7 +436,7 @@ ManualDispatch:
 
     ## Example
 
-    ```Ruby
+    ```ruby
     class MyManualDispatcher
       attr_reader :foo
 
@@ -467,7 +467,7 @@ ModuleInitialize:
 
     The `Foo` module below contains a method `initialize`. Although class `B` inherits from `A`, the inclusion of `Foo` stops `A#initialize` from being called.
 
-    ```Ruby
+    ```ruby
     class A
       def initialize(a)
         @a = a
@@ -492,7 +492,7 @@ ModuleInitialize:
 
     A simple solution is to rename `Foo#initialize` and call that method by name:
 
-    ```Ruby
+    ```ruby
     module Foo
       def setup_foo_module(foo)
         @foo = foo
@@ -518,7 +518,7 @@ NestedIterators:
 
     Given
 
-    ```Ruby
+    ```ruby
     class Duck
       class << self
         def duck_names
@@ -549,7 +549,7 @@ NilCheck:
 
     Given
 
-    ```Ruby
+    ```ruby
     class Klass
       def nil_checker(argument)
         if argument.nil?
@@ -582,7 +582,7 @@ MissingSafeMethod:
 
     Given
 
-    ```Ruby
+    ```ruby
     class C
       def foo; end
       def foo!; end
@@ -595,7 +595,7 @@ MissingSafeMethod:
     Reek reports this smell only in a class context, not in a module context in order to allow perfectly legit code like this:
 
 
-    ```Ruby
+    ```ruby
     class Parent
       def foo; end
     end
@@ -622,7 +622,7 @@ RepeatedConditional:
 
     Given
 
-    ```Ruby
+    ```ruby
     class RepeatedConditionals
       attr_accessor :switch
 
@@ -664,7 +664,7 @@ TooManyInstanceVariables:
 
     and this code:
 
-    ```Ruby
+    ```ruby
     class TooManyInstanceVariables
       def initialize
         @arg_1 = :dummy
@@ -697,7 +697,7 @@ TooManyConstants:
 
     and this code:
 
-    ```Ruby
+    ```ruby
     class TooManyConstants
       CONST_1 = :dummy
       CONST_2 = :dummy
@@ -728,7 +728,7 @@ TooManyMethods:
 
     and this code:
 
-    ```Ruby
+    ```ruby
     class TooManyMethods
       def one; end
       def two; end
@@ -752,7 +752,7 @@ TooManyStatements:
 
     So the following method would score +6 in Reek's statement-counting algorithm:
 
-    ```Ruby
+    ```ruby
     def parse(arg, argv, &error)
       if !(val = arg) and (argv.empty? or /\A-/ =~ (val = argv[0]))
         return nil, block, nil                                         # +1
@@ -768,7 +768,7 @@ TooManyStatements:
     end
     ```
 
-    (You might argue that the two assigments within the first @if@ should count as statements, and that perhaps the nested assignment should count as +2.)
+    (You might argue that the two assignments within the first @if@ should count as statements, and that perhaps the nested assignment should count as +2.)
 UncommunicativeMethodName:
   remediation_points: 150_000
   content: |
@@ -804,7 +804,7 @@ UnusedParameters:
 
     Given:
 
-    ```Ruby
+    ```ruby
     class Klass
       def unused_parameters(x,y,z)
         puts x,y # but not z
@@ -830,7 +830,7 @@ UnusedPrivateMethod:
 
     Given:
 
-    ```Ruby
+    ```ruby
     class Car
       private
       def drive; end

data/lib/reek/{report/code_climate → code_climate}/code_climate_fingerprint.rb

@@ -3,7 +3,7 @@
 require 'digest'
 
 module Reek
-  module Report
+  module CodeClimate
     # Generates a string to uniquely identify a smell
     class CodeClimateFingerprint
       NON_IDENTIFYING_PARAMETERS = [:count, :depth].freeze
@@ -36,7 +36,7 @@ module Reek
       end
 
       def parameters
-        warning.parameters.reject { |key, _| NON_IDENTIFYING_PARAMETERS.include?(key) }.sort.to_s
+        warning.parameters.except(*NON_IDENTIFYING_PARAMETERS).sort.to_s
       end
 
       def warning_uniquely_identifiable?

data/lib/reek/{report/code_climate → code_climate}/code_climate_formatter.rb

@@ -4,7 +4,7 @@ require 'codeclimate_engine'
 require_relative 'code_climate_configuration'
 
 module Reek
-  module Report
+  module CodeClimate
     # Generates a hash in the structure specified by the Code Climate engine spec
     class CodeClimateFormatter
       def initialize(warning)
@@ -57,9 +57,7 @@ module Reek
       end
 
       def configuration
-        @configuration ||= begin
-          CodeClimateConfiguration.load
-        end
+        @configuration ||= CodeClimateConfiguration.load
       end
     end
   end