reek 4.7.1 → 5.0.0

data/features/step_definitions/reek_steps.rb

@@ -6,8 +6,8 @@ When /^I pass "([^\"]*)" to reek *(.*)$/ do |stdin, args|
   reek_with_pipe(stdin, args)
 end
 
-When /^I run rake (\w*) with:$/ do |name, task_def|
-  rake(name, task_def)
+When /^I pass a stdin to reek *(.*) with:$/ do |args, stdin|
+  reek_with_pipe(stdin, args)
 end
 
 Then /^it reports nothing$/ do

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,23 +13,14 @@ end
 #
 class ReekWorld
   def reek(args)
-    run_simple("reek --no-color #{args}", false)
+    run_simple("reek --no-color --no-documentation #{args}", false)
   end
 
   def reek_with_pipe(stdin, args)
-    run "reek --no-color #{args}"
+    run "reek --no-color --no-documentation #{args}"
     type(stdin)
     close_input
   end
-
-  def rake(name, task_def)
-    header = <<-EOS.strip_heredoc
-      require 'reek/rake/task'
-
-    EOS
-    write_file 'Rakefile', header + task_def
-    run_simple("rake #{name}", false)
-  end
 end
 
 World do

data/features/todo_list.feature

@@ -15,8 +15,8 @@ Feature: Auto-generate a todo file
     And it reports:
       """
       smelly.rb -- 2 warnings:
-        [4]:UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Method-Name.md]
-        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Variable-Name.md]
+        [4]:UncommunicativeMethodName: Smelly#x has the name 'x'
+        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
       """
     When I run reek --todo smelly.rb
     Then it succeeds
@@ -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,20 +55,21 @@ 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`
+    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]
+        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
       """
-    When I run `reek --todo smelly.rb`
+    When I run reek --todo smelly.rb
     Then it succeeds
-    When I run `reek -c .todo.reek smelly.rb`
+    When I run reek -c .todo.reek smelly.rb
     Then it reports nothing
 
   Scenario: Ignore existing other configuration files that are passed explicitly
@@ -77,16 +79,17 @@ 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`
+    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]
+        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
       """
-    When I run `reek -c config.reek --todo smelly.rb`
+    When I run reek -c config.reek --todo smelly.rb
     Then it succeeds
-    When I run `reek -c .todo.reek smelly.rb`
+    When I run reek -c .todo.reek smelly.rb
     Then it reports nothing

data/lib/reek/ast/builder.rb

@@ -6,7 +6,7 @@ module Reek
     # An AST Builder for ruby parser.
     #
     class Builder < ::Parser::Builders::Default
-      # This is a work around for parsing ruby code that has a string with invliad sequence as UTF-8.
+      # This is a work around for parsing ruby code that has a string with invalid sequence as UTF-8.
       # See. https://github.com/whitequark/parser/issues/283
       def string_value(token)
         value(token)

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
@@ -12,11 +9,8 @@ module Reek
     # methods to ease the transition from Sexp to AST::Node.
     #
     class Node < ::Parser::AST::Node
-      attr_reader :parent
-
       def initialize(type, children = [], options = {})
         @comments = options.fetch(:comments, [])
-        @parent   = options.fetch(:parent, nil)
         super
       end
 
@@ -36,59 +30,47 @@ module Reek
         loc && loc.line
       end
 
+      def name
+        to_s
+      end
+
       #
-      # Carries out a depth-first traversal of this syntax tree, yielding
-      # every Sexp of type `target_type`. The traversal ignores any node
-      # whose type is listed in the Array `ignoring`.
-      # Takes a block as well.
-      #
-      # target_type - the type to look for, e.g. :send, :block
-      # ignoring - types to ignore, e.g. [:casgn, :class, :module]
-      # blk - block to execute for every hit. Gets passed in the matching element itself.
+      # Carries out a depth-first traversal of this syntax tree, yielding every
+      # Sexp of the searched for type or types. The traversal stops at any node
+      # whose type is listed in `ignoring`.
       #
-      # Examples:
-      #   context.each_node(:send, [:mlhs]) do |call_node| .... end
-      #   context.each_node(:lvar).any? { |it| it.var_name == 'something' }
+      # If a type is searched for *and* listed in ignoring, it will be yielded
+      # but traversal will not continue to its children.
       #
-      # Returns an array with all matching nodes.
-      # TODO: without a block, this doesn't do what one might expect
-      def each_node(target_type, ignoring = [], &blk)
-        if block_given?
-          look_for_type(target_type, ignoring, &blk)
-        else
-          result = []
-          look_for_type(target_type, ignoring) { |exp| result << exp }
-          result
-        end
-      end
-
+      # If the root's type is ignored, traversal does not stop, unless the root
+      # is of a target type.
       #
-      # Carries out a depth-first traversal of this syntax tree, yielding
-      # every Sexp of type `target_type`. The traversal ignores any node
-      # whose type is listed in the Array `ignoring`, including the top node.
       # Takes a block as well.
       #
-      # target_types - the types to look for, e.g. [:send, :block]
-      # ignoring - types to ignore, e.g. [:casgn, :class, :module]
-      # blk - block to execute for every hit
+      # @param target_types [Symbol, Array<Symbol>] the type or types to look
+      #     for
+      # @param ignoring [Array<Symbol>] types to ignore
+      # @param blk block to execute for every hit. Gets passed in the
+      #     matching element itself.
       #
-      # Examples:
-      #   exp.find_nodes([:block]).flat_map do |elem| ... end
+      # @example
+      #   node.each_node(:send, [:mlhs]) do |call_node| .... end
+      #   node.each_node(:lvar).any? { |it| it.var_name == 'something' }
+      #   node.each_node([:block]).flat_map do |elem| ... end
       #
       # Returns an array with all matching nodes.
-      def find_nodes(target_types, ignoring = [])
-        result = []
-        look_for_types(target_types, ignoring) { |exp| result << exp }
-        result
+      def each_node(target_types, ignoring = [], &blk)
+        return enum_for(:each_node, target_types, ignoring) unless block_given?
+
+        look_for(Array(target_types), ignoring, &blk)
       end
 
       def contains_nested_node?(target_type)
-        look_for_type(target_type) { |_elem| return true }
-        false
+        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)
@@ -123,22 +105,22 @@ module Reek
       protected
 
       # See ".each_node" for documentation.
-      def look_for_type(target_type, ignoring = [], &blk)
+      def look_for(target_types, ignoring, &blk)
+        if target_types.include? type
+          yield self
+          return if ignoring.include?(type)
+        end
         each_sexp do |elem|
-          elem.look_for_type(target_type, ignoring, &blk) unless ignoring.include?(elem.type)
+          elem.look_for_recurse(target_types, ignoring, &blk)
         end
-        yield self if type == target_type
       end
 
-      # See ".find_nodes" for documentation.
-      def look_for_types(target_types, ignoring = [], &blk)
-        return if ignoring.include?(type)
-        if target_types.include? type
-          yield self
-        else
-          each_sexp do |elem|
-            elem.look_for_types(target_types, ignoring, &blk)
-          end
+      # See ".each_node" for documentation.
+      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
       end
 

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

@@ -12,7 +12,7 @@ module Reek
       end
 
       def num_refs_to_self
-        (explicit_self_calls + implicit_self_calls).size
+        (explicit_self_calls.to_a + implicit_self_calls.to_a).size
       end
 
       private
@@ -20,9 +20,7 @@ module Reek
       attr_reader :ast
 
       def explicit_self_calls
-        [:self, :super, :zsuper, :ivar, :ivasgn].flat_map do |node_type|
-          ast.each_node(node_type)
-        end
+        ast.each_node([:self, :super, :zsuper, :ivar, :ivasgn])
       end
 
       def implicit_self_calls

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

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

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

@@ -9,8 +9,15 @@ module Reek
           children.first
         end
 
+        # @quality :reek:FeatureEnvy
         def body_nodes(type, ignoring = [])
-          children[1..-1].compact.flat_map { |child| child.find_nodes(type, ignoring) }
+          children[1..-1].compact.flat_map do |child|
+            if ignoring.include? child.type
+              []
+            else
+              child.each_node(type, ignoring).to_a
+            end
+          end
         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].find_nodes type, ignoring
+          children[1].each_node type, ignoring
         end
       end
 

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

@@ -30,11 +30,9 @@ module Reek
         end
 
         def body_nodes(types, ignoring = [])
-          if body
-            body.find_nodes(types, ignoring)
-          else
-            []
-          end
+          return [] unless body
+          return [] if ignoring.include?(body.type)
+          body.each_node(types, ignoring | types)
         end
       end
 
@@ -59,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/ast/sexp_extensions/send.rb

@@ -23,10 +23,6 @@ module Reek
           ([receiver] + args).compact
         end
 
-        def arg_names
-          args.map { |arg| arg.children.first }
-        end
-
         def module_creation_call?
           object_creation_call? && module_creation_receiver?
         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,15 +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
-          smells = scan_for_smells
           if smells.empty?
             puts "\n'.todo.reek' not generated because "\
                     'there were no smells found!'
           else
-            File.write FILE_NAME, groups_for(smells).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
@@ -28,14 +29,13 @@ module Reek
 
         private
 
-        def scan_for_smells
-          sources.map do |source|
-            Examiner.new(source,
-                         filter_by_smells: smell_names)
+        def smells
+          @smells ||= sources.map do |source|
+            Examiner.new(source, filter_by_smells: smell_names)
           end.map(&:smells).flatten
         end
 
-        def groups_for(smells)
+        def groups
           @groups ||=
             begin
               todos = smells.group_by(&:smell_class).map do |smell_class, smells_for_class|

data/lib/reek/cli/options.rb

@@ -4,6 +4,8 @@ require 'optparse'
 require 'rainbow'
 require_relative '../version'
 require_relative 'status'
+require_relative '../detector_repository'
+require_relative '../documentation_link'
 
 module Reek
   module CLI
@@ -12,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
@@ -26,6 +28,7 @@ module Reek
                     :show_empty,
                     :show_links,
                     :sorting,
+                    :stdin_filename,
                     :success_exit_code,
                     :failure_exit_code,
                     :generate_todo_list,
@@ -64,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
@@ -82,7 +85,7 @@ module Reek
 
       def set_banner
         program_name = parser.program_name
-        parser.banner = <<-EOB.gsub(/^[ ]+/, '')
+        parser.banner = <<-BANNER.gsub(/^[ ]+/, '')
           Usage: #{program_name} [options] [files]
 
           Examples:
@@ -91,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.
 
-        EOB
+        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|
@@ -104,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',
-                  'Check out https://github.com/troessner/reek/blob/master/docs/Code-Smells.md '\
+                  '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
@@ -128,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
@@ -150,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
@@ -191,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',
@@ -206,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