reek 3.3.1 → 3.4.0

data/lib/reek/smells/attribute.rb

@@ -13,7 +13,6 @@ module Reek
     # +attr_accessor+, and +attr+ with the writable flag set to +true+.
     #
     # See {file:docs/Attribute.md} for details.
-    # @api private
     #
     # TODO: Catch attributes declared "by hand"
     class Attribute < SmellDetector
@@ -32,16 +31,17 @@ module Reek
       #
       def examine_context(ctx)
         attributes_in(ctx).map do |attribute, line|
-          SmellWarning.new self,
-                           context: ctx.full_name,
-                           lines: [line],
-                           message: 'is a writable attribute',
-                           parameters: { name: attribute.to_s }
+          smell_warning(
+            context: ctx,
+            lines: [line],
+            message: 'is a writable attribute',
+            parameters: { name: attribute.to_s })
         end
       end
 
       private
 
+      # :reek:UtilityFunction
       def attributes_in(module_ctx)
         if module_ctx.visibility == :public
           call_node = module_ctx.exp

data/lib/reek/smells/boolean_parameter.rb

@@ -12,7 +12,6 @@ module Reek
     # default initializer.
     #
     # See {file:docs/Boolean-Parameter.md} for details.
-    # @api private
     class BooleanParameter < SmellDetector
       def self.smell_category
         'ControlCouple'
@@ -23,15 +22,16 @@ module Reek
       #
       # @return [Array<SmellWarning>]
       #
-      def examine_context(method_ctx)
-        method_ctx.default_assignments.select do |_param, value|
+      # :reek:FeatureEnvy
+      def examine_context(ctx)
+        ctx.default_assignments.select do |_param, value|
           [:true, :false].include?(value[0])
         end.map do |parameter, _value|
-          SmellWarning.new self,
-                           context: method_ctx.full_name,
-                           lines: [method_ctx.exp.line],
-                           message: "has boolean parameter '#{parameter}'",
-                           parameters: { name: parameter.to_s }
+          smell_warning(
+            context: ctx,
+            lines: [ctx.exp.line],
+            message: "has boolean parameter '#{parameter}'",
+            parameters: { name: parameter.to_s })
         end
       end
     end

data/lib/reek/smells/class_variable.rb

@@ -13,7 +13,6 @@ module Reek
     # the context of the test includes all global state).
     #
     # See {file:docs/Class-Variable.md} for details.
-    # @api private
     class ClassVariable < SmellDetector
       def self.contexts # :nodoc:
         [:class, :module]
@@ -26,11 +25,11 @@ module Reek
       #
       def examine_context(ctx)
         class_variables_in(ctx.exp).map do |variable, lines|
-          SmellWarning.new self,
-                           context: ctx.full_name,
-                           lines: lines,
-                           message: "declares the class variable #{variable}",
-                           parameters: { name: variable.to_s }
+          smell_warning(
+            context: ctx,
+            lines: lines,
+            message: "declares the class variable #{variable}",
+            parameters: { name: variable.to_s })
         end
       end
 
@@ -38,6 +37,8 @@ module Reek
       # Collects the names of the class variables declared and/or used
       # in the given module.
       #
+      # :reek:TooManyStatements: { max_statements: 7 }
+      # :reek:FeatureEnvy
       def class_variables_in(ast)
         result = Hash.new { |hash, key| hash[key] = [] }
         collector = proc do |cvar_node|

data/lib/reek/smells/control_parameter.rb

@@ -41,7 +41,6 @@ module Reek
     # the source code.
     #
     # See {file:docs/Control-Parameter.md} for details.
-    # @api private
     class ControlParameter < SmellDetector
       def self.smell_category
         'ControlCouple'
@@ -53,13 +52,15 @@ module Reek
       #
       # @return [Array<SmellWarning>]
       #
+      # :reek:FeatureEnvy
       def examine_context(ctx)
         ControlParameterCollector.new(ctx).control_parameters.map do |control_parameter|
-          SmellWarning.new self,
-                           context: ctx.full_name,
-                           lines: control_parameter.lines,
-                           message: "is controlled by argument #{control_parameter.name}",
-                           parameters: { name: control_parameter.name.to_s }
+          name = control_parameter.name.to_s
+          smell_warning(
+            context: ctx,
+            lines: control_parameter.lines,
+            message: "is controlled by argument #{name}",
+            parameters: { name: name })
         end
       end
 
@@ -160,7 +161,7 @@ module Reek
         end
 
         def uses_param_in_body?
-          nodes = node.body_nodes([:lvar], [:if, :case, :and, :or])
+          nodes = node.body_nodes([:lvar], CONDITIONAL_NODE_TYPES)
           nodes.any? { |lvar_node| lvar_node.var_name == param }
         end
       end

data/lib/reek/smells/data_clump.rb

@@ -16,7 +16,6 @@ module Reek
     # the same names that are expected by three or more methods of a class.
     #
     # See {file:docs/Data-Clump.md} for details.
-    # @api private
     class DataClump < SmellDetector
       #
       # The name of the config field that sets the maximum allowed
@@ -51,21 +50,22 @@ module Reek
       #
       # @return [Array<SmellWarning>]
       #
+      # :reek:FeatureEnvy
       def examine_context(ctx)
         max_copies = value(MAX_COPIES_KEY, ctx, DEFAULT_MAX_COPIES)
         min_clump_size = value(MIN_CLUMP_SIZE_KEY, ctx, DEFAULT_MIN_CLUMP_SIZE)
         MethodGroup.new(ctx, min_clump_size, max_copies).clumps.map do |clump, methods|
-          print_clump = DataClump.print_clump(clump)
-          SmellWarning.new self,
-                           context: ctx.full_name,
-                           lines: methods.map(&:line),
-                           message: "takes parameters #{print_clump} " \
-                                    "to #{methods.length} methods",
-                           parameters: {
-                             parameters: clump.map(&:to_s),
-                             count: methods.length,
-                             methods: methods.map(&:name)
-                           }
+          methods_length = methods.length
+          smell_warning(
+            context: ctx,
+            lines: methods.map(&:line),
+            message: "takes parameters #{DataClump.print_clump(clump)} " \
+                     "to #{methods_length} methods",
+            parameters: {
+              parameters: clump.map(&:to_s),
+              count: methods_length,
+              methods: methods.map(&:name)
+            })
         end
       end
 
@@ -95,6 +95,7 @@ module Reek
       end.uniq
     end
 
+    # :reek:UtilityFunction
     def common_argument_names_for(methods)
       methods.map(&:arg_names).inject(:&)
     end
@@ -117,22 +118,19 @@ module Reek
   # A method definition and a copy of its parameters
   # @private
   class CandidateMethod
+    extend Forwardable
+
+    def_delegators :defn, :line, :name
+
     def initialize(defn_node)
       @defn = defn_node
     end
 
     def arg_names
+      # TODO: Is all this sorting still needed?
       @arg_names ||= defn.arg_names.compact.sort
     end
 
-    def line
-      defn.line
-    end
-
-    def name
-      defn.name.to_s # BUG: should report the symbols!
-    end
-
     private
 
     private_attr_reader :defn

data/lib/reek/smells/duplicate_method_call.rb

@@ -17,7 +17,6 @@ module Reek
     #   end
     #
     # See {file:docs/Duplicate-Method-Call.md} for details.
-    # @api private
     class DuplicateMethodCall < SmellDetector
       # The name of the config field that sets the maximum number of
       # identical calls to be permitted within any single method.
@@ -46,17 +45,19 @@ module Reek
       #
       # @return [Array<SmellWarning>]
       #
+      # :reek:FeatureEnvy
+      # :reek:DuplicateMethodCall: { max_calls: 2 }
       def examine_context(ctx)
         max_allowed_calls = value(MAX_ALLOWED_CALLS_KEY, ctx, DEFAULT_MAX_CALLS)
         allow_calls = value(ALLOW_CALLS_KEY, ctx, DEFAULT_ALLOW_CALLS)
 
         collector = CallCollector.new(ctx, max_allowed_calls, allow_calls)
         collector.smelly_calls.map do |found_call|
-          SmellWarning.new self,
-                           context: ctx.full_name,
-                           lines: found_call.lines,
-                           message: "calls #{found_call.call} #{found_call.occurs} times",
-                           parameters: { name: found_call.call, count: found_call.occurs }
+          smell_warning(
+            context: ctx,
+            lines: found_call.lines,
+            message: "calls #{found_call.call} #{found_call.occurs} times",
+            parameters: { name: found_call.call, count: found_call.occurs })
         end
       end
 
@@ -112,6 +113,8 @@ module Reek
 
         private_attr_reader :allow_calls, :max_allowed_calls
 
+        # :reek:TooManyStatements: { max_statements: 6 }
+        # :reek:DuplicateMethodCall: { max_calls: 2 }
         def collect_calls(result)
           context.each_node(:send, [:mlhs]) do |call_node|
             next if call_node.object_creation_call?
@@ -127,6 +130,7 @@ module Reek
           found_call.occurs > max_allowed_calls && !allow_calls?(found_call.call)
         end
 
+        # :reek:UtilityFunction
         def simple_method_call?(call_node)
           !call_node.receiver && call_node.args.empty?
         end

data/lib/reek/smells/feature_envy.rb

@@ -34,7 +34,6 @@ module Reek
     # reported instead.
     #
     # See {file:docs/Feature-Envy.md} for details.
-    # @api private
     class FeatureEnvy < SmellDetector
       def self.smell_category
         'LowCohesion'
@@ -46,16 +45,25 @@ module Reek
       #
       # @return [Array<SmellWarning>]
       #
-      def examine_context(method_ctx)
-        return [] unless method_ctx.references_self?
-        method_ctx.envious_receivers.map do |name, refs|
-          SmellWarning.new self,
-                           context: method_ctx.full_name,
-                           lines: refs.map(&:line),
-                           message: "refers to #{name} more than self",
-                           parameters: { name: name.to_s, count: refs.size }
+      def examine_context(ctx)
+        return [] unless ctx.references_self?
+        envious_receivers(ctx).map do |name, refs|
+          smell_warning(
+            context: ctx,
+            lines: refs.map(&:line),
+            message: "refers to #{name} more than self (maybe move it to another class?)",
+            parameters: { name: name.to_s, count: refs.size })
         end
       end
+
+      private
+
+      # :reek:UtilityFunction
+      def envious_receivers(ctx)
+        refs = ctx.refs
+        return {} if refs.self_is_max?
+        refs.most_popular
+      end
     end
   end
 end

data/lib/reek/smells/irresponsible_module.rb

@@ -8,7 +8,6 @@ module Reek
     # with a brief comment outlining its responsibilities.
     #
     # See {file:docs/Irresponsible-Module.md} for details.
-    # @api private
     class IrresponsibleModule < SmellDetector
       def self.contexts
         [:casgn, :class, :module]
@@ -22,11 +21,11 @@ module Reek
       def examine_context(ctx)
         return [] if descriptive?(ctx) || ctx.namespace_module?
         expression = ctx.exp
-        [SmellWarning.new(self,
-                          context: ctx.full_name,
-                          lines: [expression.line],
-                          message: 'has no descriptive comment',
-                          parameters: { name: expression.name })]
+        [smell_warning(
+          context: ctx,
+          lines: [expression.line],
+          message: 'has no descriptive comment',
+          parameters: { name: expression.name })]
       end
 
       private
@@ -35,6 +34,7 @@ module Reek
         @descriptive ||= {}
       end
 
+      # :reek:FeatureEnvy
       def descriptive?(ctx)
         descriptive[ctx.full_name] ||= ctx.descriptively_commented?
       end

data/lib/reek/smells/long_parameter_list.rb

@@ -13,7 +13,6 @@ module Reek
     # many parameters.
     #
     # See {file:docs/Long-Parameter-List.md} for details.
-    # @api private
     class LongParameterList < SmellDetector
       # The name of the config field that sets the maximum number of
       # parameters permitted in any method or block.
@@ -36,13 +35,14 @@ module Reek
       #
       def examine_context(ctx)
         max_allowed_params = value(MAX_ALLOWED_PARAMS_KEY, ctx, DEFAULT_MAX_ALLOWED_PARAMS)
-        count = ctx.exp.arg_names.length
+        exp = ctx.exp
+        count = exp.arg_names.length
         return [] if count <= max_allowed_params
-        [SmellWarning.new(self,
-                          context: ctx.full_name,
-                          lines: [ctx.exp.line],
-                          message: "has #{count} parameters",
-                          parameters: { count: count })]
+        [smell_warning(
+          context: ctx,
+          lines: [exp.line],
+          message: "has #{count} parameters",
+          parameters: { count: count })]
       end
     end
   end

data/lib/reek/smells/long_yield_list.rb

@@ -8,7 +8,6 @@ module Reek
     # passed to a block by a +yield+ call.
     #
     # See {file:docs/Long-Yield-List.md} for details.
-    # @api private
     class LongYieldList < SmellDetector
       # The name of the config field that sets the maximum number of
       # parameters permitted in any method or block.
@@ -28,19 +27,21 @@ module Reek
       #
       # @return [Array<SmellWarning>]
       #
-      def examine_context(method_ctx)
+      # :reek:FeatureEnvy
+      # :reek:DuplicateMethodCall: { max_calls: 2 }
+      def examine_context(ctx)
         max_allowed_params = value(MAX_ALLOWED_PARAMS_KEY,
-                                   method_ctx,
+                                   ctx,
                                    DEFAULT_MAX_ALLOWED_PARAMS)
-        method_ctx.local_nodes(:yield).select do |yield_node|
+        ctx.local_nodes(:yield).select do |yield_node|
           yield_node.args.length > max_allowed_params
         end.map do |yield_node|
           count = yield_node.args.length
-          SmellWarning.new self,
-                           context: method_ctx.full_name,
-                           lines: [yield_node.line],
-                           message: "yields #{count} parameters",
-                           parameters: { count: count }
+          smell_warning(
+            context: ctx,
+            lines: [yield_node.line],
+            message: "yields #{count} parameters",
+            parameters: { count: count })
         end
       end
     end

data/lib/reek/smells/module_initialize.rb

@@ -9,7 +9,6 @@ module Reek
     # in a module is usually a bad idea
     #
     # See {file:docs/Module-Initialize.md} for details.
-    # @api private
     class ModuleInitialize < SmellDetector
       def self.contexts # :nodoc:
         [:module]
@@ -20,13 +19,15 @@ module Reek
       #
       # @return [Array<SmellWarning>]
       #
-      def examine_context(module_ctx)
-        module_ctx.local_nodes(:def) do |node| # FIXME: also search for :defs?
+      # :reek:FeatureEnvy
+      def examine_context(ctx)
+        ctx.local_nodes(:def) do |node| # FIXME: also search for :defs?
           if node.name.to_s == 'initialize'
             return [
-              SmellWarning.new(self, context: module_ctx.full_name,
-                                     lines:   [module_ctx.exp.line],
-                                     message: 'has initialize method')
+              smell_warning(
+                context: ctx,
+                lines:   [ctx.exp.line],
+                message: 'has initialize method')
             ]
           end
         end

data/lib/reek/smells/nested_iterators.rb

@@ -9,7 +9,6 @@ module Reek
     # +NestedIterators+ reports failing methods only once.
     #
     # See {file:docs/Nested-Iterators.md} for details.
-    # @api private
     class NestedIterators < SmellDetector
       # The name of the config field that sets the maximum depth
       # of nested iterators to be permitted within any single method.
@@ -37,11 +36,11 @@ module Reek
         exp, depth = *find_deepest_iterator(ctx)
 
         if depth && depth > value(MAX_ALLOWED_NESTING_KEY, ctx, DEFAULT_MAX_ALLOWED_NESTING)
-          [SmellWarning.new(self,
-                            context: ctx.full_name,
-                            lines: [exp.line],
-                            message: "contains iterators nested #{depth} deep",
-                            parameters: { name: ctx.full_name, count: depth })]
+          [smell_warning(
+            context: ctx,
+            lines: [exp.line],
+            message: "contains iterators nested #{depth} deep",
+            parameters: { name: ctx.full_name, count: depth })]
         else
           []
         end