reek 4.8.2 → 5.0.0

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
@@ -23,7 +23,7 @@ module Reek
         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

@@ -24,7 +24,6 @@ module Reek
         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,7 +93,7 @@ module Reek
       #
       # @return [Array<Iterator>]
       #
-      # :reek:TooManyStatements: { max_statements: 6 }
+      # @quality :reek:TooManyStatements { max_statements: 6 }
       def scout(exp:, depth:)
         return [] unless exp
         # Find all non-nested blocks in this expression
@@ -126,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
 
@@ -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 })]

data/lib/reek/smell_detectors/too_many_statements.rb

@@ -13,7 +13,7 @@ module Reek
     class TooManyStatements < BaseDetector
       # The name of the config field that sets the maximum number of
       # statements permitted in any method.
-      MAX_ALLOWED_STATEMENTS_KEY = 'max_statements'.freeze
+      MAX_ALLOWED_STATEMENTS_KEY = 'max_statements'
       DEFAULT_MAX_STATEMENTS = 5
 
       def self.default_config
@@ -31,7 +31,6 @@ module Reek
         count = context.number_of_statements
         return [] if count <= max_allowed_statements
         [smell_warning(
-          context: context,
           lines: [source_line],
           message: "has approx #{count} statements",
           parameters: { count: count })]

data/lib/reek/smell_detectors/uncommunicative_method_name.rb

@@ -20,8 +20,8 @@ module Reek
     #
     # See {file:docs/Uncommunicative-Method-Name.md} for details.
     class UncommunicativeMethodName < BaseDetector
-      REJECT_KEY = 'reject'.freeze
-      ACCEPT_KEY = 'accept'.freeze
+      REJECT_KEY = 'reject'
+      ACCEPT_KEY = 'accept'
       DEFAULT_REJECT_PATTERNS = [/^[a-z]$/, /[0-9]$/, /[A-Z]/].freeze
       DEFAULT_ACCEPT_PATTERNS = [].freeze
 
@@ -41,7 +41,6 @@ module Reek
         return [] if acceptable_name?(name)
 
         [smell_warning(
-          context: context,
           lines: [source_line],
           message: "has the name '#{name}'",
           parameters: { name: name })]

data/lib/reek/smell_detectors/uncommunicative_module_name.rb

@@ -21,13 +21,13 @@ module Reek
     class UncommunicativeModuleName < BaseDetector
       # The name of the config field that lists the regexps of
       # smelly names to be reported.
-      REJECT_KEY = 'reject'.freeze
+      REJECT_KEY = 'reject'
       DEFAULT_REJECT_PATTERNS = [/^.$/, /[0-9]$/].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
+      ACCEPT_KEY = 'accept'
       DEFAULT_ACCEPT_PATTERNS = [].freeze
 
       def self.default_config
@@ -53,7 +53,6 @@ module Reek
                                       fully_qualified_name: fully_qualified_name)
 
         [smell_warning(
-          context: context,
           lines: [source_line],
           message: "has the name '#{module_name}'",
           parameters: { name: module_name })]

data/lib/reek/smell_detectors/uncommunicative_parameter_name.rb

@@ -21,10 +21,10 @@ module Reek
     #
     # See {file:docs/Uncommunicative-Parameter-Name.md} for details.
     class UncommunicativeParameterName < BaseDetector
-      REJECT_KEY = 'reject'.freeze
+      REJECT_KEY = 'reject'
       DEFAULT_REJECT_PATTERNS = [/^.$/, /[0-9]$/, /[A-Z]/, /^_/].freeze
 
-      ACCEPT_KEY = 'accept'.freeze
+      ACCEPT_KEY = 'accept'
       DEFAULT_ACCEPT_PATTERNS = [].freeze
 
       def self.default_config
@@ -45,7 +45,6 @@ module Reek
 
         params.map(&:name).map do |name|
           smell_warning(
-            context: context,
             lines: [source_line],
             message: "has the parameter name '#{name}'",
             parameters: { name: name.to_s })

data/lib/reek/smell_detectors/uncommunicative_variable_name.rb

@@ -24,7 +24,7 @@ module Reek
     class UncommunicativeVariableName < BaseDetector
       # The name of the config field that lists the regexps of
       # smelly names to be reported.
-      REJECT_KEY = 'reject'.freeze
+      REJECT_KEY = 'reject'
       DEFAULT_REJECT_SET = [
         /^.$/, # single-character names
         /[0-9]$/,  # any name ending with a number
@@ -34,7 +34,7 @@ module Reek
       # 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
+      ACCEPT_KEY = 'accept'
       DEFAULT_ACCEPT_SET = [/^_$/].freeze
 
       def self.default_config
@@ -57,7 +57,6 @@ module Reek
           uncommunicative_variable_name?(name)
         end.map do |name, lines|
           smell_warning(
-            context: context,
             lines: lines,
             message: "has the variable name '#{name}'",
             parameters: { name: name.to_s })
@@ -102,7 +101,7 @@ module Reek
         assignment_nodes.each { |asgn| accumulator[asgn.children.first].push(asgn.line) }
       end
 
-      # :reek:TooManyStatements: { max_statements: 6 }
+      # @quality :reek:TooManyStatements { max_statements: 6 }
       def find_block_argument_variable_names(accumulator)
         arg_search_exp = case expression.type
                          when :class, :module
@@ -130,7 +129,7 @@ module Reek
         end
       end
 
-      # :reek:UtilityFunction
+      # @quality :reek:UtilityFunction
       def record_variable_name(exp, symbol, accumulator)
         varname = symbol.to_s.sub(/^\*/, '')
         return if varname == ''

data/lib/reek/smell_detectors/unused_parameters.rb

@@ -19,7 +19,6 @@ module Reek
         context.unused_params.map do |param|
           name = param.name.to_s
           smell_warning(
-            context: context,
             lines: [source_line],
             message: "has unused parameter '#{name}'",
             parameters: { name: name })

data/lib/reek/smell_detectors/unused_private_method.rb

@@ -38,7 +38,6 @@ module Reek
         hits.map do |hit|
           name = hit.name
           smell_warning(
-            context: context,
             lines: [hit.line],
             message: "has the unused private instance method '#{name}'",
             parameters: { name: name.to_s })

data/lib/reek/smell_detectors/utility_function.rb

@@ -38,7 +38,7 @@ module Reek
     #
     # See {file:docs/Utility-Function.md} for details.
     class UtilityFunction < BaseDetector
-      PUBLIC_METHODS_ONLY_KEY     = 'public_methods_only'.freeze
+      PUBLIC_METHODS_ONLY_KEY     = 'public_methods_only'
       PUBLIC_METHODS_ONLY_DEFAULT = false
 
       def self.default_config
@@ -63,7 +63,6 @@ module Reek
         return [] if ignore_method?
 
         [smell_warning(
-          context: context,
           lines: [source_line],
           message: "doesn't depend on instance state (maybe move it to another class?)")]
       end

data/lib/reek/smell_warning.rb

@@ -9,7 +9,7 @@ module Reek
   #
   # @public
   #
-  # :reek:TooManyInstanceVariables: { max_instance_variables: 6 }
+  # @quality :reek:TooManyInstanceVariables { max_instance_variables: 6 }
   class SmellWarning
     include Comparable
     extend Forwardable
@@ -22,7 +22,7 @@ module Reek
     #   objects yourself. This is why the initializer is not part of the
     #   public API.
     #
-    # :reek:LongParameterList: { max_params: 6 }
+    # @quality :reek:LongParameterList { max_params: 6 }
     def initialize(smell_detector, context: '', lines:, message:,
                    source:, parameters: {})
       @smell_detector = smell_detector
@@ -56,7 +56,9 @@ module Reek
       base_hash.merge(stringified_params)
     end
 
-    alias yaml_hash to_hash
+    def yaml_hash
+      to_hash.merge('documentation_link' => explanatory_link)
+    end
 
     def base_message
       "#{smell_type}: #{context} #{message}"
@@ -80,11 +82,11 @@ module Reek
 
     def base_hash
       {
-        'context'        => context,
-        'lines'          => lines,
-        'message'        => message,
-        'smell_type'     => smell_type,
-        'source'         => source
+        'context'    => context,
+        'lines'      => lines,
+        'message'    => message,
+        'smell_type' => smell_type,
+        'source'     => source
       }
     end
   end