reek 5.0.1 → 5.1.0

data/features/todo_list.feature

@@ -1,14 +1,11 @@
 Feature: Auto-generate a todo file
   Write a Reek configuration as a kind of todo list that will prevent Reek
-  from reporting smells on the current code.
-  This can then be worked on later on.
-  The main goal here would be to ease the Reek adoption by allowing developers to:
-    - introduce Reek right away (e.g. for CI)
-    - exclude the "old" smells from getting reported
-    - fix them step by step
-    - get rid of the todo file
+  from reporting smells on the current code. This can then be worked on later on.
+  The main goal here would be to ease the Reek adoption by allowing developers to
+  introduce Reek right away (e.g. for CI), exclude the "old" smells from getting reported
+  and then fix them step by step.
 
-  Scenario: Generate a proper todo file that disables all found smells
+  Scenario: Generate the default configuration file that disables all found smells
     Given the smelly file 'smelly.rb'
     When I run reek smelly.rb
     Then the exit status indicates smells
@@ -23,10 +20,10 @@ Feature: Auto-generate a todo file
     And it reports:
       """
 
-      '.todo.reek' generated! You can now use this as a starting point for your configuration.
+      '.reek.yml' generated! You can now use this as a starting point.
       """
-    And a file named ".todo.reek" should exist
-    And the file ".todo.reek" should contain:
+    And a file named ".reek.yml" should exist
+    And the file ".reek.yml" should contain:
       """
       ---
       detectors:
@@ -37,48 +34,52 @@ Feature: Auto-generate a todo file
           exclude:
           - Smelly#x
       """
-    When I run reek -c .todo.reek smelly.rb
+    When I run reek smelly.rb
     Then it succeeds
 
   Scenario: Reacts appropiately when there are no smells
-    Given the clean file 'clean.rb'
+    Given the clean file "clean.rb"
     When I run reek --todo clean.rb
-    Then a file named ".todo.reek" should not exist
+    Then a file named ".reek.yml" should not exist
     And it reports:
       """
 
-      '.todo.reek' not generated because there were no smells found!
+      No smells found - nothing to do, exiting.
       """
 
-  Scenario: Mercilessly overwrite existing .todo.reek files
+  Scenario: Don't overwrite existing .reek.yml files
     Given the smelly file 'smelly.rb'
-    And a file named ".todo.reek" with:
+    And a file named ".reek.yml" with:
       """
       ---
       detectors:
-        # 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
+    When I run reek smelly.rb
     Then it reports:
       """
       smelly.rb -- 1 warning:
         [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
       """
     When I run reek --todo smelly.rb
-    Then it succeeds
-    When I run reek -c .todo.reek smelly.rb
-    Then it reports nothing
+    Then it reports:
+      """
+
+      Existing '.reek.yml' detected - aborting.
+      """
+    When I run reek smelly.rb
+    Then it reports:
+      """
+      smelly.rb -- 1 warning:
+        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
+      """
 
   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
       detectors:
         UncommunicativeMethodName:
           enabled: false
@@ -91,5 +92,17 @@ Feature: Auto-generate a todo file
       """
     When I run reek -c config.reek --todo smelly.rb
     Then it succeeds
-    When I run reek -c .todo.reek smelly.rb
+    And a file named ".reek.yml" should exist
+    And the file ".reek.yml" should contain:
+      """
+      ---
+      detectors:
+        UncommunicativeMethodName:
+          exclude:
+          - Smelly#x
+        UncommunicativeVariableName:
+          exclude:
+          - Smelly#x
+      """
+    When I run reek smelly.rb
     Then it reports nothing

data/lib/reek/ast/node.rb

@@ -102,6 +102,9 @@ module Reek
         loc.expression.source_buffer.name
       end
 
+      # Method will be overridden by the code in the IfNode, CaseNode, and LogicOperatorBase sexp extensions.
+      def condition; end
+
       protected
 
       # See ".each_node" for documentation.
@@ -119,6 +122,7 @@ module Reek
       def look_for_recurse(target_types, ignoring, &blk)
         yield self if target_types.include? type
         return if ignoring.include? type
+
         each_sexp do |elem|
           elem.look_for_recurse(target_types, ignoring, &blk)
         end

data/lib/reek/ast/sexp_extensions/case.rb

@@ -10,7 +10,9 @@ module Reek
         end
 
         def body_nodes(type, ignoring = [])
-          children[1..-1].compact.flat_map { |child| child.each_node(type, ignoring).to_a }
+          children[1..-1].compact.flat_map do |child|
+            child.each_node(type, ignoring | type).to_a
+          end
         end
 
         def else_body

data/lib/reek/ast/sexp_extensions/if.rb

@@ -5,6 +5,26 @@ module Reek
     module SexpExtensions
       # Utility methods for :if nodes.
       module IfNode
+        #
+        # @return [Reek::AST::Node] the condition that is associated with a conditional node.
+        #   For instance, this code
+        #
+        #     if charlie(bravo) then delta end
+        #
+        #   would be parsed into this AST:
+        #
+        #     s(:if,
+        #       s(:send, nil, :charlie,
+        #         s(:lvar, :bravo)),
+        #       s(:send, nil, :delta), nil)
+        #
+        #   so in this case we would return this
+        #
+        #     s(:send, nil, :charlie,
+        #       s(:lvar, :bravo))
+        #
+        #   as condition.
+        #
         def condition
           children.first
         end
@@ -15,7 +35,7 @@ module Reek
             if ignoring.include? child.type
               []
             else
-              child.each_node(type, ignoring).to_a
+              child.each_node(type, ignoring | type).to_a
             end
           end
         end

data/lib/reek/ast/sexp_extensions/logical_operators.rb

@@ -10,7 +10,7 @@ module Reek
         end
 
         def body_nodes(type, ignoring = [])
-          children[1].each_node type, ignoring
+          children[1].each_node type, (ignoring | type)
         end
       end
 

data/lib/reek/ast/sexp_extensions/methods.rb

@@ -32,6 +32,7 @@ module Reek
         def body_nodes(types, ignoring = [])
           return [] unless body
           return [] if ignoring.include?(body.type)
+
           body.each_node(types, ignoring | types)
         end
       end

data/lib/reek/cli/application.rb

@@ -3,6 +3,7 @@
 require_relative 'options'
 require_relative 'status'
 require_relative '../configuration/app_configuration'
+require_relative '../configuration/configuration_file_finder'
 require_relative '../source/source_locator'
 require_relative 'command/report_command'
 require_relative 'command/todo_list_command'
@@ -27,6 +28,7 @@ module Reek
       end
 
       def execute
+        show_configuration_path
         command.execute
       end
 
@@ -48,6 +50,29 @@ module Reek
         exit Status::DEFAULT_ERROR_EXIT_CODE
       end
 
+      def show_configuration_path
+        return unless options.show_configuration_path
+
+        path = Configuration::ConfigurationFileFinder.find(path: options.config_file)
+        if path
+          puts "Using '#{path_relative_to_working_directory(path)}' as configuration file."
+        else
+          puts 'Not using any configuration file.'
+        end
+      end
+
+      # Returns the path that is relative to the current working directory given an absolute path.
+      # E.g. if the given absolute path is "/foo/bar/baz/.reek.yml" and your working directory is
+      # "/foo/bar" this method would return "baz/.reek.yml"
+      #
+      # @param path [String] Absolute path
+      # @return [Pathname], e.g. 'config/.reek.yml'
+      #
+      # :reek:UtilityFunction
+      def path_relative_to_working_directory(path)
+        Pathname(path).realpath.relative_path_from(Pathname.pwd)
+      end
+
       def command_class
         options.generate_todo_list ? Command::TodoListCommand : Command::ReportCommand
       end

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

@@ -12,17 +12,19 @@ module Reek
       # file that can serve as a todo list.
       #
       class TodoListCommand < BaseCommand
-        FILE_NAME = '.todo.reek'
+        HEADER = "# Auto generated by Reeks --todo flag\n"
+        EXISTING_FILE_MESSAGE = "\nExisting '#{DEFAULT_CONFIGURATION_FILE_NAME}' detected - aborting.\n"
+        NO_SMELLS_FOUND_MESSAGE = "\nNo smells found - nothing to do, exiting.\n"
 
         def execute
           if smells.empty?
-            puts "\n'.todo.reek' not generated because "\
-                    'there were no smells found!'
+            puts NO_SMELLS_FOUND_MESSAGE
+          elsif File.exist?(DEFAULT_CONFIGURATION_FILE_NAME)
+            puts EXISTING_FILE_MESSAGE
           else
-            File.write FILE_NAME,
-                       { Configuration::AppConfiguration::DETECTORS_KEY => groups }.to_yaml
-            puts "\n'.todo.reek' generated! You can now use "\
-                    'this as a starting point for your configuration.'
+            write_to_file
+            puts "\n'#{DEFAULT_CONFIGURATION_FILE_NAME}' generated! "\
+              'You can now use this as a starting point.'
           end
           options.success_exit_code
         end
@@ -44,6 +46,14 @@ module Reek
               todos.inject(&:merge)
             end
         end
+
+        # :reek:FeatureEnvy
+        def write_to_file
+          File.open(DEFAULT_CONFIGURATION_FILE_NAME, 'w') do |configuration_file|
+            configuration_file.write HEADER
+            configuration_file.write({ DETECTORS_KEY => groups }.to_yaml)
+          end
+        end
       end
     end
   end

data/lib/reek/cli/options.rb

@@ -14,7 +14,7 @@ module Reek
     #
     # See {file:docs/Command-Line-Options.md} for details.
     #
-    # @quality :reek:TooManyInstanceVariables { max_instance_variables: 12 }
+    # @quality :reek:TooManyInstanceVariables { max_instance_variables: 13 }
     # @quality :reek:TooManyMethods { max_methods: 18 }
     # @quality :reek:Attribute { enabled: false }
     #
@@ -32,21 +32,23 @@ module Reek
                     :success_exit_code,
                     :failure_exit_code,
                     :generate_todo_list,
-                    :force_exclusion
+                    :force_exclusion,
+                    :show_configuration_path
 
       def initialize(argv = [])
-        @argv               = argv
-        @parser             = OptionParser.new
-        @report_format      = :text
-        @location_format    = :numbers
-        @progress_format    = tty_output? ? :dots : :quiet
-        @show_links         = true
-        @smells_to_detect   = []
-        @colored            = tty_output?
-        @success_exit_code  = Status::DEFAULT_SUCCESS_EXIT_CODE
-        @failure_exit_code  = Status::DEFAULT_FAILURE_EXIT_CODE
-        @generate_todo_list = false
-        @force_exclusion    = false
+        @argv                    = argv
+        @parser                  = OptionParser.new
+        @report_format           = :text
+        @location_format         = :numbers
+        @progress_format         = tty_output? ? :dots : :quiet
+        @show_links              = true
+        @smells_to_detect        = []
+        @colored                 = tty_output?
+        @success_exit_code       = Status::DEFAULT_SUCCESS_EXIT_CODE
+        @failure_exit_code       = Status::DEFAULT_FAILURE_EXIT_CODE
+        @generate_todo_list      = false
+        @force_exclusion         = false
+        @show_configuration_path = false
 
         set_up_parser
       end
@@ -153,6 +155,7 @@ module Reek
         end
       end
 
+      # @quality :reek:TooManyStatements { max_statements: 6 }
       def set_up_verbosity_options
         parser.on('-V', '--[no-]empty-headings',
                   'Show headings for smell-free source files (default: false)') do |show_empty|
@@ -162,6 +165,10 @@ module Reek
                   'Show link to related documentation page for each smell (default: true)') do |show_links|
           self.show_links = show_links
         end
+        parser.on(nil, '--[no-]show-configuration-path',
+                  'Show which configuration file Reek is using (default: false)') do |show_configuration_path|
+          self.show_configuration_path = show_configuration_path
+        end
       end
 
       def set_up_location_formatting_options

data/lib/reek/code_comment.rb

@@ -122,6 +122,7 @@ module Reek
 
       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,
@@ -142,6 +143,7 @@ module Reek
         @detector_class = SmellDetectors::BaseDetector.to_detector(detector_name)
 
         return if given_keys_legit?
+
         raise Errors::BadDetectorConfigurationKeyInCommentError, detector_name: detector_name,
                                                                  offensive_keys: configuration_keys_difference,
                                                                  original_comment: original_comment,

data/lib/reek/configuration/app_configuration.rb

@@ -15,9 +15,6 @@ module Reek
     # @public
     class AppConfiguration
       include ConfigurationValidator
-      EXCLUDE_PATHS_KEY = 'exclude_paths'
-      DIRECTORIES_KEY = 'directories'
-      DETECTORS_KEY = 'detectors'
 
       # Instantiate a configuration via the given path.
       #

data/lib/reek/configuration/configuration_converter.rb

@@ -71,9 +71,9 @@ module Reek
       # @quality :reek:NestedIterators { max_allowed_nesting: 3 }
       # @quality :reek:TooManyStatements { max_statements: 6 }
       def strings_to_regexes_for_detectors
-        return unless configuration[AppConfiguration::DETECTORS_KEY]
+        return unless configuration[DETECTORS_KEY]
 
-        configuration[AppConfiguration::DETECTORS_KEY].tap do |detectors|
+        configuration[DETECTORS_KEY].tap do |detectors|
           detectors.keys.each do |detector|
             convertible_attributes(detectors[detector]).each do |attribute|
               detectors[detector][attribute] = detectors[detector][attribute].map do |item|
@@ -91,9 +91,9 @@ module Reek
       # @quality :reek:NestedIterators { max_allowed_nesting: 4 }
       # @quality :reek:TooManyStatements { max_statements: 7 }
       def strings_to_regexes_for_directories
-        return unless configuration[AppConfiguration::DIRECTORIES_KEY]
+        return unless configuration[DIRECTORIES_KEY]
 
-        configuration[AppConfiguration::DIRECTORIES_KEY].tap do |directories|
+        configuration[DIRECTORIES_KEY].tap do |directories|
           directories.keys.each do |directory|
             directories[directory].each do |detector, configuration|
               convertible_attributes(configuration).each do |attribute|

data/lib/reek/configuration/directory_directives.rb

@@ -17,6 +17,7 @@ module Reek
       # @return [Hash | nil] the configuration for the source or nil
       def directive_for(source_via)
         return unless source_via
+
         source_base_dir = Pathname.new(source_via).dirname
         hit = best_match_for source_base_dir
         self[hit]

data/lib/reek/configuration/schema_validator.rb

@@ -24,6 +24,7 @@ module Reek
       def validate
         errors = CLI::Silencer.without_warnings { @validator.validate @configuration }
         return if !errors || errors.empty?
+
         raise Errors::ConfigFileError, error_message(errors)
       end
 

data/lib/reek/context/method_context.rb

@@ -81,6 +81,7 @@ module Reek
         own = super
         return own unless own.empty?
         return parent_exp.full_comment if parent_exp
+
         ''
       end
 

data/lib/reek/context/module_context.rb

@@ -26,7 +26,7 @@ module Reek
       #
       # @param child [CodeContext] the child context to register
       def append_child_context(child)
-        visibility_tracker.set_child_visibility(child)
+        visibility_tracker.apply_visibility(child)
         super
       end
 
@@ -44,9 +44,9 @@ module Reek
       end
 
       def defined_instance_methods(visibility: :any)
-        instance_method_children.select do |context|
-          visibility == :any || context.visibility == visibility
-        end
+        return instance_method_children if visibility == :any
+
+        instance_method_children.select { |child| child.visibility == visibility }
       end
 
       def instance_method_calls
@@ -76,6 +76,7 @@ module Reek
       # @quality :reek:FeatureEnvy
       def namespace_module?
         return false if exp.type == :casgn
+
         children = exp.direct_children
         children.any? && children.all? { |child| [:casgn, :class, :module].include? child.type }
       end

data/lib/reek/context/visibility_tracker.rb

@@ -22,6 +22,7 @@ module Reek
       #
       def track_visibility(children:, visibility:, names:)
         return unless VISIBILITY_MODIFIERS.include? visibility
+
         if names.any?
           children.each do |child|
             child.visibility = visibility if names.include?(child.name)
@@ -44,17 +45,19 @@ module Reek
       #
       def track_singleton_visibility(children:, visibility:, names:)
         return if names.empty?
+
         visibility = VISIBILITY_MAP[visibility]
         return unless visibility
+
         track_visibility children: children, visibility: visibility, names: names
       end
 
-      # Sets the visibility of a child CodeContext to the tracked visibility.
+      # Sets the visibility of a CodeContext to the tracked visibility.
       #
-      # @param child [CodeContext]
+      # @param context [CodeContext]
       #
-      def set_child_visibility(child)
-        child.apply_current_visibility tracked_visibility
+      def apply_visibility(context)
+        context.apply_current_visibility tracked_visibility
       end
 
       private

data/lib/reek/context_builder.rb

@@ -521,6 +521,7 @@ module Reek
 
     def register_attributes(exp)
       return unless exp.attribute_writer?
+
       klass = current_context.attribute_context_class
       exp.args.each do |arg|
         append_new_context(klass, arg, exp)

data/lib/reek/detector_repository.rb

@@ -26,6 +26,7 @@ module Reek
     #         e.g. [Reek::SmellDetectors::Attribute].
     def self.eligible_smell_types(filter_by_smells = [])
       return smell_types if filter_by_smells.empty?
+
       smell_types.select do |klass|
         filter_by_smells.include? klass.smell_type
       end

data/lib/reek/errors/incomprehensible_source_error.rb

@@ -17,8 +17,8 @@ module Reek
         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 this entire error message, including the original exception below.
 
         Exception message:
 

data/lib/reek/errors/syntax_error.rb

@@ -15,6 +15,10 @@ module Reek
         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.
 
+        Things you can try:
+        - Check the syntax of the problematic file
+        - If the file is not in fact a Ruby file, exclude it in your .reek.yml file
+
         Exception message:
 
         %<exception>s

data/lib/reek/examiner.rb

@@ -95,6 +95,7 @@ module Reek
       end
     rescue StandardError => exception
       raise unless @error_handler.handle exception
+
       []
     end
 

data/lib/reek/report/text_report.rb

@@ -43,6 +43,7 @@ module Reek
 
       def display_total_smell_count
         return unless examiners.size > 1
+
         print total_smell_count_message
       end