reek 2.0.4 → 3.0.0

data/lib/reek/spec/should_reek.rb

@@ -1,11 +1,12 @@
-require 'reek/examiner'
-require 'reek/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 = Examiner.new(actual)
@@ -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 'reek/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

data/lib/reek/spec/should_reek_only_of.rb

@@ -1,5 +1,5 @@
-require 'reek/examiner'
-require 'reek/cli/report/formatter'
+require_relative '../examiner'
+require_relative '../report/formatter'
 
 module Reek
   module Spec
@@ -7,6 +7,7 @@ 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?(Examiner.new(actual))
@@ -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/spec.rb

@@ -1,6 +1,6 @@
-require 'reek/spec/should_reek'
-require 'reek/spec/should_reek_of'
-require 'reek/spec/should_reek_only_of'
+require_relative 'spec/should_reek'
+require_relative 'spec/should_reek_of'
+require_relative 'spec/should_reek_only_of'
 
 module Reek
   #

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.0.4'
+    STRING = '3.0.0'
   end
 end

data/lib/reek.rb

@@ -1,6 +1,6 @@
 #
 # Reek's core functionality
 #
-require 'reek/version'
-require 'reek/examiner'
-require 'reek/smell_warning'
+require_relative 'reek/version'
+require_relative 'reek/examiner'
+require_relative 'reek/report/report'

data/reek.gemspec

@@ -1,6 +1,5 @@
 # -*- encoding: utf-8 -*-
-$LOAD_PATH.push File.join(File.dirname(__FILE__), 'lib')
-require 'reek/version'
+require File.join(File.dirname(__FILE__), 'lib/reek/version')
 
 Gem::Specification.new do |s|
   s.name = 'reek'
@@ -15,31 +14,25 @@ Gem::Specification.new do |s|
 
   s.license = 'MIT'
   s.email = ['timo.roessner@googlemail.com']
-  s.executables = ['reek']
   s.extra_rdoc_files = ['CHANGELOG', 'License.txt']
-  s.files = Dir['.yardopts', 'CHANGELOG', 'License.txt', 'README.md',
-                'Rakefile', 'assets/html_output.html.erb', 'bin/reek',
-                'config/defaults.reek', '{features,lib,spec,tasks}/**/*',
-                'reek.gemspec'] & `git ls-files -z`.split("\0")
-  s.homepage = 'https://wiki.github.com/troessner/reek'
-  s.rdoc_options = ['--main', 'README.md',
-                    '-x', 'assets/|bin/|config/|features/|spec/|tasks/']
-  s.require_paths = ['lib']
-  s.rubyforge_project = 'reek'
-  s.rubygems_version = '1.3.6'
-  s.required_ruby_version = '>= 1.9.3'
+  s.files = `git ls-files -z`.split("\0")
+  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 = '>= 2.0.0'
   s.summary = 'Code smell detector for Ruby'
 
-  s.add_runtime_dependency('parser', ['~> 2.2'])
-  s.add_runtime_dependency('unparser', ['~> 0.2.2'])
-  s.add_runtime_dependency('rainbow', ['~> 2.0'])
-  s.add_runtime_dependency('require_all', ['~> 1.3'])
+  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('bundler', ['~> 1.1'])
-  s.add_development_dependency('rake', ['~> 10.0'])
-  s.add_development_dependency('cucumber', ['~> 1.3', '>= 1.3.18'])
-  s.add_development_dependency('rspec', ['~> 3.0'])
-  s.add_development_dependency('yard', ['>= 0.8.7', '< 0.9'])
-  s.add_development_dependency('factory_girl', ['~> 4.0'])
-  s.add_development_dependency('rubocop', ['~> 0.29.0'])
+  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'
 end

data/spec/factories/factories.rb

@@ -1,4 +1,6 @@
-require 'reek/smells'
+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
@@ -13,7 +15,7 @@ FactoryGirl.define do
     end
   end
 
-  factory :smell_warning, class: Reek::SmellWarning do
+  factory :smell_warning, class: Reek::Smells::SmellWarning do
     skip_create
     smell_detector
     context 'self'

data/spec/gem/updates_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require_relative '../spec_helper'
 require 'find'
 
 release_timestamp_file = 'build/.last-release'

data/spec/gem/yard_spec.rb

@@ -1,7 +1,7 @@
-require 'spec_helper'
+require_relative '../spec_helper'
 require 'tempfile'
 
-describe 'yardoc' do
+RSpec.describe 'yardoc' do
   before :each do
     stderr_file = Tempfile.new('yardoc')
     stderr_file.close

data/spec/quality/reek_source_spec.rb

@@ -1,7 +1,7 @@
-require 'spec_helper'
+require_relative '../spec_helper'
 
-describe 'Reek source code' do
+RSpec.describe 'Reek source code' do
   it 'has no smells' do
-    Dir['lib/**/*.rb'].should_not reek
+    expect(Dir['lib/**/*.rb']).to_not reek
   end
 end

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

@@ -1,13 +1,11 @@
-require 'spec_helper'
-require 'reek/source/sexp_node'
+require_relative '../../spec_helper'
+require_relative '../../../lib/reek/ast/node'
 
-include Reek::Source
-
-describe SexpNode do
+RSpec.describe Reek::AST::Node do
   context 'format' do
     it 'formats self' do
       @node = s(:self)
-      expect(@node.format_ruby).to eq('self')
+      expect(@node.format_to_ruby).to eq('self')
     end
   end
 

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

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

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

@@ -1,51 +1,59 @@
-require 'spec_helper'
-require 'reek/source/reference_collector'
+require_relative '../../spec_helper'
+require_relative '../../../lib/reek/ast/reference_collector'
 
-include Reek::Source
-
-describe ReferenceCollector do
+RSpec.describe Reek::AST::ReferenceCollector do
   context 'counting refs to self' do
     def refs_to_self(src)
-      ReferenceCollector.new(src.to_reek_source.syntax_tree).num_refs_to_self
+      syntax_tree = Reek::Source::SourceCode.from(src).syntax_tree
+      described_class.new(syntax_tree).num_refs_to_self
     end
+
     it 'with no refs to self' do
       expect(refs_to_self('def no_envy(arga) arga.barg end')).to eq(0)
     end
+
     it 'counts a call to super' do
       expect(refs_to_self('def simple() super; end')).to eq(1)
     end
+
     it 'counts a local call' do
       expect(refs_to_self('def simple() to_s; end')).to eq(1)
     end
+
     it 'counts a use of self' do
       expect(refs_to_self('def simple() lv = self; end')).to eq(1)
     end
+
     it 'counts a call with self as receiver' do
       expect(refs_to_self('def simple() self.to_s; end')).to eq(1)
     end
+
     it 'counts uses of an ivar' do
       expect(refs_to_self('def no_envy() @item.to_a; @item = 4; @item end')).to eq(3)
     end
+
     it 'counts an ivar passed to a method' do
       expect(refs_to_self('def no_envy(arga) arga.barg(@item); arga end')).to eq(1)
     end
+
     it 'ignores global variables' do
       expect(refs_to_self('def no_envy(arga) $s2.to_a; $s2[arga] end')).to eq(0)
     end
+
     it 'ignores global variables' do
-      src = <<EOS
-    def accept(t, pat = /.*/nm, &block)
-      if pat
-        pat.respond_to?(:match) or raise TypeError, "has no `match'"
-      else
-        pat = t if t.respond_to?(:match)
-      end
-      unless block
-        block = pat.method(:convert).to_proc if pat.respond_to?(:convert)
-      end
-      @atype[t] = [pat, block]
-    end
-EOS
+      src = <<-EOS
+        def accept(t, pat = /.*/nm, &block)
+          if pat
+            pat.respond_to?(:match) or raise TypeError, "has no `match'"
+          else
+            pat = t if t.respond_to?(:match)
+          end
+          unless block
+            block = pat.method(:convert).to_proc if pat.respond_to?(:convert)
+          end
+          @atype[t] = [pat, block]
+        end
+      EOS
       expect(refs_to_self(src)).to eq(2)
     end
   end

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

@@ -1,9 +1,7 @@
-require 'spec_helper'
-require 'reek/source/sexp_extensions'
+require_relative '../../spec_helper'
+require_relative '../../../lib/reek/ast/sexp_extensions'
 
-include Reek::Source
-
-describe SexpExtensions::DefNode do
+RSpec.describe Reek::AST::SexpExtensions::DefNode do
   context 'with no parameters' do
     before :each do
       @node = s(:def, :hello, s(:args))
@@ -110,11 +108,6 @@ describe 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 SexpNode
-    end
-
     it 'finds nodes in the body with #body_nodes' do
       expect(@node.body_nodes([:first])).to eq [s(:first)]
     end
@@ -135,7 +128,7 @@ describe SexpExtensions::DefNode do
   end
 end
 
-describe 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))
@@ -241,15 +234,10 @@ describe 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 SexpNode
-    end
   end
 end
 
-describe SexpExtensions::SendNode do
+RSpec.describe Reek::AST::SexpExtensions::SendNode do
   context 'with no parameters' do
     before :each do
       @node = s(:send, nil, :hello)
@@ -281,7 +269,7 @@ describe SexpExtensions::SendNode do
   end
 end
 
-describe 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)
@@ -313,7 +301,7 @@ describe SexpExtensions::BlockNode do
   end
 end
 
-describe SexpExtensions::ModuleNode do
+RSpec.describe Reek::AST::SexpExtensions::ModuleNode do
   context 'with a simple name' do
     subject do
       mod = ast(:module, :Fred, nil)

data/spec/reek/{source → ast}/sexp_formatter_spec.rb

@@ -1,17 +1,16 @@
-require 'spec_helper'
-require 'reek/source/sexp_formatter'
+require_relative '../../spec_helper'
+require_relative '../../../lib/reek/ast/sexp_formatter'
 
-include Reek::Source
-
-describe SexpFormatter do
+RSpec.describe Reek::AST::SexpFormatter do
   describe '::format' do
     it 'formats a simple s-expression' do
-      result = SexpFormatter.format s(:lvar, :foo)
+      result = described_class.format s(:lvar, :foo)
       expect(result).to eq('foo')
     end
 
     it 'formats a more complex s-expression' do
-      result = SexpFormatter.format s(:send, nil, :foo, s(:lvar, :bar))
+      ast = s(:send, nil, :foo, s(:lvar, :bar))
+      result = described_class.format(ast)
       expect(result).to eq('foo(bar)')
     end
 
@@ -22,9 +21,15 @@ describe SexpFormatter do
               s(:begin,
                 s(:send, nil, :baz),
                 s(:send, nil, :qux)))
-      result = SexpFormatter.format ast
+      result = described_class.format ast
 
       expect(result).to eq 'if foo ... end'
     end
+
+    it "doesn't reduce two-line ASTs" do
+      ast = s(:def, 'my_method', s(:args))
+      result = described_class.format ast
+      expect(result).to eq 'def my_method; end'
+    end
   end
 end

data/spec/reek/cli/option_interpreter_spec.rb

@@ -0,0 +1,15 @@
+require_relative '../../spec_helper'
+
+require_relative '../../../lib/reek/cli/options'
+require_relative '../../../lib/reek/report/report'
+
+RSpec.describe Reek::CLI::OptionInterpreter do
+  let(:options) { OpenStruct.new }
+  let(:instance) { Reek::CLI::OptionInterpreter.new(options) }
+
+  describe '#reporter' do
+    it 'returns a Report::TextReport instance by default' do
+      expect(instance.reporter).to be_instance_of Reek::Report::TextReport
+    end
+  end
+end