reek 2.0.4 → 3.0.0

data/features/step_definitions/sample_file_steps.rb

@@ -0,0 +1,158 @@
+Given(/^the smelly file 'demo.rb' from the example in the README$/) do
+  contents = <<-EOS.strip_heredoc
+    class Dirty
+      # This method smells of :reek:NestedIterators but ignores them
+      def awful(x, y, offset = 0, log = false)
+        puts @screen.title
+        @screen = widgets.map {|w| w.each {|key| key += 3 * x}}
+        puts @screen.contents
+      end
+    end
+  EOS
+  write_file('demo.rb', contents)
+end
+
+Given(/^a smelly file with inline masking called 'inline.rb'$/) do
+  write_file 'inline.rb', <<-EOS.strip_heredoc
+    # smells of :reek:NestedIterators but ignores them
+    class Dirty
+      def a
+        puts @s.title
+        @s = foo.map {|x| x.each {|key| key += 3}}
+        puts @s.title
+      end
+    end
+  EOS
+end
+
+Given(/^the "(.*?)" sample file exists$/) do |file_name|
+  full_path = File.expand_path file_name, 'spec/samples'
+  in_current_dir { FileUtils.cp full_path, file_name }
+end
+
+Given(/^a directory called 'clean_files' containing some clean files$/) do
+  contents = <<-EOS.strip_heredoc
+    # clean class for testing purposes
+    class Clean
+      def assign
+        puts @sub.title
+        @sub.map {|para| para.name }
+      end
+    end
+  EOS
+  write_file 'clean_files/clean_one.rb', contents
+  write_file 'clean_files/clean_two.rb', contents
+  write_file 'clean_files/clean_three.rb', contents
+end
+
+Given(/^a directory called 'smelly' containing two smelly files$/) do
+  write_file('smelly/dirty_one.rb', <<-EOS.strip_heredoc)
+    class Dirty
+      def a; end
+    end
+  EOS
+  write_file('smelly/dirty_two.rb', <<-EOS.strip_heredoc)
+    class Dirty
+      def a; end
+      def b; end
+    end
+  EOS
+end
+
+Given(/^a smelly file called 'smelly.rb'( in a subdirectory)?$/) do |in_subdir|
+  file_name = in_subdir ? 'subdir/smelly.rb' : 'smelly.rb'
+  write_file file_name, <<-EOS.strip_heredoc
+    # smelly class for testing purposes
+    class Smelly
+      def m
+        puts @foo.bar
+        puts @foo.bar
+      end
+    end
+  EOS
+end
+
+Given(/^a file with smelly variable names called 'camel_case.rb'$/) do
+  write_file('camel_case.rb', <<-EOS.strip_heredoc)
+    # Class containing camelCase variable which would normally smell
+    class CamelCase
+      def initialize
+        # These next two would normally smell if it weren't for overridden config values
+        camelCaseVariable = []
+        anotherOne = 1
+
+        # this next one should still smell
+        x1 = 0
+
+        # this next one should not smell
+        should_not_smell = true
+      end
+    end
+  EOS
+end
+
+Given(/^an empty configuration file called 'empty.reek'$/) do
+  write_file('empty.reek', '')
+end
+
+Given(/^a corrupt configuration file called 'corrupt.reek'$/) do
+  write_file('corrupt.reek', 'This is not a configuration file')
+end
+
+Given(/^a masking configuration file called 'config.reek'$/) do
+  write_file('config.reek', <<-EOS.strip_heredoc)
+    ---
+    DuplicateMethodCall:
+      enabled: false
+    UncommunicativeMethodName:
+      enabled: false
+  EOS
+end
+
+Given(/^a configuration file masking some duplication smells called 'config.reek'$/) do
+  write_file('config.reek', <<-EOS.strip_heredoc)
+    ---
+    DuplicateMethodCall:
+      allow_calls:
+        - puts\\(@foo.bar\\)
+  EOS
+end
+
+Given(/^a configuration file allowing camel case variables$/) do
+  write_file('config.reek', <<-EOS.strip_heredoc)
+    ---
+    UncommunicativeVariableName:
+      enabled: true
+      reject:
+      - !ruby/regexp /^.$/
+      - !ruby/regexp /[0-9]$/
+  EOS
+end
+
+When(/^I run "reek (.*?)" in the subdirectory$/) do |args|
+  cd 'subdir'
+  reek(args)
+end
+
+Given(/^a masking configuration file in the HOME directory$/) do
+  set_env('HOME', File.expand_path(File.join(current_dir, 'home')))
+  write_file('home/config.reek', <<-EOS.strip_heredoc)
+    ---
+    DuplicateMethodCall:
+      enabled: false
+    UncommunicativeMethodName:
+      enabled: false
+  EOS
+end
+
+Given(/^an enabling configuration file in the subdirectory$/) do
+  write_file('subdir/config.reek', <<-EOS.strip_heredoc)
+    ---
+    IrresponsibleModule:
+      enabled: true
+    UncommunicativeModuleName:
+      enabled: true
+    UncommunicativeMethodName:
+      enabled: true
+  EOS
+end

data/features/support/env.rb

@@ -1,8 +1,6 @@
-require 'English'
-require 'tempfile'
-require 'fileutils'
-require 'open3'
-require 'reek/cli/application'
+require_relative '../../lib/reek/cli/application'
+require 'aruba/cucumber'
+require 'active_support/core_ext/string/strip'
 
 begin
   require 'pry-byebug'
@@ -13,39 +11,30 @@ end
 # Provides runner methods used in the cucumber steps.
 #
 class ReekWorld
-  def run(cmd)
-    stderr_file = Tempfile.new('reek-world')
-    stderr_file.close
-    @last_stdout = `#{cmd} 2> #{stderr_file.path}`
-    @last_exit_status = $CHILD_STATUS.exitstatus
-    @last_stderr = IO.read(stderr_file.path)
-  end
-
   def reek(args)
-    run("ruby -Ilib bin/reek --no-color #{args}")
+    run_simple("reek --no-color #{args}", false)
   end
 
   def reek_with_pipe(stdin, args)
-    run("echo \"#{stdin}\" | ruby -Ilib bin/reek --no-color #{args}")
+    run_interactive("reek --no-color #{args}")
+    type(stdin)
+    close_input
   end
 
   def rake(name, task_def)
-    header = <<EOS
-$:.unshift('lib')
-require 'reek/rake/task'
+    header = <<-EOS.strip_heredoc
+      require 'reek/rake/task'
 
-EOS
-    rakefile = Tempfile.new('rake_task', '.')
-    rakefile.puts(header + task_def)
-    rakefile.close
-    run("rake -f #{rakefile.path} #{name}")
-    lines = @last_stdout.split("\n")
-    if lines.length > 0 && lines[0] =~ /^\(/
-      @last_stdout = lines[1..-1].join("\n")
-    end
+    EOS
+    write_file 'Rakefile', header + task_def
+    run_simple("rake #{name}", false)
   end
 end
 
 World do
   ReekWorld.new
 end
+
+Before do
+  @aruba_timeout_seconds = 30
+end

data/lib/reek/{source → ast}/ast_node_class_map.rb

@@ -1,23 +1,22 @@
-require 'reek/source/ast_node'
-require 'reek/source/sexp_node'
-require 'reek/source/sexp_extensions'
+require_relative 'node'
+require_relative 'sexp_extensions'
 
 module Reek
-  module Source
-    # Maps AST node types to sublasses of AstNode extended with the relevant
+  module AST
+    # Maps AST node types to sublasses of ASTNode extended with the relevant
     # utility modules.
-    class AstNodeClassMap
+    #
+    # @api private
+    class ASTNodeClassMap
       def initialize
         @klass_map = {}
       end
 
       def klass_for(type)
-        @klass_map[type] ||=
-          begin
-            klass = Class.new(AstNode)
-            klass.send :include, extension_map[type] if extension_map[type]
-            klass.send :include, SexpNode
-          end
+        @klass_map[type] ||= Class.new(Node).tap do |klass|
+          extension = extension_map[type]
+          klass.send :include, extension if extension
+        end
       end
 
       def extension_map

data/lib/reek/ast/node.rb

@@ -0,0 +1,132 @@
+require 'parser'
+
+module Reek
+  # @api private
+  module AST
+    # Base class for AST nodes extended with utility methods. Contains some
+    # methods to ease the transition from Sexp to AST::Node.
+    #
+    # @api private
+    class Node < ::Parser::AST::Node
+      attr_reader :parent
+
+      def initialize(type, children = [], options = {})
+        @comments = options.fetch(:comments, [])
+        @parent   = options.fetch(:parent, nil)
+        super
+      end
+
+      def full_comment
+        @comments.map(&:text).join("\n")
+      end
+
+      def leading_comment
+        line = location.line
+        comment_lines = @comments.select do |comment|
+          comment.location.line < line
+        end
+        comment_lines.map(&:text).join("\n")
+      end
+
+      # @deprecated
+      def [](index)
+        elements[index]
+      end
+
+      def line
+        loc.line
+      end
+
+      # @deprecated
+      def first
+        type
+      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
+      #
+      # Examples:
+      #   context.each_node(:send, [:mlhs]) do |call_node| .... end
+      #   context.each_node(:lvar).any? { |it| it.var_name == 'something' }
+      #
+      # Returns an array with all matching nodes.
+      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
+
+      #
+      # 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
+      #
+      # Examples:
+      #   exp.find_nodes([: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
+      end
+
+      def contains_nested_node?(target_type)
+        look_for_type(target_type) { |_elem| return true }
+        false
+      end
+
+      def format_to_ruby
+        SexpFormatter.format(self)
+      end
+
+      protected
+
+      # See ".each_node" for documentation.
+      def look_for_type(target_type, ignoring = [], &blk)
+        each_sexp do |elem|
+          elem.look_for_type(target_type, ignoring, &blk) unless ignoring.include?(elem.type)
+        end
+        blk.call(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
+          blk.call(self)
+        else
+          each_sexp do |elem|
+            elem.look_for_types(target_types, ignoring, &blk)
+          end
+        end
+      end
+
+      private
+
+      def each_sexp
+        children.each { |elem| yield elem if elem.is_a? ::Parser::AST::Node }
+      end
+
+      def elements
+        [type, *children]
+      end
+    end
+  end
+end

data/lib/reek/{core → ast}/object_refs.rb

@@ -1,8 +1,9 @@
 module Reek
-  module Core
+  module AST
     #
     # Manages and counts the references out of a method to other objects.
     #
+    # @api private
     class ObjectRefs  # :nodoc:
       def initialize
         @refs = Hash.new(0)

data/lib/reek/ast/reference_collector.rb

@@ -0,0 +1,32 @@
+module Reek
+  module AST
+    #
+    # Locates references to the current object within a portion
+    # of an abstract syntax tree.
+    #
+    # @api private
+    class ReferenceCollector
+      STOP_NODES = [:class, :module, :def, :defs]
+
+      def initialize(ast)
+        @ast = ast
+      end
+
+      def num_refs_to_self
+        (explicit_self_calls + implicit_self_calls).size
+      end
+
+      private
+
+      def explicit_self_calls
+        [:self, :zsuper, :ivar, :ivasgn].flat_map do |node_type|
+          @ast.each_node(node_type, STOP_NODES)
+        end
+      end
+
+      def implicit_self_calls
+        @ast.each_node(:send, STOP_NODES).reject(&:receiver)
+      end
+    end
+  end
+end

data/lib/reek/{source → ast}/sexp_extensions.rb

@@ -1,11 +1,12 @@
-require 'reek/source/sexp_node'
+require_relative 'reference_collector'
 
 module Reek
-  module Source
+  module AST
     #
-    # Extension modules providing utility methods to AstNode objects, depending
+    # Extension modules providing utility methods to ASTNode objects, depending
     # on their type.
     #
+    # @api private
     module SexpExtensions
       # Base module for utility methods for argument nodes.
       module ArgNodeBase
@@ -37,6 +38,10 @@ module Reek
         def anonymous_splat?
           false
         end
+
+        def components
+          [self]
+        end
       end
 
       # Utility methods for :arg nodes.
@@ -96,6 +101,24 @@ module Reek
         include ArgNodeBase
       end
 
+      # Base module for utility methods for nodes that can contain argument
+      # nodes nested through :mlhs nodes.
+      module NestedAssignables
+        def components
+          children.flat_map(&:components)
+        end
+      end
+
+      # Utility methods for :args nodes.
+      module ArgsNode
+        include NestedAssignables
+      end
+
+      # Utility methods for :mlhs nodes.
+      module MlhsNode
+        include NestedAssignables
+      end
+
       # Base module for utility methods for :and and :or nodes.
       module LogicOperatorBase
         def condition() self[1] end
@@ -202,7 +225,7 @@ module Reek
         end
 
         def parameters
-          argslist.children
+          argslist.components
         end
 
         def parameter_names
@@ -239,6 +262,15 @@ module Reek
           prefix = outer == '' ? '' : "#{outer}#"
           "#{prefix}#{name}"
         end
+
+        def depends_on_instance?
+          ReferenceCollector.new(self).num_refs_to_self > 0
+        end
+
+        def singleton_method?
+          # This catches the case where methods are defined within the "class << self" syntax.
+          parent.type == :sclass if parent
+        end
       end
 
       # Utility methods for :defs nodes.
@@ -254,7 +286,11 @@ module Reek
         include MethodNodeBase
         def full_name(outer)
           prefix = outer == '' ? '' : "#{outer}#"
-          "#{prefix}#{SexpNode.format(receiver)}.#{name}"
+          "#{prefix}#{SexpFormatter.format(receiver)}.#{name}"
+        end
+
+        def depends_on_instance?
+          false
         end
       end
 
@@ -296,7 +332,7 @@ module Reek
         def name() self[1] end
 
         def simple_name
-          name.is_a?(AST::Node) ? name.simple_name : name
+          name.is_a?(::Parser::AST::Node) ? name.simple_name : name
         end
 
         def full_name(outer)
@@ -305,7 +341,7 @@ module Reek
         end
 
         def text_name
-          SexpNode.format(name)
+          SexpFormatter.format(name)
         end
       end
 

data/lib/reek/ast/sexp_formatter.rb

@@ -0,0 +1,31 @@
+require_relative '../cli/silencer'
+Reek::CLI::Silencer.silently do
+  require 'unparser'
+end
+
+module Reek
+  module AST
+    #
+    # Formats snippets of syntax tree back into Ruby source code.
+    #
+    # @api private
+    class SexpFormatter
+      # Formats the given sexp.
+      #
+      # @param [AST::Node, #to_s] sexp - The expression to format
+      #
+      # @return [String] a formatted string representation.
+      #
+      # :reek:DuplicateMethodCall { max_calls: 2 } is ok for lines.first
+      def self.format(sexp)
+        return sexp.to_s unless sexp.is_a? ::Parser::AST::Node
+        lines = Unparser.unparse(sexp).split "\n"
+        case lines.length
+        when 1 then lines.first
+        when 2 then lines.join('; ')
+        else [lines.first, lines.last].join(' ... ')
+        end
+      end
+    end
+  end
+end

data/lib/reek/cli/application.rb

@@ -1,14 +1,15 @@
-require 'reek/cli/options'
-require 'reek/cli/reek_command'
-require 'reek/configuration/app_configuration'
+require_relative 'options'
+require_relative 'reek_command'
+require_relative '../configuration/app_configuration'
 
 module Reek
-  module Cli
+  module CLI
     #
     # Represents an instance of a Reek application.
     # This is the entry point for all invocations of Reek from the
     # command line.
     #
+    # @api private
     class Application
       STATUS_SUCCESS = 0
       STATUS_ERROR   = 1

data/lib/reek/cli/command.rb

@@ -1,8 +1,9 @@
 module Reek
-  module Cli
+  module CLI
     #
     # Base class for all commands
     #
+    # @api private
     class Command
       attr_reader :options
 

data/lib/reek/cli/input.rb

@@ -1,10 +1,11 @@
-require 'reek/source'
+require_relative '../source/source_locator'
 
 module Reek
-  module Cli
+  module CLI
     #
     # CLI Input utility
     #
+    # @api private
     module Input
       def sources
         if no_source_files_given?
@@ -31,15 +32,15 @@ module Reek
       end
 
       def working_directory_as_source
-        Source::SourceLocator.new(['.']).all_sources
+        Source::SourceLocator.new(['.']).sources
       end
 
       def sources_from_argv
-        Source::SourceLocator.new(@argv).all_sources
+        Source::SourceLocator.new(@argv).sources
       end
 
       def source_from_pipe
-        [$stdin.to_reek_source('$stdin')]
+        [$stdin]
       end
     end
   end

data/lib/reek/cli/option_interpreter.rb

@@ -1,16 +1,17 @@
 require 'forwardable'
-require 'reek/cli/input'
-require 'reek/cli/report/report'
-require 'reek/cli/report/formatter'
-require 'reek/cli/report/heading_formatter'
+require_relative 'input'
+require_relative '../report/report'
+require_relative '../report/formatter'
+require_relative '../report/heading_formatter'
 
 module Reek
-  module Cli
+  module CLI
     #
     # Interprets the options set from the command line
     #
+    # @api private
     class OptionInterpreter
-      include Cli::Input
+      include Input
 
       extend Forwardable
 
@@ -30,14 +31,17 @@ module Reek
             heading_formatter: heading_formatter)
       end
 
+      # TODO: Move report type mapping into Report
       def report_class
         case @options.report_format
         when :yaml
-          Report::YamlReport
+          Report::YAMLReport
         when :json
-          Report::JsonReport
+          Report::JSONReport
         when :html
-          Report::HtmlReport
+          Report::HTMLReport
+        when :xml
+          Report::XMLReport
         else # :text
           Report::TextReport
         end