reek 4.4.0 → 4.4.1

data/lib/reek/context/code_context.rb

@@ -16,6 +16,7 @@ module Reek
     # :reek:TooManyMethods: { max_methods: 19 }
     # :reek:TooManyInstanceVariables: { max_instance_variables: 8 }
     class CodeContext
+      include Enumerable
       extend Forwardable
       delegate each_node: :exp
       delegate %i(name type) => :exp

data/lib/reek/examiner.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 require_relative 'context_builder'
 require_relative 'source/source_code'
-require_relative 'cli/warning_collector'
 require_relative 'smells/smell_repository'
 
 module Reek
@@ -9,8 +8,6 @@ module Reek
   # Applies all available smell detectors to a source.
   #
   # @public
-  #
-  # :reek:TooManyInstanceVariables: { max_instance_variables: 7 }
   class Examiner
     INCOMPREHENSIBLE_SOURCE_TEMPLATE = <<-EOS.freeze
       !!!
@@ -44,19 +41,24 @@ module Reek
                    configuration: Configuration::AppConfiguration.default,
                    smell_repository_class: Smells::SmellRepository)
       @source           = Source::SourceCode.from(source)
-      @collector        = CLI::WarningCollector.new
       @smell_types      = smell_repository_class.eligible_smell_types(filter_by_smells)
       @smell_repository = smell_repository_class.new(smell_types: @smell_types,
                                                      configuration: configuration.directive_for(description))
     end
 
-    # FIXME: Should be named "origin"
+    # @return [String] origin of the source being analysed
     #
+    # @public
+    def origin
+      @origin ||= source.origin
+    end
+
     # @return [String] description of the source being analysed
     #
     # @public
+    # @deprecated Use origin
     def description
-      @description ||= source.origin
+      origin
     end
 
     #
@@ -64,8 +66,7 @@ module Reek
     #
     # @public
     def smells
-      run
-      @smells ||= collector.warnings
+      @smells ||= run.sort.uniq
     end
 
     #
@@ -86,35 +87,31 @@ module Reek
 
     private
 
-    attr_reader :collector, :source, :smell_repository
+    attr_reader :source, :smell_repository
 
-    # Runs the Examiner on the given source to scan for code smells
-    # and returns the corresponding Examiner instance.
+    # Runs the Examiner on the given source to scan for code smells.
     #
     # In case one of the smell detectors raises an exception we probably hit a Reek bug.
     # So we catch the exception here, let the user know something went wrong
     # and continue with the analysis.
     #
-    # @return an instance of Examiner
-    #
-    # :reek:TooManyStatements: { max_statements: 6 }
+    # @return [Array<SmellWarning>] the smells found in the source
     def run
-      @run ||= begin
-        syntax_tree = source.syntax_tree
-        return self unless syntax_tree
-        begin
-          examine syntax_tree
-        rescue StandardError => exception
-          $stderr.puts format(INCOMPREHENSIBLE_SOURCE_TEMPLATE, source.origin, exception.inspect)
-        else
-          smell_repository.report_on(collector)
-        end
-        self
+      return [] unless syntax_tree
+      begin
+        examine_tree
+      rescue StandardError => exception
+        $stderr.puts format(INCOMPREHENSIBLE_SOURCE_TEMPLATE, origin, exception.inspect)
+        []
       end
     end
 
-    def examine(syntax_tree)
-      ContextBuilder.new(syntax_tree).context_tree.each do |element|
+    def syntax_tree
+      @syntax_tree ||= source.syntax_tree
+    end
+
+    def examine_tree
+      ContextBuilder.new(syntax_tree).context_tree.flat_map do |element|
         smell_repository.examine(element)
       end
     end

data/lib/reek/smells/class_variable.rb

@@ -29,7 +29,7 @@ module Reek
           smell_warning(
             context: ctx,
             lines: lines,
-            message: "declares the class variable #{variable}",
+            message: "declares the class variable '#{variable}'",
             parameters: { name: variable.to_s })
         end
       end

data/lib/reek/smells/control_parameter.rb

@@ -56,7 +56,7 @@ module Reek
           smell_warning(
             context: ctx,
             lines: control_parameter.lines,
-            message: "is controlled by argument #{argument}",
+            message: "is controlled by argument '#{argument}'",
             parameters: { argument: argument })
         end
       end

data/lib/reek/smells/data_clump.rb

@@ -70,7 +70,7 @@ module Reek
 
       # @private
       def self.print_clump(clump)
-        "[#{clump.map(&:to_s).join(', ')}]"
+        "[#{clump.map { |parameter| "'#{parameter}'" }.join(', ')}]"
       end
     end
   end

data/lib/reek/smells/duplicate_method_call.rb

@@ -52,7 +52,7 @@ module Reek
           smell_warning(
             context: ctx,
             lines: found_call.lines,
-            message: "calls #{found_call.call} #{found_call.occurs} times",
+            message: "calls '#{found_call.call}' #{found_call.occurs} times",
             parameters: { name: found_call.call, count: found_call.occurs })
         end
       end

data/lib/reek/smells/feature_envy.rb

@@ -48,7 +48,7 @@ module Reek
           smell_warning(
             context: ctx,
             lines: lines,
-            message: "refers to #{name} more than self (maybe move it to another class?)",
+            message: "refers to '#{name}' more than self (maybe move it to another class?)",
             parameters: { name: name.to_s })
         end
       end

data/lib/reek/smells/instance_variable_assumption.rb

@@ -33,7 +33,7 @@ module Reek
       private
 
       def build_smell_warning(ctx, assumption)
-        message = "assumes too much for instance variable #{assumption}"
+        message = "assumes too much for instance variable '#{assumption}'"
 
         smell_warning(
           context: ctx,

data/lib/reek/smells/prima_donna_method.rb

@@ -52,7 +52,7 @@ module Reek
         smell_warning(
           context: ctx,
           lines: [ctx.exp.line],
-          message: "has prima donna method `#{name}`",
+          message: "has prima donna method '#{name}'",
           parameters: { name: name })
       end
     end

data/lib/reek/smells/repeated_conditional.rb

@@ -58,7 +58,7 @@ module Reek
           smell_warning(
             context: ctx,
             lines: lines,
-            message: "tests #{expression} at least #{occurs} times",
+            message: "tests '#{expression}' at least #{occurs} times",
             parameters: { name: expression, count: occurs })
         end
       end

data/lib/reek/smells/smell_detector.rb

@@ -13,9 +13,7 @@ module Reek
     #   - {file:README.md}
     # for details.
     #
-    # :reek:TooManyMethods: { max_methods: 19 }
-    # :reek:TooManyInstanceVariables: { max_instance_variables: 5 }
-    # :reek:UnusedPrivateMethod: { exclude: [ inherited, smell_warning ] }
+    # :reek:UnusedPrivateMethod: { exclude: [ smell_warning ] }
     class SmellDetector
       attr_reader :config
       # The name of the config field that lists the names of code contexts
@@ -28,8 +26,7 @@ module Reek
       DEFAULT_EXCLUDE_SET = [].freeze
 
       def initialize(config = {})
-        @config       = SmellConfiguration.new self.class.default_config.merge(config)
-        @smells_found = []
+        @config = SmellConfiguration.new self.class.default_config.merge(config)
       end
 
       def smell_type
@@ -41,14 +38,10 @@ module Reek
       end
 
       def run_for(context)
-        return unless enabled_for?(context)
-        return if exception?(context)
+        return [] unless enabled_for?(context)
+        return [] if exception?(context)
 
-        self.smells_found = smells_found + sniff(context)
-      end
-
-      def report_on(collector)
-        smells_found.each { |smell| smell.report_on(collector) }
+        sniff(context)
       end
 
       def exception?(context)
@@ -63,8 +56,6 @@ module Reek
 
       private
 
-      attr_accessor :smells_found
-
       def enabled_for?(context)
         config.enabled? && config_for(context)[SmellConfiguration::ENABLED_KEY] != false
       end

data/lib/reek/smells/smell_repository.rb

@@ -38,12 +38,8 @@ module Reek
         @detectors     = smell_types.map { |klass| klass.new configuration_for(klass) }
       end
 
-      def report_on(collector)
-        detectors.each { |detector| detector.report_on(collector) }
-      end
-
       def examine(context)
-        smell_detectors_for(context.type).each do |detector|
+        smell_detectors_for(context.type).flat_map do |detector|
           detector.run_for(context)
         end
       end

data/lib/reek/smells/smell_warning.rb

@@ -31,16 +31,18 @@ module Reek
         @lines          = lines
         @message        = message
         @parameters     = parameters
+
+        freeze
       end
 
       # @public
       def hash
-        sort_key.hash
+        identifying_values.hash
       end
 
       # @public
       def <=>(other)
-        sort_key <=> other.sort_key
+        identifying_values <=> other.identifying_values
       end
 
       # @public
@@ -48,10 +50,6 @@ module Reek
         (self <=> other).zero?
       end
 
-      def report_on(listener)
-        listener.found_smell(self)
-      end
-
       # @public
       def to_hash
         stringified_params = Hash[parameters.map { |key, val| [key.to_s, val] }]
@@ -70,8 +68,8 @@ module Reek
 
       protected
 
-      def sort_key
-        [smell_type, context, message]
+      def identifying_values
+        [smell_type, context, message, lines]
       end
 
       private

data/lib/reek/smells/subclassed_from_core_class.rb

@@ -46,7 +46,7 @@ module Reek
         smell_attributes = {
           context: ctx,
           lines: [ctx.exp.line],
-          message: "inherits from a core class (#{ancestor_name})",
+          message: "inherits from core class '#{ancestor_name}'",
           parameters: { ancestor: ancestor_name }
         }
 

data/lib/reek/smells/uncommunicative_variable_name.rb

@@ -13,9 +13,11 @@ module Reek
     # and they hurt the flow of reading, because the reader must slow
     # down to interpret the names.
     #
-    # Currently +UncommunicativeName+ checks for
-    # * 1-character names
-    # * names ending with a number
+    # Currently +UncommunicativeName+ checks for:
+    #
+    # * single-character names
+    # * any name ending with a number
+    # * camelCaseVariableNames
     #
     # See {file:docs/Uncommunicative-Variable-Name.md} for details.
     #
@@ -24,13 +26,17 @@ module Reek
       # The name of the config field that lists the regexps of
       # smelly names to be reported.
       REJECT_KEY = 'reject'.freeze
-      DEFAULT_REJECT_SET = [/^.$/, /[0-9]$/, /[A-Z]/].freeze
+      DEFAULT_REJECT_SET = [
+        /^.$/, # single-character names
+        /[0-9]$/,  # any name ending with a number
+        /[A-Z]/    # camelCaseVariableNames
+      ].freeze
 
       # The name of the config field that lists the specific names that are
       # to be treated as exceptions; these names will not be reported as
       # uncommunicative.
       ACCEPT_KEY = 'accept'.freeze
-      DEFAULT_ACCEPT_SET = ['_'].freeze
+      DEFAULT_ACCEPT_SET = [/^_$/].freeze
 
       def self.default_config
         super.merge(
@@ -51,7 +57,7 @@ module Reek
         self.reject_names = value(REJECT_KEY, ctx)
         self.accept_names = value(ACCEPT_KEY, ctx)
         variable_names(ctx.exp).select do |name, _lines|
-          bad_name?(name, ctx)
+          uncommunicative_variable_name?(name)
         end.map do |name, lines|
           smell_warning(
             context: ctx,
@@ -61,10 +67,16 @@ module Reek
         end
       end
 
-      def bad_name?(name, _ctx)
-        var = name.to_s.gsub(/^[@\*\&]*/, '')
-        return false if accept_names.include?(var)
-        reject_names.find { |patt| patt =~ var }
+      private
+
+      def uncommunicative_variable_name?(name)
+        sanitized_name = name.to_s.gsub(/^[@\*\&]*/, '')
+        !acceptable_name?(sanitized_name)
+      end
+
+      def acceptable_name?(name)
+        Array(accept_names).any? { |accept_pattern| name.match accept_pattern } ||
+          Array(reject_names).none? { |reject_pattern| name.match reject_pattern }
       end
 
       # :reek:TooManyStatements: { max_statements: 6 }
@@ -124,8 +136,6 @@ module Reek
         accumulator[var].push(exp.line)
       end
 
-      private
-
       attr_accessor :accept_names, :reject_names
     end
   end

data/lib/reek/smells/unused_private_method.rb

@@ -43,7 +43,7 @@ module Reek
           smell_warning(
             context: ctx,
             lines: [hit.line],
-            message: "has the unused private instance method `#{name}`",
+            message: "has the unused private instance method '#{name}'",
             parameters: { name: name })
         end
       end

data/lib/reek/spec.rb

@@ -38,8 +38,8 @@ module Reek
   # To check for specific smells, use something like this:
   #
   #   ruby = 'def double_thing() @other.thing.foo + @other.thing.foo end'
-  #   ruby.should reek_of(:Duplication, /@other.thing[^\.]/)
-  #   ruby.should reek_of(:Duplication, /@other.thing.foo/)
+  #   ruby.should reek_of(:DuplicateMethodCall, name: '@other.thing')
+  #   ruby.should reek_of(:DuplicateMethodCall, name: '@other.thing.foo', count: 2)
   #   ruby.should_not reek_of(:FeatureEnvy)
   #
   # @public

data/lib/reek/spec/should_reek_of.rb

@@ -9,6 +9,13 @@ module Reek
     # code smell.
     #
     class ShouldReekOf
+      # Variant of Examiner that doesn't swallow exceptions
+      class UnsafeExaminer < Examiner
+        def run
+          examine_tree
+        end
+      end
+
       attr_reader :failure_message, :failure_message_when_negated
 
       def initialize(smell_type_or_class,
@@ -16,13 +23,15 @@ module Reek
                      configuration = Configuration::AppConfiguration.default)
         @smell_type = normalize smell_type_or_class
         @smell_details = smell_details
+        configuration.load_values(smell_type => { Smells::SmellConfiguration::ENABLED_KEY => true })
         @configuration = configuration
-        @configuration.load_values(smell_type => { Smells::SmellConfiguration::ENABLED_KEY => true })
       end
 
       def matches?(source)
         @matching_smell_types = nil
-        self.examiner = Examiner.new(source, configuration: configuration)
+        self.examiner = UnsafeExaminer.new(source,
+                                           filter_by_smells: [smell_type],
+                                           configuration: configuration)
         set_failure_messages
         matching_smell_details?
       end
@@ -49,12 +58,7 @@ module Reek
       end
 
       def matching_smell_types
-        @matching_smell_types ||= smell_matchers.
-          select { |it| it.matches_smell_type?(smell_type) }
-      end
-
-      def smell_matchers
-        examiner.smells.map { |it| SmellMatcher.new(it) }
+        @matching_smell_types ||= examiner.smells.map { |it| SmellMatcher.new(it) }
       end
 
       def matching_smell_types?

data/lib/reek/version.rb

@@ -7,6 +7,6 @@ module Reek
   # @public
   module Version
     # @public
-    STRING = '4.4.0'.freeze
+    STRING = '4.4.1'.freeze
   end
 end