reek 4.6.0 → 5.0.0

data/lib/reek/detector_repository.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative 'smell_detectors'
 require_relative 'smell_detectors/base_detector'
 require_relative 'configuration/app_configuration'
@@ -34,31 +35,31 @@ module Reek
                    configuration: {})
       @configuration = configuration
       @smell_types   = smell_types
-      @detectors     = smell_types.map { |klass| klass.new configuration_for(klass) }
     end
 
     def examine(context)
-      smell_detectors_for(context.type).flat_map do |detector|
-        detector.run_for(context)
+      smell_detectors_for(context.type).flat_map do |klass|
+        detector = klass.new configuration: configuration_for(klass), context: context
+        detector.run
       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, :detectors
+    attr_reader :configuration, :smell_types
 
     def configuration_for(klass)
       configuration.fetch klass, {}
     end
 
     def smell_detectors_for(type)
-      enabled_detectors.select do |detector|
-        detector.contexts.include? type
-      end
-    end
-
-    def enabled_detectors
-      detectors.select { |detector| detector.config.enabled? }
+      smell_types.select { |detector| detector.contexts.include? type }
     end
   end
 end

data/lib/reek/documentation_link.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+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'
+
+    module_function
+
+    # Build link to the documentation about the given subject for the current
+    # version of Reek. The subject can be either a smell type like
+    # 'FeatureEnvy' or a general subject like 'Rake Task'.
+    #
+    # @param subject [String]
+    # @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
+
+    # Convert the given subject name to a form that is acceptable in a URL.
+    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('-')
+    end
+  end
+end

data/lib/reek/errors/bad_detector_configuration_key_in_comment_error.rb

@@ -1,35 +1,37 @@
 # frozen_string_literal: true
+
 require_relative 'base_error'
+require_relative '../documentation_link'
 
 module Reek
   module Errors
     # Gets raised when trying to configure a detector with an option
     # which is unknown to it.
     class BadDetectorConfigurationKeyInCommentError < BaseError
-      UNKNOWN_SMELL_DETECTOR_MESSAGE = <<-EOS.freeze
+      UNKNOWN_SMELL_DETECTOR_MESSAGE = <<-MESSAGE
 
-        Error: You are trying to configure the smell detector '%s'
-        in one of your source code comments with the unknown option %s.
-        The source is '%s' and the comment belongs to the expression starting in line %d.
+        Error: You are trying to configure the smell detector '%<detector>s'
+        in one of your source code comments with the unknown option %<option>s.
+        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 basic options are available: https://github.com/troessner/reek/blob/master/docs/Basic-Smell-Options.md
+          * how to configure Reek via source code comments: #{DocumentationLink.build('Smell Suppression')}
+          * what basic options are available: #{DocumentationLink.build('Basic Smell Options')}
           * what custom options are available by checking the detector specific documentation in /docs
         Update the offensive comment (or remove it if no longer applicable) and re-run Reek.
 
-      EOS
+      MESSAGE
 
       def initialize(detector_name:, offensive_keys:, source:, line:, original_comment:)
         message = format(UNKNOWN_SMELL_DETECTOR_MESSAGE,
-                         detector_name,
-                         offensive_keys,
-                         source,
-                         line,
-                         original_comment)
+                         detector: detector_name,
+                         option: offensive_keys,
+                         source: source,
+                         line: line,
+                         comment: original_comment)
         super message
       end
     end

data/lib/reek/errors/bad_detector_in_comment_error.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
+
 require_relative 'base_error'
+require_relative '../documentation_link'
 
 module Reek
   module Errors
@@ -7,28 +9,28 @@ 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 = <<-EOS.freeze
+      UNKNOWN_SMELL_DETECTOR_MESSAGE = <<-MESSAGE
 
-        Error: You are trying to configure an unknown smell detector '%s' in one
+        Error: You are trying to configure an unknown smell detector '%<detector>s' in one
         of your source code comments.
-        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.
 
-      EOS
+      MESSAGE
 
       def initialize(detector_name:, source:, line:, original_comment:)
         message = format(UNKNOWN_SMELL_DETECTOR_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/base_error.rb

@@ -4,6 +4,9 @@ module Reek
   module Errors
     # Base class for all runtime Reek errors
     class BaseError < ::RuntimeError
+      def long_message
+        message
+      end
     end
   end
 end

data/lib/reek/errors/config_file_error.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'base_error'
+
+module Reek
+  module Errors
+    # Gets raised when Reek is unable to process the source due to bad config file
+    class ConfigFileError < BaseError
+    end
+  end
+end

data/lib/reek/errors/encoding_error.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative 'base_error'
+
+module Reek
+  module Errors
+    # Gets raised when Reek is unable to process the source due to an EncodingError
+    class EncodingError < BaseError
+      TEMPLATE = "Source '%<source>s' cannot be processed by Reek due to an encoding 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.
+        Check out this article for an idea on how to get started:
+        https://www.justinweiss.com/articles/3-steps-to-fix-encoding-problems-in-ruby/
+
+        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/errors/garbage_detector_configuration_in_comment_error.rb

@@ -1,33 +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 = <<-EOS.freeze
+      BAD_DETECTOR_CONFIGURATION_MESSAGE = <<-MESSAGE
 
-        Error: You are trying to configure the smell detector '%s'.
-        Unfortunately we can not parse the configuration you have given.
-        The source is '%s' and the comment belongs to the expression starting in line %d.
+        Error: You are trying to configure the smell detector '%<detector>s'.
+        Unfortunately we cannot parse the configuration you have given.
+        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.
 
-      EOS
+      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

@@ -1,46 +1,45 @@
 # frozen_string_literal: true
+
 require_relative 'base_error'
 
 module Reek
   module Errors
     # Gets raised when Reek is unable to process the source
     class IncomprehensibleSourceError < BaseError
-      INCOMPREHENSIBLE_SOURCE_TEMPLATE = <<-EOS.freeze
-        !!!
-        Source %s can not be processed by Reek.
+      TEMPLATE = 'Source %<source>s cannot be processed by Reek.'
 
-        This is most likely either a bug 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
 
         !!!
-      EOS
-
-      def initialize(origin:, original_exception:)
-        message = format(INCOMPREHENSIBLE_SOURCE_TEMPLATE,
-                         origin,
-                         original_exception.message,
-                         original_exception.backtrace.join("\n\t"))
-        super message
+      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

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
+
 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
@@ -9,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
@@ -37,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
@@ -94,15 +89,26 @@ module Reek
     #
     # @return [Array<SmellWarning>] the smells found in the source
     #
-    # :reek:TooManyStatements { max_statements: 8 }
     def run
-      return [] unless syntax_tree
-      begin
+      wrap_exceptions do
         examine_tree
-      rescue Errors::BaseError => exception
-        raise unless @error_handler.handle exception
-        []
       end
+    rescue StandardError => exception
+      raise unless @error_handler.handle 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
@@ -113,10 +119,6 @@ module Reek
       ContextBuilder.new(syntax_tree).context_tree.flat_map do |element|
         detector_repository.examine(element)
       end
-    rescue Errors::BaseError
-      raise
-    rescue StandardError => exception
-      raise Errors::IncomprehensibleSourceError, origin: origin, original_exception: exception
     end
   end
 end

data/lib/reek/logging_error_handler.rb

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

@@ -1,4 +1,3 @@
-#!/usr/bin/env ruby
 # frozen_string_literal: true
 
 require 'rake'
@@ -34,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
@@ -74,10 +73,14 @@ module Reek
         @name          = name
         @reek_opts     = ENV['REEK_OPTS'] || ''
         @fail_on_error = true
-        @source_files  = FileList[ENV['REEK_SRC'] || 'lib/**/*.rb']
         @verbose       = false
 
         yield self if block_given?
+
+        if (reek_src = ENV['REEK_SRC'])
+          @source_files = FileList[reek_src]
+        end
+        @source_files ||= FileList['lib/**/*.rb']
         define_task
       end
 
@@ -111,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

@@ -1,10 +1,9 @@
 # frozen_string_literal: true
+
 require 'json'
 require 'pathname'
 require 'rainbow'
 
-require_relative 'formatter'
-
 module Reek
   # @public
   module Report
@@ -15,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
@@ -57,7 +54,7 @@ module Reek
       end
 
       def smells?
-        total_smell_count > 0
+        total_smell_count.positive?
       end
 
       def smells
@@ -70,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

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
+
 module Reek
   module Report
     # 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