reek 4.5.2 → 4.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 602cbf9c7a40f8103d514b8d4088192cbfd7fdff
-  data.tar.gz: 39c4099443c81b23662e3c640374a0af287001ee
+  metadata.gz: 34053f46644b02e67bce28cf14ec83289581d477
+  data.tar.gz: 66637070f65e2c5a95ef84c3e981de7a0ffa5bf5
 SHA512:
-  metadata.gz: bfd0a2c1dfa98ca1e4edbf1967d973f17bf10ad9e15c9b205c68a222bb23dd46084488c942f0570ca58e1baa86258e9f8fb6f953ac3f7ad2077f8441fd56b9b2
-  data.tar.gz: d46599e1cbb959026843db0d87c3cd8749baa517ff9db172c4ab37e73fcb3c3b827ae8ef425ead5553dea452b91bddeefa898eb80e8e091152855a9346b83116
+  metadata.gz: 9125b0336673170f5466a661f9c1893fcefc16bc7ace54d75979e817854844e7ccdd6cac5a223ca0c1a200fbaeafd56da79f0435b3f9ea14c9d67e9bea0dc024
+  data.tar.gz: a8308b810ce8785c1fdd39abbcb19708a86c0aa276698f3d803550a4d1d332ec2612fcfa5c92dbdf29096c4fed4066b05506a78ce8ea6ff1a0a708e5e6fa42aa

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change log
 
+## 4.5.3 (2016-12-05)
+
+* (jhubert) Stop reporting FeatureEnvy with super and arguments.
+
 ## 4.5.2 (2016-11-06)
 
 * (troessner) Warn about multiple configuration files.

data/Gemfile

@@ -15,7 +15,7 @@ group :development do
   gem 'activesupport', '~> 4.2'
 
   if RUBY_VERSION >= '2.3'
-    gem 'rubocop',       '~> 0.44.1'
+    gem 'rubocop',       '~> 0.45.0'
     gem 'rubocop-rspec', '~> 1.7'
   end
 

data/docs/How-To-Write-New-Detectors.md

@@ -9,19 +9,19 @@ it covers and the overall rationale behind it.
 
 ### Structure
 
-All smell detectors reside in `lib/reek/smells` and have the following base structure:
+All smell detectors reside in `lib/reek/smell_detectors` and have the following base structure:
 
 ```Ruby
-require_relative 'smell_detector'
+require_relative 'base_detector'
 require_relative 'smell_warning'
 
 module Reek
-  module Smells
+  module SmellDetectors
     #
     # Here goes your introduction for this detector.
     #
     # See {file:docs/Your-Detector.md} for details.
-    class YourDetector < SmellDetector
+    class YourDetector < BaseDetector
       def self.contexts
         [:class] # In case you're operating on class contexts only - just an example.
       end
@@ -37,7 +37,7 @@ module Reek
         # This can just be a method but it can also be a more sophisticated set up.
         # Check out other smell detectors to get a feeling for what to do here.
         found_smells(ctx).map do |smell|
-          # "smell_warning" is defined in SmellDetector and should be used by you
+          # "smell_warning" is defined in BaseDetector and should be used by you
           # to construct smell warnings
           smell_warning(
             context: ctx,
@@ -59,7 +59,7 @@ module Reek
 end
 ```
 
-For your detector to be properly loaded you need to require it in `lib/reek/smells.rb` as well.
+For your detector to be properly loaded you need to require it in `lib/reek/smell_detectors.rb` as well.
 
 ### defaults.reek
 

data/docs/Irresponsible-Module.md

@@ -2,7 +2,14 @@
 
 ## Introduction
 
-Classes and modules are the units of reuse and release. It is therefore considered good practice to annotate every class and module with a brief comment outlining its responsibilities.
+Classes and modules are the units of reuse and release. It is therefore
+considered good practice to annotate every class and module with a brief
+comment outlining its responsibilities.
+
+For further guideline on how to write good documentation in Ruby, see these
+links:
+- [Rails API documentation guidelines](http://edgeguides.rubyonrails.org/api_documentation_guidelines.html)
+- [Comments tell you why](https://blog.codinghorror.com/code-tells-you-how-comments-tell-you-why/)
 
 ## Example
 

data/docs/RSpec-matchers.md

@@ -74,15 +74,10 @@ See the "Quickstart" example from above.
 Checks the target source code for instances of "smell type"
 and returns true only if it can find one of them that matches.
 
-Remember that this includes our "smell types" as well. So it could be the
-"smell type" UtilityFunction, which is represented as a concrete class
-in Reek but it could also be "Duplication" which is a "smell categgory".
+You can pass the smell type you want to check for as String or as Symbol:
 
-You could pass many different types of input here:
 - `:UtilityFunction`
 - `"UtilityFunction"`
-- `Reek::Smells::UtilityFunction` (the right way if you really want to pass a
-  class)
 
 It is recommended to pass this as a symbol like `:UtilityFunction`. However we
 don't enforce this.
@@ -106,20 +101,20 @@ So in a nutshell `reek_of` takes the following two arguments:
 
 ```Ruby
   reek_of(:FeatureEnvy)
-  reek_of(Reek::Smells::UtilityFunction)
+  reek_of(:UtilityFunction)
 ```
 
 With smell_details:
 
 ```Ruby
-  reek_of(UncommunicativeParameterName, name: 'x2')
-  reek_of(DataClump, count: 3)
+  reek_of(:UncommunicativeParameterName, name: 'x2')
+  reek_of(:DataClump, count: 3)
 ```
 
 **Examples from a real spec**
 
 ```Ruby
-  expect(src).to reek_of(Reek::Smells::DuplicateMethodCall, name: '@other.thing')
+  expect(src).to reek_of(:DuplicateMethodCall, name: '@other.thing')
 ```
 
 ### reek_only_of

data/docs/templates/default/docstring/setup.rb

@@ -10,14 +10,7 @@ end
 
 def api_marker
   return if object.type == :root
-  case api_text
-  when 'public'
-    # erb(:public_api_marker)
-  when 'private'
-    # Let section 'private' handle this.
-  else
-    erb(:private)
-  end
+  erb(:private) unless ['public', 'private'].include? api_text
 end
 
 private

data/lib/reek/context_builder.rb

@@ -19,7 +19,7 @@ module Reek
   # counting. Ideally `ContextBuilder` would only build up the context tree and leave the
   # statement and reference counting to the contexts.
   #
-  # :reek:TooManyMethods: { max_methods: 30 }
+  # :reek:TooManyMethods: { max_methods: 31 }
   # :reek:UnusedPrivateMethod: { exclude: [ !ruby/regexp /process_/ ] }
   class ContextBuilder
     attr_reader :context_tree
@@ -228,6 +228,30 @@ module Reek
       current_context.record_use_of_self
     end
 
+    # Handles `super` nodes a.k.a. calls to `super` with arguments
+    #
+    # An input example that would trigger this method would be:
+    #
+    #   def call_me; super(); end
+    #
+    # or
+    #
+    #   def call_me; super(bar); end
+    #
+    # but not
+    #
+    #   def call_me; super; end
+    #
+    # and not
+    #
+    #   def call_me; super do end; end
+    #
+    # We record one reference to `self`.
+    #
+    def process_super(_)
+      current_context.record_use_of_self
+    end
+
     # Handles `block` nodes.
     #
     # An input example that would trigger this method would be:

data/lib/reek/detector_repository.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+require_relative 'smell_detectors'
+require_relative 'smell_detectors/base_detector'
+require_relative 'configuration/app_configuration'
+
+module Reek
+  #
+  # Contains all the existing smell detectors and exposes operations on them.
+  #
+  class DetectorRepository
+    # @return [Array<Reek::SmellDetectors::BaseDetector>] All known SmellDetectors
+    #         e.g. [Reek::SmellDetectors::BooleanParameter, Reek::SmellDetectors::ClassVariable].
+    def self.smell_types
+      Reek::SmellDetectors::BaseDetector.descendants.sort_by(&:name)
+    end
+
+    # @param filter_by_smells [Array<String>]
+    #   List of smell types to filter by, e.g. "DuplicateMethodCall".
+    #   More precisely it should be whatever is returned by `BaseDetector`.smell_type.
+    #   This means that you can write the "DuplicateMethodCall" from above also like this:
+    #     Reek::SmellDetectors::DuplicateMethodCall.smell_type
+    #   if you want to make sure you do not fat-finger strings.
+    #
+    # @return [Array<Reek::SmellDetectors::BaseDetector>] All SmellDetectors that we want to filter for
+    #         e.g. [Reek::SmellDetectors::Attribute].
+    def self.eligible_smell_types(filter_by_smells = [])
+      return smell_types if filter_by_smells.empty?
+      smell_types.select do |klass|
+        filter_by_smells.include? klass.smell_type
+      end
+    end
+
+    def initialize(smell_types: self.class.smell_types,
+                   configuration: {})
+      @configuration = configuration
+      @smell_types   = smell_types
+      @detectors     = smell_types.map { |klass| klass.new configuration_for(klass) }
+    end
+
+    def examine(context)
+      smell_detectors_for(context.type).flat_map do |detector|
+        detector.run_for(context)
+      end
+    end
+
+    private
+
+    attr_reader :configuration, :smell_types, :detectors
+
+    def configuration_for(klass)
+      configuration.fetch klass, {}
+    end
+
+    def smell_detectors_for(type)
+      enabled_detectors.select do |detector|
+        detector.contexts.include? type
+      end
+    end
+
+    def enabled_detectors
+      detectors.select { |detector| detector.config.enabled? }
+    end
+  end
+end

data/lib/reek/examiner.rb

@@ -2,7 +2,7 @@
 require_relative 'context_builder'
 require_relative 'errors/bad_detector_in_comment_error'
 require_relative 'errors/garbage_detector_configuration_in_comment_error'
-require_relative 'smell_detectors/detector_repository'
+require_relative 'detector_repository'
 require_relative 'source/source_code'
 
 module Reek
@@ -57,7 +57,7 @@ module Reek
     def initialize(source,
                    filter_by_smells: [],
                    configuration: Configuration::AppConfiguration.default,
-                   detector_repository_class: SmellDetectors::DetectorRepository)
+                   detector_repository_class: DetectorRepository)
       @source              = Source::SourceCode.from(source)
       @smell_types         = detector_repository_class.eligible_smell_types(filter_by_smells)
       @detector_repository = detector_repository_class.new(smell_types: @smell_types,

data/lib/reek/smell_configuration.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+module Reek
+  #
+  # Represents a single set of configuration options for a smell detector
+  #
+  class SmellConfiguration
+    # The name of the config field that specifies whether a smell is
+    # enabled. Set to +true+ or +false+.
+    ENABLED_KEY = 'enabled'.freeze
+
+    # 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
+
+    def initialize(hash)
+      @options = hash
+    end
+
+    def merge(new_options)
+      options.merge!(new_options)
+    end
+
+    def enabled?
+      options[ENABLED_KEY]
+    end
+
+    def overrides_for(context)
+      Overrides.new(options.fetch(OVERRIDES_KEY, {})).for_context(context)
+    end
+
+    # Retrieves the value, if any, for the given +key+ in the given +context+.
+    #
+    # Raises an error if neither the context nor this config have a value for
+    # the key.
+    #
+    def value(key, context)
+      overrides_for(context).each { |conf| return conf[key] if conf.key?(key) }
+      options.fetch(key)
+    end
+
+    private
+
+    attr_reader :options
+  end
+
+  #
+  # A set of context-specific overrides for smell detectors.
+  #
+  class Overrides
+    def initialize(hash)
+      @hash = hash
+    end
+
+    # Find any overrides that match the supplied context
+    def for_context(context)
+      contexts = hash.keys.select { |ckey| context.matches?([ckey]) }
+      contexts.map { |exc| hash[exc] }
+    end
+
+    private
+
+    attr_reader :hash
+  end
+end

data/lib/reek/smell_detectors/attribute.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
-require_relative 'smell_configuration'
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/base_detector.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 require 'set'
-require_relative 'smell_configuration'
+require_relative '../smell_warning'
+require_relative '../smell_configuration'
 
 module Reek
   module SmellDetectors
@@ -106,9 +107,9 @@ module Reek
         # Returns all descendants of BaseDetector
         #
         # @return [Array<Constant>], e.g.:
-        #   [Reek::Smells::Attribute,
-        #    Reek::Smells::BooleanParameter,
-        #    Reek::Smells::ClassVariable,
+        #   [Reek::SmellDetectors::Attribute,
+        #    Reek::SmellDetectors::BooleanParameter,
+        #    Reek::SmellDetectors::ClassVariable,
         #    ...]
         #
         def descendants

data/lib/reek/smell_detectors/boolean_parameter.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/class_variable.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 require 'set'
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/control_parameter.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/data_clump.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/duplicate_method_call.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/feature_envy.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/instance_variable_assumption.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/irresponsible_module.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/long_parameter_list.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
-require_relative 'smell_configuration'
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/long_yield_list.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/manual_dispatch.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/module_initialize.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/nested_iterators.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/nil_check.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/prima_donna_method.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/repeated_conditional.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 require_relative '../ast/node'
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/subclassed_from_core_class.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/too_many_constants.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/too_many_instance_variables.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/too_many_methods.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/too_many_statements.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/uncommunicative_method_name.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/uncommunicative_module_name.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/uncommunicative_parameter_name.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/uncommunicative_variable_name.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/unused_parameters.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/unused_private_method.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 require_relative 'base_detector'
-require_relative 'smell_warning'
-require_relative '../context/method_context'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_detectors/utility_function.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 require_relative '../ast/reference_collector'
 require_relative 'base_detector'
-require_relative 'smell_warning'
 
 module Reek
   module SmellDetectors

data/lib/reek/smell_warning.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+require 'forwardable'
+
+module Reek
+  #
+  # Reports a warning that a smell has been found.
+  #
+  # @public
+  #
+  # :reek:TooManyInstanceVariables: { max_instance_variables: 6 }
+  class SmellWarning
+    include Comparable
+    extend Forwardable
+
+    # @public
+    attr_reader :context, :lines, :message, :parameters, :smell_detector, :source
+    def_delegators :smell_detector, :smell_type
+
+    # @note When using Reek's public API, you should not create SmellWarning
+    #   objects yourself. This is why the initializer is not part of the
+    #   public API.
+    #
+    # :reek:LongParameterList: { max_params: 6 }
+    def initialize(smell_detector, context: '', lines:, message:,
+                   source:, parameters: {})
+      @smell_detector = smell_detector
+      @source         = source
+      @context        = context.to_s
+      @lines          = lines
+      @message        = message
+      @parameters     = parameters
+
+      freeze
+    end
+
+    # @public
+    def hash
+      identifying_values.hash
+    end
+
+    # @public
+    def <=>(other)
+      identifying_values <=> other.identifying_values
+    end
+
+    # @public
+    def eql?(other)
+      (self <=> other).zero?
+    end
+
+    # @public
+    def to_hash
+      stringified_params = Hash[parameters.map { |key, val| [key.to_s, val] }]
+      base_hash.merge(stringified_params)
+    end
+
+    alias yaml_hash to_hash
+
+    def base_message
+      "#{smell_type}: #{context} #{message}"
+    end
+
+    def smell_class
+      smell_detector.class
+    end
+
+    protected
+
+    def identifying_values
+      [smell_type, context, message, lines]
+    end
+
+    private
+
+    def base_hash
+      {
+        'context'        => context,
+        'lines'          => lines,
+        'message'        => message,
+        'smell_type'     => smell_type,
+        'source'         => source
+      }
+    end
+  end
+end

data/lib/reek/spec.rb

@@ -48,10 +48,10 @@ module Reek
     # Checks the target source code for instances of "smell type"
     # and returns true only if it can find one of them that matches.
     #
-    # You could pass many different types of input here:
+    # You can pass the smell type you want to check for as String or as Symbol:
+    #
     #   - :UtilityFunction
     #   - "UtilityFunction"
-    #   - Reek::Smells::UtilityFunction
     #
     # It is recommended to pass this as a symbol like :UtilityFunction. However we don't
     # enforce this.
@@ -70,7 +70,7 @@ module Reek
     # @example Without smell_details
     #
     #   reek_of(:FeatureEnvy)
-    #   reek_of(Reek::Smells::UtilityFunction)
+    #   reek_of(:UtilityFunction)
     #
     # @example With smell_details
     #
@@ -79,7 +79,7 @@ module Reek
     #
     # @example From a real spec
     #
-    #   expect(src).to reek_of(Reek::Smells::DuplicateMethodCall, name: '@other.thing')
+    #   expect(src).to reek_of(:DuplicateMethodCall, name: '@other.thing')
     #
     # @public
     #

data/lib/reek/spec/should_reek_of.rb

@@ -25,7 +25,7 @@ module Reek
                      configuration = Configuration::AppConfiguration.default)
         @smell_type = normalize smell_type_or_class
         @smell_details = smell_details
-        configuration.load_values(smell_type => { SmellDetectors::SmellConfiguration::ENABLED_KEY => true })
+        configuration.load_values(smell_type => { SmellConfiguration::ENABLED_KEY => true })
         @configuration = configuration
       end
 

data/lib/reek/version.rb

@@ -7,6 +7,6 @@ module Reek
   # @public
   module Version
     # @public
-    STRING = '4.5.2'.freeze
+    STRING = '4.5.3'.freeze
   end
 end

data/spec/factories/factories.rb

@@ -1,6 +1,6 @@
 require_relative '../../lib/reek/smell_detectors'
 require_relative '../../lib/reek/smell_detectors/base_detector'
-require_relative '../../lib/reek/smell_detectors/smell_warning'
+require_relative '../../lib/reek/smell_warning'
 require_relative '../../lib/reek/cli/options'
 
 FactoryGirl.define do
@@ -34,7 +34,7 @@ FactoryGirl.define do
     end
   end
 
-  factory :smell_warning, class: Reek::SmellDetectors::SmellWarning do
+  factory :smell_warning, class: Reek::SmellWarning do
     skip_create
     smell_detector
     context 'self'

data/spec/reek/{smell_detectors/detector_repository_spec.rb → detector_repository_spec.rb}

@@ -1,8 +1,8 @@
-require_relative '../../spec_helper'
+require_relative '../spec_helper'
 require_lib 'reek/smell_detectors/base_detector'
-require_lib 'reek/smell_detectors/detector_repository'
+require_lib 'reek/detector_repository'
 
-RSpec.describe Reek::SmellDetectors::DetectorRepository do
+RSpec.describe Reek::DetectorRepository do
   describe '.smell_types' do
     let(:smell_types) { described_class.smell_types }
 

data/spec/reek/examiner_spec.rb

@@ -87,7 +87,7 @@ RSpec.describe Reek::Examiner do
       examiner = described_class.new code, filter_by_smells: ['DuplicateMethodCall']
 
       smell = examiner.smells.first
-      expect(smell).to be_a(Reek::SmellDetectors::SmellWarning)
+      expect(smell).to be_a(Reek::SmellWarning)
       expect(smell.message).to eq("calls 'bar.call_me()' 2 times")
     end
 
@@ -111,13 +111,13 @@ RSpec.describe Reek::Examiner do
       let(:source) { 'class C; def does_crash_reek; end; end' }
 
       let(:examiner) do
-        detector_repository = instance_double 'Reek::SmellDetectors::DetectorRepository'
+        detector_repository = instance_double 'Reek::DetectorRepository'
         allow(detector_repository).to receive(:examine) do
           raise ArgumentError, 'Looks like bad source'
         end
-        class_double('Reek::SmellDetectors::DetectorRepository').as_stubbed_const
-        allow(Reek::SmellDetectors::DetectorRepository).to receive(:eligible_smell_types)
-        allow(Reek::SmellDetectors::DetectorRepository).to receive(:new).and_return detector_repository
+        class_double('Reek::DetectorRepository').as_stubbed_const
+        allow(Reek::DetectorRepository).to receive(:eligible_smell_types)
+        allow(Reek::DetectorRepository).to receive(:new).and_return detector_repository
 
         described_class.new source
       end

data/spec/reek/{smell_detectors/smell_configuration_spec.rb → smell_configuration_spec.rb}

@@ -1,7 +1,7 @@
-require_relative '../../spec_helper'
-require_lib 'reek/smell_detectors/smell_configuration'
+require_relative '../spec_helper'
+require_lib 'reek/smell_configuration'
 
-RSpec.describe Reek::SmellDetectors::SmellConfiguration do
+RSpec.describe Reek::SmellConfiguration do
   context 'when overriding default configs' do
     let(:base_config) do
       {

data/spec/reek/smell_detectors/feature_envy_spec.rb

@@ -97,6 +97,11 @@ RSpec.describe Reek::SmellDetectors::FeatureEnvy do
     expect(src).not_to reek_of(:FeatureEnvy)
   end
 
+  it 'does not report parameter method called with super ' do
+    src = 'def alfa(bravo) super(bravo.to_s); end'
+    expect(src).not_to reek_of(:FeatureEnvy)
+  end
+
   it 'ignores multiple ivars' do
     src = <<-EOS
       def func

data/spec/reek/smell_detectors/module_initialize_spec.rb

@@ -49,4 +49,15 @@ RSpec.describe Reek::SmellDetectors::ModuleInitialize do
 
     expect(src).not_to reek_of(:ModuleInitialize)
   end
+
+  it 'can be disabled via comment' do
+    src = <<-EOS
+      # :reek:ModuleInitialize
+      module Alfa
+        def initialize; end
+      end
+    EOS
+
+    expect(src).not_to reek_of(:ModuleInitialize)
+  end
 end

data/spec/reek/{smell_detectors/smell_warning_spec.rb → smell_warning_spec.rb}

@@ -1,7 +1,7 @@
-require_relative '../../spec_helper'
-require_lib 'reek/smell_detectors/smell_warning'
+require_relative '../spec_helper'
+require_lib 'reek/smell_warning'
 
-RSpec.describe Reek::SmellDetectors::SmellWarning do
+RSpec.describe Reek::SmellWarning do
   let(:duplication_detector)  { build(:smell_detector, smell_type: 'DuplicateMethodCall') }
   let(:feature_envy_detector) { build(:smell_detector, smell_type: 'FeatureEnvy') }
   let(:utility_function_detector) { build(:smell_detector, smell_type: 'UtilityFunction') }

data/spec/reek/spec/should_reek_of_spec.rb

@@ -133,7 +133,7 @@ RSpec.describe Reek::Spec::ShouldReekOf do
   context 'for a smell that is disabled by default' do
     before do
       default_config = Reek::SmellDetectors::UnusedPrivateMethod.default_config
-      expect(default_config[Reek::SmellDetectors::SmellConfiguration::ENABLED_KEY]).to be_falsy
+      expect(default_config[Reek::SmellConfiguration::ENABLED_KEY]).to be_falsy
     end
 
     it 'enables the smell detector to match automatically' do

data/tasks/configuration.rake

@@ -1,11 +1,11 @@
-require_relative '../lib/reek/smell_detectors/detector_repository'
+require_relative '../lib/reek/detector_repository'
 require 'yaml'
 
 namespace :configuration do
   desc 'Updates the default configuration file when smell defaults change'
   task :update_default_configuration do
     DEFAULT_SMELL_CONFIGURATION = 'defaults.reek'.freeze
-    content = Reek::SmellDetectors::DetectorRepository.smell_types.each_with_object({}) do |klass, hash|
+    content = Reek::DetectorRepository.smell_types.each_with_object({}) do |klass, hash|
       hash[klass.smell_type] = klass.default_config
     end
     File.open(DEFAULT_SMELL_CONFIGURATION, 'w') { |file| YAML.dump(content, file) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 4.5.2
+  version: 4.5.3
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-06 00:00:00.000000000 Z
+date: 2016-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-engine-rb
@@ -222,6 +222,7 @@ files:
 - lib/reek/context/statement_counter.rb
 - lib/reek/context/visibility_tracker.rb
 - lib/reek/context_builder.rb
+- lib/reek/detector_repository.rb
 - lib/reek/errors/bad_detector_configuration_key_in_comment_error.rb
 - lib/reek/errors/bad_detector_in_comment_error.rb
 - lib/reek/errors/garbage_detector_configuration_in_comment_error.rb
@@ -247,6 +248,7 @@ files:
 - lib/reek/report/text_report.rb
 - lib/reek/report/xml_report.rb
 - lib/reek/report/yaml_report.rb
+- lib/reek/smell_configuration.rb
 - lib/reek/smell_detectors.rb
 - lib/reek/smell_detectors/attribute.rb
 - lib/reek/smell_detectors/base_detector.rb
@@ -254,7 +256,6 @@ files:
 - lib/reek/smell_detectors/class_variable.rb
 - lib/reek/smell_detectors/control_parameter.rb
 - lib/reek/smell_detectors/data_clump.rb
-- lib/reek/smell_detectors/detector_repository.rb
 - lib/reek/smell_detectors/duplicate_method_call.rb
 - lib/reek/smell_detectors/feature_envy.rb
 - lib/reek/smell_detectors/instance_variable_assumption.rb
@@ -267,8 +268,6 @@ files:
 - lib/reek/smell_detectors/nil_check.rb
 - lib/reek/smell_detectors/prima_donna_method.rb
 - lib/reek/smell_detectors/repeated_conditional.rb
-- lib/reek/smell_detectors/smell_configuration.rb
-- lib/reek/smell_detectors/smell_warning.rb
 - lib/reek/smell_detectors/subclassed_from_core_class.rb
 - lib/reek/smell_detectors/too_many_constants.rb
 - lib/reek/smell_detectors/too_many_instance_variables.rb
@@ -281,6 +280,7 @@ files:
 - lib/reek/smell_detectors/unused_parameters.rb
 - lib/reek/smell_detectors/unused_private_method.rb
 - lib/reek/smell_detectors/utility_function.rb
+- lib/reek/smell_warning.rb
 - lib/reek/source/source_code.rb
 - lib/reek/source/source_locator.rb
 - lib/reek/spec.rb
@@ -348,6 +348,7 @@ files:
 - spec/reek/context/root_context_spec.rb
 - spec/reek/context/statement_counter_spec.rb
 - spec/reek/context_builder_spec.rb
+- spec/reek/detector_repository_spec.rb
 - spec/reek/examiner_spec.rb
 - spec/reek/rake/task_spec.rb
 - spec/reek/report/code_climate/code_climate_configuration_spec.rb
@@ -362,13 +363,13 @@ files:
 - spec/reek/report/xml_report_spec.rb
 - spec/reek/report/yaml_report_spec.rb
 - spec/reek/report_spec.rb
+- spec/reek/smell_configuration_spec.rb
 - spec/reek/smell_detectors/attribute_spec.rb
 - spec/reek/smell_detectors/base_detector_spec.rb
 - spec/reek/smell_detectors/boolean_parameter_spec.rb
 - spec/reek/smell_detectors/class_variable_spec.rb
 - spec/reek/smell_detectors/control_parameter_spec.rb
 - spec/reek/smell_detectors/data_clump_spec.rb
-- spec/reek/smell_detectors/detector_repository_spec.rb
 - spec/reek/smell_detectors/duplicate_method_call_spec.rb
 - spec/reek/smell_detectors/feature_envy_spec.rb
 - spec/reek/smell_detectors/instance_variable_assumption_spec.rb
@@ -381,8 +382,6 @@ files:
 - spec/reek/smell_detectors/nil_check_spec.rb
 - spec/reek/smell_detectors/prima_donna_method_spec.rb
 - spec/reek/smell_detectors/repeated_conditional_spec.rb
-- spec/reek/smell_detectors/smell_configuration_spec.rb
-- spec/reek/smell_detectors/smell_warning_spec.rb
 - spec/reek/smell_detectors/subclassed_from_core_class_spec.rb
 - spec/reek/smell_detectors/too_many_constants_spec.rb
 - spec/reek/smell_detectors/too_many_instance_variables_spec.rb
@@ -395,6 +394,7 @@ files:
 - spec/reek/smell_detectors/unused_parameters_spec.rb
 - spec/reek/smell_detectors/unused_private_method_spec.rb
 - spec/reek/smell_detectors/utility_function_spec.rb
+- spec/reek/smell_warning_spec.rb
 - spec/reek/source/source_code_spec.rb
 - spec/reek/source/source_locator_spec.rb
 - spec/reek/spec/should_reek_of_spec.rb

data/lib/reek/smell_detectors/detector_repository.rb

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-require_relative '../smell_detectors'
-require_relative 'base_detector'
-require_relative '../configuration/app_configuration'
-
-module Reek
-  module SmellDetectors
-    #
-    # Contains all the existing smell detectors and exposes operations on them.
-    #
-    class DetectorRepository
-      # @return [Array<Reek::SmellDetectors::BaseDetector>] All known SmellDetectors
-      #         e.g. [Reek::Smells::BooleanParameter, Reek::Smells::ClassVariable].
-      def self.smell_types
-        Reek::SmellDetectors::BaseDetector.descendants.sort_by(&:name)
-      end
-
-      # @param filter_by_smells [Array<String>]
-      #   List of smell types to filter by, e.g. "DuplicateMethodCall".
-      #   More precisely it should be whatever is returned by `BaseDetector`.smell_type.
-      #   This means that you can write the "DuplicateMethodCall" from above also like this:
-      #     Reek::Smells::DuplicateMethodCall.smell_type
-      #   if you want to make sure you do not fat-finger strings.
-      #
-      # @return [Array<Reek::SmellDetectors::BaseDetector>] All SmellDetectors that we want to filter for
-      #         e.g. [Reek::Smells::Attribute].
-      def self.eligible_smell_types(filter_by_smells = [])
-        return smell_types if filter_by_smells.empty?
-        smell_types.select do |klass|
-          filter_by_smells.include? klass.smell_type
-        end
-      end
-
-      def initialize(smell_types: self.class.smell_types,
-                     configuration: {})
-        @configuration = configuration
-        @smell_types   = smell_types
-        @detectors     = smell_types.map { |klass| klass.new configuration_for(klass) }
-      end
-
-      def examine(context)
-        smell_detectors_for(context.type).flat_map do |detector|
-          detector.run_for(context)
-        end
-      end
-
-      private
-
-      attr_reader :configuration, :smell_types, :detectors
-
-      def configuration_for(klass)
-        configuration.fetch klass, {}
-      end
-
-      def smell_detectors_for(type)
-        enabled_detectors.select do |detector|
-          detector.contexts.include? type
-        end
-      end
-
-      def enabled_detectors
-        detectors.select { |detector| detector.config.enabled? }
-      end
-    end
-  end
-end

data/lib/reek/smell_detectors/smell_configuration.rb

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-module Reek
-  module SmellDetectors
-    #
-    # Represents a single set of configuration options for a smell detector
-    #
-    class SmellConfiguration
-      # The name of the config field that specifies whether a smell is
-      # enabled. Set to +true+ or +false+.
-      ENABLED_KEY = 'enabled'.freeze
-
-      # 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
-
-      def initialize(hash)
-        @options = hash
-      end
-
-      def merge(new_options)
-        options.merge!(new_options)
-      end
-
-      def enabled?
-        options[ENABLED_KEY]
-      end
-
-      def overrides_for(context)
-        Overrides.new(options.fetch(OVERRIDES_KEY, {})).for_context(context)
-      end
-
-      # Retrieves the value, if any, for the given +key+ in the given +context+.
-      #
-      # Raises an error if neither the context nor this config have a value for
-      # the key.
-      #
-      def value(key, context)
-        overrides_for(context).each { |conf| return conf[key] if conf.key?(key) }
-        options.fetch(key)
-      end
-
-      private
-
-      attr_reader :options
-    end
-
-    #
-    # A set of context-specific overrides for smell detectors.
-    #
-    class Overrides
-      def initialize(hash)
-        @hash = hash
-      end
-
-      # Find any overrides that match the supplied context
-      def for_context(context)
-        contexts = hash.keys.select { |ckey| context.matches?([ckey]) }
-        contexts.map { |exc| hash[exc] }
-      end
-
-      private
-
-      attr_reader :hash
-    end
-  end
-end

data/lib/reek/smell_detectors/smell_warning.rb

@@ -1,88 +0,0 @@
-# frozen_string_literal: true
-require 'forwardable'
-
-module Reek
-  # @public
-  module SmellDetectors
-    #
-    # Reports a warning that a smell has been found.
-    #
-    # @public
-    #
-    # :reek:TooManyInstanceVariables: { max_instance_variables: 6 }
-    class SmellWarning
-      include Comparable
-      extend Forwardable
-
-      # @public
-      attr_reader :context, :lines, :message, :parameters, :smell_detector, :source
-      def_delegators :smell_detector, :smell_type
-
-      # @note When using Reek's public API, you should not create SmellWarning
-      #   objects yourself. This is why the initializer is not part of the
-      #   public API.
-      #
-      # :reek:LongParameterList: { max_params: 6 }
-      def initialize(smell_detector, context: '', lines:, message:,
-                     source:, parameters: {})
-        @smell_detector = smell_detector
-        @source         = source
-        @context        = context.to_s
-        @lines          = lines
-        @message        = message
-        @parameters     = parameters
-
-        freeze
-      end
-
-      # @public
-      def hash
-        identifying_values.hash
-      end
-
-      # @public
-      def <=>(other)
-        identifying_values <=> other.identifying_values
-      end
-
-      # @public
-      def eql?(other)
-        (self <=> other).zero?
-      end
-
-      # @public
-      def to_hash
-        stringified_params = Hash[parameters.map { |key, val| [key.to_s, val] }]
-        base_hash.merge(stringified_params)
-      end
-
-      alias yaml_hash to_hash
-
-      def base_message
-        "#{smell_type}: #{context} #{message}"
-      end
-
-      def smell_class
-        smell_detector.class
-      end
-
-      protected
-
-      def identifying_values
-        [smell_type, context, message, lines]
-      end
-
-      private
-
-      def base_hash
-        {
-          'context'        => context,
-          'lines'          => lines,
-          'message'        => message,
-          'smell_type'     => smell_type,
-          'source'         => source
-        }
-      end
-    end
-  end
-end