reek 3.11 → 4.0.0.pre1

data/lib/reek/smells/repeated_conditional.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative '../ast/node'
 require_relative 'smell_detector'
 require_relative 'smell_warning'
@@ -30,10 +31,6 @@ module Reek
       MAX_IDENTICAL_IFS_KEY = 'max_ifs'.freeze
       DEFAULT_MAX_IFS = 2
 
-      def self.smell_category
-        'SimulatedPolymorphism'
-      end
-
       BLOCK_GIVEN_CONDITION = ::Parser::AST::Node.new(:send, [nil, :block_given?])
 
       def self.contexts # :nodoc:

data/lib/reek/smells/smell_configuration.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Reek
   module Smells
     #

data/lib/reek/smells/smell_detector.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'set'
 require_relative 'smell_configuration'
 
@@ -31,10 +32,6 @@ module Reek
         @smells_found = []
       end
 
-      def smell_category
-        self.class.smell_category
-      end
-
       def smell_type
         self.class.smell_type
       end
@@ -88,16 +85,8 @@ module Reek
       end
 
       class << self
-        def smell_category
-          @smell_category ||= default_smell_category
-        end
-
         def smell_type
-          @smell_type ||= default_smell_category
-        end
-
-        def default_smell_category
-          name.split(/::/)[-1]
+          @smell_type ||= name.split(/::/).last
         end
 
         def contexts

data/lib/reek/smells/smell_repository.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative '../smells'
 require_relative 'smell_detector'
 require_relative '../configuration/app_configuration'

data/lib/reek/smells/smell_warning.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'forwardable'
 
 module Reek
@@ -15,17 +16,15 @@ module Reek
 
       # @public
       attr_reader :context, :lines, :message, :parameters, :smell_detector, :source
-      def_delegators :smell_detector, :smell_category, :smell_type
+      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.
       #
-      # FIXME: switch to required kwargs when dropping Ruby 2.0 compatibility
-      #
       # :reek:LongParameterList: { max_params: 6 }
-      def initialize(smell_detector, context: '', lines: raise, message: raise,
-                     source: raise, parameters: {})
+      def initialize(smell_detector, context: '', lines:, message:,
+                     source:, parameters: {})
         @smell_detector = smell_detector
         @source         = source
         @context        = context.to_s
@@ -77,7 +76,6 @@ module Reek
           'context'        => context,
           'lines'          => lines,
           'message'        => message,
-          'smell_category' => smell_category,
           'smell_type'     => smell_type,
           'source'         => source
         }

data/lib/reek/smells/too_many_instance_variables.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'smell_detector'
 require_relative 'smell_warning'
 
@@ -17,10 +18,6 @@ module Reek
       MAX_ALLOWED_IVARS_KEY = 'max_instance_variables'.freeze
       DEFAULT_MAX_IVARS = 4
 
-      def self.smell_category
-        'LargeClass'
-      end
-
       def self.contexts
         [:class]
       end

data/lib/reek/smells/too_many_methods.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'smell_detector'
 require_relative 'smell_warning'
 
@@ -19,10 +20,6 @@ module Reek
       MAX_ALLOWED_METHODS_KEY = 'max_methods'.freeze
       DEFAULT_MAX_METHODS = 15
 
-      def self.smell_category
-        'LargeClass'
-      end
-
       def self.contexts
         [:class]
       end

data/lib/reek/smells/too_many_statements.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'smell_detector'
 require_relative 'smell_warning'
 
@@ -15,10 +16,6 @@ module Reek
       MAX_ALLOWED_STATEMENTS_KEY = 'max_statements'.freeze
       DEFAULT_MAX_STATEMENTS = 5
 
-      def self.smell_category
-        'LongMethod'
-      end
-
       def self.default_config
         super.merge(
           MAX_ALLOWED_STATEMENTS_KEY => DEFAULT_MAX_STATEMENTS,

data/lib/reek/smells/uncommunicative_method_name.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'smell_detector'
 require_relative 'smell_warning'
 
@@ -23,10 +24,6 @@ module Reek
       DEFAULT_REJECT_PATTERNS = [/^[a-z]$/, /[0-9]$/, /[A-Z]/].freeze
       DEFAULT_ACCEPT_NAMES = [].freeze
 
-      def self.smell_category
-        'UncommunicativeName'
-      end
-
       def self.default_config
         super.merge(
           REJECT_KEY => DEFAULT_REJECT_PATTERNS,
@@ -52,7 +49,7 @@ module Reek
 
       private
 
-      def acceptable_name?(name: raise, context: raise)
+      def acceptable_name?(name:, context:)
         accept_names(context).any? { |accept_name| name == accept_name } ||
           reject_patterns(context).none? { |pattern| name.match pattern }
       end

data/lib/reek/smells/uncommunicative_module_name.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'smell_detector'
 require_relative 'smell_warning'
 
@@ -29,10 +30,6 @@ module Reek
       ACCEPT_KEY = 'accept'.freeze
       DEFAULT_ACCEPT_NAMES = [].freeze
 
-      def self.smell_category
-        'UncommunicativeName'
-      end
-
       def self.default_config
         super.merge(
           REJECT_KEY => DEFAULT_REJECT_PATTERNS,
@@ -67,9 +64,8 @@ module Reek
 
       private
 
-      # FIXME: switch to required kwargs when dropping Ruby 2.0 compatibility
       # :reek:ControlParameter
-      def acceptable_name?(context: raise, module_name: raise, fully_qualified_name: raise)
+      def acceptable_name?(context:, module_name:, fully_qualified_name:)
         accept_names(context).any? { |accept_name| fully_qualified_name == accept_name } ||
           reject_patterns(context).none? { |pattern| module_name.match pattern }
       end

data/lib/reek/smells/uncommunicative_parameter_name.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'smell_detector'
 require_relative 'smell_warning'
 
@@ -24,10 +25,6 @@ module Reek
       ACCEPT_KEY = 'accept'.freeze
       DEFAULT_ACCEPT_NAMES = [].freeze
 
-      def self.smell_category
-        'UncommunicativeName'
-      end
-
       def self.default_config
         super.merge(
           REJECT_KEY => DEFAULT_REJECT_PATTERNS,
@@ -56,11 +53,11 @@ module Reek
 
       private
 
-      def uncommunicative_parameter_name?(name: raise, context: raise)
+      def uncommunicative_parameter_name?(name:, context:)
         !acceptable_name?(name: name, context: context) && context.uses_param?(name)
       end
 
-      def acceptable_name?(name: raise, context: raise)
+      def acceptable_name?(name:, context:)
         accept_names(context).any? { |accept_name| name == accept_name } ||
           reject_patterns(context).none? { |pattern| name.match pattern }
       end

data/lib/reek/smells/uncommunicative_variable_name.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'smell_detector'
 require_relative 'smell_warning'
 
@@ -31,10 +32,6 @@ module Reek
       ACCEPT_KEY = 'accept'.freeze
       DEFAULT_ACCEPT_SET = ['_'].freeze
 
-      def self.smell_category
-        'UncommunicativeName'
-      end
-
       def self.default_config
         super.merge(
           REJECT_KEY => DEFAULT_REJECT_SET,

data/lib/reek/smells/unused_parameters.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'smell_detector'
 require_relative 'smell_warning'
 
@@ -8,10 +9,6 @@ module Reek
     #
     # See {file:docs/Unused-Parameters.md} for details.
     class UnusedParameters < SmellDetector
-      def self.smell_category
-        'UnusedCode'
-      end
-
       #
       # Checks whether the given method has any unused parameters.
       #

data/lib/reek/smells/unused_private_method.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'smell_detector'
 require_relative 'smell_warning'
 require_relative '../context/method_context'

data/lib/reek/smells/utility_function.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative '../ast/reference_collector'
 require_relative 'smell_detector'
 require_relative 'smell_warning'
@@ -40,10 +41,6 @@ module Reek
       PUBLIC_METHODS_ONLY_KEY     = 'public_methods_only'.freeze
       PUBLIC_METHODS_ONLY_DEFAULT = false
 
-      def self.smell_category
-        'LowCohesion'
-      end
-
       class << self
         def contexts # :nodoc:
           [:def]

data/lib/reek/source/source_code.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative '../cli/silencer'
 Reek::CLI::Silencer.silently do
   require 'parser/ruby23'
@@ -21,7 +22,7 @@ module Reek
       # code   - Ruby code as String
       # origin - 'STDIN', 'string' or a filepath as String
       # parser - the parser to use for generating AST's out of the given source
-      def initialize(code: raise, origin: raise, parser: Parser::Ruby23)
+      def initialize(code:, origin:, parser: Parser::Ruby23)
         @source = code
         @origin = origin
         @parser = parser

data/lib/reek/source/source_locator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'find'
 require 'pathname'
 

data/lib/reek/spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'spec/should_reek'
 require_relative 'spec/should_reek_of'
 require_relative 'spec/should_reek_only_of'
@@ -42,19 +43,13 @@ module Reek
   # @public
   module Spec
     #
-    # Checks the target source code for instances of "smell category"
+    # 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".
-    #
-    # In theory you could pass many different types of input here:
+    # You could pass many different types of input here:
     #   - :UtilityFunction
     #   - "UtilityFunction"
-    #   - UtilityFunction (this works in our specs because we tend to do "include Reek:Smells")
-    #   - Reek::Smells::UtilityFunction (the right way if you really want to pass a class)
-    #   - "Duplication" or :Duplication which is an abstract "smell category"
+    #   - Reek::Smells::UtilityFunction
     #
     # It is recommended to pass this as a symbol like :UtilityFunction. However we don't
     # enforce this.
@@ -67,47 +62,45 @@ module Reek
     # raise an ArgumentError to give you a hint that you passed something that doesn't make
     # much sense.
     #
-    # smell_category - The "smell category" or "smell_type" we check for.
-    # smells_details - A hash containing "smell warning" parameters
-    #
-    # Examples
+    # @param smell_type [Symbol, String, Class] The "smell type" to check for.
+    # @param smells_details [Hash] A hash containing "smell warning" parameters
     #
-    #   Without smell_details:
+    # @example Without smell_details
     #
     #   reek_of(:FeatureEnvy)
     #   reek_of(Reek::Smells::UtilityFunction)
     #
-    #   With smell_details:
+    # @example With smell_details
     #
-    #   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
+    # @example From a real spec
     #
     #   expect(src).to reek_of(Reek::Smells::DuplicateMethodCall, name: '@other.thing')
     #
     # @public
     #
     # :reek:UtilityFunction
-    def reek_of(smell_category,
+    def reek_of(smell_type,
                 smell_details = {},
                 configuration = Configuration::AppConfiguration.default)
-      ShouldReekOf.new(smell_category, smell_details, configuration)
+      ShouldReekOf.new(smell_type, smell_details, configuration)
     end
 
     #
     # See the documentaton for "reek_of".
     #
     # Notable differences to reek_of:
-    #   1.) "reek_of" doesn't mind if there are other smells of a different category.
+    #   1.) "reek_of" doesn't mind if there are other smells of a different type.
     #       "reek_only_of" will fail in that case.
     #   2.) "reek_only_of" doesn't support the additional smell_details hash.
     #
     # @public
     #
     # :reek:UtilityFunction
-    def reek_only_of(smell_category, configuration = Configuration::AppConfiguration.default)
-      ShouldReekOnlyOf.new(smell_category, configuration)
+    def reek_only_of(smell_type, configuration = Configuration::AppConfiguration.default)
+      ShouldReekOnlyOf.new(smell_type, configuration)
     end
 
     #

data/lib/reek/spec/should_reek.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative '../examiner'
 require_relative '../report/formatter'
 
@@ -11,8 +12,8 @@ module Reek
         @configuration = configuration
       end
 
-      def matches?(actual)
-        self.examiner = Examiner.new(actual, configuration: configuration)
+      def matches?(source)
+        self.examiner = Examiner.new(source, configuration: configuration)
         examiner.smelly?
       end
 

data/lib/reek/spec/should_reek_of.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative '../examiner'
 require_relative 'smell_matcher'
 
@@ -10,23 +11,23 @@ module Reek
     class ShouldReekOf
       attr_reader :failure_message, :failure_message_when_negated
 
-      def initialize(smell_category,
+      def initialize(smell_type_or_class,
                      smell_details = {},
                      configuration = Configuration::AppConfiguration.default)
-        @smell_category = normalize smell_category
+        @smell_type = normalize smell_type_or_class
         @smell_details  = smell_details
         @configuration  = configuration
       end
 
-      def matches?(actual)
-        self.examiner = Examiner.new(actual, configuration: configuration)
+      def matches?(source)
+        self.examiner = Examiner.new(source, configuration: configuration)
         set_failure_messages
         matching_smell_types? && matching_smell_details?
       end
 
       private
 
-      attr_reader :configuration, :smell_category, :smell_details
+      attr_reader :configuration, :smell_type, :smell_details
       attr_writer :failure_message, :failure_message_when_negated
       attr_accessor :examiner
 
@@ -41,7 +42,7 @@ module Reek
 
       def matching_smell_types
         @matching_smell_types ||= smell_matchers.
-          select { |it| it.matches_smell_type?(smell_category) }
+          select { |it| it.matches_smell_type?(smell_type) }
       end
 
       def smell_matchers
@@ -57,17 +58,17 @@ module Reek
       end
 
       def set_failure_messages_for_smell_type
-        self.failure_message = "Expected #{origin} to reek of #{smell_category}, "\
+        self.failure_message = "Expected #{origin} to reek of #{smell_type}, "\
           'but it didn\'t'
         self.failure_message_when_negated = "Expected #{origin} not to reek "\
-          "of #{smell_category}, but it did"
+          "of #{smell_type}, but it did"
       end
 
       def set_failure_messages_for_smell_details
-        self.failure_message = "Expected #{origin} to reek of #{smell_category} "\
+        self.failure_message = "Expected #{origin} to reek of #{smell_type} "\
           "(which it did) with smell details #{smell_details}, which it didn't"
         self.failure_message_when_negated = "Expected #{origin} not to reek of "\
-          "#{smell_category} with smell details #{smell_details}, but it did"
+          "#{smell_type} with smell details #{smell_details}, but it did"
       end
 
       def origin
@@ -75,11 +76,13 @@ module Reek
       end
 
       # :reek:UtilityFunction
-      def normalize(smell_category_or_type)
-        # In theory, users can give us many different types of input (see the documentation for
-        # reek_of below), however we're basically ignoring all of those subleties and just
-        # return a string with the prepending namespace stripped.
-        smell_category_or_type.to_s.split(/::/)[-1]
+      def normalize(smell_type_or_class)
+        case smell_type_or_class
+        when Class
+          smell_type_or_class.smell_type
+        else
+          smell_type_or_class.to_s
+        end
       end
     end
   end