reek 4.8.2 → 5.0.0

data/lib/reek/report/progress_formatter.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Reek
+  module Report
+    module ProgressFormatter
+      #
+      # Base class for progress formatters.
+      # Is responsible for formatting the progress emitted for each examiner
+      #
+      # @abstract Override {#header, #progress, #footer} to implement a progress formatter.
+      class Base
+        attr_reader :sources_count
+
+        def initialize(sources_count)
+          @sources_count = sources_count
+        end
+
+        def header
+          raise NotImplementedError
+        end
+
+        def progress(_examiner)
+          raise NotImplementedError
+        end
+
+        def footer
+          raise NotImplementedError
+        end
+      end
+
+      #
+      # Shows the status of each source as either a dot (.) or an S
+      #
+      class Dots < Base
+        NO_WARNINGS_COLOR = :green
+        WARNINGS_COLOR = :red
+
+        def header
+          "Inspecting #{sources_count} file(s):\n"
+        end
+
+        def progress(examiner)
+          examiner.smelly? ? display_smelly : display_clean
+        end
+
+        def footer
+          "\n\n"
+        end
+
+        private
+
+        def display_clean
+          Rainbow('.').color(NO_WARNINGS_COLOR)
+        end
+
+        def display_smelly
+          Rainbow('S').color(WARNINGS_COLOR)
+        end
+      end
+
+      #
+      # Does not show progress
+      #
+      class Quiet < Base
+        def header
+          ''
+        end
+
+        def progress(_examiner)
+          ''
+        end
+
+        def footer
+          ''
+        end
+      end
+    end
+  end
+end

data/lib/reek/report/simple_warning_formatter.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'code_climate/code_climate_formatter'
+
+module Reek
+  module Report
+    #
+    # Basic formatter that just shows a simple message for each warning,
+    # prepended with the result of the passed-in location formatter.
+    #
+    class SimpleWarningFormatter
+      def initialize(location_formatter: BlankLocationFormatter)
+        @location_formatter = location_formatter
+      end
+
+      def format(warning)
+        "#{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
+
+      private
+
+      attr_reader :location_formatter
+    end
+  end
+end

data/lib/reek/report/text_report.rb

@@ -49,8 +49,7 @@ module Reek
       def summarize_single_examiner(examiner)
         result = heading_formatter.header(examiner)
         if examiner.smelly?
-          formatted_list = report_formatter.format_list(examiner.smells,
-                                                        formatter: warning_formatter)
+          formatted_list = warning_formatter.format_list(examiner.smells)
           result += ":\n#{formatted_list}"
         end
         result

data/lib/reek/report/xml_report.rb

@@ -34,8 +34,8 @@ module Reek
         end
       end
 
-      # :reek:FeatureEnvy
-      # :reek:NestedIterators: { max_allowed_nesting: 2 }
+      # @quality :reek:FeatureEnvy
+      # @quality :reek:NestedIterators { max_allowed_nesting: 2 }
       def file(name, smells)
         REXML::Element.new('file').tap do |file|
           file.add_attribute 'name', File.realpath(name)
@@ -47,7 +47,7 @@ module Reek
         end
       end
 
-      # :reek:UtilityFunction
+      # @quality :reek:UtilityFunction
       def error(smell, line)
         REXML::Element.new('error').tap do |error|
           error.add_attributes 'column' => 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/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.rb

@@ -15,10 +15,9 @@ require_relative 'smell_detectors/manual_dispatch'
 require_relative 'smell_detectors/module_initialize'
 require_relative 'smell_detectors/nested_iterators'
 require_relative 'smell_detectors/nil_check'
-require_relative 'smell_detectors/prima_donna_method'
+require_relative 'smell_detectors/missing_safe_method'
 require_relative 'smell_detectors/repeated_conditional'
 require_relative 'smell_detectors/subclassed_from_core_class'
-require_relative 'smell_detectors/syntax'
 require_relative 'smell_detectors/too_many_instance_variables'
 require_relative 'smell_detectors/too_many_constants'
 require_relative 'smell_detectors/too_many_methods'

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.
@@ -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

@@ -28,7 +28,6 @@ module Reek
         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 })

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,8 +117,8 @@ 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.local_nodes(:send, [:mlhs]) do |call_node|
             next if call_node.object_creation_call?
@@ -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

@@ -47,7 +47,6 @@ module Reek
         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 })

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