reek 4.7.3 → 5.0.0

data/lib/reek/errors/garbage_detector_configuration_in_comment_error.rb

@@ -1,34 +1,35 @@
 # frozen_string_literal: true
 
 require_relative 'base_error'
+require_relative '../documentation_link'
 
 module Reek
   module Errors
     # 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.freeze
+      BAD_DETECTOR_CONFIGURATION_MESSAGE = <<-MESSAGE
 
-        Error: You are trying to configure the smell detector '%s'.
+        Error: You are trying to configure the smell detector '%<detector>s'.
         Unfortunately we cannot parse the configuration you have given.
-        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(BAD_DETECTOR_CONFIGURATION_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/incomprehensible_source_error.rb

@@ -6,42 +6,40 @@ module Reek
   module Errors
     # Gets raised when Reek is unable to process the source
     class IncomprehensibleSourceError < BaseError
-      INCOMPREHENSIBLE_SOURCE_TEMPLATE = <<-MESSAGE.freeze
-        !!!
-        Source %s cannot be processed by Reek.
+      TEMPLATE = 'Source %<source>s cannot be processed by Reek.'
 
-        This is most likely either a problem in your Reek configuration (config file or
-        source code comments) or a Reek bug.
+      LONG_TEMPLATE = <<-MESSAGE
+        !!!
+        %<message>s
 
-        Please double check your Reek configuration taking the original exception
-        below into account -  you might have misspelled a smell detector for instance.
-        (In the future Reek will handle configuration errors more gracefully, something
-        we are working on already).
+        This is most likely a Reek bug.
 
-        If you feel that this is not a problem with your Reek configuration but with
-        Reek itself it would be great if you could report this back to the Reek
-        team by opening up a corresponding issue at https://github.com/troessner/reek/issues.
+        It would be great if you could report this back to the Reek team by opening a
+        corresponding issue at https://github.com/troessner/reek/issues.
 
-        Please make sure to include the source in question, the Reek version
-        and the original exception below.
+        Please make sure to include the source in question, the Reek version and the
+        original exception below.
 
         Exception message:
 
-        %s
+        %<exception>s
 
         Original exception:
 
-        %s
+        %<original>s
 
         !!!
       MESSAGE
 
-      def initialize(origin:, original_exception:)
-        message = format(INCOMPREHENSIBLE_SOURCE_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

data/lib/reek/errors/syntax_error.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative 'base_error'
+
+module Reek
+  module Errors
+    # Gets raised when Reek is unable to process the source due to a SyntaxError
+    class SyntaxError < BaseError
+      TEMPLATE = "Source '%<source>s' cannot be processed by Reek due to a syntax error in the source file."
+
+      LONG_TEMPLATE = <<-MESSAGE
+        !!!
+        %<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.
+
+        Exception message:
+
+        %<exception>s
+
+        Original backtrace:
+
+        %<original>s
+
+        !!!
+      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
+end

data/lib/reek/examiner.rb

@@ -3,6 +3,8 @@
 require_relative 'context_builder'
 require_relative 'detector_repository'
 require_relative 'errors/incomprehensible_source_error'
+require_relative 'errors/encoding_error'
+require_relative 'errors/syntax_error'
 require_relative 'source/source_code'
 
 module Reek
@@ -10,6 +12,7 @@ module Reek
   # Applies all available smell detectors to a source.
   #
   # @public
+  # @quality :reek:TooManyInstanceVariables { max_instance_variables: 5 }
   class Examiner
     # Handles no errors
     class NullHandler
@@ -38,26 +41,17 @@ module Reek
                    detector_repository_class: DetectorRepository,
                    error_handler: NullHandler.new)
       @source              = Source::SourceCode.from(source)
+      @origin              = @source.origin
       @smell_types         = detector_repository_class.eligible_smell_types(filter_by_smells)
       @detector_repository = detector_repository_class.new(smell_types: @smell_types,
-                                                           configuration: configuration.directive_for(description))
+                                                           configuration: configuration.directive_for(@origin))
       @error_handler       = error_handler
     end
 
     # @return [String] origin of the source being analysed
     #
     # @public
-    def origin
-      @origin ||= source.origin
-    end
-
-    # @return [String] description of the source being analysed
-    #
-    # @public
-    # @deprecated Use origin
-    def description
-      origin
-    end
+    attr_reader :origin
 
     #
     # @return [Array<SmellWarning>] the smells found in the source
@@ -95,26 +89,26 @@ module Reek
     #
     # @return [Array<SmellWarning>] the smells found in the source
     #
-    # :reek:TooManyStatements { max_statements: 6 }
     def run
-      if source.valid_syntax? && syntax_tree
+      wrap_exceptions do
         examine_tree
-      else
-        SmellDetectors::Syntax.smells_from_source(source)
       end
     rescue StandardError => exception
-      wrapper = wrap_exception exception
-      raise wrapper unless @error_handler.handle wrapper
+      raise unless @error_handler.handle exception
       []
     end
 
-    def wrap_exception(exception)
-      case exception
-      when Errors::BaseError
-        exception
-      else
-        Errors::IncomprehensibleSourceError.new(origin: origin, original_exception: exception)
-      end
+    # @quality :reek:TooManyStatements { max_statements: 6 }
+    def wrap_exceptions
+      yield
+    rescue Errors::BaseError
+      raise
+    rescue EncodingError
+      raise Errors::EncodingError, origin: origin
+    rescue Parser::SyntaxError
+      raise Errors::SyntaxError, origin: origin
+    rescue StandardError
+      raise Errors::IncomprehensibleSourceError, origin: origin
     end
 
     def syntax_tree

data/lib/reek/logging_error_handler.rb

@@ -1,15 +1,17 @@
 # frozen_string_literal: true
 
-require_relative 'errors/bad_detector_configuration_key_in_comment_error'
-require_relative 'errors/bad_detector_in_comment_error'
-require_relative 'errors/garbage_detector_configuration_in_comment_error'
-require_relative 'errors/incomprehensible_source_error'
+require_relative 'errors/base_error'
 
 module Reek
   # Handles errors by logging to stderr
   class LoggingErrorHandler
     def handle(exception)
-      warn exception
+      case exception
+      when Errors::BaseError
+        warn exception.long_message
+      else
+        warn exception
+      end
       true
     end
   end

data/lib/reek/rake/task.rb

@@ -33,8 +33,8 @@ module Reek
     #
     # @public
     #
-    # :reek:TooManyInstanceVariables: { max_instance_variables: 6 }
-    # :reek:Attribute
+    # @quality :reek:TooManyInstanceVariables { max_instance_variables: 6 }
+    # @quality :reek:Attribute
     class Task < ::Rake::TaskLib
       # Name of Reek task. Defaults to :reek.
       # @public
@@ -114,7 +114,7 @@ module Reek
           reject(&:empty?)
       end
 
-      # :reek:UtilityFunction
+      # @quality :reek:UtilityFunction
       def sys_call_failed?
         !$CHILD_STATUS.success?
       end

data/lib/reek/report/base_report.rb

@@ -4,8 +4,6 @@ require 'json'
 require 'pathname'
 require 'rainbow'
 
-require_relative 'formatter'
-
 module Reek
   # @public
   module Report
@@ -16,22 +14,20 @@ module Reek
     #
     # @public
     #
-    # :reek:TooManyInstanceVariables: { max_instance_variables: 7 }
+    # @quality :reek:TooManyInstanceVariables { max_instance_variables: 7 }
     class BaseReport
       NO_WARNINGS_COLOR = :green
       WARNINGS_COLOR = :red
 
       # @public
       #
-      # :reek:BooleanParameter
-      def initialize(heading_formatter: Formatter::QuietHeadingFormatter,
-                     report_formatter: Formatter,
+      # @quality :reek:BooleanParameter
+      def initialize(heading_formatter: QuietHeadingFormatter,
                      sort_by_issue_count: false,
-                     warning_formatter: Formatter::SimpleWarningFormatter.new,
-                     progress_formatter: Formatter::ProgressFormatter::Quiet.new(0))
+                     warning_formatter: SimpleWarningFormatter.new,
+                     progress_formatter: ProgressFormatter::Quiet.new(0))
         @examiners           = []
-        @heading_formatter   = heading_formatter.new(report_formatter)
-        @report_formatter    = report_formatter
+        @heading_formatter   = heading_formatter.new
         @progress_formatter  = progress_formatter
         @sort_by_issue_count = sort_by_issue_count
         @total_smell_count   = 0
@@ -58,7 +54,7 @@ module Reek
       end
 
       def smells?
-        total_smell_count > 0
+        total_smell_count.positive?
       end
 
       def smells
@@ -71,7 +67,7 @@ module Reek
 
       private
 
-      attr_reader :examiners, :heading_formatter, :report_formatter,
+      attr_reader :examiners, :heading_formatter,
                   :sort_by_issue_count, :warning_formatter, :progress_formatter
     end
   end

data/lib/reek/report/code_climate/code_climate_configuration.rb

@@ -5,7 +5,7 @@ module Reek
     # loads the smell type metadata to present in Code Climate
     module CodeClimateConfiguration
       def self.load
-        config_file = File.expand_path('../code_climate_configuration.yml', __FILE__)
+        config_file = File.expand_path('code_climate_configuration.yml', __dir__)
         YAML.load_file config_file
       end
     end

data/lib/reek/report/code_climate/code_climate_configuration.yml

@@ -284,7 +284,7 @@ InstanceVariableAssumption:
     would report:
 
     ```Bash
-      [1]:InstanceVariableAssumption: Dummy assumes too much for instance variable @ivar [https://github.com/troessner/reek/blob/master/docs/Instance-Variable-Assumption.md]
+      [1]:InstanceVariableAssumption: Dummy assumes too much for instance variable @ivar
     ```
 
     Note that this example would trigger this smell warning as well:
@@ -565,10 +565,10 @@ NilCheck:
     test.rb -- 1 warning:
       [3]:Klass#nil_checker performs a nil-check. (NilCheck)
     ```
-PrimaDonnaMethod:
+MissingSafeMethod:
   remediation_points: 250_000
   content: |
-    A candidate method for the `Prima Donna Method` smell are methods whose names end with an exclamation mark.
+    A candidate method for the `Missing Safe Method` smell are methods whose names end with an exclamation mark.
 
     An exclamation mark in method names means (the explanation below is taken from [here](http://dablog.rubypal.com/2007/8/15/bang-methods-or-danger-will-rubyist) ):
 
@@ -576,7 +576,7 @@ PrimaDonnaMethod:
     The ! in method names that end with ! means, “This method is dangerous”—or, more precisely, this method is the “dangerous” version of an otherwise equivalent method, with the same name minus the !. “Danger” is relative; the ! doesn’t mean anything at all unless the method name it’s in corresponds to a similar but bang-less method name.
     So, for example, gsub! is the dangerous version of gsub. exit! is the dangerous version of exit. flatten! is the dangerous version of flatten. And so forth.
 
-    Such a method is called `Prima Donna Method` if and only if her non-bang version does not exist and this method is reported as a smell.
+    Such a method is called `Missing Safe Method` if and only if her non-bang version does not exist and this method is reported as a smell.
 
     ## Example
 
@@ -590,7 +590,7 @@ PrimaDonnaMethod:
     end
     ```
 
-    Reek would report `bar!` as `prima donna method` smell but not `foo!`.
+    Reek would report `bar!` as `Missing Safe Method` smell but not `foo!`.
 
     Reek reports this smell only in a class context, not in a module context in order to allow perfectly legit code like this:
 
@@ -612,7 +612,7 @@ PrimaDonnaMethod:
     end
     ```
 
-    In this example, Reek would not report the `prima donna method` smell for the method `foo` of the `Dangerous` module.
+    In this example, Reek would not report the `Missing Safe Method` smell for the method `foo` of the `Dangerous` module.
 RepeatedConditional:
   remediation_points: 400_000
   content: |
@@ -860,7 +860,3 @@ SubclassedFromCoreClass:
     you are gonna have a bad time.
 
     Source: http://words.steveklabnik.com/beware-subclassing-ruby-core-classes
-Syntax:
-  remediation_points: 250_000
-  content: |
-    Check syntax errors.

data/lib/reek/report/documentation_link_warning_formatter.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative 'simple_warning_formatter'
+
+module Reek
+  module Report
+    #
+    # Formatter that adds a link to the docs to the basic message from
+    # SimpleWarningFormatter.
+    #
+    class DocumentationLinkWarningFormatter < SimpleWarningFormatter
+      def format(warning)
+        "#{super} [#{warning.explanatory_link}]"
+      end
+    end
+  end
+end

data/lib/reek/report/heading_formatter.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Reek
+  module Report
+    #
+    # Base class for heading formatters.
+    # Is responsible for formatting the heading emitted for each examiner
+    #
+    # @abstract Override {#show_header?} to implement a heading formatter.
+    class HeadingFormatterBase
+      # @quality :reek:UtilityFunction
+      def show_header?(_examiner)
+        raise NotImplementedError
+      end
+
+      def header(examiner)
+        if show_header?(examiner)
+          formatted_header examiner
+        else
+          ''
+        end
+      end
+
+      private
+
+      def formatted_header(examiner)
+        count = examiner.smells_count
+        result = Rainbow("#{examiner.origin} -- ").cyan +
+          Rainbow("#{count} warning").yellow
+        result += Rainbow('s').yellow unless count == 1
+        result
+      end
+    end
+
+    #
+    # Lists out each examiner, even if it has no smell
+    #
+    class VerboseHeadingFormatter < HeadingFormatterBase
+      def show_header?(_examiner)
+        true
+      end
+    end
+
+    #
+    # Lists only smelly examiners
+    #
+    class QuietHeadingFormatter < HeadingFormatterBase
+      # @quality :reek:UtilityFunction
+      def show_header?(examiner)
+        examiner.smelly?
+      end
+    end
+  end
+end

data/lib/reek/report/json_report.rb

@@ -12,7 +12,7 @@ module Reek
     #
     class JSONReport < BaseReport
       def show(out = $stdout)
-        out.print ::JSON.generate smells.map { |smell| warning_formatter.format_hash(smell) }
+        out.print ::JSON.generate smells.map(&:yaml_hash)
       end
     end
   end

data/lib/reek/report/location_formatter.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Reek
+  module Report
+    #
+    # Formats the location of a warning as an empty string.
+    #
+    module BlankLocationFormatter
+      module_function
+
+      def format(_warning)
+        ''
+      end
+    end
+
+    #
+    # Formats the location of a warning as an array of line numbers.
+    #
+    module DefaultLocationFormatter
+      module_function
+
+      def format(warning)
+        "#{warning.lines.sort.inspect}:"
+      end
+    end
+
+    #
+    # Formats the location of a warning as a combination of source file name
+    # and line number. In this format, it is not possible to show more than
+    # one line number, so the first number is displayed.
+    #
+    module SingleLineLocationFormatter
+      module_function
+
+      def format(warning)
+        "#{warning.source}:#{warning.lines.min}: "
+      end
+    end
+  end
+end

data/lib/reek/report/progress_formatter.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Reek
+  module Report
+    module ProgressFormatter
+      #
+      # Base class for progress formatters.
+      # Is responsible for formatting the progress emitted for each examiner
+      #
+      # @abstract Override {#header, #progress, #footer} to implement a progress formatter.
+      class Base
+        attr_reader :sources_count
+
+        def initialize(sources_count)
+          @sources_count = sources_count
+        end
+
+        def header
+          raise NotImplementedError
+        end
+
+        def progress(_examiner)
+          raise NotImplementedError
+        end
+
+        def footer
+          raise NotImplementedError
+        end
+      end
+
+      #
+      # Shows the status of each source as either a dot (.) or an S
+      #
+      class Dots < Base
+        NO_WARNINGS_COLOR = :green
+        WARNINGS_COLOR = :red
+
+        def header
+          "Inspecting #{sources_count} file(s):\n"
+        end
+
+        def progress(examiner)
+          examiner.smelly? ? display_smelly : display_clean
+        end
+
+        def footer
+          "\n\n"
+        end
+
+        private
+
+        def display_clean
+          Rainbow('.').color(NO_WARNINGS_COLOR)
+        end
+
+        def display_smelly
+          Rainbow('S').color(WARNINGS_COLOR)
+        end
+      end
+
+      #
+      # Does not show progress
+      #
+      class Quiet < Base
+        def header
+          ''
+        end
+
+        def progress(_examiner)
+          ''
+        end
+
+        def footer
+          ''
+        end
+      end
+    end
+  end
+end

data/lib/reek/report/simple_warning_formatter.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'code_climate/code_climate_formatter'
+
+module Reek
+  module Report
+    #
+    # Basic formatter that just shows a simple message for each warning,
+    # prepended with the result of the passed-in location formatter.
+    #
+    class SimpleWarningFormatter
+      def initialize(location_formatter: BlankLocationFormatter)
+        @location_formatter = location_formatter
+      end
+
+      def format(warning)
+        "#{location_formatter.format(warning)}#{warning.base_message}"
+      end
+
+      # @quality :reek:UtilityFunction
+      def format_code_climate_hash(warning)
+        CodeClimateFormatter.new(warning).render
+      end
+
+      def format_list(warnings)
+        warnings.map { |warning| "  #{format(warning)}" }.join("\n")
+      end
+
+      private
+
+      attr_reader :location_formatter
+    end
+  end
+end

data/lib/reek/report/text_report.rb

@@ -49,8 +49,7 @@ module Reek
       def summarize_single_examiner(examiner)
         result = heading_formatter.header(examiner)
         if examiner.smelly?
-          formatted_list = report_formatter.format_list(examiner.smells,
-                                                        formatter: warning_formatter)
+          formatted_list = warning_formatter.format_list(examiner.smells)
           result += ":\n#{formatted_list}"
         end
         result

data/lib/reek/report/xml_report.rb

@@ -34,8 +34,8 @@ module Reek
         end
       end
 
-      # :reek:FeatureEnvy
-      # :reek:NestedIterators: { max_allowed_nesting: 2 }
+      # @quality :reek:FeatureEnvy
+      # @quality :reek:NestedIterators { max_allowed_nesting: 2 }
       def file(name, smells)
         REXML::Element.new('file').tap do |file|
           file.add_attribute 'name', File.realpath(name)
@@ -47,7 +47,7 @@ module Reek
         end
       end
 
-      # :reek:UtilityFunction
+      # @quality :reek:UtilityFunction
       def error(smell, line)
         REXML::Element.new('error').tap do |error|
           error.add_attributes 'column' => 0,