reek 4.6.0 → 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
@@ -84,3 +84,15 @@ end
 Then /^it reports the current version$/ do
   expect(last_command_started).to have_output("reek #{Reek::Version::STRING}")
 end
+
+Then /^it reports this Code Climate output:$/ do |expected_output|
+  expected_issues = expected_output.split('NULL_BYTE_CHARACTER').map do |issue|
+    JSON.parse(issue)
+  end
+
+  actual_issues = last_command_started.stdout.split("\0").map do |issue|
+    JSON.parse(issue)
+  end
+
+  expect(actual_issues).to eq(expected_issues)
+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,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/ast_node_class_map.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative 'node'
 require_relative 'sexp_extensions'
 

data/lib/reek/ast/builder.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Reek
+  module AST
+    #
+    # 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 invalid sequence as UTF-8.
+      # See. https://github.com/whitequark/parser/issues/283
+      def string_value(token)
+        value(token)
+      end
+    end
+  end
+end

data/lib/reek/ast/node.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
-require_relative '../cli/silencer'
 
-Reek::CLI::Silencer.silently do
-  require 'parser'
-end
+require_relative '../cli/silencer'
+Reek::CLI::Silencer.without_warnings { require 'parser' }
 
 module Reek
   module AST
@@ -11,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
 
@@ -35,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)
@@ -106,6 +89,15 @@ module Reek
         1
       end
 
+      # Most nodes represent only one statement (although they can have nested
+      # statements). The special type :begin exists primarily to contain more
+      # statements.
+      #
+      # @return Array of unique outer-level statements contained in this node
+      def statements
+        [self]
+      end
+
       def source
         loc.expression.source_buffer.name
       end
@@ -113,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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Reek
   # Represents functionality related to an Abstract Syntax Tree.
   module AST
@@ -49,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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Reek
   module AST
     #
@@ -11,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
@@ -19,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/arguments.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Reek
   module AST
     module SexpExtensions

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Reek
   module AST
     module SexpExtensions

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Reek
+  module AST
+    module SexpExtensions
+      # Utility methods for :begin nodes.
+      module BeginNode
+        # The special type :begin exists primarily to contain more statements.
+        # Therefore, this method overrides the default implementation to return
+        # this node's children.
+        def statements
+          children
+        end
+      end
+    end
+  end
+end

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Reek
   module AST
     module SexpExtensions

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Reek
   module AST
     module SexpExtensions
@@ -9,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/constant.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Reek
   module AST
     module SexpExtensions

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Reek
   module AST
     module SexpExtensions
@@ -8,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/lambda.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Reek
   module AST
     module SexpExtensions

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Reek
   module AST
     module SexpExtensions

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Reek
   module AST
     module SexpExtensions
@@ -9,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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Reek
   module AST
     module SexpExtensions
@@ -29,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
 
@@ -58,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/module.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
+
 module Reek
   module AST
     module SexpExtensions
-      # Base module for utility methods for module nodes.
-      module ModuleNodeBase
-        # The full name of the module or class, including the name of any
+      # Base module for utility methods for nodes that define constants: module
+      # definition, class definition and constant assignment.
+      module ConstantDefiningNodeBase
+        # The full name of the constant, including the name of any
         # module or class it is nested inside of.
         #
         # For example, given code like this:
@@ -15,7 +17,8 @@ module Reek
         #   end
         #
         # The full name for the inner class will be 'Foo::Bar::Baz'. To return
-        # the correct name, the name of the outer context has to be passed into this method.
+        # the correct name, the name of the outer context has to be passed into
+        # this method.
         #
         # @param outer [String] full name of the wrapping module or class
         # @return the module's full name
@@ -31,27 +34,71 @@ module Reek
         def simple_name
           name.split('::').last
         end
+      end
+
+      # Base module for utility methods for module nodes.
+      module ModuleNodeBase
+        include ConstantDefiningNodeBase
 
         def name
           children.first.format_to_ruby
         end
+
+        # In the AST, the set of children of a module that a human might identify
+        # is coded in three different ways.
+        #
+        # If there are no children, the last element of the module node is nil,
+        # like so:
+        #
+        #   s(:class,
+        #     s(:const, nil, :C),
+        #     nil,
+        #     nil)
+        #
+        # If there is one child, the last element of the module node is that
+        # child, like so:
+        #
+        #   s(:class,
+        #     s(:const, nil, :C),
+        #     nil,
+        #     s(:def, :f, s(:args), nil))
+        #
+        # If there is more than one child, those are wrapped as children in a
+        # node of type :begin, like so:
+        #
+        #   s(:class,
+        #     s(:const, nil, :Alfa),
+        #     nil,
+        #     s(:begin,
+        #       s(:def, :bravo, s(:args), nil),
+        #       s(:class, s(:const, nil, :Charlie), nil, nil)))
+        #
+        # This method unifies those three ways to avoid having to handle them
+        # differently.
+        #
+        # @return an array of directly visible children of the module
+        #
+        def direct_children
+          contents = children.last or return []
+          contents.statements
+        end
       end
 
-      # Utility methods for :module nodes.
+      # Utility methods for module definition (:module) nodes.
       module ModuleNode
         include ModuleNodeBase
       end
 
-      # Utility methods for :class nodes.
+      # Utility methods for class definition (:class) nodes.
       module ClassNode
         include ModuleNodeBase
 
         def superclass() children[1] end
       end
 
-      # Utility methods for :casgn nodes.
+      # Utility methods for constant assignment (:casgn) nodes.
       module CasgnNode
-        include ModuleNodeBase
+        include ConstantDefiningNodeBase
 
         def defines_module?
           call = constant_definition

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Reek
   module AST
     module SexpExtensions

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Reek
   module AST
     module SexpExtensions