reek 6.1.3 → 6.2.0

data/lib/reek/{report/code_climate → code_climate}/code_climate_configuration.yml

@@ -10,7 +10,7 @@ Attribute:
 
     Given:
 
-    ```Ruby
+    ```ruby
     class Klass
       attr_accessor :dummy
     end
@@ -33,7 +33,7 @@ BooleanParameter:
 
     Given
 
-    ```Ruby
+    ```ruby
     class Dummy
       def hit_the_switch(switch = true)
         if switch
@@ -76,7 +76,7 @@ ClassVariable:
 
     Given
 
-    ```Ruby
+    ```ruby
     class Dummy
       @@class_variable = :whatever
     end
@@ -95,7 +95,7 @@ ClassVariable:
 
     You can use class-instance variable to mitigate the problem (as also suggested in the linked article above):
 
-    ```Ruby
+    ```ruby
     class Dummy
       @class_variable = :whatever
     end
@@ -109,7 +109,7 @@ ControlParameter:
 
     A simple example would be the "quoted" parameter in the following method:
 
-    ```Ruby
+    ```ruby
     def write(quoted)
       if quoted
         write_quoted @value
@@ -131,7 +131,7 @@ DataClump:
 
     Given
 
-    ```Ruby
+    ```ruby
     class Dummy
       def x(y1,y2); end
       def y(y1,y2); end
@@ -160,7 +160,7 @@ DuplicateMethodCall:
 
     Here's a very much simplified and contrived example. The following method will report a warning:
 
-    ```Ruby
+    ```ruby
     def double_thing()
       @other.thing + @other.thing
     end
@@ -168,7 +168,7 @@ DuplicateMethodCall:
 
     One quick approach to silence Reek would be to refactor the code thus:
 
-    ```Ruby
+    ```ruby
     def double_thing()
       thing = @other.thing
       thing + thing
@@ -177,7 +177,7 @@ DuplicateMethodCall:
 
     A slightly different approach would be to replace all calls of `double_thing` by calls to `@other.double_thing`:
 
-    ```Ruby
+    ```ruby
     class Other
       def double_thing()
         thing + thing
@@ -201,7 +201,7 @@ FeatureEnvy:
 
     Running Reek on:
 
-    ```Ruby
+    ```ruby
     class Warehouse
       def sale_price(item)
         (item.price - item.rebate) * @vat
@@ -211,13 +211,13 @@ FeatureEnvy:
 
     would report:
 
-    ```Bash
+    ```bash
     Warehouse#total_price refers to item more than self (FeatureEnvy)
     ```
 
     since this:
 
-    ```Ruby
+    ```ruby
     (item.price - item.rebate)
     ```
 
@@ -229,7 +229,7 @@ InstanceVariableAssumption:
 
     Good:
 
-    ```Ruby
+    ```ruby
     class Foo
       def initialize
         @bar = :foo
@@ -243,7 +243,7 @@ InstanceVariableAssumption:
 
     Good as well:
 
-    ```Ruby
+    ```ruby
     class Foo
       def foo?
         bar == :foo
@@ -257,7 +257,7 @@ InstanceVariableAssumption:
 
     Bad:
 
-    ```Ruby
+    ```ruby
     class Foo
       def go_foo!
         @bar = :foo
@@ -273,7 +273,7 @@ InstanceVariableAssumption:
 
     Running Reek on:
 
-    ```Ruby
+    ```ruby
     class Dummy
       def test
         @ivar
@@ -283,13 +283,13 @@ InstanceVariableAssumption:
 
     would report:
 
-    ```Bash
+    ```bash
       [1]:InstanceVariableAssumption: Dummy assumes too much for instance variable @ivar
     ```
 
     Note that this example would trigger this smell warning as well:
 
-    ```Ruby
+    ```ruby
     class Parent
       def initialize(omg)
         @omg = omg
@@ -305,7 +305,7 @@ InstanceVariableAssumption:
 
     The way to address the smell warning is that you should create an `attr_reader` to use `@omg` in the subclass and not access `@omg` directly like this:
 
-    ```Ruby
+    ```ruby
     class Parent
       attr_reader :omg
 
@@ -325,7 +325,7 @@ InstanceVariableAssumption:
 
     If you don't want to expose those methods as public API just make them private like this:
 
-    ```Ruby
+    ```ruby
     class Parent
       def initialize(omg)
         @omg = omg
@@ -360,7 +360,7 @@ IrresponsibleModule:
 
     Given
 
-    ```Ruby
+    ```ruby
     class Dummy
       # Do things...
     end
@@ -375,7 +375,7 @@ IrresponsibleModule:
 
     Fixing this is simple - just an explaining comment:
 
-    ```Ruby
+    ```ruby
     # The Dummy class is responsible for ...
     class Dummy
       # Do things...
@@ -390,7 +390,7 @@ LongParameterList:
 
     Given
 
-    ```Ruby
+    ```ruby
     class Dummy
       def long_list(foo,bar,baz,fling,flung)
         puts foo,bar,baz,fling,flung
@@ -413,7 +413,7 @@ LongYieldList:
 
     ## Example
 
-    ```Ruby
+    ```ruby
     class Dummy
       def yields_a_lot(foo,bar,baz,fling,flung)
         yield foo,bar,baz,fling,flung
@@ -436,7 +436,7 @@ ManualDispatch:
 
     ## Example
 
-    ```Ruby
+    ```ruby
     class MyManualDispatcher
       attr_reader :foo
 
@@ -467,7 +467,7 @@ ModuleInitialize:
 
     The `Foo` module below contains a method `initialize`. Although class `B` inherits from `A`, the inclusion of `Foo` stops `A#initialize` from being called.
 
-    ```Ruby
+    ```ruby
     class A
       def initialize(a)
         @a = a
@@ -492,7 +492,7 @@ ModuleInitialize:
 
     A simple solution is to rename `Foo#initialize` and call that method by name:
 
-    ```Ruby
+    ```ruby
     module Foo
       def setup_foo_module(foo)
         @foo = foo
@@ -518,7 +518,7 @@ NestedIterators:
 
     Given
 
-    ```Ruby
+    ```ruby
     class Duck
       class << self
         def duck_names
@@ -549,7 +549,7 @@ NilCheck:
 
     Given
 
-    ```Ruby
+    ```ruby
     class Klass
       def nil_checker(argument)
         if argument.nil?
@@ -582,7 +582,7 @@ MissingSafeMethod:
 
     Given
 
-    ```Ruby
+    ```ruby
     class C
       def foo; end
       def foo!; end
@@ -595,7 +595,7 @@ MissingSafeMethod:
     Reek reports this smell only in a class context, not in a module context in order to allow perfectly legit code like this:
 
 
-    ```Ruby
+    ```ruby
     class Parent
       def foo; end
     end
@@ -622,7 +622,7 @@ RepeatedConditional:
 
     Given
 
-    ```Ruby
+    ```ruby
     class RepeatedConditionals
       attr_accessor :switch
 
@@ -664,7 +664,7 @@ TooManyInstanceVariables:
 
     and this code:
 
-    ```Ruby
+    ```ruby
     class TooManyInstanceVariables
       def initialize
         @arg_1 = :dummy
@@ -697,7 +697,7 @@ TooManyConstants:
 
     and this code:
 
-    ```Ruby
+    ```ruby
     class TooManyConstants
       CONST_1 = :dummy
       CONST_2 = :dummy
@@ -728,7 +728,7 @@ TooManyMethods:
 
     and this code:
 
-    ```Ruby
+    ```ruby
     class TooManyMethods
       def one; end
       def two; end
@@ -752,7 +752,7 @@ TooManyStatements:
 
     So the following method would score +6 in Reek's statement-counting algorithm:
 
-    ```Ruby
+    ```ruby
     def parse(arg, argv, &error)
       if !(val = arg) and (argv.empty? or /\A-/ =~ (val = argv[0]))
         return nil, block, nil                                         # +1
@@ -804,7 +804,7 @@ UnusedParameters:
 
     Given:
 
-    ```Ruby
+    ```ruby
     class Klass
       def unused_parameters(x,y,z)
         puts x,y # but not z
@@ -830,7 +830,7 @@ UnusedPrivateMethod:
 
     Given:
 
-    ```Ruby
+    ```ruby
     class Car
       private
       def drive; end

data/lib/reek/{report/code_climate → code_climate}/code_climate_fingerprint.rb

@@ -3,7 +3,7 @@
 require 'digest'
 
 module Reek
-  module Report
+  module CodeClimate
     # Generates a string to uniquely identify a smell
     class CodeClimateFingerprint
       NON_IDENTIFYING_PARAMETERS = [:count, :depth].freeze
@@ -36,7 +36,7 @@ module Reek
       end
 
       def parameters
-        warning.parameters.reject { |key, _| NON_IDENTIFYING_PARAMETERS.include?(key) }.sort.to_s
+        warning.parameters.except(*NON_IDENTIFYING_PARAMETERS).sort.to_s
       end
 
       def warning_uniquely_identifiable?

data/lib/reek/{report/code_climate → code_climate}/code_climate_formatter.rb

@@ -4,7 +4,7 @@ require 'codeclimate_engine'
 require_relative 'code_climate_configuration'
 
 module Reek
-  module Report
+  module CodeClimate
     # Generates a hash in the structure specified by the Code Climate engine spec
     class CodeClimateFormatter
       def initialize(warning)

data/lib/reek/{report/code_climate → code_climate}/code_climate_report.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
-require_relative '../base_report'
+require_relative '../report/base_report'
 require_relative 'code_climate_formatter'
 
 module Reek
-  module Report
+  module CodeClimate
     #
     # Displays a list of smells in Code Climate engine format
     # (https://github.com/codeclimate/spec/blob/master/SPEC.md)
     # JSON with empty array for 0 smells
     #
-    class CodeClimateReport < BaseReport
+    class CodeClimateReport < Report::BaseReport
       def show(out = $stdout)
         smells.map do |smell|
           out.print CodeClimateFormatter.new(smell).render

data/lib/reek/code_comment.rb

@@ -19,8 +19,8 @@ module Reek
                           (\w+)      # smell detector e.g.: UncommunicativeVariableName
                           (:?\s*)    # separator
                           (\{.*?\})? # details in hash style e.g.: { max_methods: 30 }
-                         /x.freeze
-    SANITIZE_REGEX                 = /(#|\n|\s)+/.freeze # Matches '#', newlines and > 1 whitespaces.
+                         /x
+    SANITIZE_REGEX                 = /(#|\n|\s)+/ # Matches '#', newlines and > 1 whitespaces.
     DISABLE_DETECTOR_CONFIGURATION = '{ enabled: false }'
     MINIMUM_CONTENT_LENGTH         = 2
 
@@ -170,7 +170,7 @@ module Reek
 
       # @return [Set] the configuration keys that are found in the code comment
       def given_configuration_keys
-        parsed_options.keys.map(&:to_sym).to_set
+        parsed_options.keys.to_set(&:to_sym)
       end
 
       # @return [String] all keys from the code comment that look bad

data/lib/reek/configuration/app_configuration.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 require 'pathname'
-require_relative './configuration_file_finder'
-require_relative './configuration_validator'
-require_relative './default_directive'
-require_relative './directory_directives'
-require_relative './excluded_paths'
+require_relative 'configuration_file_finder'
+require_relative 'configuration_validator'
+require_relative 'default_directive'
+require_relative 'directory_directives'
+require_relative 'excluded_paths'
 
 module Reek
   module Configuration

data/lib/reek/configuration/configuration_converter.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative './configuration_validator'
+require_relative 'configuration_validator'
 
 module Reek
   module Configuration

data/lib/reek/configuration/configuration_file_finder.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 require 'pathname'
-require_relative './configuration_converter'
-require_relative './schema_validator'
+require_relative 'configuration_converter'
+require_relative 'schema_validator'
 require_relative '../errors/config_file_error'
 
 module Reek
@@ -58,11 +58,11 @@ module Reek
 
           begin
             configuration = YAML.load_file(path) || {}
+            SchemaValidator.new(configuration).validate
           rescue StandardError => error
             raise Errors::ConfigFileError, "Invalid configuration file #{path}, error is #{error}"
           end
 
-          SchemaValidator.new(configuration).validate
           ConfigurationConverter.new(configuration).convert
         end
 

data/lib/reek/configuration/default_directive.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative './configuration_validator'
+require_relative 'configuration_validator'
 
 module Reek
   module Configuration

data/lib/reek/configuration/directory_directives.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative './configuration_validator'
+require_relative 'configuration_validator'
 
 module Reek
   module Configuration

data/lib/reek/configuration/excluded_paths.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative './configuration_validator'
+require_relative 'configuration_validator'
 require_relative '../errors/config_file_error'
 
 module Reek

data/lib/reek/configuration/schema.rb

@@ -0,0 +1,177 @@
+# frozen_string_literal: true
+
+require 'dry/schema'
+
+module Reek
+  module Configuration
+    #
+    # Configuration schema constants.
+    #
+    class Schema
+      # Enable the :info extension so we can introspect
+      # your keys and types
+      Dry::Schema.load_extensions(:info)
+
+      # rubocop:disable Metrics/BlockLength
+      ALL_DETECTORS_SCHEMA = Dry::Schema.Params do
+        optional(:Attribute).filled(:hash) do
+          optional(:enabled).filled(:bool)
+          optional(:exclude).array(:string)
+        end
+        optional(:BooleanParameter).filled(:hash) do
+          optional(:enabled).filled(:bool)
+          optional(:exclude).array(:string)
+        end
+        optional(:ClassVariable).filled(:hash) do
+          optional(:enabled).filled(:bool)
+          optional(:exclude).array(:string)
+        end
+        optional(:ControlParameter).filled(:hash) do
+          optional(:enabled).filled(:bool)
+          optional(:exclude).array(:string)
+        end
+        optional(:DataClump).filled(:hash) do
+          optional(:enabled).filled(:bool)
+          optional(:exclude).array(:string)
+          optional(:max_copies).filled(:integer)
+          optional(:min_clump_size).filled(:integer)
+        end
+        optional(:DuplicateMethodCall).filled(:hash) do
+          optional(:enabled).filled(:bool)
+          optional(:exclude).array(:string)
+          optional(:max_calls).filled(:integer)
+          optional(:allow_calls).array(:string)
+        end
+        optional(:FeatureEnvy).filled(:hash) do
+          optional(:enabled).filled(:bool)
+          optional(:exclude).array(:string)
+        end
+        optional(:InstanceVariableAssumption).filled(:hash) do
+          optional(:enabled).filled(:bool)
+          optional(:exclude).array(:string)
+        end
+        optional(:IrresponsibleModule).filled(:hash) do
+          optional(:enabled).filled(:bool)
+          optional(:exclude).array(:string)
+        end
+        optional(:LongParameterList).filled(:hash) do
+          optional(:enabled).filled(:bool)
+          optional(:exclude).array(:string)
+          optional(:max_params).filled(:integer)
+          optional(:overrides).filled(:hash) do
+            required(:initialize).filled(:hash) do
+              required(:max_params).filled(:integer)
+            end
+          end
+        end
+        optional(:LongYieldList).filled(:hash) do
+          optional(:enabled).filled(:bool)
+          optional(:exclude).array(:string)
+          optional(:max_params).filled(:integer)
+        end
+        optional(:ManualDispatch).filled(:hash) do
+          optional(:enabled).filled(:bool)
+          optional(:exclude).array(:string)
+        end
+        optional(:MissingSafeMethod).filled(:hash) do
+          optional(:enabled).filled(:bool)
+          optional(:exclude).array(:string)
+        end
+        optional(:ModuleInitialize).filled(:hash) do
+          optional(:enabled).filled(:bool)
+          optional(:exclude).array(:string)
+        end
+        optional(:NestedIterators).filled(:hash) do
+          optional(:enabled).filled(:bool)
+          optional(:exclude).array(:string)
+          optional(:max_allowed_nesting).filled(:integer)
+          optional(:ignore_iterators) { array(:string) & filled? }
+        end
+        optional(:NilCheck).filled(:hash) do
+          optional(:enabled).filled(:bool)
+          optional(:exclude).array(:string)
+        end
+        optional(:RepeatedConditional).filled(:hash) do
+          optional(:enabled).filled(:bool)
+          optional(:exclude).array(:string)
+          optional(:max_ifs).filled(:integer)
+        end
+        optional(:SubclassedFromCoreClass).filled(:hash) do
+          optional(:enabled).filled(:bool)
+          optional(:exclude).array(:string)
+        end
+        optional(:TooManyConstants).filled(:hash) do
+          optional(:enabled).filled(:bool)
+          optional(:exclude).array(:string)
+          optional(:max_constants).filled(:integer)
+        end
+        optional(:TooManyInstanceVariables).filled(:hash) do
+          optional(:enabled).filled(:bool)
+          optional(:exclude).array(:string)
+          optional(:max_instance_variables).filled(:integer)
+        end
+        optional(:TooManyMethods).filled(:hash) do
+          optional(:enabled).filled(:bool)
+          optional(:exclude).array(:string)
+          optional(:max_methods).filled(:integer)
+        end
+        optional(:TooManyStatements).filled(:hash) do
+          optional(:enabled).filled(:bool)
+          optional(:exclude).array(:string)
+          optional(:max_statements).filled(:integer)
+        end
+        optional(:UncommunicativeMethodName).filled(:hash) do
+          optional(:enabled).filled(:bool)
+          optional(:exclude).array(:string)
+          optional(:reject).array(:string)
+          optional(:accept).array(:string)
+        end
+        optional(:UncommunicativeModuleName).filled(:hash) do
+          optional(:enabled).filled(:bool)
+          optional(:exclude).array(:string)
+          optional(:reject).array(:string)
+          optional(:accept).array(:string)
+        end
+        optional(:UncommunicativeParameterName).filled(:hash) do
+          optional(:enabled).filled(:bool)
+          optional(:exclude).array(:string)
+          optional(:reject).array(:string)
+          optional(:accept).array(:string)
+        end
+        optional(:UncommunicativeVariableName).filled(:hash) do
+          optional(:enabled).filled(:bool)
+          optional(:exclude).array(:string)
+          optional(:reject).array(:string)
+          optional(:accept).array(:string)
+        end
+        optional(:UnusedParameters).filled(:hash) do
+          optional(:enabled).filled(:bool)
+          optional(:exclude).array(:string)
+        end
+        optional(:UnusedPrivateMethod).filled(:hash) do
+          optional(:enabled).filled(:bool)
+          optional(:exclude).array(:string)
+        end
+        optional(:UtilityFunction).filled(:hash) do
+          optional(:enabled).filled(:bool)
+          optional(:exclude).array(:string)
+          optional(:public_methods_only).filled(:bool)
+        end
+      end
+      # rubocop:enable Metrics/BlockLength
+
+      # @quality :reek:TooManyStatements { max_statements: 7 }
+      def self.schema(directories = [])
+        Dry::Schema.Params do
+          config.validate_keys = true
+
+          optional(:detectors).filled(ALL_DETECTORS_SCHEMA)
+          optional(:directories).filled(:hash) do
+            directories.each { |dir| optional(dir.to_sym).filled(ALL_DETECTORS_SCHEMA) }
+          end
+          optional(:exclude_paths).array(:string)
+        end
+      end
+    end
+  end
+end