reek 4.2.3 → 4.2.4

data/features/todo_list.feature

@@ -10,15 +10,14 @@ Feature:
     - get rid of the todo file
 
   Scenario: Generate a proper todo file that disables all found smells
-    Given a smelly file called 'smelly.rb'
+    Given the smelly file 'smelly.rb'
     When I run reek smelly.rb
     Then the exit status indicates smells
     And it reports:
       """
-      smelly.rb -- 3 warnings:
-        [4, 5]:DuplicateMethodCall: Smelly#m calls @foo.bar 2 times [https://github.com/troessner/reek/blob/master/docs/Duplicate-Method-Call.md]
-        [4, 5]:DuplicateMethodCall: Smelly#m calls puts @foo.bar 2 times [https://github.com/troessner/reek/blob/master/docs/Duplicate-Method-Call.md]
-        [3]:UncommunicativeMethodName: Smelly#m has the name 'm' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Method-Name.md]
+      smelly.rb -- 2 warnings:
+        [4]:UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Method-Name.md]
+        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Variable-Name.md]
       """
     When I run reek --todo smelly.rb
     Then it succeeds
@@ -31,28 +30,28 @@ Feature:
     And the file ".todo.reek" should contain:
       """
       ---
-      DuplicateMethodCall:
-        exclude:
-        - Smelly#m
       UncommunicativeMethodName:
         exclude:
-        - Smelly#m
+        - Smelly#x
+      UncommunicativeVariableName:
+        exclude:
+        - Smelly#x
         """
     When I run reek -c .todo.reek smelly.rb
     Then it succeeds
 
   Scenario: Respects a configuration file
-    Given a smelly file called 'smelly.rb'
-    And a configuration file disabling DuplicateMethodCall called 'config.reek'
-    When I run reek -c config.reek --todo smelly.rb
+    Given the smelly file 'smelly.rb'
+    And a configuration file 'partial_mask.reek'
+    When I run reek -c partial_mask.reek --todo smelly.rb
     Then it succeeds
     And a file named ".todo.reek" should exist
     And the file ".todo.reek" should contain:
       """
       ---
-      UncommunicativeMethodName:
+      UncommunicativeVariableName:
         exclude:
-        - Smelly#m
+        - Smelly#x
       """
 
   Scenario: Reacts appropiately when there are no smells

data/lib/reek/cli/options.rb

@@ -97,7 +97,7 @@ module Reek
       end
 
       def set_generate_todo_list_options
-        parser.separator '\nGenerate a todo list:'
+        parser.separator "\nGenerate a todo list:"
         parser.on('-t', '--todo', 'Generate a todo list') do
           self.generate_todo_list = true
         end

data/lib/reek/examiner.rb

@@ -10,8 +10,21 @@ module Reek
   #
   # @public
   #
-  # :reek:TooManyInstanceVariables: { max_instance_variables: 6 }
+  # :reek:TooManyInstanceVariables: { max_instance_variables: 7 }
   class Examiner
+    INCOMPREHENSIBLE_SOURCE_TEMPLATE = <<-EOS.freeze
+      !!!
+      Source %s can not be processed by Reek.
+      This is most likely a Reek bug.
+      It would be great if you could report this back to the Reek team
+      by opening up a corresponding issue at https://github.com/troessner/reek/issues
+      Make sure to include the source in question, the Reek version
+      and the original exception below.
+
+      Original exception:
+      %s
+      !!!
+    EOS
     #
     # Creates an Examiner which scans the given +source+ for code smells.
     #
@@ -28,13 +41,13 @@ module Reek
     # @public
     def initialize(source,
                    filter_by_smells: [],
-                   configuration: Configuration::AppConfiguration.default)
+                   configuration: Configuration::AppConfiguration.default,
+                   smell_repository_class: Smells::SmellRepository)
       @source           = Source::SourceCode.from(source)
       @collector        = CLI::WarningCollector.new
-      @smell_types      = Smells::SmellRepository.eligible_smell_types(filter_by_smells)
-      @smell_repository = Smells::SmellRepository.new(smell_types: @smell_types,
-                                                      configuration: configuration.directive_for(description))
-      run
+      @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"
@@ -51,6 +64,7 @@ module Reek
     #
     # @public
     def smells
+      run
       @smells ||= collector.warnings
     end
 
@@ -74,14 +88,35 @@ module Reek
 
     attr_reader :collector, :source, :smell_repository
 
+    # Runs the Examiner on the given source to scan for code smells
+    # and returns the corresponding Examiner instance.
+    #
+    # 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 }
     def run
-      syntax_tree = source.syntax_tree
-      return unless syntax_tree
+      @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
+      end
+    end
+
+    def examine(syntax_tree)
       ContextBuilder.new(syntax_tree).context_tree.each do |element|
         smell_repository.examine(element)
       end
-
-      smell_repository.report_on(collector)
     end
   end
 end

data/lib/reek/smells/attribute.rb

@@ -30,13 +30,12 @@ module Reek
       #
       # @return [Array<SmellWarning>]
       #
-      def inspect(ctx)
-        attributes_in(ctx).map do |attribute, line|
+      def sniff(ctx)
+        attributes_in(ctx).map do |_attribute, line|
           smell_warning(
             context: ctx,
             lines: [line],
-            message: 'is a writable attribute',
-            parameters: { name: attribute.to_s })
+            message: 'is a writable attribute')
         end
       end
 

data/lib/reek/smells/boolean_parameter.rb

@@ -20,7 +20,7 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       # :reek:FeatureEnvy
-      def inspect(ctx)
+      def sniff(ctx)
         ctx.default_assignments.select do |_param, value|
           [:true, :false].include?(value.type)
         end.map do |parameter, _value|
@@ -28,7 +28,7 @@ module Reek
             context: ctx,
             lines: [ctx.exp.line],
             message: "has boolean parameter '#{parameter}'",
-            parameters: { name: parameter.to_s })
+            parameters: { parameter: parameter.to_s })
         end
       end
     end

data/lib/reek/smells/class_variable.rb

@@ -24,7 +24,7 @@ module Reek
       #
       # @return [Array<SmellWarning>]
       #
-      def inspect(ctx)
+      def sniff(ctx)
         class_variables_in(ctx.exp).map do |variable, lines|
           smell_warning(
             context: ctx,

data/lib/reek/smells/control_parameter.rb

@@ -50,14 +50,14 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       # :reek:FeatureEnvy
-      def inspect(ctx)
+      def sniff(ctx)
         ControlParameterCollector.new(ctx).control_parameters.map do |control_parameter|
-          name = control_parameter.name.to_s
+          argument = control_parameter.name.to_s
           smell_warning(
             context: ctx,
             lines: control_parameter.lines,
-            message: "is controlled by argument #{name}",
-            parameters: { name: name })
+            message: "is controlled by argument #{argument}",
+            parameters: { argument: argument })
         end
       end
 

data/lib/reek/smells/data_clump.rb

@@ -51,7 +51,7 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       # :reek:FeatureEnvy
-      def inspect(ctx)
+      def sniff(ctx)
         max_copies = value(MAX_COPIES_KEY, ctx)
         min_clump_size = value(MIN_CLUMP_SIZE_KEY, ctx)
         MethodGroup.new(ctx, min_clump_size, max_copies).clumps.map do |clump, methods|
@@ -63,8 +63,7 @@ module Reek
                      "to #{methods_length} methods",
             parameters: {
               parameters: clump.map(&:to_s),
-              count: methods_length,
-              methods: methods.map(&:name)
+              count: methods_length
             })
         end
       end

data/lib/reek/smells/duplicate_method_call.rb

@@ -43,7 +43,7 @@ module Reek
       #
       # :reek:FeatureEnvy
       # :reek:DuplicateMethodCall: { max_calls: 2 }
-      def inspect(ctx)
+      def sniff(ctx)
         max_allowed_calls = value(MAX_ALLOWED_CALLS_KEY, ctx)
         allow_calls = value(ALLOW_CALLS_KEY, ctx)
 

data/lib/reek/smells/feature_envy.rb

@@ -42,14 +42,14 @@ module Reek
       #
       # @return [Array<SmellWarning>]
       #
-      def inspect(ctx)
+      def sniff(ctx)
         return [] unless ctx.references_self?
         envious_receivers(ctx).map do |name, lines|
           smell_warning(
             context: ctx,
             lines: lines,
             message: "refers to #{name} more than self (maybe move it to another class?)",
-            parameters: { name: name.to_s, count: lines.size })
+            parameters: { name: name.to_s })
         end
       end
 

data/lib/reek/smells/irresponsible_module.rb

@@ -19,14 +19,13 @@ module Reek
       #
       # @return [Array<SmellWarning>]
       #
-      def inspect(ctx)
+      def sniff(ctx)
         return [] if descriptive?(ctx) || ctx.namespace_module?
         expression = ctx.exp
         [smell_warning(
           context: ctx,
           lines: [expression.line],
-          message: 'has no descriptive comment',
-          parameters: { name: expression.name })]
+          message: 'has no descriptive comment')]
       end
 
       private

data/lib/reek/smells/long_parameter_list.rb

@@ -33,7 +33,7 @@ module Reek
       #
       # @return [Array<SmellWarning>]
       #
-      def inspect(ctx)
+      def sniff(ctx)
         max_allowed_params = value(MAX_ALLOWED_PARAMS_KEY, ctx)
         exp = ctx.exp
         count = exp.arg_names.length

data/lib/reek/smells/long_yield_list.rb

@@ -26,7 +26,7 @@ module Reek
       #
       # :reek:FeatureEnvy
       # :reek:DuplicateMethodCall: { max_calls: 2 }
-      def inspect(ctx)
+      def sniff(ctx)
         max_allowed_params = value(MAX_ALLOWED_PARAMS_KEY, ctx)
         ctx.local_nodes(:yield).select do |yield_node|
           yield_node.args.length > max_allowed_params

data/lib/reek/smells/module_initialize.rb

@@ -21,7 +21,7 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       # :reek:FeatureEnvy
-      def inspect(ctx)
+      def sniff(ctx)
         ctx.local_nodes(:def) do |node|
           if node.name.to_s == 'initialize'
             return [

data/lib/reek/smells/nested_iterators.rb

@@ -41,7 +41,7 @@ module Reek
       #
       # @return [Array<SmellWarning>]
       #
-      def inspect(ctx)
+      def sniff(ctx)
         configure_ignore_iterators ctx
         violations = find_violations ctx
 
@@ -51,7 +51,7 @@ module Reek
             context: ctx,
             lines: lines,
             message: "contains iterators nested #{depth} deep",
-            parameters: { name: ctx.full_name, count: depth })
+            parameters: { depth: depth })
         end
       end
 

data/lib/reek/smells/nil_check.rb

@@ -9,7 +9,7 @@ module Reek
     #
     # See {file:docs/Nil-Check.md} for details.
     class NilCheck < SmellDetector
-      def inspect(ctx)
+      def sniff(ctx)
         call_node_finder = NodeFinder.new(ctx, :send, NilCallNodeDetector)
         case_node_finder = NodeFinder.new(ctx, :when, NilWhenNodeDetector)
         smelly_nodes = call_node_finder.smelly_nodes + case_node_finder.smelly_nodes

data/lib/reek/smells/prima_donna_method.rb

@@ -29,7 +29,7 @@ module Reek
         [:class]
       end
 
-      def inspect(ctx)
+      def sniff(ctx)
         ctx.node_instance_methods.map do |method_sexp|
           check_for_smells(method_sexp, ctx)
         end.compact
@@ -38,6 +38,7 @@ module Reek
       private
 
       # :reek:FeatureEnvy
+      # :reek:TooManyStatements: { max_statements: 6 }
       def check_for_smells(method_sexp, ctx)
         return unless method_sexp.ends_with_bang?
 
@@ -47,10 +48,12 @@ module Reek
 
         return if version_without_bang
 
+        name = method_sexp.name
         smell_warning(
           context: ctx,
           lines: [ctx.exp.line],
-          message: "has prima donna method `#{method_sexp.name}`")
+          message: "has prima donna method `#{name}`",
+          parameters: { name: name })
       end
     end
   end

data/lib/reek/smells/repeated_conditional.rb

@@ -48,7 +48,7 @@ module Reek
       #
       # :reek:TooManyStatements: { max_statements: 6 }
       # :reek:DuplicateMethodCall: { max_calls: 2 }
-      def inspect(ctx)
+      def sniff(ctx)
         max_identical_ifs = value(MAX_IDENTICAL_IFS_KEY, ctx)
         conditional_counts(ctx).select do |_key, lines|
           lines.length > max_identical_ifs

data/lib/reek/smells/smell_detector.rb

@@ -44,7 +44,7 @@ module Reek
         return unless enabled_for?(context)
         return if exception?(context)
 
-        self.smells_found = smells_found + inspect(context)
+        self.smells_found = smells_found + sniff(context)
       end
 
       def report_on(collector)

data/lib/reek/smells/smell_warning.rb

@@ -45,7 +45,7 @@ module Reek
 
       # @public
       def eql?(other)
-        (self <=> other) == 0
+        (self <=> other).zero?
       end
 
       def report_on(listener)
@@ -53,12 +53,13 @@ module Reek
       end
 
       # @public
-      def yaml_hash
+      def to_hash
         stringified_params = Hash[parameters.map { |key, val| [key.to_s, val] }]
-        core_yaml_hash.
-          merge(stringified_params)
+        base_hash.merge(stringified_params)
       end
 
+      alias yaml_hash to_hash
+
       def base_message
         "#{smell_type}: #{context} #{message}"
       end
@@ -75,7 +76,7 @@ module Reek
 
       private
 
-      def core_yaml_hash
+      def base_hash
         {
           'context'        => context,
           'lines'          => lines,

data/lib/reek/smells/subclassed_from_core_class.rb

@@ -26,17 +26,17 @@ module Reek
       # class Foo < Bar; end;
       #
       # @return [Array<SmellWarning>]
-      def inspect(ctx)
+      def sniff(ctx)
         superclass = ctx.exp.superclass
 
         return [] unless superclass
 
-        inspect_superclass(ctx, superclass.name)
+        sniff_superclass(ctx, superclass.name)
       end
 
       private
 
-      def inspect_superclass(ctx, superclass_name)
+      def sniff_superclass(ctx, superclass_name)
         return [] unless CORE_CLASSES.include?(superclass_name)
 
         [build_smell_warning(ctx, superclass_name)]