reek 4.8.2 → 5.0.0

data/features/reports/yaml.feature

@@ -25,6 +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.0/docs/Uncommunicative-Method-Name.md
       - context: Smelly#x
         lines:
         - 5
@@ -32,6 +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.0/docs/Uncommunicative-Variable-Name.md
       """
 
   Scenario: Indicate smells and print them as yaml when using STDIN
@@ -46,4 +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.0/docs/Irresponsible-Module.md
       """

data/features/rspec_matcher.feature

@@ -24,7 +24,15 @@ Feature: Use reek_of matcher
     """
 
   Scenario: Masking smells with a configuration file
-    Given a configuration file 'full_mask.reek'
+    Given a file named ".reek.yml" with:
+      """
+      ---
+      detectors:
+        UncommunicativeMethodName:
+          enabled: false
+        UncommunicativeVariableName:
+          enabled: false
+      """
     When I run `rspec reek_spec.rb`
     Then stdout should contain:
     """

data/features/step_definitions/reek_steps.rb

@@ -6,6 +6,10 @@ When /^I pass "([^\"]*)" to reek *(.*)$/ do |stdin, args|
   reek_with_pipe(stdin, args)
 end
 
+When /^I pass a stdin to reek *(.*) with:$/ do |args, stdin|
+  reek_with_pipe(stdin, args)
+end
+
 Then /^it reports nothing$/ do
   expect(last_command_started).to have_output_on_stdout('')
 end

data/features/step_definitions/sample_file_steps.rb

@@ -1,7 +1,7 @@
 require_relative '../../samples/paths'
 
 Given(/^the smelly file '(.+)'$/) do |filename|
-  write_file(filename, SAMPLES_PATH.join(filename).read)
+  write_file(filename, SAMPLES_DIR.join('smelly_source').join(filename).read)
 end
 
 Given(/^the clean file 'clean.rb'$/) do
@@ -28,13 +28,18 @@ Given(/^a directory called 'smelly' containing two smelly files$/) do
 end
 
 Given(/^the smelly file '(.+)' in a subdirectory$/) do |filename|
-  contents = SAMPLES_PATH.join(filename).read
+  contents = SAMPLES_DIR.join('smelly_source').join(filename).read
 
   write_file("subdir/#{filename}", contents)
 end
 
 Given(/^a configuration file '(.+)'$/) do |filename|
-  write_file(filename, CONFIG_PATH.join(filename).read)
+  write_file(filename, CONFIGURATION_DIR.join(filename).read)
+end
+
+Given(/^our default configuration file$/) do
+  default_configuration = File.read SAMPLES_DIR.join('..').join('docs').join('defaults.reek.yml')
+  write_file('defaults.reek', default_configuration)
 end
 
 When(/^I run "reek (.*?)" in a subdirectory$/) do |args|
@@ -44,7 +49,7 @@ When(/^I run "reek (.*?)" in a subdirectory$/) do |args|
 end
 
 Given(/^a configuration file '(.+)' in a subdirectory$/) do |filename|
-  contents = CONFIG_PATH.join(filename).read
+  contents = CONFIGURATION_DIR.join(filename).read
 
   write_file("subdir/#{filename}", contents)
 end

data/features/support/env.rb

@@ -13,11 +13,11 @@ end
 #
 class ReekWorld
   def reek(args)
-    run_simple("reek --no-color --no-wiki-links #{args}", false)
+    run_simple("reek --no-color --no-documentation #{args}", false)
   end
 
   def reek_with_pipe(stdin, args)
-    run "reek --no-color --no-wiki-links #{args}"
+    run "reek --no-color --no-documentation #{args}"
     type(stdin)
     close_input
   end

data/features/todo_list.feature

@@ -29,13 +29,14 @@ Feature: Auto-generate a todo file
     And the file ".todo.reek" should contain:
       """
       ---
-      UncommunicativeMethodName:
-        exclude:
-        - Smelly#x
-      UncommunicativeVariableName:
-        exclude:
-        - Smelly#x
-        """
+      detectors:
+        UncommunicativeMethodName:
+          exclude:
+          - Smelly#x
+        UncommunicativeVariableName:
+          exclude:
+          - Smelly#x
+      """
     When I run reek -c .todo.reek smelly.rb
     Then it succeeds
 
@@ -54,10 +55,11 @@ Feature: Auto-generate a todo file
     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
+      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
     Then it reports:
@@ -77,8 +79,9 @@ Feature: Auto-generate a todo file
       ---
       # smelly.rb reeks of UncommunicativeMethodName and UncommunicativeVariableName
       # so the configuration below will partially mask this
-      UncommunicativeMethodName:
-        enabled: false
+      detectors:
+        UncommunicativeMethodName:
+          enabled: false
       """
     When I run reek -c config.reek smelly.rb
     Then it reports:

data/lib/reek/ast/node.rb

@@ -1,10 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../cli/silencer'
-
-Reek::CLI::Silencer.silently do
-  require 'parser'
-end
+Reek::CLI::Silencer.without_warnings { require 'parser' }
 
 module Reek
   module AST
@@ -72,8 +69,8 @@ module Reek
         each_node(target_type).any?
       end
 
-      # :reek:DuplicateMethodCall { max_calls: 2 } is ok for lines.first
-      # :reek:FeatureEnvy
+      # @quality :reek:DuplicateMethodCall { max_calls: 2 } is ok for lines.first
+      # @quality :reek:FeatureEnvy
       def format_to_ruby
         if location
           lines = location.expression.source.split("\n").map(&:strip)

data/lib/reek/ast/object_refs.rb

@@ -50,7 +50,7 @@ module Reek
       end
 
       def self_is_max?
-        refs.empty? || most_popular.keys.include?(:self)
+        refs.empty? || most_popular.key?(:self)
       end
 
       private

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

@@ -9,7 +9,7 @@ module Reek
           children.first
         end
 
-        # :reek:FeatureEnvy
+        # @quality :reek:FeatureEnvy
         def body_nodes(type, ignoring = [])
           children[1..-1].compact.flat_map do |child|
             if ignoring.include? child.type

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

@@ -57,7 +57,7 @@ module Reek
         end
 
         def depends_on_instance?
-          ReferenceCollector.new(self).num_refs_to_self > 0
+          ReferenceCollector.new(self).num_refs_to_self.positive?
         end
       end
 

data/lib/reek/cli/application.rb

@@ -6,6 +6,7 @@ require_relative '../configuration/app_configuration'
 require_relative '../source/source_locator'
 require_relative 'command/report_command'
 require_relative 'command/todo_list_command'
+require_relative '../errors/config_file_error'
 
 module Reek
   module CLI
@@ -42,7 +43,7 @@ module Reek
 
       def configure_app_configuration(config_file)
         Configuration::AppConfiguration.from_path(config_file)
-      rescue Reek::Configuration::ConfigFileException => error
+      rescue Errors::ConfigFileError => error
         warn "Error: #{error}"
         exit Status::DEFAULT_ERROR_EXIT_CODE
       end
@@ -68,7 +69,7 @@ module Reek
         options.argv
       end
 
-      # :reek:UtilityFunction
+      # @quality :reek:UtilityFunction
       def input_was_piped?
         !$stdin.tty?
       end
@@ -88,7 +89,7 @@ module Reek
       end
 
       def source_from_pipe
-        [$stdin]
+        [Source::SourceCode.from($stdin, origin: options.stdin_filename)]
       end
 
       def disable_progress_output_unless_verbose

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

@@ -38,7 +38,6 @@ module Reek
           @reporter ||=
             report_class.new(
               warning_formatter: warning_formatter,
-              report_formatter: Report::Formatter,
               sort_by_issue_count: sort_by_issue_count,
               heading_formatter: heading_formatter,
               progress_formatter: progress_formatter.new(sources.length))
@@ -53,7 +52,7 @@ module Reek
         end
 
         def warning_formatter_class
-          Report.warning_formatter_class(options.show_links ? :wiki_links : :simple)
+          Report.warning_formatter_class(options.show_links ? :documentation_links : :simple)
         end
 
         def location_formatter

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

@@ -2,6 +2,7 @@
 
 require_relative 'base_command'
 require_relative '../../examiner'
+require_relative '../../configuration/app_configuration'
 
 module Reek
   module CLI
@@ -11,14 +12,15 @@ module Reek
       # file that can serve as a todo list.
       #
       class TodoListCommand < BaseCommand
-        FILE_NAME = '.todo.reek'.freeze
+        FILE_NAME = '.todo.reek'
 
         def execute
           if smells.empty?
             puts "\n'.todo.reek' not generated because "\
                     'there were no smells found!'
           else
-            File.write FILE_NAME, groups.to_yaml
+            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.'
           end

data/lib/reek/cli/options.rb

@@ -4,6 +4,7 @@ require 'optparse'
 require 'rainbow'
 require_relative '../version'
 require_relative 'status'
+require_relative '../detector_repository'
 require_relative '../documentation_link'
 
 module Reek
@@ -13,9 +14,9 @@ module Reek
     #
     # See {file:docs/Command-Line-Options.md} for details.
     #
-    # :reek:TooManyInstanceVariables: { max_instance_variables: 12 }
-    # :reek:TooManyMethods: { max_methods: 18 }
-    # :reek:Attribute: { enabled: false }
+    # @quality :reek:TooManyInstanceVariables { max_instance_variables: 12 }
+    # @quality :reek:TooManyMethods { max_methods: 18 }
+    # @quality :reek:Attribute { enabled: false }
     #
     class Options
       attr_reader :argv, :parser, :smells_to_detect
@@ -27,6 +28,7 @@ module Reek
                     :show_empty,
                     :show_links,
                     :sorting,
+                    :stdin_filename,
                     :success_exit_code,
                     :failure_exit_code,
                     :generate_todo_list,
@@ -65,12 +67,12 @@ module Reek
       # processing by a machine, but will be viewed by a human. This means
       # features like coloring can be safely enabled by default.
       #
-      # :reek:UtilityFunction
+      # @quality :reek:UtilityFunction
       def tty_output?
         $stdout.tty?
       end
 
-      # :reek:TooManyStatements: { max_statements: 7 }
+      # @quality :reek:TooManyStatements { max_statements: 7 }
       def set_up_parser
         set_banner
         set_configuration_options
@@ -92,12 +94,12 @@ module Reek
           #{program_name} -s lib
           cat my_class.rb | #{program_name}
 
-          See https://wiki.github.com/troessner/reek for detailed help.
+          See https://github.com/troessner/reek for detailed help.
 
         BANNER
       end
 
-      # :reek:TooManyStatements: { max_statements: 6 }
+      # @quality :reek:TooManyStatements { max_statements: 7 }
       def set_configuration_options
         parser.separator 'Configuration:'
         parser.on('-c', '--config FILE', 'Read configuration options from FILE') do |file|
@@ -105,11 +107,16 @@ module Reek
         end
         parser.on('--smell SMELL',
                   'Only look for a specific smell.',
-                  'Call it like this: reek --smell PrimaDonnaMethod source.rb',
+                  'Call it like this: reek --smell MissingSafeMethod source.rb',
                   "Check out #{DocumentationLink.build('Code Smells')} "\
                   'for a list of smells') do |smell|
           smells_to_detect << smell
         end
+        parser.on('--stdin-filename FILE',
+                  'When passing code in via pipe, assume this filename when '\
+                  'checking file or directory rules in the config.') do |file|
+          self.stdin_filename = file
+        end
       end
 
       def set_generate_todo_list_options
@@ -129,7 +136,7 @@ module Reek
         end
       end
 
-      # :reek:TooManyStatements: { max_statements: 7 }
+      # @quality :reek:TooManyStatements { max_statements: 7 }
       def set_report_formatting_options
         parser.separator "\nText format options:"
         set_up_color_option
@@ -151,8 +158,8 @@ module Reek
                   'Show headings for smell-free source files (default: false)') do |show_empty|
           self.show_empty = show_empty
         end
-        parser.on('-U', '--[no-]wiki-links',
-                  'Show link to related wiki page for each smell (default: true)') do |show_links|
+        parser.on('-U', '--[no-]documentation',
+                  'Show link to related documentation page for each smell (default: true)') do |show_links|
           self.show_links = show_links
         end
       end
@@ -192,7 +199,7 @@ module Reek
         end
       end
 
-      # :reek:DuplicateMethodCall: { max_calls: 2 }
+      # @quality :reek:DuplicateMethodCall { max_calls: 2 }
       def set_exit_codes
         parser.separator "\nExit codes:"
         parser.on('--success-exit-code CODE',
@@ -207,13 +214,20 @@ module Reek
         end
       end
 
-      # :reek:TooManyStatements: { max_statements: 7 }
+      # @quality :reek:TooManyStatements { max_statements: 12 }
       def set_utility_options
         parser.separator "\nUtility options:"
         parser.on_tail('-h', '--help', 'Show this message') do
           puts parser
           exit
         end
+        parser.on_tail('-l', '--list', 'List all available smell detectors') do
+          puts "All available smell detectors:\n\n"
+          puts DetectorRepository.available_detector_names
+          puts "\nCheck out #{DocumentationLink.build('Code Smells')} "\
+                  'for a details on each detector'
+          exit
+        end
         parser.on_tail('-v', '--version', 'Show version') do
           puts "#{parser.program_name} #{Reek::Version::STRING}\n"
           exit

data/lib/reek/cli/silencer.rb

@@ -8,17 +8,28 @@ module Reek
     module Silencer
       module_function
 
-      # :reek:TooManyStatements: { max_statements: 7 }
+      # @quality :reek:TooManyStatements { max_statements: 9 }
       def silently
         old_verbose = $VERBOSE
+        old_stderr = $stderr
+        old_stdout = $stdout
+
         $VERBOSE = false
         $stderr = StringIO.new
         $stdout = StringIO.new
         yield
       ensure
         $VERBOSE = old_verbose
-        $stderr = STDERR
-        $stdout = STDOUT
+        $stderr = old_stderr
+        $stdout = old_stdout
+      end
+
+      def without_warnings
+        old_verbose = $VERBOSE
+        $VERBOSE = false
+        yield
+      ensure
+        $VERBOSE = old_verbose
       end
     end
   end

data/lib/reek/code_comment.rb

@@ -17,22 +17,20 @@ module Reek
                           :reek: # prefix
                           (\w+)  # smell detector e.g.: UncommunicativeVariableName
                           (
-                            :? # legacy separator
                             \s*
                             (\{.*?\}) # optional details in hash style e.g.: { max_methods: 30 }
                           )?
                          /x
     SANITIZE_REGEX                 = /(#|\n|\s)+/ # Matches '#', newlines and > 1 whitespaces.
-    DISABLE_DETECTOR_CONFIGURATION = '{ enabled: false }'.freeze
+    DISABLE_DETECTOR_CONFIGURATION = '{ enabled: false }'
     MINIMUM_CONTENT_LENGTH         = 2
-    LEGACY_SEPARATOR               = ':'.freeze
 
     attr_reader :config
 
     #
-    # @param 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 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"
     #
     def initialize(comment:, line: nil, source: nil)
       @original_comment  = comment
@@ -80,15 +78,15 @@ module Reek
     # This class validates [1], [2] and [3] at the moment but will also validate
     # [4] in the future.
     #
-    # :reek:TooManyInstanceVariables: { max_instance_variables: 7 }
+    # @quality :reek:TooManyInstanceVariables { max_instance_variables: 7 }
     class CodeCommentValidator
       #
-      # @param detector_name [String] - the detector class that was parsed out of the original
+      # @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
+      # @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
@@ -151,24 +149,24 @@ module Reek
                                                                  line: line
       end
 
-      # @return [Boolean] - all keys in code comment are applicable to the detector in question
+      # @return [Boolean] all keys in code comment are applicable to the detector in question
       def given_keys_legit?
         given_configuration_keys.subset? valid_detector_keys
       end
 
-      # @return [Set] - the configuration keys that are found in the code comment
+      # @return [Set] the configuration keys that are found in the code comment
       def given_configuration_keys
         parsed_options.keys.map(&:to_sym).to_set
       end
 
-      # @return [String] - all keys from the code comment that look bad
+      # @return [String] all keys from the code comment that look bad
       def configuration_keys_difference
         given_configuration_keys.difference(valid_detector_keys).
           to_a.map { |key| "'#{key}'" }.
           join(', ')
       end
 
-      # @return [Set] - all keys that are legit for the given detector
+      # @return [Set] all keys that are legit for the given detector
       def valid_detector_keys
         detector_class.configuration_keys
       end