reek 4.8.2 → 5.0.0

data/lib/reek/configuration/excluded_paths.rb

@@ -10,7 +10,7 @@ module Reek
     module ExcludedPaths
       include ConfigurationValidator
 
-      # :reek:NestedIterators: { max_allowed_nesting: 2 }
+      # @quality :reek:NestedIterators { max_allowed_nesting: 2 }
       def add(paths)
         paths.each do |path|
           with_valid_directory(path) { |directory| self << directory }

data/lib/reek/configuration/rake_task_converter.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Reek
+  module Configuration
+    # Responsible for converting configuration values coming from the outside world
+    # to whatever we want to use internally.
+    module RakeTaskConverter
+      class << self
+        REGEXABLE_ATTRIBUTES = %w(accept reject exclude).freeze
+
+        # Converts marked strings like "/foobar/" into regexes.
+        #
+        # @param configuration [Hash] e.g.
+        #   {"enabled"=>true, "exclude"=>[], "reject"=>[/^[a-z]$/, /[0-9]$/, /[A-Z]/], "accept"=>[]}
+        # @return [Hash]
+        #
+        # @quality :reek:NestedIterators { max_allowed_nesting: 2 }
+        def convert(configuration)
+          (configuration.keys & REGEXABLE_ATTRIBUTES).each do |attribute|
+            configuration[attribute] = configuration[attribute].map do |item|
+              item.is_a?(Regexp) ? item.inspect : item
+            end
+          end
+          configuration
+        end
+      end
+    end
+  end
+end

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,8 +14,8 @@ 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
@@ -110,8 +110,8 @@ 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

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

@@ -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
 
@@ -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

@@ -3,7 +3,7 @@
 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'.freeze
+    HELP_LINK_TEMPLATE = 'https://github.com/troessner/reek/blob/v%<version>s/docs/%<item>s.md'
 
     module_function
 
@@ -12,7 +12,7 @@ module Reek
     # 'FeatureEnvy' or a general subject like 'Rake Task'.
     #
     # @param subject [String]
-    # @return [String] - the full URL for the relevant documentation
+    # @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

data/lib/reek/errors/bad_detector_configuration_key_in_comment_error.rb

@@ -8,7 +8,7 @@ module Reek
     # 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 '%<detector>s'
         in one of your source code comments with the unknown option %<option>s.

data/lib/reek/errors/bad_detector_in_comment_error.rb

@@ -9,7 +9,7 @@ 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 '%<detector>s' in one
         of your source code comments.