reek 5.4.1 → 6.0.2

data/lib/reek/examiner.rb

@@ -105,11 +105,11 @@ module Reek
     rescue Errors::BaseError
       raise
     rescue EncodingError
-      raise Errors::EncodingError, origin: origin
+      raise Errors::EncodingError.new(origin: origin)
     rescue Parser::SyntaxError
-      raise Errors::SyntaxError, origin: origin
+      raise Errors::SyntaxError.new(origin: origin)
     rescue StandardError
-      raise Errors::IncomprehensibleSourceError, origin: origin
+      raise Errors::IncomprehensibleSourceError.new(origin: origin)
     end
 
     def syntax_tree

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_configuration.yml

@@ -59,7 +59,7 @@ BooleanParameter:
 
     ## Getting rid of the smell
 
-    This is highly dependant on your exact architecture, but looking at the example above what you could do is:
+    This is highly dependent on your exact architecture, but looking at the example above what you could do is:
 
     * Move everything in the `if` branch into a separate method
     * Move everything in the `else` branch into a separate method

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/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.
@@ -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/boolean_parameter.rb

@@ -14,6 +14,8 @@ module Reek
     #
     # See {file:docs/Boolean-Parameter.md} for details.
     class BooleanParameter < BaseDetector
+      BOOLEAN_VALUES = [:true, :false].freeze
+
       #
       # Checks whether the given method has any Boolean parameters.
       #
@@ -21,7 +23,7 @@ module Reek
       #
       def sniff
         context.default_assignments.select do |_parameter, value|
-          [:true, :false].include?(value.type)
+          BOOLEAN_VALUES.include?(value.type)
         end.map do |parameter, _value|
           smell_warning(
             lines: [source_line],

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

@@ -74,7 +74,7 @@ module Reek
       end
 
       def uncommunicative_variable_name?(name)
-        sanitized_name = name.to_s.gsub(/^[@\*\&]*/, '')
+        sanitized_name = name.to_s.gsub(/^[@*&]*/, '')
         !acceptable_name?(sanitized_name)
       end
 

data/lib/reek/smell_warning.rb

@@ -31,8 +31,7 @@ module Reek
     #   public API.
     #
     # @quality :reek:LongParameterList { max_params: 6 }
-    def initialize(smell_type, context: '', lines:, message:,
-                   source:, parameters: {})
+    def initialize(smell_type, lines:, message:, source:, context: '', parameters: {})
       @smell_type = smell_type
       @source     = source
       @context    = context.to_s

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/source/source_locator.rb

@@ -33,23 +33,26 @@ module Reek
 
       attr_reader :configuration, :paths, :options
 
-      # @quality :reek:TooManyStatements { max_statements: 7 }
-      # @quality :reek:NestedIterators { max_allowed_nesting: 2 }
       def source_paths
         paths.each_with_object([]) do |given_path, relevant_paths|
-          unless given_path.exist?
+          if given_path.exist?
+            relevant_paths.concat source_files_from_path(given_path)
+          else
             print_no_such_file_error(given_path)
-            next
           end
+        end
+      end
 
-          given_path.find do |path|
-            if path.directory?
-              ignore_path?(path) ? Find.prune : next
-            elsif ruby_file?(path)
-              relevant_paths << path unless ignore_file?(path)
-            end
+      def source_files_from_path(given_path)
+        relevant_paths = []
+        given_path.find do |path|
+          if path.directory?
+            Find.prune if ignore_path?(path)
+          elsif ruby_file?(path)
+            relevant_paths << path unless ignore_file?(path)
           end
         end
+        relevant_paths
       end
 
       def ignore_file?(path)

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.1'
+    STRING = '6.0.2'
   end
 end

data/reek.gemspec

@@ -16,12 +16,19 @@ 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.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'
+  }
+
+  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'
+  s.add_runtime_dependency 'rainbow', '>= 2.0', '< 4.0'
 end

data/spec/performance/reek/smell_detectors/runtime_speed_spec.rb

@@ -6,10 +6,8 @@ RSpec.describe 'Runtime speed' do
 
   it 'runs on our smelly sources in less than 5 seconds' do
     expect do
-      source_directory.each_entry do |entry|
-        next if %w(. ..).include?(entry.to_s)
-
-        examiner = Reek::Examiner.new entry.to_path
+      Dir[source_directory.join('**/*.rb')].each do |entry|
+        examiner = Reek::Examiner.new Pathname.new(entry)
         examiner.smells.size
       end
     end.to perform_under(5).sec

data/spec/quality/documentation_spec.rb

@@ -4,6 +4,7 @@ require 'kramdown'
 RSpec.describe 'Documentation' do
   root = File.expand_path('../..', __dir__)
   files = Dir.glob(File.join(root, '*.md')) + Dir.glob(File.join(root, 'docs', '*.md'))
+  code_types = [:codeblock, :codespan]
 
   files.each do |file|
     describe "from #{file}" do
@@ -13,7 +14,7 @@ RSpec.describe 'Documentation' do
 
       blocks.each do |block|
         # Only consider code blocks with language 'ruby'.
-        next unless [:codeblock, :codespan].include?(block.type)
+        next unless code_types.include?(block.type)
         next unless block.attr['class'] == 'language-ruby'
 
         it "has a valid sample at #{block.options[:location] + 1}" do