reek 4.4.2 → 4.5.0

data/features/step_definitions/sample_file_steps.rb

@@ -15,6 +15,11 @@ Given(/^a directory called 'clean' containing two clean files$/) do
   write_file('clean/clean_two.rb', contents)
 end
 
+Given(/^a directory called 'mixed_files' containing some clean and smelly files$/) do
+  write_file('mixed_files/clean.rb', CLEAN_FILE.read)
+  write_file('mixed_files/dirty.rb', SMELLY_FILE.read)
+end
+
 Given(/^a directory called 'smelly' containing two smelly files$/) do
   contents = SMELLY_FILE.read
 

data/features/todo_list.feature

@@ -40,20 +40,6 @@ Feature:
     When I run reek -c .todo.reek smelly.rb
     Then it succeeds
 
-  Scenario: Respects a configuration file
-    Given the smelly file 'smelly.rb'
-    And a configuration file 'partial_mask.reek'
-    When I run reek -c partial_mask.reek --todo smelly.rb
-    Then it succeeds
-    And a file named ".todo.reek" should exist
-    And the file ".todo.reek" should contain:
-      """
-      ---
-      UncommunicativeVariableName:
-        exclude:
-        - Smelly#x
-      """
-
   Scenario: Reacts appropiately when there are no smells
     Given the clean file 'clean.rb'
     When I run reek --todo clean.rb
@@ -63,3 +49,45 @@ Feature:
 
       '.todo.reek' not generated because there were no smells found!
       """
+
+  Scenario: Mercilessly overwrite existing .todo.reek files
+    Given the smelly file 'smelly.rb'
+    And a file named ".todo.reek" with:
+      """
+      ---
+      # smelly.rb reeks of UncommunicativeMethodName and UncommunicativeVariableName
+      # so the configuration below will partially mask this
+      UncommunicativeMethodName:
+        enabled: false
+      """
+    When I run `reek -c .todo.reek smelly.rb`
+    Then it reports:
+      """
+      smelly.rb -- 1 warning:
+        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Variable-Name.md]
+      """
+    When I run `reek --todo smelly.rb`
+    Then it succeeds
+    When I run `reek -c .todo.reek smelly.rb`
+    Then it reports nothing
+
+  Scenario: Ignore existing other configuration files that are passed explicitly
+    Given the smelly file 'smelly.rb'
+    And a file named "config.reek" with:
+      """
+      ---
+      # smelly.rb reeks of UncommunicativeMethodName and UncommunicativeVariableName
+      # so the configuration below will partially mask this
+      UncommunicativeMethodName:
+        enabled: false
+      """
+    When I run `reek -c config.reek smelly.rb`
+    Then it reports:
+      """
+      smelly.rb -- 1 warning:
+        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Variable-Name.md]
+      """
+    When I run `reek -c config.reek --todo smelly.rb`
+    Then it succeeds
+    When I run `reek -c .todo.reek smelly.rb`
+    Then it reports nothing

data/lib/reek.rb

@@ -4,4 +4,4 @@
 #
 require_relative 'reek/version'
 require_relative 'reek/examiner'
-require_relative 'reek/report/report'
+require_relative 'reek/report'

data/lib/reek/cli/application.rb

@@ -54,6 +54,7 @@ module Reek
       def sources
         if no_source_files_given?
           if input_was_piped?
+            disable_progress_output_unless_verbose
             source_from_pipe
           else
             working_directory_as_source
@@ -89,6 +90,10 @@ module Reek
       def source_from_pipe
         [$stdin]
       end
+
+      def disable_progress_output_unless_verbose
+        options.progress_format = :quiet unless options.show_empty
+      end
     end
   end
 end

data/lib/reek/cli/command/report_command.rb

@@ -37,7 +37,8 @@ module Reek
               warning_formatter: warning_formatter,
               report_formatter: Report::Formatter,
               sort_by_issue_count: sort_by_issue_count,
-              heading_formatter: heading_formatter)
+              heading_formatter: heading_formatter,
+              progress_formatter: progress_formatter.new(sources.length))
         end
 
         def report_class
@@ -60,6 +61,10 @@ module Reek
           Report.heading_formatter(options.show_empty ? :verbose : :quiet)
         end
 
+        def progress_formatter
+          Report.progress_formatter(options.progress_format)
+        end
+
         def sort_by_issue_count
           options.sorting == :smelliness
         end

data/lib/reek/cli/command/todo_list_command.rb

@@ -30,8 +30,7 @@ module Reek
         def scan_for_smells
           sources.map do |source|
             Examiner.new(source,
-                         filter_by_smells: smell_names,
-                         configuration: configuration)
+                         filter_by_smells: smell_names)
           end.map(&:smells).flatten
         end
 

data/lib/reek/cli/options.rb

@@ -10,7 +10,8 @@ module Reek
     #
     # See {file:docs/Command-Line-Options.md} for details.
     #
-    # :reek:TooManyInstanceVariables: { max_instance_variables: 10 }
+    # :reek:TooManyInstanceVariables: { max_instance_variables: 11 }
+    # :reek:TooManyMethods: { max_methods: 17 }
     # :reek:Attribute: { enabled: false }
     #
     class Options
@@ -22,6 +23,7 @@ module Reek
       attr_accessor :colored,
                     :config_file,
                     :location_format,
+                    :progress_format,
                     :report_format,
                     :show_empty,
                     :show_links,
@@ -35,9 +37,10 @@ module Reek
         @parser             = OptionParser.new
         @report_format      = :text
         @location_format    = :numbers
+        @progress_format    = tty_output? ? :dots : :quiet
         @show_links         = true
         @smells_to_detect   = []
-        @colored            = color_support?
+        @colored            = tty_output?
         @success_exit_code  = DEFAULT_SUCCESS_EXIT_CODE
         @failure_exit_code  = DEFAULT_FAILURE_EXIT_CODE
         @generate_todo_list = false
@@ -53,8 +56,12 @@ module Reek
 
       private
 
+      # TTY output generally means the output will not undergo further
+      # processing by a machine, but will be viewed by a human. This means
+      # features like coloring can be safely enabled by default.
+      #
       # :reek:UtilityFunction
-      def color_support?
+      def tty_output?
         $stdout.tty?
       end
 
@@ -113,11 +120,13 @@ module Reek
         end
       end
 
+      # :reek:TooManyStatements: { max_statements: 6 }
       def set_report_formatting_options
         parser.separator "\nText format options:"
         set_up_color_option
         set_up_verbosity_options
         set_up_location_formatting_options
+        set_up_progress_formatting_options
         set_up_sorting_option
       end
 
@@ -149,6 +158,13 @@ module Reek
         end
       end
 
+      def set_up_progress_formatting_options
+        parser.on('-P', '--[no-]progress',
+                  'Show progress of each source as it is examined (default: true)') do |show_progress|
+          self.progress_format = show_progress ? :dots : :quiet
+        end
+      end
+
       def set_up_sorting_option
         parser.on('--sort-by SORTING', [:smelliness, :none],
                   'Sort reported files by the given criterium:',

data/lib/reek/code_comment.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
+
 require 'yaml'
-require_relative 'smells/smell_detector'
-require_relative 'errors'
+
+require_relative 'smell_detectors/base_detector'
+require_relative 'errors/bad_detector_in_comment_error'
+require_relative 'errors/garbage_detector_configuration_in_comment_error'
 
 module Reek
   #
@@ -32,16 +35,17 @@ module Reek
     #
     def initialize(comment:, line: nil, source: nil)
       @original_comment  = comment
+      @line              = line
+      @source            = source
       @config            = Hash.new { |hash, key| hash[key] = {} }
 
-      @original_comment.scan(CONFIGURATION_REGEX) do |detector, _option_string, options|
-        unless Smells::SmellDetector.valid_detector?(detector)
-          raise BadDetectorInCommentError, detector: detector,
-                                           source: source,
-                                           line: line,
-                                           original_comment: @original_comment
-        end
-        @config.merge! detector => YAML.load(options || DISABLE_DETECTOR_CONFIGURATION)
+      @original_comment.scan(CONFIGURATION_REGEX) do |detector_name, _option_string, options|
+        CodeCommentValidator.new(detector_name:    detector_name,
+                                 original_comment: original_comment,
+                                 line:             line,
+                                 source:           source,
+                                 options:          options).validate
+        @config.merge! detector_name => YAML.load(options || DISABLE_DETECTOR_CONFIGURATION)
       end
     end
 
@@ -51,7 +55,7 @@ module Reek
 
     private
 
-    attr_reader :original_comment
+    attr_reader :original_comment, :source, :line
 
     def sanitized_comment
       @sanitized_comment ||= original_comment.
@@ -59,5 +63,73 @@ module Reek
         gsub(SANITIZE_REGEX, ' ').
         strip
     end
+
+    #
+    # A typical configuration via code comment looks like this:
+    #
+    #   :reek:DuplicateMethodCall { enabled: false }
+    #
+    # There are a lot of ways a user can introduce some errors here:
+    #
+    # 1.) Unknown smell detector
+    # 2.) Garbage in the detector configuration like { thats: a: bad: config }
+    # 3.) Unknown configuration keys (e.g. by doing a simple typo: "exclude" vs. "exlude" )
+    # 4.) Bad data types given as values for those keys
+    # This class validates [1] and [2] at the moment but will also validate [3]
+    # and [4] in the future.
+    #
+    # :reek:TooManyInstanceVariables: { max_instance_variables: 5 }
+    class CodeCommentValidator
+      #
+      # @param detector_name [String] - the detector class that was parsed out of the original
+      #   comment, e.g. "DuplicateMethodCall" or "UnknownSmellDetector"
+      # @param original_comment [String] - the original comment as found in the source code
+      # @param line [Integer] - start of the expression the comment belongs to
+      # @param source [String] - path to source file or "string"
+      # @param options [String] - the configuration options as String for the detector that were
+      #   extracted from the original comment
+      def initialize(detector_name:, original_comment:, line:, source:, options: {})
+        @detector_name    = detector_name
+        @original_comment = original_comment
+        @line             = line
+        @source           = source
+        @options          = options
+      end
+
+      #
+      # Method can raise the following errors:
+      #   * Errors::BadDetectorInCommentError
+      #   * Errors::GarbageDetectorConfigurationInCommentError
+      # @return [undefined]
+      def validate
+        escalate_bad_detector
+        escalate_bad_detector_configuration
+      end
+
+      private
+
+      attr_reader :detector_name,
+                  :original_comment,
+                  :line,
+                  :source,
+                  :options
+
+      def escalate_bad_detector
+        return if SmellDetectors::BaseDetector.valid_detector?(detector_name)
+        raise Errors::BadDetectorInCommentError, detector_name: detector_name,
+                                                 original_comment: original_comment,
+                                                 source: source,
+                                                 line: line
+      end
+
+      def escalate_bad_detector_configuration
+        YAML.load(options || CodeComment::DISABLE_DETECTOR_CONFIGURATION)
+      rescue Psych::SyntaxError
+        raise Errors::GarbageDetectorConfigurationInCommentError, detector_name: detector_name,
+                                                                  original_comment: original_comment,
+                                                                  source: source,
+                                                                  line: line
+      end
+    end
   end
 end

data/lib/reek/configuration/configuration_validator.rb

@@ -14,7 +14,7 @@ module Reek
           true
         when String
           begin
-            Reek::Smells.const_defined? key
+            Reek::SmellDetectors.const_defined? key
           rescue NameError
             false
           end
@@ -27,7 +27,7 @@ module Reek
         when Class
           key
         else
-          Reek::Smells.const_get key
+          Reek::SmellDetectors.const_get key
         end
       end
 

data/lib/reek/errors/bad_detector_in_comment_error.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Reek
+  module Errors
+    # Gets raised when trying to configure a detector which is unknown to us.
+    # 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 < RuntimeError
+      UNKNOWN_SMELL_DETECTOR_MESSAGE = <<-EOS.freeze
+
+        Error: You are trying to configure an unknown smell detector '%s' in one
+        of your source code comments.
+        The source is '%s' and the comment belongs to the expression starting in line %d.
+        Here's the original 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
+        Update the offensive comment (or remove it if no longer applicable) and re-run Reek.
+
+      EOS
+
+      def initialize(detector_name:, source:, line:, original_comment:)
+        message = format(UNKNOWN_SMELL_DETECTOR_MESSAGE,
+                         detector_name,
+                         source,
+                         line,
+                         original_comment)
+        super message
+      end
+    end
+  end
+end

data/lib/reek/errors/garbage_detector_configuration_in_comment_error.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+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 < RuntimeError
+      BAD_DETECTOR_CONFIGURATION_MESSAGE = <<-EOS.freeze
+
+        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.
+        Here's the original 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
+        Update the offensive comment (or remove it if no longer applicable) and re-run Reek.
+
+      EOS
+
+      def initialize(detector_name:, source:, line:, original_comment:)
+        message = format(BAD_DETECTOR_CONFIGURATION_MESSAGE,
+                         detector_name,
+                         source,
+                         line,
+                         original_comment)
+        super message
+      end
+    end
+  end
+end

data/lib/reek/examiner.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 require_relative 'context_builder'
+require_relative 'errors/bad_detector_in_comment_error'
+require_relative 'errors/garbage_detector_configuration_in_comment_error'
+require_relative 'smell_detectors/detector_repository'
 require_relative 'source/source_code'
-require_relative 'smells/smell_repository'
 
 module Reek
   #
@@ -12,14 +14,30 @@ module Reek
     INCOMPREHENSIBLE_SOURCE_TEMPLATE = <<-EOS.freeze
       !!!
       Source %s can not be processed by Reek.
-      This is most likely a Reek bug.
-      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
-      Make sure to include the source in question, the Reek version
+
+      This is most likely either a bug in your Reek configuration (config file or
+      source code comments) or a Reek bug.
+
+      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).
+
+      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.
+
+      Please make sure to include the source in question, the Reek version
       and the original exception below.
 
+      Exception message:
+
+      %s
+
       Original exception:
+
       %s
+
       !!!
     EOS
     #
@@ -39,11 +57,11 @@ module Reek
     def initialize(source,
                    filter_by_smells: [],
                    configuration: Configuration::AppConfiguration.default,
-                   smell_repository_class: Smells::SmellRepository)
-      @source           = Source::SourceCode.from(source)
-      @smell_types      = smell_repository_class.eligible_smell_types(filter_by_smells)
-      @smell_repository = smell_repository_class.new(smell_types: @smell_types,
-                                                     configuration: configuration.directive_for(description))
+                   detector_repository_class: SmellDetectors::DetectorRepository)
+      @source              = Source::SourceCode.from(source)
+      @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))
     end
 
     # @return [String] origin of the source being analysed
@@ -87,7 +105,7 @@ module Reek
 
     private
 
-    attr_reader :source, :smell_repository
+    attr_reader :source, :detector_repository
 
     # Runs the Examiner on the given source to scan for code smells.
     #
@@ -102,11 +120,15 @@ module Reek
       return [] unless syntax_tree
       begin
         examine_tree
-      rescue BadDetectorInCommentError => exception
+      rescue Errors::BadDetectorInCommentError,
+             Errors::GarbageDetectorConfigurationInCommentError => exception
         warn exception
         []
       rescue StandardError => exception
-        warn format(INCOMPREHENSIBLE_SOURCE_TEMPLATE, origin, exception.inspect)
+        warn format(INCOMPREHENSIBLE_SOURCE_TEMPLATE,
+                    origin,
+                    exception.message,
+                    exception.backtrace.join("\n\t"))
         []
       end
     end
@@ -117,7 +139,7 @@ module Reek
 
     def examine_tree
       ContextBuilder.new(syntax_tree).context_tree.flat_map do |element|
-        smell_repository.examine(element)
+        detector_repository.examine(element)
       end
     end
   end