reek 4.7.3 → 5.0.0

data/lib/reek/configuration/schema.yml

@@ -0,0 +1,210 @@
+---
+type: map
+mapping:
+  "detectors":
+    type: map
+    mapping: &all_detectors
+      Attribute:
+        type: map
+        mapping: &detector_base
+          "enabled":
+            type: bool
+          "exclude":
+            type: seq
+            sequence:
+              - type: str
+      BooleanParameter:
+        type: map
+        mapping:
+          <<: *detector_base
+      ClassVariable:
+        type: map
+        mapping:
+          <<: *detector_base
+      ControlParameter:
+        type: map
+        mapping:
+          <<: *detector_base
+      DataClump:
+        type: map
+        mapping:
+          <<: *detector_base
+          max_copies:
+            type: number
+          min_clump_size:
+            type: number
+      DuplicateMethodCall:
+        type: map
+        mapping:
+          <<: *detector_base
+          max_calls:
+            type: number
+          allow_calls:
+            type: seq
+            sequence:
+              - type: str
+      FeatureEnvy:
+        type: map
+        mapping:
+          <<: *detector_base
+      InstanceVariableAssumption:
+        type: map
+        mapping:
+          <<: *detector_base
+      IrresponsibleModule:
+        type: map
+        mapping:
+          <<: *detector_base
+      LongParameterList:
+        type: map
+        mapping:
+          <<: *detector_base
+          max_params:
+            type: number
+          overrides:
+            type: map
+            mapping:
+              initialize:
+                type: map
+                mapping:
+                  max_params:
+                    type: number
+      LongYieldList:
+        type: map
+        mapping:
+          <<: *detector_base
+          max_params:
+            type: number
+      ManualDispatch:
+        type: map
+        mapping:
+          <<: *detector_base
+      MissingSafeMethod:
+        type: map
+        mapping:
+          <<: *detector_base
+      ModuleInitialize:
+        type: map
+        mapping:
+          <<: *detector_base
+      NestedIterators:
+        type: map
+        mapping:
+          <<: *detector_base
+          max_allowed_nesting:
+            type: number
+          ignore_iterators:
+            type: seq
+            sequence:
+              - type: str
+      NilCheck:
+        type: map
+        mapping:
+          <<: *detector_base
+      RepeatedConditional:
+        type: map
+        mapping:
+          <<: *detector_base
+          max_ifs:
+            type: number
+      SubclassedFromCoreClass:
+        type: map
+        mapping:
+          <<: *detector_base
+      Syntax:
+        type: map
+        mapping:
+          <<: *detector_base
+      TooManyConstants:
+        type: map
+        mapping:
+          <<: *detector_base
+          max_constants:
+            type: number
+      TooManyInstanceVariables:
+        type: map
+        mapping:
+          <<: *detector_base
+          max_instance_variables:
+            type: number
+      TooManyMethods:
+        type: map
+        mapping:
+          <<: *detector_base
+          max_methods:
+            type: number
+      TooManyStatements:
+        type: map
+        mapping:
+          <<: *detector_base
+          max_statements:
+            type: number
+      UncommunicativeMethodName:
+        type: map
+        mapping:
+          <<: *detector_base
+          reject: &reject_settings
+            type: seq
+            sequence:
+              - type: str
+          accept: &accept_settings
+            type: seq
+            sequence:
+              - type: str
+      UncommunicativeModuleName:
+        type: map
+        mapping:
+          <<: *detector_base
+          reject: *reject_settings
+          accept: *accept_settings
+      UncommunicativeParameterName:
+        type: map
+        mapping:
+          <<: *detector_base
+          reject: *reject_settings
+          accept: *accept_settings
+      UncommunicativeVariableName:
+        type: map
+        mapping:
+          <<: *detector_base
+          reject: *reject_settings
+          accept: *accept_settings
+      UnusedParameters:
+        type: map
+        mapping:
+          <<: *detector_base
+      UnusedPrivateMethod:
+        type: map
+        mapping:
+          <<: *detector_base
+      UtilityFunction:
+        type: map
+        mapping:
+          <<: *detector_base
+          public_methods_only:
+            type: bool
+
+  "directories":
+    type: map
+    mapping:
+      # For any given key that is not matched somewhere else we'll apply the schema below.
+      # So this will just slurp in every directory we throw at it and then validate everything under
+      # it against all detectors - for instance:
+      #
+      #  directories:
+      #    "web_app/app/controllers":
+      #      NestedIterators:
+      #        enabled: false
+      #    "web_app/app/helpers":
+      #      UtilityFunction:
+      #        enabled: false
+      #
+      # For details check out: http://www.kuwata-lab.com/kwalify/ruby/users-guide.02.html#tips-default
+      =:
+        type: map
+        mapping: *all_detectors
+        
+  "exclude_paths":
+    type: seq
+    sequence:
+      - type: str

data/lib/reek/configuration/schema_validator.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require_relative '../cli/silencer'
+Reek::CLI::Silencer.without_warnings { require 'kwalify' }
+require_relative '../errors/config_file_error'
+
+module Reek
+  module Configuration
+    #
+    # Schema validator module.
+    #
+    class SchemaValidator
+      SCHEMA_FILE_PATH = File.expand_path('./schema.yml', __dir__)
+
+      def initialize(configuration)
+        @configuration = configuration
+        @validator = CLI::Silencer.without_warnings do
+          schema_file = Kwalify::Yaml.load_file(SCHEMA_FILE_PATH)
+          Kwalify::Validator.new(schema_file)
+        end
+      end
+
+      def validate
+        errors = CLI::Silencer.without_warnings { @validator.validate @configuration }
+        return if !errors || errors.empty?
+        raise Errors::ConfigFileError, error_message(errors)
+      end
+
+      private
+
+      # :reek:UtilityFunction
+      def error_message(errors)
+        "We found some problems with your configuration file: #{CLI::Silencer.silently { errors.join(', ') }}"
+      end
+    end
+  end
+end

data/lib/reek/context/attribute_context.rb

@@ -7,7 +7,7 @@ module Reek
     #
     # A context wrapper for attribute definitions found in a syntax tree.
     #
-    # :reek:Attribute
+    # @quality :reek:Attribute
     class AttributeContext < CodeContext
       attr_accessor :visibility
 

data/lib/reek/context/code_context.rb

@@ -14,12 +14,11 @@ module Reek
     # code element. CodeContexts form a tree in the same way the code does,
     # with each context holding a reference to a unique outer context.
     #
-    # :reek:TooManyMethods: { max_methods: 19 }
-    # :reek:TooManyInstanceVariables: { max_instance_variables: 8 }
+    # @quality :reek:TooManyMethods { max_methods: 19 }
+    # @quality :reek:TooManyInstanceVariables { max_instance_variables: 8 }
     class CodeContext
       include Enumerable
       extend Forwardable
-      delegate each_node: :exp
       delegate [:name, :type] => :exp
 
       attr_reader :children, :parent, :exp, :statement_counter
@@ -40,12 +39,12 @@ module Reek
       # @yield block that is executed for every node.
       #
       def local_nodes(type, ignored = [], &blk)
-        ignored += [:casgn, :class, :module]
-        each_node(type, ignored, &blk)
+        ignored |= [:class, :module]
+        exp.each_node(type, ignored, &blk)
       end
 
       # Iterate over `self` and child contexts.
-      # The main difference (among others) to `each_node` is that we are traversing
+      # The main difference (among others) to `local_nodes` is that we are traversing
       # `CodeContexts` here, not AST nodes (see `Reek::AST::Node`).
       #
       # @yield block that is executed for every node.
@@ -111,17 +110,15 @@ module Reek
         self
       end
 
-      # :reek:TooManyStatements: { max_statements: 6 }
-      # :reek:FeatureEnvy
+      # @quality :reek:TooManyStatements { max_statements: 6 }
+      # @quality :reek:FeatureEnvy
       def record_call_to(exp)
         receiver = exp.receiver
         type = receiver ? receiver.type : :self
         line = exp.line
         case type
         when :lvar, :lvasgn
-          unless exp.object_creation_call?
-            refs.record_reference(name: receiver.name, line: line)
-          end
+          refs.record_reference(name: receiver.name, line: line) unless exp.object_creation_call?
         when :self
           refs.record_reference(name: :self, line: line)
         end

data/lib/reek/context/method_context.rb

@@ -7,7 +7,7 @@ module Reek
     #
     # A context wrapper for any method definition found in a syntax tree.
     #
-    # :reek:Attribute
+    # @quality :reek:Attribute
     class MethodContext < CodeContext
       attr_accessor :visibility
       attr_reader :refs
@@ -23,24 +23,19 @@ module Reek
       end
 
       def uses_param?(param)
-        # local_nodes(:lvasgn) catches:
+        # :lvasgn catches:
+        #
         #   def foo(bar); bar += 1; end
-        # In this example there is no `lvar` node present.
         #
-        # local_nodes(:lvar) catches:
+        # :lvar catches:
+        #
         #   def foo(bar); other(bar); end
         #   def foo(bar); tmp = other(bar); tmp[0]; end
         #
-        # Note that in the last example the `lvar` node for `bar` is part of an `lvasgn` node for `tmp`.
-        # This means that if we would just search for [:lvar, :lvasgn]
-        # (e.g. via Reek::AST::Node#find_nodes) this would fail for this example since we would
-        # stop at the `lvasgn` and not detect the contained `lvar`.
-        # Hence we first get all `lvar` nodes followed by all `lvasgn` nodes.
-        #
-        (local_nodes(:lvar) + local_nodes(:lvasgn)).find { |node| node.var_name == param.name }
+        local_nodes([:lvar, :lvasgn]).find { |node| node.var_name == param.name }
       end
 
-      # :reek:FeatureEnvy
+      # @quality :reek:FeatureEnvy
       def unused_params
         exp.arguments.reject do |param|
           param.anonymous_splat? ||

data/lib/reek/context/module_context.rb

@@ -43,9 +43,9 @@ module Reek
         AttributeContext
       end
 
-      def defined_instance_methods(visibility: :public)
+      def defined_instance_methods(visibility: :any)
         instance_method_children.select do |context|
-          context.visibility == visibility
+          visibility == :any || context.visibility == visibility
         end
       end
 
@@ -59,7 +59,7 @@ module Reek
       # @deprecated use `defined_instance_methods` instead
       #
       def node_instance_methods
-        local_nodes(:def)
+        local_nodes(:def).to_a
       end
 
       def descriptively_commented?
@@ -73,7 +73,7 @@ module Reek
       #
       # @return true if the module is a namespace module
       #
-      # :reek:FeatureEnvy
+      # @quality :reek:FeatureEnvy
       def namespace_module?
         return false if exp.type == :casgn
         children = exp.direct_children

data/lib/reek/context_builder.rb

@@ -20,9 +20,9 @@ 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: 31 }
-  # :reek:UnusedPrivateMethod: { exclude: [ !ruby/regexp /process_/ ] }
-  # :reek:DataClump
+  # @quality :reek:TooManyMethods { max_methods: 31 }
+  # @quality :reek:UnusedPrivateMethod { exclude: [ !ruby/regexp /process_/ ] }
+  # @quality :reek:DataClump
   class ContextBuilder
     attr_reader :context_tree
 
@@ -206,7 +206,7 @@ module Reek
     #
     #   def self.foo; end
     #
-    def process_self(_, _parent)
+    def process_self(_exp, _parent)
       current_context.record_use_of_self
     end
 
@@ -226,7 +226,7 @@ module Reek
     #
     # We record one reference to `self`.
     #
-    def process_zsuper(_, _parent)
+    def process_zsuper(_exp, _parent)
       current_context.record_use_of_self
     end
 
@@ -470,7 +470,7 @@ module Reek
       self.class.private_method_defined?(name)
     end
 
-    # :reek:ControlParameter
+    # @quality :reek:ControlParameter
     def increase_statement_count_by(sexp)
       current_context.statement_counter.increase_by sexp
     end
@@ -482,8 +482,8 @@ module Reek
     # Stores a reference to the current context, creates a nested new one,
     # yields to the given block and then restores the previous context.
     #
-    # @param klass [Context::*Context] - context class
-    # @param args - arguments for the class initializer
+    # @param klass [Context::*Context] context class
+    # @param args arguments for the class initializer
     # @yield block
     #
     def inside_new_context(klass, *args)
@@ -497,10 +497,10 @@ module Reek
     # Appends a new child context to the current context but does not change
     # the current context.
     #
-    # @param klass [Context::*Context] - context class
-    # @param args - arguments for the class initializer
+    # @param klass [Context::*Context] context class
+    # @param args arguments for the class initializer
     #
-    # @return [Context::*Context] - the context that was appended
+    # @return [Context::*Context] the context that was appended
     #
     def append_new_context(klass, *args)
       klass.new(*args).tap do |new_context|

data/lib/reek/detector_repository.rb

@@ -44,6 +44,12 @@ module Reek
       end
     end
 
+    # @return [Array<String>] The names of all known SmellDetectors
+    #         e.g. ["BooleanParameter", "ClassVariable"].
+    def self.available_detector_names
+      smell_types.map(&:smell_type)
+    end
+
     private
 
     attr_reader :configuration, :smell_types

data/lib/reek/documentation_link.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Reek
+  # Generate versioned links to our documentation
+  module DocumentationLink
+    HELP_LINK_TEMPLATE = 'https://github.com/troessner/reek/blob/v%<version>s/docs/%<item>s.md'
+
+    module_function
+
+    # Build link to the documentation about the given subject for the current
+    # version of Reek. The subject can be either a smell type like
+    # 'FeatureEnvy' or a general subject like 'Rake Task'.
+    #
+    # @param subject [String]
+    # @return [String] the full URL for the relevant documentation
+    def build(subject)
+      Kernel.format(HELP_LINK_TEMPLATE, version: Version::STRING, item: name_to_param(subject))
+    end
+
+    # Convert the given subject name to a form that is acceptable in a URL.
+    def name_to_param(name)
+      # Splits the subject on the start of capitalized words, optionally
+      # preceded by a space. The space is discarded, the start of the word is
+      # not.
+      name.split(/ *(?=[A-Z][a-z])/).join('-')
+    end
+  end
+end

data/lib/reek/errors/bad_detector_configuration_key_in_comment_error.rb

@@ -1,24 +1,25 @@
 # frozen_string_literal: true
 
 require_relative 'base_error'
+require_relative '../documentation_link'
 
 module Reek
   module Errors
     # Gets raised when trying to configure a detector with an option
     # which is unknown to it.
     class BadDetectorConfigurationKeyInCommentError < BaseError
-      UNKNOWN_SMELL_DETECTOR_MESSAGE = <<-MESSAGE.freeze
+      UNKNOWN_SMELL_DETECTOR_MESSAGE = <<-MESSAGE
 
-        Error: You are trying to configure the smell detector '%s'
-        in one of your source code comments with the unknown option %s.
-        The source is '%s' and the comment belongs to the expression starting in line %d.
+        Error: You are trying to configure the smell detector '%<detector>s'
+        in one of your source code comments with the unknown option %<option>s.
+        The source is '%<source>s' and the comment belongs to the expression starting in line %<line>d.
         Here's the original comment:
 
-        %s
+        %<comment>s
 
         Please see the Reek docs for:
-          * how to configure Reek via source code comments: https://github.com/troessner/reek/blob/master/docs/Smell-Suppression.md
-          * what basic options are available: https://github.com/troessner/reek/blob/master/docs/Basic-Smell-Options.md
+          * how to configure Reek via source code comments: #{DocumentationLink.build('Smell Suppression')}
+          * what basic options are available: #{DocumentationLink.build('Basic Smell Options')}
           * what custom options are available by checking the detector specific documentation in /docs
         Update the offensive comment (or remove it if no longer applicable) and re-run Reek.
 
@@ -26,11 +27,11 @@ module Reek
 
       def initialize(detector_name:, offensive_keys:, source:, line:, original_comment:)
         message = format(UNKNOWN_SMELL_DETECTOR_MESSAGE,
-                         detector_name,
-                         offensive_keys,
-                         source,
-                         line,
-                         original_comment)
+                         detector: detector_name,
+                         option: offensive_keys,
+                         source: source,
+                         line: line,
+                         comment: original_comment)
         super message
       end
     end

data/lib/reek/errors/bad_detector_in_comment_error.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'base_error'
+require_relative '../documentation_link'
 
 module Reek
   module Errors
@@ -8,28 +9,28 @@ module Reek
     # This might happen for multiple reasons. The users might have a typo in
     # his comment or he might use a detector that does not exist anymore.
     class BadDetectorInCommentError < BaseError
-      UNKNOWN_SMELL_DETECTOR_MESSAGE = <<-MESSAGE.freeze
+      UNKNOWN_SMELL_DETECTOR_MESSAGE = <<-MESSAGE
 
-        Error: You are trying to configure an unknown smell detector '%s' in one
+        Error: You are trying to configure an unknown smell detector '%<detector>s' in one
         of your source code comments.
-        The source is '%s' and the comment belongs to the expression starting in line %d.
+        The source is '%<source>s' and the comment belongs to the expression starting in line %<line>d.
         Here's the original comment:
 
-        %s
+        %<comment>s
 
         Please see the Reek docs for:
-          * how to configure Reek via source code comments: https://github.com/troessner/reek/blob/master/docs/Smell-Suppression.md
-          * what smell detectors are available: https://github.com/troessner/reek/blob/master/docs/Code-Smells.md
+          * how to configure Reek via source code comments: #{DocumentationLink.build('Smell Suppression')}
+          * what smell detectors are available: #{DocumentationLink.build('Code Smells')}
         Update the offensive comment (or remove it if no longer applicable) and re-run Reek.
 
       MESSAGE
 
       def initialize(detector_name:, source:, line:, original_comment:)
         message = format(UNKNOWN_SMELL_DETECTOR_MESSAGE,
-                         detector_name,
-                         source,
-                         line,
-                         original_comment)
+                         detector: detector_name,
+                         source: source,
+                         line: line,
+                         comment: original_comment)
         super message
       end
     end

data/lib/reek/errors/base_error.rb

@@ -4,6 +4,9 @@ module Reek
   module Errors
     # Base class for all runtime Reek errors
     class BaseError < ::RuntimeError
+      def long_message
+        message
+      end
     end
   end
 end

data/lib/reek/errors/config_file_error.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'base_error'
+
+module Reek
+  module Errors
+    # Gets raised when Reek is unable to process the source due to bad config file
+    class ConfigFileError < BaseError
+    end
+  end
+end

data/lib/reek/errors/encoding_error.rb

@@ -6,9 +6,11 @@ module Reek
   module Errors
     # Gets raised when Reek is unable to process the source due to an EncodingError
     class EncodingError < BaseError
-      ENCODING_ERROR_TEMPLATE = <<-MESSAGE.freeze
+      TEMPLATE = "Source '%<source>s' cannot be processed by Reek due to an encoding error in the source file."
+
+      LONG_TEMPLATE = <<-MESSAGE
         !!!
-        Source '%s' cannot be processed by Reek due to an encoding error in the source file.
+        %<message>s
 
         This is a problem that is outside of Reek's scope and should be fixed by you, the
         user, in order for Reek being able to continue.
@@ -17,21 +19,24 @@ module Reek
 
         Exception message:
 
-        %s
+        %<exception>s
 
-        Original exception:
+        Original backtrace:
 
-        %s
+        %<original>s
 
         !!!
       MESSAGE
 
-      def initialize(origin:, original_exception:)
-        message = format(ENCODING_ERROR_TEMPLATE,
-                         origin,
-                         original_exception.message,
-                         original_exception.backtrace.join("\n\t"))
-        super message
+      def initialize(origin:)
+        super format(TEMPLATE, source: origin)
+      end
+
+      def long_message
+        format(LONG_TEMPLATE,
+               message: message,
+               exception: cause.inspect,
+               original: cause.backtrace.join("\n\t"))
       end
     end
   end