reek 6.1.4 → 6.2.0

data/lib/reek/configuration/schema_validator.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
-require 'yaml'
-require_relative '../cli/silencer'
-Reek::CLI::Silencer.without_warnings { require 'kwalify' }
 require_relative '../errors/config_file_error'
+require_relative 'schema'
 
 module Reek
   module Configuration
@@ -11,28 +9,29 @@ module Reek
     # 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
+        config_directories = configuration['directories']&.keys || []
+        @validator = Reek::Configuration::Schema.schema(config_directories)
       end
 
       def validate
-        errors = CLI::Silencer.without_warnings { @validator.validate @configuration }
-        return if !errors || errors.empty?
+        result = @validator.call(@configuration)
+        return if result.success?
 
-        raise Errors::ConfigFileError, error_message(errors)
+        raise Errors::ConfigFileError, error_message(result.errors)
+      rescue NoMethodError
+        raise Errors::ConfigFileError, 'unrecognized configuration data'
       end
 
       private
 
       # :reek:UtilityFunction
       def error_message(errors)
-        "We found some problems with your configuration file: #{CLI::Silencer.silently { errors.join(', ') }}"
+        messages = errors.map do |error|
+          "[/#{error.path.join('/')}] #{error.text}."
+        end.join("\n")
+        "\n#{messages}"
       end
     end
   end

data/lib/reek/context/attribute_context.rb

@@ -14,7 +14,7 @@ module Reek
       def initialize(exp, send_expression)
         @visibility = :public
         @send_expression = send_expression
-        super exp
+        super(exp)
       end
 
       def full_comment

data/lib/reek/context/method_context.rb

@@ -15,7 +15,7 @@ module Reek
       def initialize(exp, parent_exp)
         @parent_exp = parent_exp
         @visibility = :public
-        super exp
+        super(exp)
       end
 
       def references_self?

data/lib/reek/context/send_context.rb

@@ -12,7 +12,7 @@ module Reek
 
       def initialize(exp, name)
         @name = name
-        super exp
+        super(exp)
       end
 
       def method_name_called_to_call

data/lib/reek/documentation_link.rb

@@ -17,12 +17,10 @@ module Reek
       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.
+    # Convert the given subject name to a form that is acceptable in a URL, by
+    # dasherizeing it at the start of capitalized words. Spaces are discared.
     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('-')
+      name.split(/([A-Z][a-z][a-z]*)/).map(&:strip).reject(&:empty?).join('-')
     end
   end
 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
+      UNKNOWN_SMELL_DETECTOR_MESSAGE = <<-MESSAGE.freeze
 
         Error: You are trying to configure the smell detector '%<detector>s'
         in one of your source code comments with the unknown option %<option>s.
@@ -32,7 +32,7 @@ module Reek
                          source: source,
                          line: line,
                          comment: original_comment)
-        super message
+        super(message)
       end
     end
   end

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
+      UNKNOWN_SMELL_DETECTOR_MESSAGE = <<-MESSAGE.freeze
 
         Error: You are trying to configure an unknown smell detector '%<detector>s' in one
         of your source code comments.
@@ -31,7 +31,7 @@ module Reek
                          source: source,
                          line: line,
                          comment: original_comment)
-        super message
+        super(message)
       end
     end
   end

data/lib/reek/errors/encoding_error.rb

@@ -29,7 +29,7 @@ module Reek
       MESSAGE
 
       def initialize(origin:)
-        super format(TEMPLATE, source: origin)
+        super(format(TEMPLATE, source: origin))
       end
 
       def long_message

data/lib/reek/errors/garbage_detector_configuration_in_comment_error.rb

@@ -8,7 +8,7 @@ module Reek
     # Gets raised when trying to use a configuration for a detector
     # that can't be parsed into a hash.
     class GarbageDetectorConfigurationInCommentError < BaseError
-      BAD_DETECTOR_CONFIGURATION_MESSAGE = <<-MESSAGE
+      BAD_DETECTOR_CONFIGURATION_MESSAGE = <<-MESSAGE.freeze
 
         Error: You are trying to configure the smell detector '%<detector>s'.
         Unfortunately we cannot parse the configuration you have given.
@@ -30,7 +30,7 @@ module Reek
                          source: source,
                          line: line,
                          comment: original_comment)
-        super message
+        super(message)
       end
     end
   end

data/lib/reek/errors/incomprehensible_source_error.rb

@@ -32,7 +32,7 @@ module Reek
       MESSAGE
 
       def initialize(origin:)
-        super format(TEMPLATE, source: origin)
+        super(format(TEMPLATE, source: origin))
       end
 
       def long_message

data/lib/reek/errors/legacy_comment_separator_error.rb

@@ -6,7 +6,7 @@ module Reek
   module Errors
     # Gets raised for old-style comment configuration format.
     class LegacyCommentSeparatorError < BaseError
-      MESSAGE = <<-MESSAGE
+      MESSAGE = <<-MESSAGE.freeze
         Error: You are using the legacy configuration format (including three
         colons) to configure Reek in one your source code comments.
 
@@ -29,7 +29,7 @@ module Reek
                          source: source,
                          line: line,
                          comment: original_comment)
-        super message
+        super(message)
       end
     end
   end

data/lib/reek/errors/syntax_error.rb

@@ -31,7 +31,7 @@ module Reek
       MESSAGE
 
       def initialize(origin:)
-        super format(TEMPLATE, source: origin)
+        super(format(TEMPLATE, source: origin))
       end
 
       def long_message

data/lib/reek/smell_detectors/control_parameter_helpers/control_parameter_finder.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative './call_in_condition_finder'
+require_relative 'call_in_condition_finder'
 require_relative '../../ast/node'
 
 module Reek

data/lib/reek/smell_detectors/instance_variable_assumption.rb

@@ -20,7 +20,7 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       def sniff
-        assumptions = (variables_from_context - variables_from_initialize).uniq
+        assumptions = (variables_from_context - variables_from_initializers).uniq
 
         assumptions.map do |assumption|
           build_smell_warning(assumption)
@@ -42,14 +42,14 @@ module Reek
           parameters: { assumption: assumption.to_s })
       end
 
-      def variables_from_initialize
-        initialize_exp = method_expressions.detect do |method|
-          method.name == :initialize
-        end
-
-        return [] unless initialize_exp
+      def variables_from_initializers
+        variables_from_initialize.map do |method|
+          method.each_node(:ivasgn).map(&:name)
+        end.flatten
+      end
 
-        initialize_exp.each_node(:ivasgn).map(&:name)
+      def variables_from_initialize
+        method_expressions.select { |method| method.name == :initialize }
       end
 
       def variables_from_context

data/lib/reek/smell_detectors/nested_iterators.rb

@@ -26,7 +26,7 @@ module Reek
       # The name of the config field that sets the names of any
       # methods for which nesting should not be considered
       IGNORE_ITERATORS_KEY = 'ignore_iterators'
-      DEFAULT_IGNORE_ITERATORS = ['tap'].freeze
+      DEFAULT_IGNORE_ITERATORS = ['tap', 'Tempfile.create'].freeze
 
       def self.default_config
         super.merge(
@@ -128,8 +128,9 @@ module Reek
 
       # @quality :reek:FeatureEnvy
       def ignored_iterator?(exp)
-        ignore_iterators.any? { |pattern| /#{pattern}/ =~ exp.call.name } ||
-          exp.without_block_arguments?
+        ignore_iterators.any? do |pattern|
+          /#{pattern}/ =~ exp.call.format_to_ruby
+        end || exp.without_block_arguments?
       end
     end
   end

data/lib/reek/smell_detectors/unused_private_method.rb

@@ -50,9 +50,9 @@ module Reek
       # @return [Array<Hit>]
       #
       def hits
-        unused_private_methods.map do |defined_method|
+        unused_private_methods.filter_map do |defined_method|
           Hit.new(defined_method) unless ignore_method?(defined_method)
-        end.compact
+        end
       end
 
       #

data/lib/reek/version.rb

@@ -8,6 +8,6 @@ module Reek
   # @public
   module Version
     # @public
-    STRING = '6.1.4'
+    STRING = '6.2.0'
   end
 end

data/reek.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.executables = spec.files.grep(%r{^bin/}).map { |path| File.basename(path) }
   spec.rdoc_options = %w(--main README.md -x assets/|bin/|config/|features/|spec/|tasks/)
-  spec.required_ruby_version = '>= 2.6.0'
+  spec.required_ruby_version = '>= 3.0.0'
 
   spec.metadata = {
     'homepage_uri'          => 'https://github.com/troessner/reek',
@@ -31,7 +31,8 @@ Gem::Specification.new do |spec|
     'rubygems_mfa_required' => 'true'
   }
 
-  spec.add_runtime_dependency 'kwalify', '~> 0.7.0'
+  spec.add_runtime_dependency 'dry-schema', '~> 1.13.0'
   spec.add_runtime_dependency 'parser',  '~> 3.2.0'
   spec.add_runtime_dependency 'rainbow', '>= 2.0', '< 4.0'
+  spec.add_runtime_dependency 'rexml',   '~> 3.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 6.1.4
+  version: 6.2.0
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -11,22 +11,22 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-14 00:00:00.000000000 Z
+date: 2023-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: kwalify
+  name: dry-schema
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 1.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 1.13.0
 - !ruby/object:Gem::Dependency
   name: parser
   requirement: !ruby/object:Gem::Requirement
@@ -61,6 +61,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
 description: Reek is a tool that examines Ruby classes, modules and methods and reports
   any code smells it finds.
 email:
@@ -124,6 +138,12 @@ files:
 - lib/reek/cli/options.rb
 - lib/reek/cli/silencer.rb
 - lib/reek/cli/status.rb
+- lib/reek/code_climate.rb
+- lib/reek/code_climate/code_climate_configuration.rb
+- lib/reek/code_climate/code_climate_configuration.yml
+- lib/reek/code_climate/code_climate_fingerprint.rb
+- lib/reek/code_climate/code_climate_formatter.rb
+- lib/reek/code_climate/code_climate_report.rb
 - lib/reek/code_comment.rb
 - lib/reek/configuration/app_configuration.rb
 - lib/reek/configuration/configuration_converter.rb
@@ -133,7 +153,7 @@ files:
 - lib/reek/configuration/directory_directives.rb
 - lib/reek/configuration/excluded_paths.rb
 - lib/reek/configuration/rake_task_converter.rb
-- lib/reek/configuration/schema.yml
+- lib/reek/configuration/schema.rb
 - lib/reek/configuration/schema_validator.rb
 - lib/reek/context/attribute_context.rb
 - lib/reek/context/class_context.rb
@@ -165,12 +185,6 @@ files:
 - lib/reek/rake/task.rb
 - lib/reek/report.rb
 - lib/reek/report/base_report.rb
-- lib/reek/report/code_climate.rb
-- lib/reek/report/code_climate/code_climate_configuration.rb
-- lib/reek/report/code_climate/code_climate_configuration.yml
-- lib/reek/report/code_climate/code_climate_fingerprint.rb
-- lib/reek/report/code_climate/code_climate_formatter.rb
-- lib/reek/report/code_climate/code_climate_report.rb
 - lib/reek/report/documentation_link_warning_formatter.rb
 - lib/reek/report/heading_formatter.rb
 - lib/reek/report/html_report.rb
@@ -256,14 +270,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Code smell detector for Ruby

data/lib/reek/configuration/schema.yml

@@ -1,210 +0,0 @@
----
-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