reek 4.4.2 → 4.5.0

data/lib/reek/{smells → smell_detectors}/duplicate_method_call.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
-require_relative 'smell_detector'
+require_relative 'base_detector'
 require_relative 'smell_warning'
 
 module Reek
-  module Smells
+  module SmellDetectors
     #
     # Duplication occurs when two fragments of code look nearly identical,
     # or when two fragments of code have nearly identical effects
@@ -18,7 +18,7 @@ module Reek
     #   end
     #
     # See {file:docs/Duplicate-Method-Call.md} for details.
-    class DuplicateMethodCall < SmellDetector
+    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

data/lib/reek/{smells → smell_detectors}/feature_envy.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
-require_relative 'smell_detector'
+require_relative 'base_detector'
 require_relative 'smell_warning'
 
 module Reek
-  module Smells
+  module SmellDetectors
     #
     # Feature Envy occurs when a code fragment references another object
     # more often than it references itself, or when several clients do
@@ -35,7 +35,7 @@ module Reek
     # reported instead.
     #
     # See {file:docs/Feature-Envy.md} for details.
-    class FeatureEnvy < SmellDetector
+    class FeatureEnvy < BaseDetector
       #
       # Checks whether the given +context+ includes any code fragment that
       # might "belong" on another class.

data/lib/reek/{smells → smell_detectors}/instance_variable_assumption.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
-require_relative 'smell_detector'
+require_relative 'base_detector'
 require_relative 'smell_warning'
 
 module Reek
-  module Smells
+  module SmellDetectors
     #
     # The +InstanceVariableAssumption+ class is responsible for
     # detecting directly access of instance variables in a class
     # that does not define them in its initialize method.
     #
-    class InstanceVariableAssumption < SmellDetector
+    class InstanceVariableAssumption < BaseDetector
       def self.contexts
         [:class]
       end

data/lib/reek/{smells → smell_detectors}/irresponsible_module.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
-require_relative 'smell_detector'
+require_relative 'base_detector'
 require_relative 'smell_warning'
 
 module Reek
-  module Smells
+  module SmellDetectors
     #
     # It is considered good practice to annotate every class and module
     # with a brief comment outlining its responsibilities.
     #
     # See {file:docs/Irresponsible-Module.md} for details.
-    class IrresponsibleModule < SmellDetector
+    class IrresponsibleModule < BaseDetector
       def self.contexts
         [:casgn, :class, :module]
       end

data/lib/reek/{smells → smell_detectors}/long_parameter_list.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 require_relative 'smell_configuration'
-require_relative 'smell_detector'
+require_relative 'base_detector'
 require_relative 'smell_warning'
 
 module Reek
-  module Smells
+  module SmellDetectors
     #
     # A Long Parameter List occurs when a method has more than one
     # or two parameters, or when a method yields more than one or
@@ -14,7 +14,7 @@ module Reek
     # many parameters.
     #
     # See {file:docs/Long-Parameter-List.md} for details.
-    class LongParameterList < SmellDetector
+    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

data/lib/reek/{smells → smell_detectors}/long_yield_list.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
-require_relative 'smell_detector'
+require_relative 'base_detector'
 require_relative 'smell_warning'
 
 module Reek
-  module Smells
+  module SmellDetectors
     #
     # A variant on LongParameterList that checks the number of items
     # passed to a block by a +yield+ call.
     #
     # See {file:docs/Long-Yield-List.md} for details.
-    class LongYieldList < SmellDetector
+    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

data/lib/reek/{smells → smell_detectors}/manual_dispatch.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
-require_relative 'smell_detector'
+require_relative 'base_detector'
 require_relative 'smell_warning'
 
 module Reek
-  module Smells
+  module SmellDetectors
     #
     # A Manual Dispatch occurs when a method is only called after a
     # manual check that the method receiver is of the correct type.
@@ -11,7 +11,7 @@ module Reek
     # The +ManualDispatch+ checker reports any invocation of +respond_to?+
     #
     # See {file:docs/Manual-Dispatch.md} for details.
-    class ManualDispatch < SmellDetector
+    class ManualDispatch < BaseDetector
       MESSAGE = 'manually dispatches method call'.freeze
 
       #

data/lib/reek/{smells → smell_detectors}/module_initialize.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
-require_relative 'smell_detector'
+require_relative 'base_detector'
 require_relative 'smell_warning'
 
 module Reek
-  module Smells
+  module SmellDetectors
     #
     # a module is usually a mixin, so when initialize method is present it is
     # hard to tell initialization order and parameters so having 'initialize'
     # in a module is usually a bad idea
     #
     # See {file:docs/Module-Initialize.md} for details.
-    class ModuleInitialize < SmellDetector
+    class ModuleInitialize < BaseDetector
       def self.contexts # :nodoc:
         [:module]
       end

data/lib/reek/{smells → smell_detectors}/nested_iterators.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
-require_relative 'smell_detector'
+require_relative 'base_detector'
 require_relative 'smell_warning'
 
 module Reek
-  module Smells
+  module SmellDetectors
     #
     # A Nested Iterator occurs when a block contains another block.
     #
     # +NestedIterators+ reports failing methods only once.
     #
     # See {file:docs/Nested-Iterators.md} for details.
-    class NestedIterators < SmellDetector
+    class NestedIterators < BaseDetector
       # Struct for conveniently associating iterators with their depth (that is, their nesting).
       Iterator = Struct.new :exp, :depth do
         def line

data/lib/reek/{smells → smell_detectors}/nil_check.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
-require_relative 'smell_detector'
+require_relative 'base_detector'
 require_relative 'smell_warning'
 
 module Reek
-  module Smells
+  module SmellDetectors
     # Checking for nil is a special kind of type check, and therefore a case of
     # SimulatedPolymorphism.
     #
     # See {file:docs/Nil-Check.md} for details.
-    class NilCheck < SmellDetector
+    class NilCheck < BaseDetector
       def sniff(ctx)
         lines = NodeDetector.new(ctx).detect.map(&:line)
         if lines.any?

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

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
-require_relative 'smell_detector'
+require_relative 'base_detector'
 require_relative 'smell_warning'
 
 module Reek
-  module Smells
+  module SmellDetectors
     # Excerpt from:
     # http://dablog.rubypal.com/2007/8/15/bang-methods-or-danger-will-rubyist
     # since this sums it up really well:
@@ -24,7 +24,7 @@ module Reek
     # Such a method is called PrimaDonnaMethod and is reported as a smell.
     #
     # See {file:docs/Prima-Donna-Method.md} for details.
-    class PrimaDonnaMethod < SmellDetector
+    class PrimaDonnaMethod < BaseDetector
       def self.contexts # :nodoc:
         [:class]
       end

data/lib/reek/{smells → smell_detectors}/repeated_conditional.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 require_relative '../ast/node'
-require_relative 'smell_detector'
+require_relative 'base_detector'
 require_relative 'smell_warning'
 
 module Reek
-  module Smells
+  module SmellDetectors
     #
     # Simulated Polymorphism occurs when
     # * code uses a case statement (especially on a type field);
@@ -25,7 +25,7 @@ module Reek
     # testing the same value throughout a single class.
     #
     # See {file:docs/Repeated-Conditional.md} for details.
-    class RepeatedConditional < SmellDetector
+    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

data/lib/reek/{smells → smell_detectors}/smell_configuration.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module Reek
-  module Smells
+  module SmellDetectors
     #
     # Represents a single set of configuration options for a smell detector
     #

data/lib/reek/{smells → smell_detectors}/smell_warning.rb

@@ -3,7 +3,7 @@ require 'forwardable'
 
 module Reek
   # @public
-  module Smells
+  module SmellDetectors
     #
     # Reports a warning that a smell has been found.
     #

data/lib/reek/{smells → smell_detectors}/subclassed_from_core_class.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
-require_relative 'smell_detector'
+require_relative 'base_detector'
 require_relative 'smell_warning'
 
 module Reek
-  module Smells
+  module SmellDetectors
     #
     # Subclassing core classes in Ruby can lead to unexpected side effects.
     # Knowing that Ruby has a core library, which is written in C, and a standard
@@ -12,7 +12,7 @@ module Reek
     #
     # Source: http://words.steveklabnik.com/beware-subclassing-ruby-core-classes
     #
-    class SubclassedFromCoreClass < SmellDetector
+    class SubclassedFromCoreClass < BaseDetector
       CORE_CLASSES = ['Array', 'Hash', 'String'].freeze
 
       def self.contexts

data/lib/reek/{smells → smell_detectors}/too_many_constants.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
-require_relative 'smell_detector'
+require_relative 'base_detector'
 require_relative 'smell_warning'
 
 module Reek
-  module Smells
+  module SmellDetectors
     #
     # A Large Class is a class or module that has a large number of
     # instance variables, methods, constants or lines of code.
@@ -12,7 +12,7 @@ module Reek
     # configurable number of constants.
     #
     # See {file:docs/Too-Many-Constants.md} for details.
-    class TooManyConstants < SmellDetector
+    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

data/lib/reek/{smells → smell_detectors}/too_many_instance_variables.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
-require_relative 'smell_detector'
+require_relative 'base_detector'
 require_relative 'smell_warning'
 
 module Reek
-  module Smells
+  module SmellDetectors
     #
     # A Large Class is a class or module that has a large number of
     # instance variables, methods or lines of code.
@@ -12,7 +12,7 @@ module Reek
     # configurable number of instance variables.
     #
     # See {file:docs/Too-Many-Instance-Variables.md} for details.
-    class TooManyInstanceVariables < SmellDetector
+    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

data/lib/reek/{smells → smell_detectors}/too_many_methods.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
-require_relative 'smell_detector'
+require_relative 'base_detector'
 require_relative 'smell_warning'
 
 module Reek
-  module Smells
+  module SmellDetectors
     #
     # A Large Class is a class or module that has a large number of
     # instance variables, methods or lines of code.
@@ -14,7 +14,7 @@ module Reek
     # modules.
     #
     # See {file:docs/Too-Many-Methods.md} for details.
-    class TooManyMethods < SmellDetector
+    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

data/lib/reek/{smells → smell_detectors}/too_many_statements.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
-require_relative 'smell_detector'
+require_relative 'base_detector'
 require_relative 'smell_warning'
 
 module Reek
-  module Smells
+  module SmellDetectors
     #
     # A Long Method is any method that has a large number of lines.
     #
     # +TooManyStatements+ reports any method with more than 5 statements.
     #
     # See {file:docs/Too-Many-Statements.md} for details.
-    class TooManyStatements < SmellDetector
+    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

data/lib/reek/{smells → smell_detectors}/uncommunicative_method_name.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
-require_relative 'smell_detector'
+require_relative 'base_detector'
 require_relative 'smell_warning'
 
 module Reek
-  module Smells
+  module SmellDetectors
     #
     # An Uncommunicative Name is a name that doesn't communicate its intent
     # well enough.
@@ -19,7 +19,7 @@ module Reek
     # * names containing a capital letter (assuming camelCase)
     #
     # See {file:docs/Uncommunicative-Method-Name.md} for details.
-    class UncommunicativeMethodName < SmellDetector
+    class UncommunicativeMethodName < BaseDetector
       REJECT_KEY = 'reject'.freeze
       ACCEPT_KEY = 'accept'.freeze
       DEFAULT_REJECT_PATTERNS = [/^[a-z]$/, /[0-9]$/, /[A-Z]/].freeze

data/lib/reek/{smells → smell_detectors}/uncommunicative_module_name.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
-require_relative 'smell_detector'
+require_relative 'base_detector'
 require_relative 'smell_warning'
 
 module Reek
-  module Smells
+  module SmellDetectors
     #
     # An Uncommunicative Name is a name that doesn't communicate its intent
     # well enough.
@@ -18,7 +18,7 @@ module Reek
     # * names ending with a number
     #
     # See {file:docs/Uncommunicative-Module-Name.md} for details.
-    class UncommunicativeModuleName < SmellDetector
+    class UncommunicativeModuleName < BaseDetector
       # The name of the config field that lists the regexps of
       # smelly names to be reported.
       REJECT_KEY = 'reject'.freeze

data/lib/reek/{smells → smell_detectors}/uncommunicative_parameter_name.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
-require_relative 'smell_detector'
+require_relative 'base_detector'
 require_relative 'smell_warning'
 
 module Reek
-  module Smells
+  module SmellDetectors
     #
     # An Uncommunicative Name is a name that doesn't communicate its intent
     # well enough.
@@ -20,7 +20,7 @@ module Reek
     # * names containing a capital letter (assuming camelCase)
     #
     # See {file:docs/Uncommunicative-Parameter-Name.md} for details.
-    class UncommunicativeParameterName < SmellDetector
+    class UncommunicativeParameterName < BaseDetector
       REJECT_KEY = 'reject'.freeze
       DEFAULT_REJECT_PATTERNS = [/^.$/, /[0-9]$/, /[A-Z]/, /^_/].freeze
 

data/lib/reek/{smells → smell_detectors}/uncommunicative_variable_name.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
-require_relative 'smell_detector'
+require_relative 'base_detector'
 require_relative 'smell_warning'
 
 module Reek
-  module Smells
+  module SmellDetectors
     #
     # An Uncommunicative Name is a name that doesn't communicate its intent
     # well enough.
@@ -22,7 +22,7 @@ module Reek
     # See {file:docs/Uncommunicative-Variable-Name.md} for details.
     #
     # :reek:DataClump: { max_copies: 4 }
-    class UncommunicativeVariableName < SmellDetector
+    class UncommunicativeVariableName < BaseDetector
       # The name of the config field that lists the regexps of
       # smelly names to be reported.
       REJECT_KEY = 'reject'.freeze