reek 5.4.0 → 6.0.1

data/lib/reek/report/text_report.rb

@@ -11,8 +11,8 @@ module Reek
     #
     class TextReport < BaseReport
       # @public
-      def initialize(*args)
-        super(*args)
+      def initialize(**args)
+        super
 
         print progress_formatter.header
       end

data/lib/reek/smell_detectors/base_detector.rb

@@ -19,6 +19,7 @@ module Reek
     # @quality :reek:TooManyMethods { max_methods: 18 }
     class BaseDetector
       attr_reader :config
+
       # The name of the config field that lists the names of code contexts
       # that should not be checked. Add this field to the config for each
       # smell that should ignore this code element.
@@ -79,7 +80,7 @@ module Reek
       end
 
       def smell_warning(**options)
-        SmellWarning.new(self,
+        SmellWarning.new(smell_type,
                          source: expression.source,
                          context: context.full_name,
                          lines: options.fetch(:lines),
@@ -121,15 +122,6 @@ module Reek
           @descendants ||= []
         end
 
-        #
-        # @param detector [String] the detector in question, e.g. 'DuplicateMethodCall'
-        # @return [Boolean]
-        #
-        def valid_detector?(detector)
-          descendants.map { |descendant| descendant.to_s.split('::').last }.
-            include?(detector)
-        end
-
         #
         # Transform a detector name to the corresponding constant.
         # Note that we assume a valid name - exceptions are not handled here.

data/lib/reek/smell_detectors/data_clump.rb

@@ -51,7 +51,7 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       def sniff
-        MethodGroup.new(context, min_clump_size, max_copies).clumps.map do |clump, methods|
+        clumps.map do |clump, methods|
           methods_length = methods.length
           smell_warning(
             lines: methods.map(&:line),
@@ -72,72 +72,39 @@ module Reek
       private
 
       def max_copies
-        value(MAX_COPIES_KEY, context)
+        @max_copies ||= value(MAX_COPIES_KEY, context)
       end
 
       def min_clump_size
-        value(MIN_CLUMP_SIZE_KEY, context)
+        @min_clump_size ||= value(MIN_CLUMP_SIZE_KEY, context)
       end
-    end
-  end
 
-  # Represents a group of methods
-  # @private
-  class MethodGroup
-    def initialize(ctx, min_clump_size, max_copies)
-      @min_clump_size = min_clump_size
-      @max_copies = max_copies
-      @candidate_methods = ctx.node_instance_methods.map do |defn_node|
-        CandidateMethod.new(defn_node)
+      def candidate_methods
+        @candidate_methods ||= context.node_instance_methods
       end
-    end
 
-    def candidate_clumps
-      candidate_methods.each_cons(max_copies + 1).map do |methods|
-        common_argument_names_for(methods)
-      end.select do |clump|
-        clump.length >= min_clump_size
-      end.uniq
-    end
-
-    # @quality :reek:UtilityFunction
-    def common_argument_names_for(methods)
-      methods.map(&:arg_names).inject(:&)
-    end
-
-    def methods_containing_clump(clump)
-      candidate_methods.select { |method| clump & method.arg_names == clump }
-    end
-
-    def clumps
-      candidate_clumps.map do |clump|
-        [clump, methods_containing_clump(clump)]
+      def candidate_clumps
+        candidate_methods.each_cons(max_copies + 1).map do |methods|
+          common_argument_names_for(methods)
+        end.select do |clump|
+          clump.length >= min_clump_size
+        end.uniq
       end
-    end
-
-    private
 
-    attr_reader :candidate_methods, :max_copies, :min_clump_size
-  end
-
-  # A method definition and a copy of its parameters
-  # @private
-  class CandidateMethod
-    extend Forwardable
-
-    def_delegators :defn, :line, :name
+      # @quality :reek:UtilityFunction
+      def common_argument_names_for(methods)
+        methods.map(&:arg_names).inject(:&).compact.sort
+      end
 
-    def initialize(defn_node)
-      @defn = defn_node
-    end
+      def methods_containing_clump(clump)
+        candidate_methods.select { |method| clump & method.arg_names == clump }
+      end
 
-    def arg_names
-      # TODO: Is all this sorting still needed?
-      @arg_names ||= defn.arg_names.compact.sort
+      def clumps
+        candidate_clumps.map do |clump|
+          [clump, methods_containing_clump(clump)]
+        end
+      end
     end
-
-    private
-
-    attr_reader :defn
   end
 end

data/lib/reek/smell_detectors/nil_check.rb

@@ -24,8 +24,7 @@ module Reek
 
       def detect_nodes
         finders = [NodeFinder.new(context, :send, NilCallNodeDetector),
-                   NodeFinder.new(context, :when, NilWhenNodeDetector),
-                   NodeFinder.new(context, :csend, SafeNavigationNodeDetector)]
+                   NodeFinder.new(context, :when, NilWhenNodeDetector)]
         finders.flat_map(&:smelly_nodes)
       end
 
@@ -88,16 +87,6 @@ module Reek
           node.condition_list.any? { |it| it.type == :nil }
         end
       end
-
-      # Detect safe navigation. Returns true for all nodes, since all :csend
-      # nodes are considered smelly.
-      module SafeNavigationNodeDetector
-        module_function
-
-        def detect(_node)
-          true
-        end
-      end
     end
   end
 end

data/lib/reek/smell_detectors/subclassed_from_core_class.rb

@@ -43,13 +43,9 @@ module Reek
       end
 
       def build_smell_warning(ancestor_name)
-        smell_attributes = {
-          lines:      [source_line],
-          message:    "inherits from core class '#{ancestor_name}'",
-          parameters: { ancestor: ancestor_name }
-        }
-
-        smell_warning(smell_attributes)
+        smell_warning(lines:      [source_line],
+                      message:    "inherits from core class '#{ancestor_name}'",
+                      parameters: { ancestor: ancestor_name })
       end
     end
   end

data/lib/reek/smell_detectors/too_many_constants.rb

@@ -35,7 +35,7 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       def sniff
-        count = context.local_nodes(:casgn).reject(&:defines_module?).length
+        count = context.local_nodes(:casgn).count { |it| !it.defines_module? }
 
         return [] if count <= max_allowed_constants
 

data/lib/reek/smell_warning.rb

@@ -15,22 +15,30 @@ module Reek
     extend Forwardable
 
     # @public
-    attr_reader :context, :lines, :message, :parameters, :smell_detector, :source
-    def_delegators :smell_detector, :smell_type
-
+    attr_reader :context, :lines, :message, :parameters, :smell_type, :source
+
+    # @param smell_type [String] type of detected smell; corresponds to
+    #   detector#smell_type
+    # @param context [String] name of the context in which the smell occured
+    # @param lines [Array<Integer>] list of lines on which the smell occured
+    # @param message [String] text describing the smell in more detail
+    # @param source [String] name of the source (e.g., the file name) in which
+    #   the smell occured
+    # @param parameters [Hash] smell-specific parameters
+    #
     # @note When using Reek's public API, you should not create SmellWarning
     #   objects yourself. This is why the initializer is not part of the
     #   public API.
     #
     # @quality :reek:LongParameterList { max_params: 6 }
-    def initialize(smell_detector, context: '', lines:, message:,
+    def initialize(smell_type, context: '', lines:, message:,
                    source:, parameters: {})
-      @smell_detector = smell_detector
-      @source         = source
-      @context        = context.to_s
-      @lines          = lines
-      @message        = message
-      @parameters     = parameters
+      @smell_type = smell_type
+      @source     = source
+      @context    = context.to_s
+      @lines      = lines
+      @message    = message
+      @parameters = parameters
 
       freeze
     end
@@ -64,10 +72,6 @@ module Reek
       "#{smell_type}: #{context} #{message}"
     end
 
-    def smell_class
-      smell_detector.class
-    end
-
     def explanatory_link
       DocumentationLink.build(smell_type)
     end

data/lib/reek/source/source_code.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 require_relative '../cli/silencer'
-Reek::CLI::Silencer.without_warnings { require 'parser/ruby26' }
+# Silence Parser's warnings about Ruby micro version differences
+Reek::CLI::Silencer.silently { require 'parser/current' }
 require_relative '../tree_dresser'
 require_relative '../ast/node'
 require_relative '../ast/builder'
@@ -53,7 +54,7 @@ module Reek
       end
 
       def self.default_parser
-        Parser::Ruby26.new(AST::Builder.new).tap do |parser|
+        Parser::CurrentRuby.new(AST::Builder.new).tap do |parser|
           diagnostics = parser.diagnostics
           diagnostics.all_errors_are_fatal = true
           diagnostics.ignore_warnings      = true

data/lib/reek/spec/smell_matcher.rb

@@ -43,8 +43,9 @@ module Reek
         raise ArgumentError, "The attribute '#{extra_keys.first}' is not available for comparison"
       end
 
+      # :reek:FeatureEnvy
       def common_parameters_equal?(other_parameters)
-        smell_warning.parameters.slice(*other_parameters.keys) == other_parameters
+        smell_warning.parameters.values_at(*other_parameters.keys) == other_parameters.values
       end
 
       def common_attributes_equal?(attributes)

data/lib/reek/version.rb

@@ -8,6 +8,6 @@ module Reek
   # @public
   module Version
     # @public
-    STRING = '5.4.0'
+    STRING = '6.0.1'
   end
 end

data/reek.gemspec

@@ -16,12 +16,11 @@ Gem::Specification.new do |s|
   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.3.0'
+  s.required_ruby_version = '>= 2.4.0'
   s.summary = 'Code smell detector for Ruby'
 
-  s.add_runtime_dependency 'codeclimate-engine-rb', '~> 0.4.0'
-  s.add_runtime_dependency 'kwalify',               '~> 0.7.0'
-  s.add_runtime_dependency 'parser',                '< 2.7', '>= 2.5.0.0', '!= 2.5.1.1'
-  s.add_runtime_dependency 'psych',                 '~> 3.1.0'
-  s.add_runtime_dependency 'rainbow',               '>= 2.0', '< 4.0'
+  s.add_runtime_dependency 'kwalify', '~> 0.7.0'
+  s.add_runtime_dependency 'parser',  '< 2.8', '>= 2.5.0.0', '!= 2.5.1.1'
+  s.add_runtime_dependency 'psych',   '~> 3.1.0'
+  s.add_runtime_dependency 'rainbow', '>= 2.0', '< 4.0'
 end

data/spec/reek/ast/sexp_extensions_spec.rb

@@ -443,73 +443,55 @@ end
 
 RSpec.describe Reek::AST::SexpExtensions::CasgnNode do
   describe '#defines_module?' do
-    context 'with single assignment' do
-      it 'does not define a module' do
-        exp = sexp(:casgn, nil, :Foo)
-        expect(exp).not_to be_defines_module
-      end
+    it 'is false for single assignment' do
+      exp = sexp(:casgn, nil, :Foo)
+      expect(exp).not_to be_defines_module
     end
 
-    context 'with implicit receiver to new' do
-      it 'does not define a module' do
-        exp = sexp(:casgn, nil, :Foo, sexp(:send, nil, :new))
-        expect(exp).not_to be_defines_module
-      end
+    it 'is false for implicit receiver to new' do
+      exp = sexp(:casgn, nil, :Foo, sexp(:send, nil, :new))
+      expect(exp).not_to be_defines_module
     end
 
-    context 'with implicit receiver to new' do
-      it 'does not define a module' do
-        exp = Reek::Source::SourceCode.from('Foo = Class.new(Bar)').syntax_tree
-
-        expect(exp).to be_defines_module
-      end
+    it 'is true for explicit receiver to new' do
+      exp = Reek::Source::SourceCode.from('Foo = Class.new(Bar)').syntax_tree
+      expect(exp).to be_defines_module
     end
 
-    context 'when assigning a lambda to a constant' do
-      it 'does not define a module' do
-        exp = Reek::Source::SourceCode.from('C = ->{}').syntax_tree
-
-        expect(exp).not_to be_defines_module
-      end
+    it 'is false for assigning a lambda to a constant' do
+      exp = Reek::Source::SourceCode.from('C = ->{}').syntax_tree
+      expect(exp).not_to be_defines_module
     end
 
-    context 'when assigning a string to a constant' do
-      it 'does not define a module' do
-        exp = Reek::Source::SourceCode.from('C = "hello"').syntax_tree
-
-        expect(exp).not_to be_defines_module
-      end
+    it 'is false for assigning a string to a constant' do
+      exp = Reek::Source::SourceCode.from('C = "hello"').syntax_tree
+      expect(exp).not_to be_defines_module
     end
   end
 
   describe '#superclass' do
     it 'returns the superclass from the class definition' do
       exp = Reek::Source::SourceCode.from('Foo = Class.new(Bar)').syntax_tree
-
       expect(exp.superclass).to eq sexp(:const, nil, :Bar)
     end
 
     it 'returns nil in case of no class definition' do
       exp = Reek::Source::SourceCode.from('Foo = 23').syntax_tree
-
       expect(exp.superclass).to be_nil
     end
 
     it 'returns nil in case of no superclass' do
       exp = Reek::Source::SourceCode.from('Foo = Class.new').syntax_tree
-
       expect(exp.superclass).to be_nil
     end
 
     it 'returns nothing for a class definition using Struct.new' do
       exp = Reek::Source::SourceCode.from('Foo = Struct.new("Bar")').syntax_tree
-
       expect(exp.superclass).to be_nil
     end
 
     it 'returns nothing for a constant assigned with a bare method call' do
       exp = Reek::Source::SourceCode.from('Foo = foo("Bar")').syntax_tree
-
       expect(exp.superclass).to be_nil
     end
   end

data/spec/reek/cli/application_spec.rb

@@ -9,7 +9,7 @@ RSpec.describe Reek::CLI::Application do
           described_class.new ['--foo']
         end
       end
-      expect(call).to raise_error(SystemExit) do |error|
+      expect(&call).to raise_error(SystemExit) do |error|
         expect(error.status).to eq Reek::CLI::Status::DEFAULT_ERROR_EXIT_CODE
       end
     end

data/spec/reek/code_comment_spec.rb

@@ -3,7 +3,7 @@ require_lib 'reek/code_comment'
 
 RSpec.describe Reek::CodeComment do
   context 'with an empty comment' do
-    let(:comment) { build(:code_comment, comment: '') }
+    let(:comment) { build_code_comment(comment: '') }
 
     it 'is not descriptive' do
       expect(comment).not_to be_descriptive
@@ -16,77 +16,63 @@ RSpec.describe Reek::CodeComment do
 
   describe '#descriptive' do
     it 'rejects an empty comment' do
-      comment = build(:code_comment, comment: '#')
+      comment = build_code_comment(comment: '#')
       expect(comment).not_to be_descriptive
     end
 
     it 'rejects a 1-word comment' do
-      comment = build(:code_comment, comment: "# alpha\n#  ")
+      comment = build_code_comment(comment: "# alpha\n#  ")
       expect(comment).not_to be_descriptive
     end
 
     it 'accepts a 2-word comment' do
-      comment = build(:code_comment, comment: '# alpha bravo  ')
+      comment = build_code_comment(comment: '# alpha bravo  ')
       expect(comment).to be_descriptive
     end
 
     it 'accepts a multi-word comment' do
-      comment = build(:code_comment, comment: "# alpha bravo \n# charlie \n   # delta ")
+      comment = build_code_comment(comment: "# alpha bravo \n# charlie \n   # delta ")
       expect(comment).to be_descriptive
     end
   end
 
   describe 'good comment config' do
     it 'parses hashed options' do
-      comment = '# :reek:DuplicateMethodCall { enabled: false }'
-      config = build(:code_comment,
-                     comment: comment).config
+      comment = '# :reek:DuplicateMethodCall { max_calls: 3 }'
+      config = build_code_comment(comment: comment).config
 
       expect(config).to include('DuplicateMethodCall')
-      expect(config['DuplicateMethodCall']).to include('enabled')
-      expect(config['DuplicateMethodCall']['enabled']).to be_falsey
-    end
-
-    it "supports hashed options with the legacy separator ':' after the smell detector" do
-      comment = '# :reek:DuplicateMethodCall: { enabled: false }'
-      config = build(:code_comment,
-                     comment: comment).config
-
-      expect(config).to include('DuplicateMethodCall')
-      expect(config['DuplicateMethodCall']).to include('enabled')
-      expect(config['DuplicateMethodCall']['enabled']).to be_falsey
+      expect(config['DuplicateMethodCall']).to have_key 'max_calls'
+      expect(config['DuplicateMethodCall']['max_calls']).to eq 3
     end
 
     it 'parses multiple hashed options' do
       comment = <<-RUBY
-        # :reek:DuplicateMethodCall { enabled: false }
+        # :reek:DuplicateMethodCall { max_calls: 3 }
         # :reek:NestedIterators { enabled: true }
       RUBY
-      config = build(:code_comment, comment: comment).config
+      config = build_code_comment(comment: comment).config
 
       expect(config).to include('DuplicateMethodCall', 'NestedIterators')
-      expect(config['DuplicateMethodCall']).to include('enabled')
-      expect(config['DuplicateMethodCall']['enabled']).to be_falsey
-      expect(config['NestedIterators']).to include('enabled')
+      expect(config['DuplicateMethodCall']['max_calls']).to eq 3
       expect(config['NestedIterators']['enabled']).to be_truthy
     end
 
     it 'parses multiple hashed options on the same line' do
       comment = <<-RUBY
-        #:reek:DuplicateMethodCall { enabled: false } and :reek:NestedIterators { enabled: true }
+        #:reek:DuplicateMethodCall { max_calls: 3 } and :reek:NestedIterators { enabled: true }
       RUBY
-      config = build(:code_comment, comment: comment).config
+      config = build_code_comment(comment: comment).config
 
       expect(config).to include('DuplicateMethodCall', 'NestedIterators')
-      expect(config['DuplicateMethodCall']).to include('enabled')
-      expect(config['DuplicateMethodCall']['enabled']).to be_falsey
+      expect(config['DuplicateMethodCall']['max_calls']).to eq 3
       expect(config['NestedIterators']).to include('enabled')
       expect(config['NestedIterators']['enabled']).to be_truthy
     end
 
     it 'parses multiple unhashed options on the same line' do
       comment = '# :reek:DuplicateMethodCall and :reek:NestedIterators'
-      config = build(:code_comment, comment: comment).config
+      config = build_code_comment(comment: comment).config
 
       expect(config).to include('DuplicateMethodCall', 'NestedIterators')
       expect(config['DuplicateMethodCall']).to include('enabled')
@@ -97,27 +83,33 @@ RSpec.describe Reek::CodeComment do
 
     it 'disables the smell if no options are specifed' do
       comment = '# :reek:DuplicateMethodCall'
-      config = build(:code_comment, comment: comment).config
+      config = build_code_comment(comment: comment).config
 
       expect(config).to include('DuplicateMethodCall')
       expect(config['DuplicateMethodCall']).to include('enabled')
       expect(config['DuplicateMethodCall']['enabled']).to be_falsey
     end
 
+    it 'does not disable the smell if options are specifed' do
+      comment = '# :reek:DuplicateMethodCall { max_calls: 3 }'
+      config = build_code_comment(comment: comment).config
+
+      expect(config['DuplicateMethodCall']).not_to include('enabled')
+    end
+
     it 'ignores smells after a space' do
-      config = build(:code_comment,
-                     comment: '# :reek: DuplicateMethodCall').config
+      config = build_code_comment(comment: '# :reek: DuplicateMethodCall').config
       expect(config).not_to include('DuplicateMethodCall')
     end
 
     it 'removes the configuration options from the comment' do
       original_comment = <<-RUBY
         # Actual
-        # :reek:DuplicateMethodCall { enabled: false }
+        # :reek:DuplicateMethodCall { max_calls: 3 }
         # :reek:NestedIterators { enabled: true }
         # comment
       RUBY
-      comment = build(:code_comment, comment: original_comment)
+      comment = build_code_comment(comment: original_comment)
 
       expect(comment.send(:sanitized_comment)).to eq('Actual comment')
     end
@@ -128,8 +120,7 @@ RSpec.describe Reek::CodeComment::CodeCommentValidator do
   context 'when the comment contains an unknown detector name' do
     it 'raises BadDetectorInCommentError' do
       expect do
-        build(:code_comment,
-              comment: '# :reek:DoesNotExist')
+        build_code_comment(comment: '# :reek:DoesNotExist')
       end.to raise_error(Reek::Errors::BadDetectorInCommentError)
     end
   end
@@ -138,18 +129,26 @@ RSpec.describe Reek::CodeComment::CodeCommentValidator do
     it 'raises GarbageDetectorConfigurationInCommentError' do
       expect do
         comment = '# :reek:UncommunicativeMethodName { thats: a: bad: config }'
-        build(:code_comment, comment: comment)
+        build_code_comment(comment: comment)
       end.to raise_error(Reek::Errors::GarbageDetectorConfigurationInCommentError)
     end
   end
 
+  context 'when the legacy comment format was used' do
+    it 'raises LegacyCommentSeparatorError' do
+      comment = '# :reek:DuplicateMethodCall:'
+      expect { build_code_comment(comment: comment) }.
+        to raise_error Reek::Errors::LegacyCommentSeparatorError
+    end
+  end
+
   describe 'validating configuration keys' do
     context 'when basic options are mispelled' do
       it 'raises BadDetectorConfigurationKeyInCommentError' do
         expect do
           # exclude -> exlude and enabled -> nabled
           comment = '# :reek:UncommunicativeMethodName { exlude: alfa, nabled: true }'
-          build(:code_comment, comment: comment)
+          build_code_comment(comment: comment)
         end.to raise_error(Reek::Errors::BadDetectorConfigurationKeyInCommentError)
       end
     end
@@ -158,7 +157,7 @@ RSpec.describe Reek::CodeComment::CodeCommentValidator do
       it 'does not raise' do
         expect do
           comment = '# :reek:UncommunicativeMethodName { exclude: alfa, enabled: true }'
-          build(:code_comment, comment: comment)
+          build_code_comment(comment: comment)
         end.not_to raise_error
       end
     end
@@ -168,7 +167,7 @@ RSpec.describe Reek::CodeComment::CodeCommentValidator do
         expect do
           # max_copies -> mx_copies and min_clump_size -> mn_clump_size
           comment = '# :reek:DataClump { mx_copies: 4, mn_clump_size: 3 }'
-          build(:code_comment, comment: comment)
+          build_code_comment(comment: comment)
         end.to raise_error(Reek::Errors::BadDetectorConfigurationKeyInCommentError)
       end
     end
@@ -177,7 +176,7 @@ RSpec.describe Reek::CodeComment::CodeCommentValidator do
       it 'does not raise' do
         expect do
           comment = '# :reek:DataClump { max_copies: 4, min_clump_size: 3 }'
-          build(:code_comment, comment: comment)
+          build_code_comment(comment: comment)
         end.not_to raise_error
       end
     end