reek 5.6.0 → 6.0.0

data/lib/reek/errors/legacy_comment_separator_error.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'base_error'
+
+module Reek
+  module Errors
+    # Gets raised for old-style comment configuration format.
+    class LegacyCommentSeparatorError < BaseError
+      MESSAGE = <<-MESSAGE
+        Error: You are using the legacy configuration format (including three
+        colons) to configure Reek in one your source code comments.
+
+        The source is '%<source>s' and the comment belongs to the expression
+        starting in line %<line>d.
+
+        Here's the original comment:
+
+        %<comment>s
+
+        Please see the Reek docs for information on how to configure Reek via
+        source code comments: #{DocumentationLink.build('Smell Suppression')}
+
+        Update the offensive comment and re-run Reek.
+
+      MESSAGE
+
+      def initialize(source:, line:, original_comment:)
+        message = format(MESSAGE,
+                         source: source,
+                         line: line,
+                         comment: original_comment)
+        super message
+      end
+    end
+  end
+end

data/lib/reek/report.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'report/code_climate'
 require_relative 'report/html_report'
 require_relative 'report/json_report'
 require_relative 'report/text_report'
@@ -17,12 +16,11 @@ module Reek
   # Reek reporting functionality.
   module Report
     REPORT_CLASSES = {
-      yaml:         YAMLReport,
-      json:         JSONReport,
-      html:         HTMLReport,
-      xml:          XMLReport,
-      text:         TextReport,
-      code_climate: CodeClimateReport
+      yaml: YAMLReport,
+      json: JSONReport,
+      html: HTMLReport,
+      xml:  XMLReport,
+      text: TextReport
     }.freeze
 
     LOCATION_FORMATTERS = {

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../base_report'
+require_relative 'code_climate_formatter'
 
 module Reek
   module Report
@@ -12,7 +13,7 @@ module Reek
     class CodeClimateReport < BaseReport
       def show(out = $stdout)
         smells.map do |smell|
-          out.print warning_formatter.format_code_climate_hash(smell)
+          out.print CodeClimateFormatter.new(smell).render
         end
       end
     end

data/lib/reek/report/simple_warning_formatter.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'code_climate/code_climate_formatter'
-
 module Reek
   module Report
     #
@@ -17,11 +15,6 @@ module Reek
         "#{location_formatter.format(warning)}#{warning.base_message}"
       end
 
-      # @quality :reek:UtilityFunction
-      def format_code_climate_hash(warning)
-        CodeClimateFormatter.new(warning).render
-      end
-
       def format_list(warnings)
         warnings.map { |warning| "  #{format(warning)}" }.join("\n")
       end

data/lib/reek/smell_detectors/base_detector.rb

@@ -121,15 +121,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/version.rb

@@ -8,6 +8,6 @@ module Reek
   # @public
   module Version
     # @public
-    STRING = '5.6.0'
+    STRING = '6.0.0'
   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.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'
+  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/code_comment_spec.rb

@@ -38,48 +38,35 @@ RSpec.describe Reek::CodeComment do
 
   describe 'good comment config' do
     it 'parses hashed options' do
-      comment = '# :reek:DuplicateMethodCall { enabled: false }'
+      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
 
       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
 
       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
@@ -104,6 +91,13 @@ RSpec.describe Reek::CodeComment do
       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
@@ -113,7 +107,7 @@ RSpec.describe Reek::CodeComment do
     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
@@ -143,6 +137,14 @@ RSpec.describe Reek::CodeComment::CodeCommentValidator do
     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