reek 2.2.1 → 3.0.0

data/lib/reek/source/source_locator.rb

@@ -1,8 +1,11 @@
+require 'find'
+
 module Reek
   module Source
     #
     # Finds Ruby source files in a filesystem.
     #
+    # @api private
     class SourceLocator
       # Initialize with the paths we want to search.
       #
@@ -14,24 +17,39 @@ module Reek
       # Traverses all paths we initialized the SourceLocator with, finds
       # all relevant ruby files and returns them as a list.
       #
-      # Returns a list of Source::SourceCode.
+      # @return [Array<File>] - Ruby files found
       def sources
-        find_sources.map { |pathname| Source::SourceCode.from File.new(pathname) }
+        source_paths.map { |pathname| File.new(pathname) }
       end
 
       private
 
-      def find_sources(paths = @paths)
-        paths.map do |path|
-          pathname = Pathname.new(path)
-          if pathname.directory?
-            find_sources(Dir["#{pathname}/**/*.rb"])
-          else
-            next pathname if pathname.file?
-            $stderr.puts "Error: No such file - #{pathname}"
-            nil
+      def source_paths
+        relevant_paths = []
+        @paths.map do |given_path|
+          print_no_such_file_error(given_path) && next unless path_exists?(given_path)
+          Find.find(given_path) do |path|
+            pathname = Pathname.new(path)
+            if pathname.directory?
+              exclude_path?(pathname) ? Find.prune : next
+            else
+              relevant_paths << pathname
+            end
           end
-        end.flatten.sort
+        end
+        relevant_paths.flatten.sort
+      end
+
+      def exclude_path?(pathname)
+        Configuration::AppConfiguration.exclude_paths.include? pathname.to_s
+      end
+
+      def path_exists?(path)
+        Pathname.new(path).exist?
+      end
+
+      def print_no_such_file_error(path)
+        $stderr.puts "Error: No such file - #{path}"
       end
     end
   end

data/lib/reek/spec/should_reek.rb

@@ -1,14 +1,15 @@
-require_relative '../core/examiner'
-require_relative '../cli/report/formatter'
+require_relative '../examiner'
+require_relative '../report/formatter'
 
 module Reek
   module Spec
     #
     # An rspec matcher that matches when the +actual+ has code smells.
     #
+    # @api private
     class ShouldReek        # :nodoc:
       def matches?(actual)
-        @examiner = Core::Examiner.new(actual)
+        @examiner = Examiner.new(actual)
         @examiner.smelly?
       end
 
@@ -17,7 +18,7 @@ module Reek
       end
 
       def failure_message_when_negated
-        rpt = CLI::Report::Formatter.format_list(@examiner.smells)
+        rpt = Report::Formatter.format_list(@examiner.smells)
         "Expected no smells, but got:\n#{rpt}"
       end
     end

data/lib/reek/spec/should_reek_of.rb

@@ -1,4 +1,4 @@
-require_relative '../core/examiner'
+require_relative '../examiner'
 
 module Reek
   module Spec
@@ -6,6 +6,7 @@ module Reek
     # An rspec matcher that matches when the +actual+ has the specified
     # code smell.
     #
+    # @api private
     class ShouldReekOf
       def initialize(smell_category, smell_details = {})
         @smell_category = normalize smell_category
@@ -13,7 +14,7 @@ module Reek
       end
 
       def matches?(actual)
-        @examiner = Core::Examiner.new(actual)
+        @examiner = Examiner.new(actual)
         @all_smells = @examiner.smells
         @all_smells.any? { |warning| warning.matches?(@smell_category, @smell_details) }
       end

data/lib/reek/spec/should_reek_only_of.rb

@@ -1,5 +1,5 @@
-require_relative '../core/examiner'
-require_relative '../cli/report/formatter'
+require_relative '../examiner'
+require_relative '../report/formatter'
 
 module Reek
   module Spec
@@ -7,9 +7,10 @@ module Reek
     # An rspec matcher that matches when the +actual+ has the specified
     # code smell and no others.
     #
+    # @api private
     class ShouldReekOnlyOf < ShouldReekOf
       def matches?(actual)
-        matches_examiner?(Core::Examiner.new(actual))
+        matches_examiner?(Examiner.new(actual))
       end
 
       def matches_examiner?(examiner)
@@ -20,7 +21,7 @@ module Reek
       end
 
       def failure_message
-        rpt = CLI::Report::Formatter.format_list(@warnings)
+        rpt = Report::Formatter.format_list(@warnings)
         "Expected #{@examiner.description} to reek only of #{@smell_category}, but got:\n#{rpt}"
       end
 

data/lib/reek/tree_dresser.rb

@@ -0,0 +1,32 @@
+require_relative 'ast/ast_node_class_map'
+
+module Reek
+  #
+  # Adorns an abstract syntax tree with mix-in modules to make accessing
+  # the tree more understandable and less implementation-dependent.
+  #
+  # @api private
+  class TreeDresser
+    def initialize(klass_map = AST::ASTNodeClassMap.new)
+      @klass_map = klass_map
+    end
+
+    # Recursively enhance an AST with type-dependent mixins, and comments.
+    #
+    # See {file:docs/How-reek-works-internally.md} for the big picture of how this works.
+    #
+    # @param sexp [Parser::AST::Node] - the given sexp
+    # @param comment_map [Hash] - see the documentation for SourceCode#syntax_tree
+    # @param parent [Parser::AST::Node] - the parent sexp
+    #
+    # @return an instance of Reek::AST::Node with type-dependent sexp extensions mixed in.
+    def dress(sexp, comment_map, parent = nil)
+      return sexp unless sexp.is_a? ::Parser::AST::Node
+      type = sexp.type
+      children = sexp.children.map { |child| dress(child, comment_map, sexp) }
+      comments = comment_map[sexp]
+      @klass_map.klass_for(type).new(type, children,
+                                     location: sexp.loc, comments: comments, parent: parent)
+    end
+  end
+end

data/lib/reek/tree_walker.rb

@@ -0,0 +1,182 @@
+require_relative 'context/method_context'
+require_relative 'context/module_context'
+require_relative 'context/root_context'
+require_relative 'context/singleton_method_context'
+require_relative 'smells/smell_repository'
+require_relative 'ast/node'
+
+module Reek
+  #
+  # Traverses a Sexp abstract syntax tree and fires events whenever
+  # it encounters specific node types.
+  #
+  # SMELL: This class is responsible for counting statements and for feeding
+  # each context to the smell repository.
+  #
+  # @api private
+  class TreeWalker
+    def initialize(smell_repository = Smells::SmellRepository.new)
+      @smell_repository = smell_repository
+      @element = Context::RootContext.new
+    end
+
+    def process(exp)
+      context_processor = "process_#{exp.type}"
+      if context_processor_exists?(context_processor)
+        send(context_processor, exp)
+      else
+        process_default exp
+      end
+      @element
+    end
+
+    def process_default(exp)
+      exp.children.each do |child|
+        process(child) if child.is_a? AST::Node
+      end
+    end
+
+    def process_module(exp)
+      inside_new_context(Context::ModuleContext, exp) do
+        process_default(exp)
+      end
+    end
+
+    alias_method :process_class, :process_module
+
+    def process_def(exp)
+      inside_new_context(Context::MethodContext, exp) do
+        count_clause(exp.body)
+        process_default(exp)
+      end
+    end
+
+    def process_defs(exp)
+      inside_new_context(Context::SingletonMethodContext, exp) do
+        count_clause(exp.body)
+        process_default(exp)
+      end
+    end
+
+    def process_args(_) end
+
+    #
+    # Recording of calls to methods and self
+    #
+
+    def process_send(exp)
+      @element.record_call_to(exp)
+      process_default(exp)
+    end
+
+    alias_method :process_attrasgn, :process_send
+    alias_method :process_op_asgn, :process_send
+
+    def process_ivar(exp)
+      @element.record_use_of_self
+      process_default(exp)
+    end
+
+    alias_method :process_ivasgn, :process_ivar
+
+    def process_self(_)
+      @element.record_use_of_self
+    end
+
+    alias_method :process_zsuper, :process_self
+
+    #
+    # Statement counting
+    #
+
+    def process_block(exp)
+      count_clause(exp.block)
+      process_default(exp)
+    end
+
+    def process_begin(exp)
+      count_statement_list(exp.children)
+      @element.count_statements(-1)
+      process_default(exp)
+    end
+
+    alias_method :process_kwbegin, :process_begin
+
+    def process_if(exp)
+      count_clause(exp[2])
+      count_clause(exp[3])
+      @element.count_statements(-1)
+      process_default(exp)
+    end
+
+    def process_while(exp)
+      count_clause(exp[2])
+      @element.count_statements(-1)
+      process_default(exp)
+    end
+
+    alias_method :process_until, :process_while
+
+    def process_for(exp)
+      count_clause(exp[3])
+      @element.count_statements(-1)
+      process_default(exp)
+    end
+
+    def process_rescue(exp)
+      count_clause(exp[1])
+      @element.count_statements(-1)
+      process_default(exp)
+    end
+
+    def process_resbody(exp)
+      count_statement_list(exp[2..-1].compact)
+      process_default(exp)
+    end
+
+    def process_case(exp)
+      count_clause(exp.else_body)
+      @element.count_statements(-1)
+      process_default(exp)
+    end
+
+    def process_when(exp)
+      count_clause(exp.body)
+      process_default(exp)
+    end
+
+    private
+
+    def context_processor_exists?(name)
+      respond_to?(name)
+    end
+
+    def count_clause(sexp)
+      @element.count_statements(1) if sexp
+    end
+
+    def count_statement_list(statement_list)
+      @element.count_statements statement_list.length
+    end
+
+    def inside_new_context(klass, exp)
+      scope = klass.new(@element, exp)
+      push(scope) do
+        yield
+        check_smells(exp.type)
+      end
+      scope
+    end
+
+    def check_smells(type)
+      @smell_repository.examine(@element, type)
+    end
+
+    def push(scope)
+      orig = @element
+      @element = scope
+      yield
+      @element = orig
+    end
+  end
+end

data/lib/reek/version.rb

@@ -3,6 +3,6 @@ module Reek
   # This module holds the Reek version informations
   #
   module Version
-    STRING = '2.2.1'
+    STRING = '3.0.0'
   end
 end

data/reek.gemspec

@@ -19,20 +19,20 @@ Gem::Specification.new do |s|
   s.executables = s.files.grep(%r{^bin/}).map { |path| File.basename(path) }
   s.homepage = 'https://github.com/troessner/reek/wiki'
   s.rdoc_options = %w(--main README.md -x assets/|bin/|config/|features/|spec/|tasks/)
-  s.required_ruby_version = '>= 1.9.3'
+  s.required_ruby_version = '>= 2.0.0'
   s.summary = 'Code smell detector for Ruby'
 
-  s.add_runtime_dependency 'parser',   '~> 2.2'
+  s.add_runtime_dependency 'parser',   '~> 2.2.2.5'
   s.add_runtime_dependency 'rainbow',  '~> 2.0'
   s.add_runtime_dependency 'unparser', '~> 0.2.2'
 
   s.add_development_dependency 'activesupport', '~> 4.2'
   s.add_development_dependency 'aruba',         '~> 0.6.2'
+  s.add_development_dependency 'ataru',         '~> 0.2.0'
   s.add_development_dependency 'bundler',       '~> 1.1'
   s.add_development_dependency 'cucumber',      '~> 2.0'
   s.add_development_dependency 'factory_girl',  '~> 4.0'
   s.add_development_dependency 'rake',          '~> 10.0'
   s.add_development_dependency 'rspec',         '~> 3.0'
   s.add_development_dependency 'rubocop',       '~> 0.30.0'
-  s.add_development_dependency 'yard',          '~> 0.8.7'
 end

data/spec/factories/factories.rb

@@ -1,4 +1,6 @@
 require_relative '../../lib/reek/smells'
+require_relative '../../lib/reek/smells/smell_detector'
+require_relative '../../lib/reek/smells/smell_warning'
 
 FactoryGirl.define do
   factory :smell_detector, class: Reek::Smells::SmellDetector do

data/spec/reek/{sexp/sexp_node_spec.rb → ast/node_spec.rb}

@@ -1,7 +1,7 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/sexp/sexp_node'
+require_relative '../../../lib/reek/ast/node'
 
-RSpec.describe Reek::Sexp::SexpNode do
+RSpec.describe Reek::AST::Node do
   context 'format' do
     it 'formats self' do
       @node = s(:self)

data/spec/reek/{core → ast}/object_refs_spec.rb

@@ -1,9 +1,9 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/core/object_refs'
+require_relative '../../../lib/reek/ast/object_refs'
 
-RSpec.describe Reek::Core::ObjectRefs do
+RSpec.describe Reek::AST::ObjectRefs do
   before(:each) do
-    @refs = Reek::Core::ObjectRefs.new
+    @refs = Reek::AST::ObjectRefs.new
   end
 
   context 'when empty' do

data/spec/reek/{core → ast}/reference_collector_spec.rb

@@ -1,7 +1,7 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/core/reference_collector'
+require_relative '../../../lib/reek/ast/reference_collector'
 
-RSpec.describe Reek::Core::ReferenceCollector do
+RSpec.describe Reek::AST::ReferenceCollector do
   context 'counting refs to self' do
     def refs_to_self(src)
       syntax_tree = Reek::Source::SourceCode.from(src).syntax_tree

data/spec/reek/{sexp → ast}/sexp_extensions_spec.rb

@@ -1,7 +1,7 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/sexp/sexp_extensions'
+require_relative '../../../lib/reek/ast/sexp_extensions'
 
-RSpec.describe Reek::Sexp::SexpExtensions::DefNode do
+RSpec.describe Reek::AST::SexpExtensions::DefNode do
   context 'with no parameters' do
     before :each do
       @node = s(:def, :hello, s(:args))
@@ -108,11 +108,6 @@ RSpec.describe Reek::Sexp::SexpExtensions::DefNode do
       expect(@node.body).to eq s(:begin, s(:first), s(:second))
     end
 
-    it 'has a body extended with SexpNode' do
-      b = @node.body
-      expect(b.class.included_modules.first).to eq Reek::Sexp::SexpNode
-    end
-
     it 'finds nodes in the body with #body_nodes' do
       expect(@node.body_nodes([:first])).to eq [s(:first)]
     end
@@ -133,7 +128,7 @@ RSpec.describe Reek::Sexp::SexpExtensions::DefNode do
   end
 end
 
-RSpec.describe Reek::Sexp::SexpExtensions::DefsNode do
+RSpec.describe Reek::AST::SexpExtensions::DefsNode do
   context 'with no parameters' do
     before :each do
       @node = s(:defs, s(:lvar, :obj), :hello, s(:args))
@@ -239,15 +234,10 @@ RSpec.describe Reek::Sexp::SexpExtensions::DefsNode do
     it 'has 2 body statements' do
       expect(@node.body).to eq s(:begin, s(:first), s(:second))
     end
-
-    it 'has a body extended with SexpNode' do
-      b = @node.body
-      expect(b.class.included_modules.first).to eq Reek::Sexp::SexpNode
-    end
   end
 end
 
-RSpec.describe Reek::Sexp::SexpExtensions::SendNode do
+RSpec.describe Reek::AST::SexpExtensions::SendNode do
   context 'with no parameters' do
     before :each do
       @node = s(:send, nil, :hello)
@@ -279,7 +269,7 @@ RSpec.describe Reek::Sexp::SexpExtensions::SendNode do
   end
 end
 
-RSpec.describe Reek::Sexp::SexpExtensions::BlockNode do
+RSpec.describe Reek::AST::SexpExtensions::BlockNode do
   context 'with no parameters' do
     before :each do
       @node = s(:block, s(:send, nil, :map), s(:args), nil)
@@ -311,7 +301,7 @@ RSpec.describe Reek::Sexp::SexpExtensions::BlockNode do
   end
 end
 
-RSpec.describe Reek::Sexp::SexpExtensions::ModuleNode do
+RSpec.describe Reek::AST::SexpExtensions::ModuleNode do
   context 'with a simple name' do
     subject do
       mod = ast(:module, :Fred, nil)