reek 4.7.3 → 5.0.0

data/lib/reek/report/yaml_report.rb

@@ -12,7 +12,7 @@ module Reek
     #
     class YAMLReport < BaseReport
       def show(out = $stdout)
-        out.print smells.map { |smell| warning_formatter.format_hash(smell) }.to_yaml
+        out.print smells.map(&:yaml_hash).to_yaml
       end
     end
   end

data/lib/reek/report.rb

@@ -6,7 +6,12 @@ require_relative 'report/json_report'
 require_relative 'report/text_report'
 require_relative 'report/xml_report'
 require_relative 'report/yaml_report'
-require_relative 'report/formatter'
+
+require_relative 'report/heading_formatter'
+require_relative 'report/location_formatter'
+require_relative 'report/progress_formatter'
+require_relative 'report/simple_warning_formatter'
+require_relative 'report/documentation_link_warning_formatter'
 
 module Reek
   # Reek reporting functionality.
@@ -21,24 +26,24 @@ module Reek
     }.freeze
 
     LOCATION_FORMATTERS = {
-      single_line: Formatter::SingleLineLocationFormatter,
-      plain: Formatter::BlankLocationFormatter,
-      numbers: Formatter::DefaultLocationFormatter
+      single_line: SingleLineLocationFormatter,
+      plain: BlankLocationFormatter,
+      numbers: DefaultLocationFormatter
     }.freeze
 
     HEADING_FORMATTERS = {
-      verbose: Formatter::VerboseHeadingFormatter,
-      quiet: Formatter::QuietHeadingFormatter
+      verbose: VerboseHeadingFormatter,
+      quiet: QuietHeadingFormatter
     }.freeze
 
     PROGRESS_FORMATTERS = {
-      dots: Formatter::ProgressFormatter::Dots,
-      quiet: Formatter::ProgressFormatter::Quiet
+      dots: ProgressFormatter::Dots,
+      quiet: ProgressFormatter::Quiet
     }.freeze
 
     WARNING_FORMATTER_CLASSES = {
-      wiki_links: Formatter::WikiLinkWarningFormatter,
-      simple: Formatter::SimpleWarningFormatter
+      documentation_links: DocumentationLinkWarningFormatter,
+      simple: SimpleWarningFormatter
     }.freeze
 
     # Map report format symbol to a report class.

data/lib/reek/smell_configuration.rb

@@ -7,11 +7,11 @@ module Reek
   class SmellConfiguration
     # The name of the config field that specifies whether a smell is
     # enabled. Set to +true+ or +false+.
-    ENABLED_KEY = 'enabled'.freeze
+    ENABLED_KEY = 'enabled'
 
     # The name of the config field that sets scope-specific overrides
     # for other values in the current smell detector's configuration.
-    OVERRIDES_KEY = 'overrides'.freeze
+    OVERRIDES_KEY = 'overrides'
 
     def initialize(hash)
       @options = hash

data/lib/reek/smell_detectors/attribute.rb

@@ -28,7 +28,6 @@ module Reek
       def sniff
         attributes_in_context.map do |_attribute, line|
           smell_warning(
-            context: context,
             lines: [line],
             message: 'is a writable attribute')
         end

data/lib/reek/smell_detectors/base_detector.rb

@@ -15,14 +15,14 @@ module Reek
     #   - {file:README.md}
     # for details.
     #
-    # :reek:UnusedPrivateMethod: { exclude: [ smell_warning ] }
-    # :reek:TooManyMethods: { max_methods: 18 }
+    # @quality :reek:UnusedPrivateMethod { exclude: [ smell_warning ] }
+    # @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.
-      EXCLUDE_KEY = 'exclude'.freeze
+      EXCLUDE_KEY = 'exclude'
 
       # The default value for the +EXCLUDE_KEY+ if it isn't specified
       # in any configuration file.
@@ -59,7 +59,7 @@ module Reek
       end
 
       def source_line
-        @line ||= expression.line
+        @source_line ||= expression.line
       end
 
       def exception?
@@ -78,12 +78,9 @@ module Reek
         ctx.config_for(self.class)
       end
 
-      # :reek:FeatureEnvy
-      def smell_warning(options = {})
-        context = options.fetch(:context)
-        exp = context.exp
+      def smell_warning(**options)
         SmellWarning.new(self,
-                         source: exp.source,
+                         source: expression.source,
                          context: context.full_name,
                          lines: options.fetch(:lines),
                          message: options.fetch(:message),
@@ -99,7 +96,7 @@ module Reek
           [:def, :defs]
         end
 
-        # :reek:UtilityFunction
+        # @quality :reek:UtilityFunction
         def default_config
           {
             SmellConfiguration::ENABLED_KEY => true,
@@ -138,14 +135,14 @@ module Reek
         # Note that we assume a valid name - exceptions are not handled here.
         #
         # @param detector_name [String] the detector in question, e.g. 'DuplicateMethodCall'
-        # @return [SmellDetector] - this will return the class, not an instance
+        # @return [SmellDetector] this will return the class, not an instance
         #
         def to_detector(detector_name)
           SmellDetectors.const_get detector_name
         end
 
         #
-        # @return [Set<Symbol>] - all configuration keys that are available for this detector
+        # @return [Set<Symbol>] all configuration keys that are available for this detector
         #
         def configuration_keys
           Set.new(default_config.keys.map(&:to_sym))

data/lib/reek/smell_detectors/boolean_parameter.rb

@@ -24,7 +24,6 @@ module Reek
           [:true, :false].include?(value.type)
         end.map do |parameter, _value|
           smell_warning(
-            context: context,
             lines: [source_line],
             message: "has boolean parameter '#{parameter}'",
             parameters: { parameter: parameter.to_s })

data/lib/reek/smell_detectors/class_variable.rb

@@ -25,9 +25,9 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       def sniff
-        class_variables_in_context.map do |variable, lines|
+        class_variables_in_context.map do |variable, occurences|
+          lines = occurences.map(&:line)
           smell_warning(
-            context: context,
             lines: lines,
             message: "declares the class variable '#{variable}'",
             parameters: { name: variable.to_s })
@@ -38,16 +38,8 @@ module Reek
       # Collects the names of the class variables declared and/or used
       # in the given module.
       #
-      # :reek:TooManyStatements: { max_statements: 7 }
       def class_variables_in_context
-        result = Hash.new { |hash, key| hash[key] = [] }
-        collector = proc do |cvar_node|
-          result[cvar_node.name].push(cvar_node.line)
-        end
-        [:cvar, :cvasgn, :cvdecl].each do |stmt_type|
-          expression.each_node(stmt_type, [:class, :module], &collector)
-        end
-        result
+        context.local_nodes([:cvar, :cvasgn, :cvdecl]).group_by(&:name)
       end
     end
   end

data/lib/reek/smell_detectors/control_parameter.rb

@@ -49,18 +49,32 @@ module Reek
       #
       # @return [Array<SmellWarning>]
       #
-      # :reek:FeatureEnvy
       def sniff
-        ControlParameterCollector.new(context).control_parameters.map do |control_parameter|
+        control_parameters.map do |control_parameter|
           argument = control_parameter.name.to_s
           smell_warning(
-            context: context,
             lines: control_parameter.lines,
             message: "is controlled by argument '#{argument}'",
             parameters: { argument: argument })
         end
       end
 
+      private
+
+      def control_parameters
+        potential_parameters.
+          map { |param| FoundControlParameter.new(param, find_matches(param)) }.
+          select(&:smells?)
+      end
+
+      def potential_parameters
+        expression.parameter_names
+      end
+
+      def find_matches(param)
+        ControlParameterFinder.new(expression, param).find_matches
+      end
+
       #
       # Collects information about a single control parameter.
       #
@@ -166,35 +180,6 @@ module Reek
       end
 
       private_constant :ControlParameterFinder
-
-      #
-      # Collects all control parameters in a given context.
-      #
-      class ControlParameterCollector
-        def initialize(context)
-          @context = context
-        end
-
-        def control_parameters
-          potential_parameters.
-            map { |param| FoundControlParameter.new(param, find_matches(param)) }.
-            select(&:smells?)
-        end
-
-        private
-
-        attr_reader :context
-
-        def potential_parameters
-          context.exp.parameter_names
-        end
-
-        def find_matches(param)
-          ControlParameterFinder.new(context.exp, param).find_matches
-        end
-      end
-
-      private_constant :ControlParameterCollector
     end
   end
 end

data/lib/reek/smell_detectors/data_clump.rb

@@ -24,7 +24,7 @@ module Reek
       # reported as a DataClump unless there are more than this many
       # methods containing those parameters.
       #
-      MAX_COPIES_KEY = 'max_copies'.freeze
+      MAX_COPIES_KEY = 'max_copies'
       DEFAULT_MAX_COPIES = 2
 
       #
@@ -32,7 +32,7 @@ module Reek
       # size. No group of common parameters will be reported as
       # a DataClump unless it contains at least this many parameters.
       #
-      MIN_CLUMP_SIZE_KEY = 'min_clump_size'.freeze
+      MIN_CLUMP_SIZE_KEY = 'min_clump_size'
       DEFAULT_MIN_CLUMP_SIZE = 2
 
       def self.contexts # :nodoc:
@@ -54,7 +54,6 @@ module Reek
         MethodGroup.new(context, min_clump_size, max_copies).clumps.map do |clump, methods|
           methods_length = methods.length
           smell_warning(
-            context: context,
             lines: methods.map(&:line),
             message: "takes parameters #{DataClump.print_clump(clump)} " \
                      "to #{methods_length} methods",
@@ -101,7 +100,7 @@ module Reek
       end.uniq
     end
 
-    # :reek:UtilityFunction
+    # @quality :reek:UtilityFunction
     def common_argument_names_for(methods)
       methods.map(&:arg_names).inject(:&)
     end

data/lib/reek/smell_detectors/duplicate_method_call.rb

@@ -21,13 +21,13 @@ module Reek
     class DuplicateMethodCall < BaseDetector
       # The name of the config field that sets the maximum number of
       # identical calls to be permitted within any single method.
-      MAX_ALLOWED_CALLS_KEY = 'max_calls'.freeze
+      MAX_ALLOWED_CALLS_KEY = 'max_calls'
       DEFAULT_MAX_CALLS = 1
 
       # The name of the config field that sets the names of any
       # methods for which identical calls should be to be permitted
       # within any single method.
-      ALLOW_CALLS_KEY = 'allow_calls'.freeze
+      ALLOW_CALLS_KEY = 'allow_calls'
       DEFAULT_ALLOW_CALLS = [].freeze
 
       def self.default_config
@@ -47,7 +47,6 @@ module Reek
           call = found_call.call
           occurs = found_call.occurs
           smell_warning(
-            context: context,
             lines: found_call.lines,
             message: "calls '#{call}' #{occurs} times",
             parameters: { name: call, count: occurs })
@@ -118,10 +117,10 @@ module Reek
 
         attr_reader :allow_calls, :max_allowed_calls
 
-        # :reek:TooManyStatements: { max_statements: 6 }
-        # :reek:DuplicateMethodCall: { max_calls: 2 }
+        # @quality :reek:TooManyStatements { max_statements: 6 }
+        # @quality :reek:DuplicateMethodCall { max_calls: 2 }
         def collect_calls(result)
-          context.each_node(:send, [:mlhs]) do |call_node|
+          context.local_nodes(:send, [:mlhs]) do |call_node|
             next if call_node.object_creation_call?
             next if simple_method_call? call_node
             result[call_node].record(call_node)
@@ -135,7 +134,7 @@ module Reek
           found_call.occurs > max_allowed_calls && !allow_calls?(found_call.call)
         end
 
-        # :reek:UtilityFunction
+        # @quality :reek:UtilityFunction
         def simple_method_call?(call_node)
           !call_node.receiver && call_node.args.empty?
         end

data/lib/reek/smell_detectors/feature_envy.rb

@@ -43,10 +43,10 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       def sniff
+        return [] if context.singleton_method? || context.module_function?
         return [] unless context.references_self?
         envious_receivers.map do |name, lines|
           smell_warning(
-            context: context,
             lines: lines,
             message: "refers to '#{name}' more than self (maybe move it to another class?)",
             parameters: { name: name.to_s })

data/lib/reek/smell_detectors/instance_variable_assumption.rb

@@ -37,7 +37,6 @@ module Reek
         message = "assumes too much for instance variable '#{assumption}'"
 
         smell_warning(
-          context: context,
           lines: [source_line],
           message: message,
           parameters: { assumption: assumption.to_s })
@@ -55,17 +54,9 @@ module Reek
 
       def variables_from_context
         method_expressions.map do |method|
-          method.find_nodes(assumption_nodes, ignored_nodes).map(&:name)
+          method.each_node(:ivar, [:or_asgn]).map(&:name)
         end.flatten
       end
-
-      def assumption_nodes
-        [:ivar]
-      end
-
-      def ignored_nodes
-        [:or_asgn]
-      end
     end
   end
 end

data/lib/reek/smell_detectors/irresponsible_module.rb

@@ -22,7 +22,6 @@ module Reek
       def sniff
         return [] if descriptive_context? || context.namespace_module?
         [smell_warning(
-          context: context,
           lines: [source_line],
           message: 'has no descriptive comment')]
       end

data/lib/reek/smell_detectors/long_parameter_list.rb

@@ -16,7 +16,7 @@ module Reek
     class LongParameterList < BaseDetector
       # The name of the config field that sets the maximum number of
       # parameters permitted in any method or block.
-      MAX_ALLOWED_PARAMS_KEY = 'max_params'.freeze
+      MAX_ALLOWED_PARAMS_KEY = 'max_params'
       DEFAULT_MAX_ALLOWED_PARAMS = 3
 
       def self.default_config
@@ -36,7 +36,6 @@ module Reek
         count = expression.arg_names.length
         return [] if count <= max_allowed_params
         [smell_warning(
-          context: context,
           lines: [source_line],
           message: "has #{count} parameters",
           parameters: { count: count })]

data/lib/reek/smell_detectors/long_yield_list.rb

@@ -12,7 +12,7 @@ module Reek
     class LongYieldList < BaseDetector
       # The name of the config field that sets the maximum number of
       # parameters permitted in any method or block.
-      MAX_ALLOWED_PARAMS_KEY = 'max_params'.freeze
+      MAX_ALLOWED_PARAMS_KEY = 'max_params'
       DEFAULT_MAX_ALLOWED_PARAMS = 3
 
       def self.default_config
@@ -24,14 +24,13 @@ module Reek
       #
       # @return [Array<SmellWarning>]
       #
-      # :reek:DuplicateMethodCall: { max_calls: 2 }
+      # @quality :reek:DuplicateMethodCall { max_calls: 2 }
       def sniff
         context.local_nodes(:yield).select do |yield_node|
           yield_node.args.length > max_allowed_params
         end.map do |yield_node|
           count = yield_node.args.length
           smell_warning(
-            context: context,
             lines: [yield_node.line],
             message: "yields #{count} parameters",
             parameters: { count: count })

data/lib/reek/smell_detectors/manual_dispatch.rb

@@ -12,7 +12,7 @@ module Reek
     #
     # See {file:docs/Manual-Dispatch.md} for details.
     class ManualDispatch < BaseDetector
-      MESSAGE = 'manually dispatches method call'.freeze
+      MESSAGE = 'manually dispatches method call'
 
       #
       # Checks for +respond_to?+ usage within the given method
@@ -20,10 +20,10 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       def sniff
-        smelly_nodes = context.each_node(:send).select { |node| node.name == :respond_to? }
+        smelly_nodes = context.local_nodes(:send).select { |node| node.name == :respond_to? }
         return [] if smelly_nodes.empty?
         lines = smelly_nodes.map(&:line)
-        [smell_warning(context: context, lines: lines, message: MESSAGE)]
+        [smell_warning(lines: lines, message: MESSAGE)]
       end
     end
   end

data/lib/reek/smell_detectors/{prima_donna_method.rb → missing_safe_method.rb}

@@ -21,10 +21,10 @@ module Reek
     #   gets distorted and diluted, and ! ceases to convey any information
     #   whatsoever.
     #
-    # Such a method is called PrimaDonnaMethod and is reported as a smell.
+    # Such a method is called MissingSafeMethod and is reported as a smell.
     #
-    # See {file:docs/Prima-Donna-Method.md} for details.
-    class PrimaDonnaMethod < BaseDetector
+    # See {file:docs/Missing-Safe-Method.md} for details.
+    class MissingSafeMethod < BaseDetector
       def self.contexts # :nodoc:
         [:class]
       end
@@ -48,20 +48,19 @@ module Reek
       #
       def sniff
         context.node_instance_methods.select do |method_sexp|
-          prima_donna_method?(method_sexp)
+          missing_safe_method?(method_sexp)
         end.map do |method_sexp|
           name = method_sexp.name
           smell_warning(
-            context: context,
             lines: [method_sexp.line],
-            message: "has prima donna method '#{name}'",
+            message: "has missing safe method '#{name}'",
             parameters: { name: name.to_s })
         end
       end
 
       private
 
-      def prima_donna_method?(method_sexp)
+      def missing_safe_method?(method_sexp)
         return false unless method_sexp.ends_with_bang?
         return false if ignore_method? method_sexp
         return false if version_without_bang_exists? method_sexp

data/lib/reek/smell_detectors/module_initialize.rb

@@ -21,10 +21,9 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       def sniff
-        context.local_nodes(:def) do |node|
+        context.defined_instance_methods.each do |node|
           if node.name == :initialize
             return smell_warning(
-              context: context,
               lines:   [source_line],
               message: 'has initialize method')
           end

data/lib/reek/smell_detectors/nested_iterators.rb

@@ -20,12 +20,12 @@ module Reek
 
       # The name of the config field that sets the maximum depth
       # of nested iterators to be permitted within any single method.
-      MAX_ALLOWED_NESTING_KEY = 'max_allowed_nesting'.freeze
+      MAX_ALLOWED_NESTING_KEY = 'max_allowed_nesting'
       DEFAULT_MAX_ALLOWED_NESTING = 1
 
       # The name of the config field that sets the names of any
       # methods for which nesting should not be considered
-      IGNORE_ITERATORS_KEY = 'ignore_iterators'.freeze
+      IGNORE_ITERATORS_KEY = 'ignore_iterators'
       DEFAULT_IGNORE_ITERATORS = ['tap'].freeze
 
       def self.default_config
@@ -45,7 +45,6 @@ module Reek
         find_violations.group_by(&:depth).map do |depth, group|
           lines = group.map(&:line)
           smell_warning(
-            context: context,
             lines: lines,
             message: "contains iterators nested #{depth} deep",
             parameters: { depth: depth })
@@ -94,10 +93,11 @@ module Reek
       #
       # @return [Array<Iterator>]
       #
-      # :reek:TooManyStatements: { max_statements: 6 }
+      # @quality :reek:TooManyStatements { max_statements: 6 }
       def scout(exp:, depth:)
         return [] unless exp
-        exp.find_nodes([:block]).flat_map do |iterator|
+        # Find all non-nested blocks in this expression
+        exp.each_node([:block], [:block]).flat_map do |iterator|
           new_depth = increment_depth(iterator, depth)
           # 1st case: we recurse down the given block of the iterator. In this case
           # we need to check if we should increment the depth.
@@ -125,7 +125,7 @@ module Reek
         @max_allowed_nesting ||= value(MAX_ALLOWED_NESTING_KEY, context)
       end
 
-      # :reek:FeatureEnvy
+      # @quality :reek:FeatureEnvy
       def ignored_iterator?(exp)
         ignore_iterators.any? { |pattern| /#{pattern}/ =~ exp.call.name } ||
           exp.without_block_arguments?

data/lib/reek/smell_detectors/nil_check.rb

@@ -13,7 +13,6 @@ module Reek
         lines = detect_nodes.map(&:line)
         if lines.any?
           [smell_warning(
-            context: context,
             lines: lines,
             message: 'performs a nil-check')]
         else

data/lib/reek/smell_detectors/repeated_conditional.rb

@@ -28,7 +28,7 @@ module Reek
     class RepeatedConditional < BaseDetector
       # The name of the config field that sets the maximum number of
       # identical conditionals permitted within any single class.
-      MAX_IDENTICAL_IFS_KEY = 'max_ifs'.freeze
+      MAX_IDENTICAL_IFS_KEY = 'max_ifs'
       DEFAULT_MAX_IFS = 2
 
       BLOCK_GIVEN_CONDITION = ::Parser::AST::Node.new(:send, [nil, :block_given?])
@@ -46,7 +46,7 @@ module Reek
       #
       # @return [Array<SmellWarning>]
       #
-      # :reek:DuplicateMethodCall: { max_calls: 2 }
+      # @quality :reek:DuplicateMethodCall { max_calls: 2 }
       def sniff
         conditional_counts.select do |_key, lines|
           lines.length > max_identical_ifs
@@ -54,7 +54,6 @@ module Reek
           occurs = lines.length
           expression = key.format_to_ruby
           smell_warning(
-            context: context,
             lines: lines,
             message: "tests '#{expression}' at least #{occurs} times",
             parameters: { name: expression, count: occurs })
@@ -72,7 +71,7 @@ module Reek
       # the given syntax tree together with the number of times each
       # occurs. Ignores nested classes and modules.
       #
-      # :reek:TooManyStatements: { max_statements: 9 }
+      # @quality :reek:TooManyStatements { max_statements: 9 }
       def conditional_counts
         result = Hash.new { |hash, key| hash[key] = [] }
         collector = proc do |node|

data/lib/reek/smell_detectors/subclassed_from_core_class.rb

@@ -44,7 +44,6 @@ module Reek
 
       def build_smell_warning(ancestor_name)
         smell_attributes = {
-          context: context,
           lines: [source_line],
           message: "inherits from core class '#{ancestor_name}'",
           parameters: { ancestor: ancestor_name }

data/lib/reek/smell_detectors/too_many_constants.rb

@@ -15,7 +15,7 @@ module Reek
     class TooManyConstants < BaseDetector
       # The name of the config field that sets the maximum number
       # of constants permitted in a class.
-      MAX_ALLOWED_CONSTANTS_KEY = 'max_constants'.freeze
+      MAX_ALLOWED_CONSTANTS_KEY = 'max_constants'
       DEFAULT_MAX_CONSTANTS = 5
       IGNORED_NODES = [:module, :class].freeze
 
@@ -35,7 +35,7 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       def sniff
-        count = context.each_node(:casgn, IGNORED_NODES).delete_if(&:defines_module?).length
+        count = context.local_nodes(:casgn).reject(&:defines_module?).length
 
         return [] if count <= max_allowed_constants
 
@@ -50,7 +50,6 @@ module Reek
 
       def build_smell_warning(count)
         [smell_warning(
-          context: context,
           lines: [source_line],
           message: "has #{count} constants",
           parameters: { count: count })]

data/lib/reek/smell_detectors/too_many_instance_variables.rb

@@ -15,7 +15,7 @@ module Reek
     class TooManyInstanceVariables < BaseDetector
       # The name of the config field that sets the maximum number of instance
       # variables permitted in a class.
-      MAX_ALLOWED_IVARS_KEY = 'max_instance_variables'.freeze
+      MAX_ALLOWED_IVARS_KEY = 'max_instance_variables'
       DEFAULT_MAX_IVARS = 4
 
       def self.contexts
@@ -38,7 +38,6 @@ module Reek
         count = variables.uniq.size
         return [] if count <= max_allowed_ivars
         [smell_warning(
-          context: context,
           lines: [source_line],
           message: "has at least #{count} instance variables",
           parameters: { count: count })]

data/lib/reek/smell_detectors/too_many_methods.rb

@@ -17,7 +17,7 @@ module Reek
     class TooManyMethods < BaseDetector
       # The name of the config field that sets the maximum number of methods
       # permitted in a class.
-      MAX_ALLOWED_METHODS_KEY = 'max_methods'.freeze
+      MAX_ALLOWED_METHODS_KEY = 'max_methods'
       DEFAULT_MAX_METHODS = 15
 
       def self.contexts
@@ -40,7 +40,6 @@ module Reek
         actual = context.node_instance_methods.length
         return [] if actual <= max_allowed_methods
         [smell_warning(
-          context: context,
           lines: [source_line],
           message: "has at least #{actual} methods",
           parameters: { count: actual })]