reek 0.0.1 → 0.1.0

data/History.txt

@@ -1,3 +1,12 @@
+== 0.1.0 2008-09-09
+
+* 1 minor enhancement:
+  * Added a check for nested iterators within a method
+* Some tweaks:
+  * Begun adding some rdoc
+  * Split some of the specs into more meaningful chunks
+  * Updated the rakefile so that rcov is no longer the default
+
 == 0.0.1 2008-09-08
 
 * 1 major enhancement:

data/README.txt

@@ -9,8 +9,19 @@
 Reek is a tool that examines Ruby classes, modules and methods and
 reports any code smells it finds.
 
+=== SUPPORTED SMELLS:
+
+* Long Method
+* Large Class
+* Feature Envy
+* Uncommunicative Name
+* Long Parameter List
+* Utility Function
+* Nested Iterators
+
 == FEATURES/PROBLEMS:
 
+* Most of the current checks are quite naive.
 * Not many smells checked right now; more coming soon.
 * The current Feature Envy check is probably over zealous.
 * There's no convenient programmer's API just yet.
@@ -32,7 +43,7 @@ reports any code smells it finds.
 
 (The MIT License)
 
-Copyright (c) Kevin Rutherford, Rutherford Software
+Copyright (c) 2008 Kevin Rutherford, Rutherford Software
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/reek.rb

@@ -3,14 +3,17 @@ $:.unshift File.dirname(__FILE__)
 require 'reek/class_checker'
 require 'reek/report'
 
-module Reek
+module Reek # :doc:
 
-  def self.analyse(*klasses)
-    report = Report.new
-    klasses.each do |klass|
-      ClassChecker.new(report).check_object(klass)
-    end
-    report
-  end
-  
+    #
+    # Analyse the given instances of class Class, looking for code smells.
+    # Returns a +Report+ listing the smells found.
+    #
+    def self.analyse(*klasses)  # :doc:
+      report = Report.new
+      klasses.each do |klass|
+        ClassChecker.new(report).check_object(klass)
+      end
+      report
+    end    
 end

data/lib/reek/checker.rb

@@ -9,31 +9,39 @@ module Reek
   class Checker < SexpProcessor
     attr_accessor :description
 
-    def initialize(smells)
+    # Creates a new Ruby code checker. Any smells discovered by
+    # +check_source+ or +check_object+ will be stored in +report+.
+    def initialize(report)
       super()
       @require_empty = false
-      @smells = smells
+      @smells = report
       @description = ''
       @unsupported -= [:cfunc]
     end
 
-    def report(smell)
+    def report(smell)  # :nodoc:
       @smells << smell
     end
 
+    # Analyses the given Ruby source +code+ looking for smells.
+    # Any smells found are saved in the +Report+ object that
+    # was passed to this object's constructor.
     def check_source(code)
       check_parse_tree ParseTree.new.parse_tree_for_string(code)
     end
 
+    # Analyses the given Ruby object +obj+ looking for smells.
+    # Any smells found are saved in the +Report+ object that
+    # was passed to this object's constructor.
     def check_object(obj)
       check_parse_tree ParseTree.new.parse_tree(obj)
     end
     
-    def to_s
+    def to_s  # :nodoc:
       description
     end
 
-    def check_parse_tree(sexp)
+    def check_parse_tree(sexp)  # :nodoc:
       sexp.each { |exp| process(exp) }
     end
   end

data/lib/reek/class_checker.rb

@@ -7,12 +7,12 @@ module Reek
 
   class ClassChecker < Checker
 
-    def initialize(smells)
-      super(smells)
+    def initialize(report)
+      super(report)
       @description = ''
     end
 
-    def process_class(exp)
+    def process_class(exp)  # :nodoc:
       @description = exp[1].to_s
       superclass = exp[2]
       LargeClass.check(@description, self)
@@ -20,7 +20,7 @@ module Reek
       s(exp)
     end
 
-    def process_defn(exp)
+    def process_defn(exp)  # :nodoc:
       bc = Reek::MethodChecker.new(@smells, @description)
       bc.process(exp)
       s(exp)

data/lib/reek/method_checker.rb

@@ -15,6 +15,7 @@ module Reek
       @top_level_block = true
       @calls = Hash.new(0)
       @lvars = Set.new
+      @inside_an_iter = false
     end
 
     def process_defn(exp)
@@ -39,7 +40,9 @@ module Reek
     end
 
     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) }
       s(exp)
     end

data/lib/reek/report.rb

@@ -3,26 +3,28 @@ $:.unshift File.dirname(__FILE__)
 module Reek
 
   class Report
-    def initialize
+    def initialize  # :nodoc:
       @smells = []
     end
 
-    def <<(smell)
+    def <<(smell)  # :nodoc:
       @smells << smell
     end
     
-    def empty?
+    def empty?  # :nodoc:
       @smells.empty?
     end
     
-    def length
+    def length  # :nodoc:
       @smells.length
     end
     
-    def [](i)
+    def [](i)  # :nodoc:
       @smells[i]
     end
 
+    # Creates a formatted report of all the smells recorded in
+    # this report.
     def to_s
       @smells.map {|smell| smell.report}.join("\n")
     end

data/lib/reek/smells.rb

@@ -103,15 +103,14 @@ module Reek
 
     def recognise?(calls)
       max = calls.empty? ? 0 : calls.values.max
-      mine = calls[:self]
-      return false unless max > mine
+      return false unless max > calls[:self]
       receivers = calls.keys.select { |key| calls[key] == max }
       @receiver = receivers.map {|r| Printer.print(r)}.sort.join(' or ')
       return true
     end
 
     def detailed_report
-      "#{@context} could be moved to #{@receiver}"
+      "#{@context} uses #{@receiver} more than self"
     end
   end
 
@@ -156,4 +155,14 @@ module Reek
       "#{@context} uses the #{@symbol_type} name '#{@symbol}'"
     end
   end
+
+  class NestedIterators < Smell
+    def recognise?(already_in_iter)
+      already_in_iter
+    end
+
+    def detailed_report
+      "#{@context} has nested iterators"
+    end
+  end
 end

data/lib/reek/version.rb

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

data/spec/reek/long_method_spec.rb

@@ -0,0 +1,52 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+require 'reek/method_checker'
+require 'reek/report'
+
+include Reek
+
+describe MethodChecker, "(Long Method)" do
+
+  before(:each) do
+    @rpt = Report.new
+    @cchk = MethodChecker.new(@rpt, 'Thing')
+  end
+
+  it 'should not report short methods' do
+    @cchk.check_source('def short(arga) alf = f(1);@bet = 2;@cut = 3;@dit = 4; @emp = 5;end')
+    @rpt.should be_empty
+  end
+
+  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)
+  end
+end
+
+describe MethodChecker, "(Long Block)" do
+
+  before(:each) do
+    @rpt = Report.new
+    @cchk = MethodChecker.new(@rpt, 'Thing')
+  end
+
+  it 'should report long inner block' do
+    src = <<EOS
+def long(arga)
+  f(3)
+  37.each do |xyzero|
+    xyzero = 1
+    xyzero = 2
+    xyzero = 3
+    xyzero = 4
+    xyzero = 5
+    xyzero = 6
+  end
+end
+EOS
+    @cchk.check_source(src)
+    @rpt.length.should == 1
+    @rpt[0].report.should match(/block/)
+  end
+end

data/spec/reek/method_checker_spec.rb

@@ -149,44 +149,6 @@ describe LongParameterList, '#report' do
 
 end
 
-describe MethodChecker, "(Long Method)" do
-
-  before(:each) do
-    @rpt = Report.new
-    @cchk = MethodChecker.new(@rpt, 'Thing')
-  end
-
-  it 'should not report short methods' do
-    @cchk.check_source('def short(arga) alf = f(1);@bet = 2;@cut = 3;@dit = 4; @emp = 5;end')
-    @rpt.should be_empty
-  end
-
-  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)
-  end
-
-  it 'should report long inner block' do
-    src = <<EOS
-def long(arga)
-  f(3)
-  37.each do |xyzero|
-    xyzero = 1
-    xyzero = 2
-    xyzero = 3
-    xyzero = 4
-    xyzero = 5
-    xyzero = 6
-  end
-end
-EOS
-    @cchk.check_source(src)
-    @rpt.length.should == 1
-    @rpt[0].report.should match(/block/)
-  end
-end
-
 describe MethodChecker, 'when given a C extension' do
 
   before(:each) do

data/spec/reek/nested_iterators_spec.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+require 'reek/method_checker'
+require 'reek/report'
+
+include Reek
+
+describe MethodChecker, " nested iterators" do
+
+  before(:each) do
+    @rpt = Report.new
+    @chk = MethodChecker.new(@rpt, 'Thing')
+  end
+
+  it "should report nested iterators in a method" do
+    @chk.check_source('def bad(fred) @fred.each {|item| item.each {|ting| ting.ting} } end')
+    @rpt.length.should == 1
+  end
+end
+

data/tasks/rspec.rake

@@ -20,12 +20,12 @@ end
 REPORT_DIR = 'spec/output/coverage'
 CLEAN.include(REPORT_DIR)
 
-desc 'runs the specs in colour'
-Spec::Rake::SpecTask.new(:spec_colour) do |t|
-  t.spec_opts = ['--options', "spec/spec.opts"]
-  t.spec_files = FileList['spec/**/*_spec.rb']
+desc "runs the specs"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_files = FileList['spec/**/*.rb']
 end
 
+desc "runs the specs and reports coverage in #{REPORT_DIR}"
 Spec::Rake::SpecTask.new(:spec_rcov) do |t|
   t.spec_files = FileList['spec/**/*.rb']
   t.rcov = true
@@ -33,8 +33,8 @@ Spec::Rake::SpecTask.new(:spec_rcov) do |t|
   t.rcov_opts = ['--exclude', 'spec,\.autotest']
 end
 
-"runs the specs and reports coverage in #{REPORT_DIR}"
-RCov::VerifyTask.new(:spec => :spec_rcov) do |t|
+desc "runs the specs and checks for 100% coverage"
+RCov::VerifyTask.new(:rcov => :spec_rcov) do |t|
   t.index_html = "#{REPORT_DIR}/index.html"
   t.threshold = 100
 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.0.1</a>
+      <a href="http://rubyforge.org/projects/reek" class="numbers">0.1.0</a>
     </div>
     <h1>&#x2192; &#8216;reek&#8217;</h1>
 
@@ -62,16 +62,21 @@
 	<p>(More details coming soon&#8230;)</p>
 
 
-	<h2>Demonstration of usage</h2>
+	<h2>Code Smells</h2>
 
 
-	<p>(More details coming soon&#8230;)</p>
-
-
-	<h2>Forum</h2>
+	<p>reek currently includes very naive checks for the following code smells:</p>
 
 
-	<p>Coming soon&#8230;</p>
+	<ul>
+	<li>Long Method</li>
+		<li>Large Class</li>
+		<li>Feature Envy</li>
+		<li>Uncommunicative Name</li>
+		<li>Long Parameter List</li>
+		<li>Utility Function</li>
+		<li>Nested Iterators</li>
+	</ul>
 
 
 	<h2>How to access the source code</h2>
@@ -91,7 +96,7 @@
 
 	<p>Comments are welcome. Send an email to <a href="mailto:kevin@rutherford-software.com">Kevin Rutherford</a></p>
     <p class="coda">
-      <a href="http://www.kevinrutherford.co.uk">Kevin Rutherford</a>, 8th September 2008<br>
+      <a href="http://www.kevinrutherford.co.uk">Kevin Rutherford</a>, 9th September 2008<br>
       Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
     </p>
 </div>

data/website/index.txt

@@ -20,13 +20,17 @@ h2. The basics
 
 (More details coming soon...)
 
-h2. Demonstration of usage
+h2. Code Smells
 
-(More details coming soon...)
-
-h2. Forum
+reek currently includes very naive checks for the following code smells:
 
-Coming soon...
+* Long Method
+* Large Class
+* Feature Envy
+* Uncommunicative Name
+* Long Parameter List
+* Utility Function
+* Nested Iterators
 
 h2. How to access the source code
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: reek
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors: 
 - Kevin Rutherford
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-08 00:00:00 +01:00
+date: 2008-09-09 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -60,7 +60,9 @@ files:
 - spec/reek/class_checker_spec.rb
 - spec/reek/feature_envy_spec.rb
 - spec/reek/large_class_spec.rb
+- spec/reek/long_method_spec.rb
 - spec/reek/method_checker_spec.rb
+- spec/reek/nested_iterators_spec.rb
 - spec/reek/report_spec.rb
 - spec/reek/smell_spec.rb
 - spec/reek/uncommunicative_name_spec.rb