reek 0.1.0 → 0.1.1

data/History.txt

@@ -1,3 +1,11 @@
+== 0.1.1 2008-09-09
+
+* Some tweaks:
+  * Fixed report printing for Feature Envy when the receiver is a block
+  * Fixed: successive iterators reported as nested
+  * Fixed: Long Method now reports the total length of the method
+  * Fixed: each smell reported only once
+
 == 0.1.0 2008-09-09
 
 * 1 minor enhancement:

data/README.txt

@@ -2,7 +2,7 @@
 
 * http://rubyforge.org/projects/reek/
 * http://www.refactoring-workbook.com/reek
-* mailto:kevin@rutherford-software.com
+* kevin@rutherford-software.com
 
 == DESCRIPTION:
 

data/lib/reek/method_checker.rb

@@ -12,19 +12,20 @@ module Reek
       super(smells)
       @class_name = klass_name
       @description = klass_name
-      @top_level_block = true
       @calls = Hash.new(0)
       @lvars = Set.new
       @inside_an_iter = false
     end
 
     def process_defn(exp)
+      @num_statements = 0
       @description = "#{@class_name}##{exp[1]}"
       UncommunicativeName.check(exp[1], self, 'method')
       process(exp[2])
       @lvars.each {|lvar| UncommunicativeName.check(lvar, self, 'local variable') }
       UtilityFunction.check(@calls, self)
       FeatureEnvy.check(@calls, self)
+      LongMethod.check(@num_statements, self)
       s(exp)
     end
 
@@ -41,18 +42,14 @@ module Reek
 
     def process_iter(exp)
       NestedIterators.check(@inside_an_iter, self)
-      @top_level_block = false
       @inside_an_iter = true
       exp[1..-1].each { |s| process(s) }
+      @inside_an_iter = false
       s(exp)
     end
 
     def process_block(exp)
-      if @top_level_block
-        LongMethod.check(exp, self)
-      else
-        LongBlock.check(exp, self)
-      end
+      @num_statements += count_statements(exp)
       exp[1..-1].each { |s| process(s) }
       s(exp)
     end
@@ -108,5 +105,13 @@ module Reek
       process(exp[2])
       s(exp)
     end
+
+  private
+    
+    def count_statements(exp)
+      result = exp.length - 1
+      result -= 1 if Array === exp[1] and exp[1][0] == :args
+      result
+    end
   end
 end

data/lib/reek/printer.rb

@@ -19,7 +19,11 @@ module Reek
 
     def print(sexp)
       @report = sexp.inspect
-      process(sexp)
+      begin
+        process(sexp)
+      rescue
+        raise "Error in print, parsing:\n #{sexp.inspect}"
+      end
       @report
     end
 
@@ -43,6 +47,11 @@ module Reek
       s(exp)
     end
 
+    def process_iter(exp)
+      @report = 'block'
+      s(exp)
+    end
+
     def process_call(exp)
       @report = "#{exp[1]}.#{exp[2]}"
       @report += "(#{exp[3]})" if exp.length > 3

data/lib/reek/report.rb

@@ -1,10 +1,12 @@
 $:.unshift File.dirname(__FILE__)
 
+require 'set'
+
 module Reek
 
   class Report
     def initialize  # :nodoc:
-      @smells = []
+      @smells = SortedSet.new
     end
 
     def <<(smell)  # :nodoc:
@@ -14,13 +16,17 @@ module Reek
     def empty?  # :nodoc:
       @smells.empty?
     end
-    
+
+    def include?(obj)  # :nodoc:
+      @smells.include?(obj)
+    end
+
     def length  # :nodoc:
       @smells.length
     end
-    
+
     def [](i)  # :nodoc:
-      @smells[i]
+      @smells.to_a[i]
     end
 
     # Creates a formatted report of all the smells recorded in

data/lib/reek/smells.rb

@@ -5,6 +5,8 @@ require 'reek/printer'
 module Reek
 
   class Smell
+    include Comparable
+  
     def self.convert_camel_case(class_name)
       class_name.gsub(/([a-z])([A-Z])/) { |s| "#{$1} #{$2}"}
     end
@@ -18,8 +20,16 @@ module Reek
       context.report(smell) if smell.recognise?(exp)
     end
 
-    def ==(other)
-      self.report == other.report
+    def hash  # :nodoc:
+      report.hash
+    end
+
+    def <=>(other)  # :nodoc:
+      self.report <=> other.report
+    end
+
+    def eql?(other)  # :nodoc:
+      self.report.eql?(other.report)
     end
     
     def name
@@ -62,36 +72,13 @@ module Reek
   class LongMethod < Smell
     MAX_ALLOWED = 5
 
-    def count_statements(exp)
-      result = exp.length - 1
-      result -= 1 if Array === exp[1] and exp[1][0] == :args
-      result
-    end
-
-    def recognise?(exp)
-      count_statements(exp) > MAX_ALLOWED
-    end
-
-    def detailed_report
-      "#{@context} has > #{MAX_ALLOWED} statements"
-    end
-  end
-
-  class LongBlock < Smell
-    MAX_ALLOWED = 5
-
-    def count_statements(exp)
-      result = exp.length - 1
-      result -= 1 if Array === exp[1] and exp[1][0] == :args
-      result
-    end
-
-    def recognise?(exp)
-      count_statements(exp) > MAX_ALLOWED
+    def recognise?(num_stmts)
+      @num_stmts = num_stmts
+      num_stmts > MAX_ALLOWED
     end
 
     def detailed_report
-      "#{@context} has a block with > #{MAX_ALLOWED} statements"
+      "#{@context} has approx #{@num_stmts} statements"
     end
   end
 
@@ -105,7 +92,7 @@ module Reek
       max = calls.empty? ? 0 : calls.values.max
       return false unless max > calls[:self]
       receivers = calls.keys.select { |key| calls[key] == max }
-      @receiver = receivers.map {|r| Printer.print(r)}.sort.join(' or ')
+      @receiver = receivers.map {|r| Printer.print(r)}.sort.join(' and ')
       return true
     end
 

data/lib/reek/version.rb

@@ -2,7 +2,7 @@ module Reek #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 1
-    TINY  = 0
+    TINY  = 1
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/spec/reek/feature_envy_spec.rb

@@ -25,8 +25,8 @@ describe MethodChecker, "(Feature Envy)" do
   it 'should report simple parameter call' do
     @cchk.check_source('def simple(arga) arga[3] end')
     @rpt.length.should == 2
-    @rpt[0].should == UtilityFunction.new(@cchk)
-    @rpt[1].should == FeatureEnvy.new(@cchk, ':arga')
+    @rpt[1].should == UtilityFunction.new(@cchk)
+    @rpt[0].should == FeatureEnvy.new(@cchk, ':arga')
   end
 
   it 'should report highest affinity' do
@@ -38,7 +38,7 @@ describe MethodChecker, "(Feature Envy)" do
   it 'should report multiple affinities' do
     @cchk.check_source('def simple(arga) s1 = ""; s1.to_s; s2 = ""; s2.to_s; @m = 34; end')
     @rpt.length.should == 1
-    @rpt[0].should == FeatureEnvy.new(@cchk, ':s1 or :s2')
+    @rpt[0].should == FeatureEnvy.new(@cchk, ':s1 and :s2')
   end
 
   it 'should not reference global variables' do

data/spec/reek/long_method_spec.rb

@@ -20,7 +20,31 @@ describe MethodChecker, "(Long Method)" do
   it 'should report long methods' do
     @cchk.check_source('def long(arga) alf = f(1);@bet = 2;@cut = 3;@dit = 4; @emp = 5;@fry = 6;end')
     @rpt.length.should == 1
-    @rpt[0].should == LongMethod.new(@cchk)
+    @rpt[0].should be_instance_of(LongMethod)
+  end
+
+  it 'should only report a long method once' do
+    source =<<EOS
+  def standard_entries(rbconfig)
+    @abc = rbconfig
+    rubypath = File.join(@abc['bindir'], @abc['ruby_install_name'] + c['EXEEXT'])
+    major = c['MAJOR'].to_i
+    minor = c['MINOR'].to_i
+    teeny = c['TEENY'].to_i
+    version = ""
+    if c['rubylibdir']
+      libruby         = "/lib/ruby"
+      librubyver      = "/lib/ruby/"
+      librubyverarch  = "/lib/ruby/"
+      siteruby        = "lib/ruby/version/site_ruby"
+      siterubyver     = siteruby
+      siterubyverarch = "$siterubyver/['arch']}"
+    end
+  end
+EOS
+    @cchk.check_source(source)
+    @rpt.length.should == 1
+    @rpt[0].should be_instance_of(LongMethod)
   end
 end
 
@@ -47,6 +71,5 @@ end
 EOS
     @cchk.check_source(src)
     @rpt.length.should == 1
-    @rpt[0].report.should match(/block/)
   end
 end

data/spec/reek/nested_iterators_spec.rb

@@ -16,5 +16,27 @@ describe MethodChecker, " nested iterators" do
     @chk.check_source('def bad(fred) @fred.each {|item| item.each {|ting| ting.ting} } end')
     @rpt.length.should == 1
   end
+
+  it "should not report method with successive iterators" do
+    source =<<EOS
+def bad(fred)
+  @fred.each {|item| item.each }
+  @jim.each {|item| item.each }
+end    
+EOS
+    @chk.check_source(source)
+    @rpt.should be_empty
+  end
+
+  it "should report nested iterators only once per method" do
+    source =<<EOS
+def bad(fred)
+  @fred.each {|item| item.each {|part| @jim.send} }
+  @jim.each {|item| item.each {|piece| @fred.send} }
+end    
+EOS
+    @chk.check_source(source)
+    @rpt.length.should == 1
+  end
 end
 

data/spec/reek/report_spec.rb

@@ -1,12 +1,26 @@
 require File.dirname(__FILE__) + '/../spec_helper.rb'
 
 require 'reek/method_checker'
+require 'reek/smells'
 require 'reek/report'
 
 include Reek
 
-describe Report, "to_s" do
+describe Report, " when empty" do
+  before(:each) do
+    @rpt = Report.new
+  end
+
+  it 'should have zero length' do
+    @rpt.length.should == 0
+  end
+
+  it 'should claim to be empty' do
+    @rpt.should be_empty
+  end
+end
 
+describe Report, "to_s" do
   before(:each) do
     rpt = Report.new
     chk = MethodChecker.new(rpt, 'Thing')
@@ -24,3 +38,12 @@ describe Report, "to_s" do
   end
 end
 
+describe Report, " as a SortedSet" do
+  it 'should only add a smell once' do
+    rpt = Report.new
+    rpt << UtilityFunction.new(self)
+    rpt.length.should == 1
+    rpt << UtilityFunction.new(self)
+    rpt.length.should == 1
+  end
+end

data/spec/reek/smell_spec.rb

@@ -10,8 +10,24 @@ describe Smell, "camel case converter" do
   end
   
   it "should display correct name in report" do
-    mchk = MethodChecker.new([], 'Class')
-    smell = FeatureEnvy.new(mchk, [:lvar, :fred])
+    smell = FeatureEnvy.new(self, [:lvar, :fred])
     smell.report.should match(/[#{smell.name}]/)
   end
 end
+
+describe Smell, ' in comparisons' do
+  it 'should hash equal when the smell is the same' do
+    UtilityFunction.new(self).hash.should == UtilityFunction.new(self).hash
+    NestedIterators.new(self).hash.should == NestedIterators.new(self).hash
+  end
+
+  it 'should compare equal when the smell is the same' do
+    UtilityFunction.new(self).should == UtilityFunction.new(self)
+    NestedIterators.new(self).should == NestedIterators.new(self)
+  end
+
+  it 'should compare equal when using <=>' do
+    (UtilityFunction.new(self) <=> UtilityFunction.new(self)).should == 0
+    (NestedIterators.new(self) <=> NestedIterators.new(self)).should == 0
+  end
+end

data/website/index.html

@@ -33,7 +33,7 @@
     <h1>Code smell detector</h1>
     <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/reek"; return false'>
       <p>Get Version</p>
-      <a href="http://rubyforge.org/projects/reek" class="numbers">0.1.0</a>
+      <a href="http://rubyforge.org/projects/reek" class="numbers">0.1.1</a>
     </div>
     <h1>&#x2192; &#8216;reek&#8217;</h1>
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: reek
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Kevin Rutherford