kevinrutherford-reek 1.1.3 → 1.1.3.1

data/History.txt

@@ -1,3 +1,9 @@
+== 1.1.4 (in git)
+
+=== Minor Changes
+* LongMethod now counts statements deeper into each method (#25)
+* LongMethod no longer counts control structures, only their contained stmts
+
 == 1.1.3 2009-05-19
 
 === Minor Changes

data/lib/reek/class_context.rb

@@ -28,9 +28,8 @@ module Reek
     end
 
     def find_module(modname)
-      sym = modname.to_s
       return nil unless myself
-      @myself.const_defined?(sym) ? @myself.const_get(sym) : nil
+      @myself.const_or_nil(modname.to_s)
     end
 
     def is_overriding_method?(name)

data/lib/reek/code_context.rb

@@ -1,3 +1,10 @@
+class Module
+
+  def const_or_nil(sym)
+    const_defined?(sym) ? const_get(sym) : nil
+  end
+end
+
 module Reek
   
   #

data/lib/reek/code_parser.rb

@@ -9,6 +9,20 @@ require 'reek/method_context'
 require 'reek/singleton_method_context'
 require 'reek/yield_call_context'
 
+class Sexp
+  def children
+    find_all { |item| Sexp === item }
+  end
+
+  def is_language_node?
+    first.class == Symbol
+  end
+
+  def has_type?(type)
+    is_language_node? and first == type
+  end
+end
+
 module Reek
 
   class CodeParser
@@ -25,6 +39,7 @@ module Reek
       meth = "process_#{exp[0]}"
       meth = :process_default unless self.respond_to?(meth)
       self.send(meth, exp)
+      @element
     end
 
     def process_default(exp)
@@ -90,19 +105,10 @@ module Reek
       process_default(exp)
     end
 
-    def process_fcall(exp)
-      @element.record_use_of_self
-      process_default(exp)
-    end
-
     def process_cfunc(exp)
       @element.record_depends_on_self
     end
 
-    def process_vcall(exp)
-      @element.record_use_of_self
-    end
-
     def process_attrasgn(exp)
       process_call(exp)
     end
@@ -112,7 +118,49 @@ module Reek
     end
 
     def process_if(exp)
+      count_clause(exp[2])
+      count_clause(exp[3])
       handle_context(IfContext, :if, exp)
+      @element.count_statements(-1)
+    end
+
+    def process_while(exp)
+      count_clause(exp[2])
+      process_default(exp)
+      @element.count_statements(-1)
+    end
+
+    def process_until(exp)
+      count_clause(exp[2])
+      process_default(exp)
+      @element.count_statements(-1)
+    end
+
+    def process_for(exp)
+      count_clause(exp[3])
+      process_default(exp)
+      @element.count_statements(-1)
+    end
+
+    def process_rescue(exp)
+      count_clause(exp[1])
+      process_default(exp)
+      @element.count_statements(-1)
+    end
+
+    def process_resbody(exp)
+      count_clause(exp[2])
+      process_default(exp)
+    end
+
+    def process_case(exp)
+      process_default(exp)
+      @element.count_statements(-1)
+    end
+
+    def process_when(exp)
+      count_clause(exp[2])
+      process_default(exp)
     end
 
     def process_ivar(exp)
@@ -134,33 +182,33 @@ module Reek
       @element.record_depends_on_self
     end
 
+    def count_clause(sexp)
+      if sexp and !sexp.has_type?(:block)
+        @element.count_statements(1)
+      end
+    end
+
     def self.count_statements(exp)
       stmts = exp[1..-1]
       ignore = 0
-      ignore = 1 if is_expr?(stmts[0], :args)
       ignore += 1 if stmts[1] == s(:nil)
       stmts.length - ignore
     end
 
   private
 
-    def self.is_expr?(exp, type)
-      Array === exp and exp[0] == type
-    end
-
-    def self.is_global_variable?(exp)
-      is_expr?(exp, :gvar)
-    end
-
     def handle_context(klass, type, exp)
-      push(klass.new(@element, exp)) do
+      scope = klass.new(@element, exp)
+      push(scope) do
         process_default(exp)
         check_smells(type)
       end
+      scope
     end
 
     def check_smells(type)
-      @smells[type].each {|smell| smell.examine(@element, @report) }
+      listeners = @smells[type]
+      listeners.each {|smell| smell.examine(@element, @report) } if listeners
     end
 
     def push(context)
@@ -169,9 +217,5 @@ module Reek
       yield
       @element = orig
     end
-    
-    def pop(exp)
-      @element = @element.outer
-    end
   end
 end

data/lib/reek/module_context.rb

@@ -19,8 +19,7 @@ module Reek
 
     def find_module(modname)
       return nil unless myself
-      sym = modname.to_s
-      @myself.const_defined?(sym) ? @myself.const_get(sym) : nil
+      @myself.const_or_nil(modname.to_s)
     end
 
     def outer_name

data/lib/reek/options.rb

@@ -44,8 +44,8 @@ EOB
     def self.parse(args)
       begin
         @@opts = parse_args(args)
-        if ARGV.length > 0
-          return Source.from_pathlist(ARGV)
+        if args.length > 0
+          return Source.from_pathlist(args)
         else
           return Source.from_io($stdin, 'stdin')
         end

data/lib/reek.rb

@@ -1,5 +1,5 @@
 $:.unshift File.dirname(__FILE__)
 
 module Reek # :doc:
-  VERSION = '1.1.3'
+  VERSION = '1.1.3.1'
 end

data/reek.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{reek}
-  s.version = "1.1.3"
+  s.version = "1.1.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kevin Rutherford"]
-  s.date = %q{2009-05-19}
+  s.date = %q{2009-06-04}
   s.default_executable = %q{reek}
   s.description = %q{Code smell detector for Ruby}
   s.email = ["kevin@rutherford-software.com"]

data/spec/reek/options_spec.rb

@@ -7,7 +7,7 @@ include Reek
 describe Options, ' when given no arguments' do
   it "should retain the default sort order" do
     default_order = Options[:format]
-    Options.parse ['nosuchfile.rb']
+    Options.parse_args(['nosuchfile.rb'])
     Options[:format].should == default_order
   end
 end

data/spec/reek/smells/feature_envy_spec.rb

@@ -177,12 +177,8 @@ describe FeatureEnvy do
   it 'counts self references correctly' do
     'def adopt!(other)
       other.keys.each do |key|
-        ov = other[key]
-        if Array === ov and has_key?(key)
-          self[key] += ov
-        else
-          self[key] = ov
-        end
+        self[key] += 3
+        self[key] = o4
       end
       self
     end'.should_not reek
@@ -202,7 +198,7 @@ def report
   @report
 end
 EOS
-    ruby.should reek_only_of(:LongMethod)
+    ruby.should_not reek
   end
 end
 

data/spec/reek/smells/long_method_spec.rb

@@ -2,8 +2,10 @@ require File.dirname(__FILE__) + '/../../spec_helper.rb'
 
 require 'reek/code_parser'
 require 'reek/report'
+require 'reek/smells/long_method'
 
 include Reek
+include Reek::Smells
 
 describe LongMethod do
   it 'should not report short methods' do
@@ -57,3 +59,175 @@ EOS
     src.should reek_only_of(:LongMethod)
   end
 end
+
+describe LongMethod do
+  it 'counts 1 assignment' do
+    src = 'def one() val = 4; end'
+    source = Source.from_s(src)
+    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method.num_statements.should == 1
+  end
+
+  it 'counts 3 assignments' do
+    src = 'def one() val = 4; val = 4; val = 4; end'
+    source = Source.from_s(src)
+    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method.num_statements.should == 3
+  end
+
+  it 'counts 1 attr assignment' do
+    src = 'def one() val[0] = 4; end'
+    source = Source.from_s(src)
+    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method.num_statements.should == 1
+  end
+
+  it 'counts 1 increment assignment' do
+    src = 'def one() val += 4; end'
+    source = Source.from_s(src)
+    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method.num_statements.should == 1
+  end
+
+  it 'counts 1 increment attr assignment' do
+    src = 'def one() val[0] += 4; end'
+    source = Source.from_s(src)
+    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method.num_statements.should == 1
+  end
+
+  it 'counts 1 nested assignment' do
+    src = 'def one() val = fred = 4; end'
+    source = Source.from_s(src)
+    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method.num_statements.should == 1
+  end
+
+  it 'counts returns' do
+    src = 'def one() val = 4; true; end'
+    source = Source.from_s(src)
+    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method.num_statements.should == 2
+  end
+end
+
+describe LongMethod, 'does not count control statements' do
+  it 'counts 1 statement in a conditional expression' do
+    src = 'def one() if val == 4; callee(); end; end'
+    source = Source.from_s(src)
+    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method.num_statements.should == 1
+  end
+
+  it 'counts 3 statements in a conditional expression' do
+    src = 'def one() if val == 4; callee(); callee(); callee(); end; end'
+    source = Source.from_s(src)
+    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method.num_statements.should == 3
+  end
+
+  it 'does not count empty conditional expression' do
+    src = 'def one() if val == 4; ; end; end'
+    source = Source.from_s(src)
+    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method.num_statements.should == 0
+  end
+
+  it 'counts 1 statement in a while loop' do
+    src = 'def one() while val < 4; callee(); end; end'
+    source = Source.from_s(src)
+    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method.num_statements.should == 1
+  end
+
+  it 'counts 3 statements in a while loop' do
+    src = 'def one() while val < 4; callee(); callee(); callee(); end; end'
+    source = Source.from_s(src)
+    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method.num_statements.should == 3
+  end
+
+  it 'counts 1 statement in a until loop' do
+    src = 'def one() until val < 4; callee(); end; end'
+    source = Source.from_s(src)
+    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method.num_statements.should == 1
+  end
+
+  it 'counts 3 statements in a until loop' do
+    src = 'def one() until val < 4; callee(); callee(); callee(); end; end'
+    source = Source.from_s(src)
+    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method.num_statements.should == 3
+  end
+
+  it 'counts 1 statement in a for loop' do
+    src = 'def one() for i in 0..4; callee(); end; end'
+    source = Source.from_s(src)
+    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method.num_statements.should == 1
+  end
+
+  it 'counts 3 statements in a for loop' do
+    src = 'def one() for i in 0..4; callee(); callee(); callee(); end; end'
+    source = Source.from_s(src)
+    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method.num_statements.should == 3
+  end
+
+  it 'counts 1 statement in a rescue' do
+    src = 'def one() begin; callee(); rescue; callee(); end; end'
+    source = Source.from_s(src)
+    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method.num_statements.should == 2
+  end
+
+  it 'counts 3 statements in a rescue' do
+    src = 'def one() begin; callee(); callee(); callee(); rescue; callee(); callee(); callee(); end; end'
+    source = Source.from_s(src)
+    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method.num_statements.should == 6
+  end
+
+  it 'counts 1 statement in a when' do
+    src = 'def one() case fred; when "hi"; callee(); end; end'
+    source = Source.from_s(src)
+    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method.num_statements.should == 1
+  end
+
+  it 'counts 3 statements in a when' do
+    src = 'def one() case fred; when "hi"; callee(); callee(); when "lo"; callee(); end; end'
+    source = Source.from_s(src)
+    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method.num_statements.should == 3
+  end
+
+  it 'does not count empty case' do
+    src = 'def one() case fred; when "hi"; ; when "lo"; ; end; end'
+    source = Source.from_s(src)
+    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method.num_statements.should == 0
+  end
+
+  it 'counts else statement' do
+    src = <<EOS
+def parse(arg, argv, &error)
+  if !(val = arg) and (argv.empty? or /\A-/ =~ (val = argv[0]))
+    return nil, block, nil
+  end
+  opt = (val = parse_arg(val, &error))[1]
+  val = conv_arg(*val)
+  if opt and !arg
+    argv.shift
+  else
+    val[0] = nil
+  end
+  val
+end
+EOS
+    source = Source.from_s(src)
+    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method.num_statements.should == 6
+  end
+end

data/spec/slow/inline_spec.rb

@@ -22,11 +22,8 @@ describe 'sample gem source code' do
     ruby.should reek_of(:Duplication, /Module#inline/, /Inline.const_get\(lang\)/)
     ruby.should reek_of(:FeatureEnvy, /Inline::C#strip_comments/, /src/)
     ruby.should reek_of(:LargeClass, /Inline::C/, /instance variables/)
-    ruby.should reek_of(:LongMethod, /File#self.write_with_backup/)
     ruby.should reek_of(:LongMethod, /Inline::C#build/)
     ruby.should reek_of(:LongMethod, /Inline::C#generate/)
-    ruby.should reek_of(:LongMethod, /Inline::C#load_cache/)
-    ruby.should reek_of(:LongMethod, /Inline::C#module_name/)
     ruby.should reek_of(:LongMethod, /Inline::C#parse_signature/)
     ruby.should reek_of(:LongMethod, /Inline::self.rootdir/)
     ruby.should reek_of(:LongMethod, /Module#inline/)
@@ -38,6 +35,6 @@ describe 'sample gem source code' do
     ruby.should reek_of(:UncommunicativeName, /Inline::C#module_name/, /'x'/)
     ruby.should reek_of(:UncommunicativeName, /Inline::C#parse_signature/, /'x'/)
     ruby.should reek_of(:UtilityFunction, /Inline::C#strip_comments/)
-    ruby.report.should have_at_most(35).smells
+    ruby.report.should have_at_most(32).smells
   end
 end

data/spec/slow/optparse_spec.rb

@@ -54,6 +54,7 @@ describe 'sample gem source code' do
     ruby.should reek_of(:LargeClass, /OptionParser/)
     ruby.should reek_of(:LongMethod, /OptionParser#Completion::complete/)
     ruby.should reek_of(:LongMethod, /OptionParser#List#update/)
+    ruby.should reek_of(:LongMethod, /OptionParser#Switch#PlacedArgument#parse/)
     ruby.should reek_of(:LongMethod, /OptionParser#Switch#parse_arg/)
     ruby.should reek_of(:LongMethod, /OptionParser#Switch#summarize/)
     ruby.should reek_of(:LongMethod, /OptionParser#getopts/)
@@ -103,6 +104,6 @@ describe 'sample gem source code' do
     ruby.should reek_of(:UncommunicativeName, /OptionParser#summarize/, /'l'/)
     ruby.should reek_of(:UncommunicativeName, /OptionParser#ver/, /'v'/)
     ruby.should reek_of(:UncommunicativeName, /block/, /'q'/)
-    ruby.report.should have_at_most(116).smells
+    ruby.report.should have_at_most(117).smells
   end
 end

data/spec/spec_helper.rb

@@ -1,11 +1,11 @@
 $:.unshift File.dirname(__FILE__) + '/../lib'
 
 begin
-  require 'spec'
+  require 'spec/expectations'
 rescue LoadError
   require 'rubygems'
   gem 'rspec'
-  require 'spec'
+  require 'spec/expectations'
 end
 
 require 'reek/spec'

data/tasks/rspec.rake

@@ -13,7 +13,8 @@ namespace 'rspec' do
 
   Spec::Rake::SpecTask.new('all') do |t|
     t.spec_files = FAST + SLOW
-    t.rcov = false
+    t.rcov = true
+    t.rcov_dir = 'build/coverage'
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: kevinrutherford-reek
 version: !ruby/object:Gem::Version 
-  version: 1.1.3
+  version: 1.1.3.1
 platform: ruby
 authors: 
 - Kevin Rutherford
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-19 00:00:00 -07:00
+date: 2009-06-04 00:00:00 -07:00
 default_executable: reek
 dependencies: 
 - !ruby/object:Gem::Dependency