reek 5.0.2 → 5.1.0

data/features/configuration_files/show_configuration_file.feature

@@ -0,0 +1,44 @@
+Feature: Show configuration file
+  With Reeks dynamic mechanism of finding a configuration file you might run into a situation where you are not
+  100% sure what configuration file Reek is using. E.g. you have a project specific configuration file in your
+  project root and also another Reek configuration in your HOME directory that you use for all your other projects
+  and for whatever reasons Reek seems to be using another configuration file than the one you assumed it would.
+  In this case you can pass the flag `--show-configuration-path` to Reek which will cause Reek to output the path
+  to the configuration file it is using.
+
+  Scenario: Default configuration file present
+    Given the clean file "clean.rb"
+    And an empty file named ".reek.yml"
+    When I run reek --show-configuration-path clean.rb
+    Then it reports:
+      """
+      Using '.reek.yml' as configuration file.
+      """
+
+  Scenario: Non-default configuration file passed via CLI
+    Given the clean file "clean.rb"
+    And an empty file named "config.reek"
+    When I run reek --show-configuration-path -c config.reek clean.rb
+    Then it reports:
+      """
+      Using 'config.reek' as configuration file.
+      """
+
+  Scenario: Display the right configuration file even when there are multiple files present
+    Given the clean file "clean.rb"
+    And an empty file named ".reek.yml"
+    And an empty file named "config.reek"
+    When I run reek --show-configuration-path -c config.reek clean.rb
+    Then it reports:
+      """
+      Using 'config.reek' as configuration file.
+      """
+
+  Scenario: Use configuration file we find when traversing up the directory tree
+    Given the clean file "clean.rb"
+    And with a configuration file that is further up in the directory tree
+    When I run reek --show-configuration-path clean.rb
+    Then it reports:
+      """
+      Using '../../.reek.yml' as configuration file.
+      """

data/features/rake_task/rake_task.feature

@@ -117,7 +117,7 @@ Feature: Reek can be driven through its Task
 
   Scenario: REEK_SRC overrides the files to check
     Given the smelly file 'smelly.rb'
-    And the clean file 'clean.rb'
+    And the clean file "clean.rb"
     And a file "Rakefile" with:
       """
       require 'reek/rake/task'

data/features/reports/json.feature

@@ -24,7 +24,7 @@ Feature: Report smells using simple JSON layout
               "context": "Smelly#x",
               "lines": [ 4 ],
               "message": "has the name 'x'",
-              "documentation_link": "https://github.com/troessner/reek/blob/v5.0.2/docs/Uncommunicative-Method-Name.md",
+              "documentation_link": "https://github.com/troessner/reek/blob/v5.1.0/docs/Uncommunicative-Method-Name.md",
               "name": "x"
           },
           {
@@ -33,7 +33,7 @@ Feature: Report smells using simple JSON layout
               "context": "Smelly#x",
               "lines": [ 5 ],
               "message": "has the variable name 'y'",
-              "documentation_link": "https://github.com/troessner/reek/blob/v5.0.2/docs/Uncommunicative-Variable-Name.md",
+              "documentation_link": "https://github.com/troessner/reek/blob/v5.1.0/docs/Uncommunicative-Variable-Name.md",
               "name": "y"
           }
       ]
@@ -53,7 +53,7 @@ Feature: Report smells using simple JSON layout
                   1
               ],
               "message": "has no descriptive comment",
-              "documentation_link": "https://github.com/troessner/reek/blob/v5.0.2/docs/Irresponsible-Module.md"
+              "documentation_link": "https://github.com/troessner/reek/blob/v5.1.0/docs/Irresponsible-Module.md"
           }
       ]
       """

data/features/reports/reports.feature

@@ -182,8 +182,8 @@ Feature: Correctly formatted reports
     And it reports:
       """
       smelly.rb -- 2 warnings:
-        [4]:UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/v5.0.2/docs/Uncommunicative-Method-Name.md]
-        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v5.0.2/docs/Uncommunicative-Variable-Name.md]
+        [4]:UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/v5.1.0/docs/Uncommunicative-Method-Name.md]
+        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v5.1.0/docs/Uncommunicative-Variable-Name.md]
       """
 
     Examples:
@@ -209,8 +209,8 @@ Feature: Correctly formatted reports
     And it reports:
       """
       smelly.rb -- 2 warnings:
-        UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/v5.0.2/docs/Uncommunicative-Method-Name.md]
-        UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v5.0.2/docs/Uncommunicative-Variable-Name.md]
+        UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/v5.1.0/docs/Uncommunicative-Method-Name.md]
+        UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v5.1.0/docs/Uncommunicative-Variable-Name.md]
       """
 
     Examples:

data/features/reports/yaml.feature

@@ -25,7 +25,7 @@ Feature: Report smells using simple YAML layout
         smell_type: UncommunicativeMethodName
         source: smelly.rb
         name: x
-        documentation_link: https://github.com/troessner/reek/blob/v5.0.2/docs/Uncommunicative-Method-Name.md
+        documentation_link: https://github.com/troessner/reek/blob/v5.1.0/docs/Uncommunicative-Method-Name.md
       - context: Smelly#x
         lines:
         - 5
@@ -33,7 +33,7 @@ Feature: Report smells using simple YAML layout
         smell_type: UncommunicativeVariableName
         source: smelly.rb
         name: y
-        documentation_link: https://github.com/troessner/reek/blob/v5.0.2/docs/Uncommunicative-Variable-Name.md
+        documentation_link: https://github.com/troessner/reek/blob/v5.1.0/docs/Uncommunicative-Variable-Name.md
       """
 
   Scenario: Indicate smells and print them as yaml when using STDIN
@@ -48,5 +48,5 @@ Feature: Report smells using simple YAML layout
         lines:
         - 1
         message: has no descriptive comment
-        documentation_link: https://github.com/troessner/reek/blob/v5.0.2/docs/Irresponsible-Module.md
+        documentation_link: https://github.com/troessner/reek/blob/v5.1.0/docs/Irresponsible-Module.md
       """

data/features/rspec_matcher.feature

@@ -7,6 +7,7 @@ Feature: Use reek_of matcher
     Given the smelly file 'smelly.rb'
     And a file "reek_spec.rb" with:
     """
+    require 'reek'
     require 'reek/spec'
 
     describe 'smelly.rb' do

data/features/step_definitions/sample_file_steps.rb

@@ -4,8 +4,8 @@ Given(/^the smelly file '(.+)'$/) do |filename|
   write_file(filename, SAMPLES_DIR.join('smelly_source').join(filename).read)
 end
 
-Given(/^the clean file 'clean.rb'$/) do
-  write_file('clean.rb', CLEAN_FILE.read)
+Given(/^the clean file "(.*)"$/) do |filename|
+  write_file(filename, CLEAN_FILE.read)
 end
 
 Given(/^a directory called 'clean' containing two clean files$/) do
@@ -48,12 +48,10 @@ When(/^I run "reek (.*?)" in a subdirectory$/) do |args|
   reek(args)
 end
 
-Given(/^a configuration file '(.+)' in a subdirectory$/) do |filename|
-  contents = CONFIGURATION_DIR.join(filename).read
-
-  write_file("subdir/#{filename}", contents)
-end
-
 Then(/^it does not report private or protected methods$/) do
   # Pseudo step for feature clarity.
 end
+
+Given('with a configuration file that is further up in the directory tree') do
+  # Pseudo step for feature clarity. We have an empty .reek.yml in our root directory already.
+end

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

@@ -6,3 +6,10 @@
 require_relative 'reek/version'
 require_relative 'reek/examiner'
 require_relative 'reek/report'
+
+module Reek
+  DEFAULT_CONFIGURATION_FILE_NAME = '.reek.yml'
+  DETECTORS_KEY = 'detectors'
+  EXCLUDE_PATHS_KEY = 'exclude_paths'
+  DIRECTORIES_KEY = 'directories'
+end

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/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

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