reek 6.0.2 → 6.5.0

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

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/code_context.rb

@@ -38,9 +38,9 @@ module Reek
       # @param type [Symbol] the type of the nodes we are looking for, e.g. :defs.
       # @yield block that is executed for every node.
       #
-      def local_nodes(type, ignored = [], &blk)
+      def local_nodes(type, ignored = [], &)
         ignored |= [:class, :module]
-        exp.each_node(type, ignored, &blk)
+        exp.each_node(type, ignored, &)
       end
 
       # Iterate over `self` and child contexts.
@@ -51,7 +51,7 @@ module Reek
       # @return [Enumerator]
       #
       def each(&block)
-        return enum_for(:each) unless block_given?
+        return enum_for(:each) unless block
 
         yield self
         children.each do |child|

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/module_context.rb

@@ -55,6 +55,10 @@ module Reek
         end
       end
 
+      def instance_method_names_via_to_call
+        instance_method_calls.flat_map(&:method_name_called_to_call).compact
+      end
+
       #
       # @deprecated use `defined_instance_methods` instead
       #

data/lib/reek/context/refinement_context.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative 'module_context'
+
+module Reek
+  module Context
+    #
+    # A context wrapper for any refinement blocks found in a syntax tree.
+    #
+    class RefinementContext < ModuleContext
+      def full_name
+        exp.call.args.first.name
+      end
+    end
+  end
+end

data/lib/reek/context/send_context.rb

@@ -12,7 +12,13 @@ module Reek
 
       def initialize(exp, name)
         @name = name
-        super exp
+        super(exp)
+      end
+
+      def method_name_called_to_call
+        return unless @name == :method
+
+        local_nodes(:sym).map(&:name)
       end
     end
   end

data/lib/reek/context_builder.rb

@@ -5,6 +5,7 @@ require_relative 'context/class_context'
 require_relative 'context/ghost_context'
 require_relative 'context/method_context'
 require_relative 'context/module_context'
+require_relative 'context/refinement_context'
 require_relative 'context/root_context'
 require_relative 'context/send_context'
 require_relative 'context/singleton_attribute_context'
@@ -20,7 +21,7 @@ module Reek
   # counting. Ideally `ContextBuilder` would only build up the context tree and leave the
   # statement and reference counting to the contexts.
   #
-  # @quality :reek:TooManyMethods { max_methods: 31 }
+  # @quality :reek:TooManyMethods { max_methods: 32 }
   # @quality :reek:UnusedPrivateMethod { exclude: [ !ruby/regexp /process_/ ] }
   # @quality :reek:DataClump
   class ContextBuilder
@@ -263,9 +264,16 @@ module Reek
     #
     # Counts non-empty blocks as one statement.
     #
+    # A refinement block is handled differently and causes a RefinementContext
+    # to be opened.
+    #
     def process_block(exp, _parent)
       increase_statement_count_by(exp.block)
-      process(exp)
+      if exp.call.name == :refine
+        handle_refinement_block(exp)
+      else
+        process(exp)
+      end
     end
 
     # Handles `begin` and `kwbegin` nodes. `begin` nodes are created implicitly
@@ -414,7 +422,7 @@ module Reek
     # See `process_rescue` for additional reference.
     #
     def process_resbody(exp, _parent)
-      increase_statement_count_by(exp.children[1..-1].compact)
+      increase_statement_count_by(exp.children[1..].compact)
       process(exp)
     end
 
@@ -508,6 +516,12 @@ module Reek
       end
     end
 
+    def handle_refinement_block(exp)
+      inside_new_context(Context::RefinementContext, exp) do
+        process(exp)
+      end
+    end
+
     def handle_send_for_modules(exp)
       arg_names = exp.args.map { |arg| arg.children.first }
       current_context.track_visibility(exp.name, arg_names)

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/rake/task.rb

@@ -69,15 +69,15 @@ module Reek
 
       # @public
       def initialize(name = :reek)
-        @config_file   = ENV['REEK_CFG']
+        @config_file   = ENV.fetch('REEK_CFG', nil)
         @name          = name
-        @reek_opts     = ENV['REEK_OPTS'] || ''
+        @reek_opts     = ENV.fetch('REEK_OPTS', '')
         @fail_on_error = true
         @verbose       = false
 
         yield self if block_given?
 
-        if (reek_src = ENV['REEK_SRC'])
+        if (reek_src = ENV.fetch('REEK_SRC', nil))
           @source_files = FileList[reek_src]
         end
         @source_files ||= FileList['lib/**/*.rb']
@@ -87,8 +87,8 @@ module Reek
       # @public
       def source_files=(files)
         unless files.is_a?(String) || files.is_a?(FileList)
-          raise ArgumentError, 'File list should be a FileList or a String that can contain'\
-            " a glob pattern, e.g. '{app,lib,spec}/**/*.rb'"
+          raise ArgumentError, 'File list should be a FileList or a String that can contain ' \
+                               "a glob pattern, e.g. '{app,lib,spec}/**/*.rb'"
         end
         @source_files = FileList[files]
       end

data/lib/reek/report/github_report.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require_relative 'base_report'
+
+module Reek
+  module Report
+    #
+    # Displays smells as GitHub Workflow commands.
+    #
+    # @public
+    #
+    class GithubReport < BaseReport
+      def show(out = $stdout)
+        out.print(workflow_commands.join)
+      end
+
+      private
+
+      def workflow_commands
+        smells.map do |smell|
+          WorkflowCommand.new(smell)
+        end
+      end
+
+      # Represents a smell as a GitHub Workflow command.
+      class WorkflowCommand
+        def initialize(smell)
+          @smell = smell
+        end
+
+        def to_s
+          format(
+            "::warning file=%<file>s,line=%<line>d::%<message>s\n",
+            file: file,
+            line: line,
+            message: message)
+        end
+
+        private
+
+        def file
+          @smell.source
+        end
+
+        def line
+          @smell.lines.first
+        end
+
+        def message
+          @smell.base_message.gsub('%', '%25').gsub("\r", '%0D').gsub("\n", '%0A')
+        end
+      end
+    end
+  end
+end

data/lib/reek/report/text_report.rb

@@ -20,7 +20,7 @@ module Reek
       # @public
       def add_examiner(examiner)
         print progress_formatter.progress examiner
-        super(examiner)
+        super
       end
 
       # @public

data/lib/reek/report.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'report/github_report'
 require_relative 'report/html_report'
 require_relative 'report/json_report'
 require_relative 'report/text_report'
@@ -16,11 +17,12 @@ module Reek
   # Reek reporting functionality.
   module Report
     REPORT_CLASSES = {
-      yaml: YAMLReport,
-      json: JSONReport,
-      html: HTMLReport,
-      xml:  XMLReport,
-      text: TextReport
+      yaml:   YAMLReport,
+      json:   JSONReport,
+      html:   HTMLReport,
+      xml:    XMLReport,
+      text:   TextReport,
+      github: GithubReport
     }.freeze
 
     LOCATION_FORMATTERS = {

data/lib/reek/smell_detectors/base_detector.rb

@@ -90,7 +90,7 @@ module Reek
 
       class << self
         def smell_type
-          @smell_type ||= name.split(/::/).last
+          @smell_type ||= name.split('::').last
         end
 
         def contexts

data/lib/reek/smell_detectors/class_variable.rb

@@ -25,8 +25,8 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       def sniff
-        class_variables_in_context.map do |variable, occurences|
-          lines = occurences.map(&:line)
+        class_variables_in_context.map do |variable, occurrences|
+          lines = occurrences.map(&:line)
           smell_warning(
             lines: lines,
             message: "declares the class variable '#{variable}'",

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

@@ -9,20 +9,20 @@ module Reek
       class Candidate
         #
         # @param parameter [Symbol] the parameter name
-        # @param occurences [Array<Reek::AST::Node>] the occurences of the ControlParameter smell
+        # @param occurrences [Array<Reek::AST::Node>] the occurrences of the ControlParameter smell
         #   e.g. [s(:lvar, :bravo), s(:lvar, :bravo)]
         #
-        def initialize(parameter, occurences)
+        def initialize(parameter, occurrences)
           @parameter = parameter
-          @occurences = occurences
+          @occurrences = occurrences
         end
 
         def smells?
-          occurences.any?
+          occurrences.any?
         end
 
         def lines
-          occurences.map(&:line)
+          occurrences.map(&:line)
         end
 
         def name
@@ -31,7 +31,7 @@ module Reek
 
         private
 
-        attr_reader :occurences, :parameter
+        attr_reader :occurrences, :parameter
       end
     end
   end