reek 0.0.1

data/spec/reek/class_checker_spec.rb

@@ -0,0 +1,48 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+require 'reek/class_checker'
+
+include Reek
+
+describe ClassChecker do
+
+  before(:each) do
+    @rpt = []
+    @cchk = ClassChecker.new(@rpt)
+  end
+
+  it 'should report Long Parameter List' do
+    @cchk.check_source('class Inner; def simple(arga, argb, argc, argd) f(3);true end end')
+    @rpt.length.should == 1
+    @rpt[0].report.should match(/Inner#simple/)
+  end
+
+  it 'should report two different methods' do
+    src = <<EOEX
+class Fred
+  def simple(arga, argb, argc, argd) f(3);true end
+  def simply(arga, argb, argc, argd) f(3);false end
+end
+EOEX
+    @cchk.check_source(src)
+    @rpt.length.should == 2
+    @rpt[0].report.should match(/Fred#simple/)
+    @rpt[1].report.should match(/Fred#simply/)
+  end
+
+  it 'should report many different methods' do
+    src = <<EOEX
+class Fred
+    def textile_bq(tag, atts, cite, content) f(3);end
+    def textile_p(tag, atts, cite, content) f(3);end
+    def textile_fn_(tag, num, atts, cite, content) f(3);end
+    def textile_popup_help(name, windowW, windowH) f(3);end
+end
+EOEX
+    @cchk.check_source(src)
+    @rpt.length.should == 3
+    @rpt[0].report.should match(/Fred#textile_bq/)
+    @rpt[1].report.should match(/Fred#textile_p/)
+  end
+
+end

data/spec/reek/feature_envy_spec.rb

@@ -0,0 +1,62 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+require 'reek/method_checker'
+require 'reek/report'
+
+include Reek
+
+describe MethodChecker, "(Feature Envy)" do
+
+  before(:each) do
+    @rpt = Report.new
+    @cchk = MethodChecker.new(@rpt, 'Thing')
+  end
+
+  it 'should not report local method call' do
+    @cchk.check_source('def simple(arga) f(17) end')
+    @rpt.should be_empty
+  end
+
+  it 'should report message chain' do
+    @cchk.check_source('def parse(arga) arga.b.c end')
+    @rpt.length.should == 2
+  end
+
+  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')
+  end
+
+  it 'should report highest affinity' do
+    @cchk.check_source('def simple(arga) slim = ""; s1 = ""; s1.to_s; @m = 34; end')
+    @rpt.length.should == 1
+    @rpt[0].should == FeatureEnvy.new(@cchk, ':s1')
+  end
+
+  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')
+  end
+
+  it 'should not reference global variables' do
+    @cchk.check_source('def simple(arga) @s = ""; $s2.to_a; $s2.to_s; end')
+    @rpt.length.should == 0
+  end
+
+  it 'should not report class methods' do
+    @cchk.check_source('def simple() self.class.new.flatten_merge(self) end')
+    @rpt.should be_empty
+  end
+end
+
+describe FeatureEnvy, '#report' do
+  it 'should report the envious host' do
+    mchk = MethodChecker.new([], 'Class')
+    smell = FeatureEnvy.new(mchk, [:lvar, :fred])
+    smell.report.should match(/fred/)
+    smell.report.should_not match(/:fred/)
+  end
+end

data/spec/reek/large_class_spec.rb

@@ -0,0 +1,45 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+require 'reek/class_checker'
+require 'reek/report'
+
+include Reek
+
+describe ClassChecker, "(Large Class)" do
+
+  class BigOne
+    26.times do |i|
+      define_method "m#{i}".to_sym do
+        @melting
+      end
+    end
+  end
+
+  before(:each) do
+    @rpt = Report.new
+    @cchk = ClassChecker.new(@rpt)
+  end
+
+  it 'should not report short class' do
+    class ShortClass
+      def m1() @m1; end
+      def m2() @m2; end
+      def m3() @m3; end
+      def m4() @m4; end
+      def m5() @m5; end
+      def m6() @m6; end
+    end
+    @cchk.check_object(ShortClass)
+    @rpt.should be_empty
+  end
+
+  it 'should report large class' do
+    @cchk.check_object(BigOne)
+    @rpt.length.should == 1
+  end
+
+  it 'should report class name' do
+    @cchk.check_object(BigOne)
+    @rpt[0].report.should match(/BigOne/)
+  end
+end

data/spec/reek/method_checker_spec.rb

@@ -0,0 +1,201 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+require 'reek/method_checker'
+require 'reek/report'
+
+include Reek
+
+describe MethodChecker, "(Long Parameter List)" do
+  
+  before(:each) do
+    @rpt = Report.new
+    @cchk = MethodChecker.new(@rpt, 'Thing')
+  end
+
+  describe 'with no method definitions' do
+    it 'should report no problems for empty source code' do
+      @cchk.check_source('')
+      @rpt.should be_empty
+    end
+
+    it 'should report no problems for empty class' do
+      @cchk.check_source('class Fred; end')
+      @rpt.should be_empty
+    end
+  end
+  
+  describe 'for methods with few parameters' do
+    it 'should report nothing for no parameters' do
+      @cchk.check_source('def simple; f(3);true; end')
+      @rpt.should be_empty
+    end
+
+    it 'should report nothing for 1 parameter' do
+      @cchk.check_source('def simple(yep) f(3);true end')
+      @rpt.should be_empty
+    end
+
+    it 'should report nothing for 2 parameters' do
+      @cchk.check_source('def simple(yep,zero) f(3);true end')
+      @rpt.should be_empty
+    end
+
+    it 'should not count an optional block' do
+      @cchk.check_source('def simple(alpha, yep, zero, &opt) f(3);true end')
+      @rpt.should be_empty
+    end
+
+    it 'should not report inner block with too many parameters' do
+      @cchk.check_source('def simple(yep,zero); m[3]; rand(34); f.each { |arga, argb, argc, argd| true}; end')
+      @rpt.should be_empty
+    end
+    
+    describe 'and default values' do
+      it 'should report nothing for 1 parameter' do
+        @cchk.check_source('def simple(zero=nil) f(3);false end')
+        @rpt.should be_empty
+      end
+      
+      it 'should report nothing for 2 parameters with 1 default' do
+        @cchk.check_source('def simple(yep, zero=nil) f(3);false end')
+        @rpt.should be_empty
+      end
+      
+      it 'should report nothing for 2 defaulted parameters' do
+        @cchk.check_source('def simple(yep=4, zero=nil) f(3);false end')
+        @rpt.should be_empty
+      end
+    end
+  end
+
+  describe 'for methods with too many parameters' do
+    it 'should report 4 parameters' do
+      @cchk.check_source('def simple(arga, argb, argc, argd) f(3);true end')
+      @rpt.length.should == 1
+      @rpt[0].should == LongParameterList.new(@cchk)
+    end
+    
+    it 'should report 8 parameters' do
+      @cchk.check_source('def simple(arga, argb, argc, argd,arge, argf, argg, argh) f(3);true end')
+      @rpt.length.should == 1
+      @rpt[0].should == LongParameterList.new(@cchk)
+    end
+
+    describe 'and default values' do
+      it 'should report 3 with 1 defaulted' do
+        @cchk.check_source('def simple(polly, queue, yep, zero=nil) f(3);false end')
+        @rpt.length.should == 1
+        @rpt[0].should == LongParameterList.new(@cchk)
+      end
+
+      it 'should report with 3 defaulted' do
+        @cchk.check_source('def simple(aarg, polly=2, yep=true, zero=nil) f(3);false end')
+        @rpt.length.should == 1
+        @rpt[0].should == LongParameterList.new(@cchk)
+      end
+    end
+    
+    describe 'in a class' do
+      class InnerTest
+        def xyzero(arga,argb) f(3);true end
+        def abc(argx,yep,zero,argm) f(3);false end
+      end
+
+      it 'should only report long param list' do
+        @cchk.check_object(InnerTest)
+        @rpt.length.should == 1
+        @rpt[0].should == LongParameterList.new(@cchk)
+      end
+    end
+  end
+  
+  describe 'yield' do
+    it 'should not report yield with few parameters' do
+      @cchk.check_source('def simple(arga, argb, &blk) f(3);yield a,b; end')
+      @rpt.should be_empty
+    end
+
+    it 'should report yield with many parameters' do
+      @cchk.check_source('def simple(arga, argb, &blk) f(3);yield a,b,a,b; end')
+      @rpt.length.should == 1
+      @rpt[0].should == LongYieldList.new(@cchk)
+    end
+
+  end
+
+end
+
+describe MethodChecker, 'when given the class name' do
+  
+  before(:each) do
+    @rpt = Report.new
+    @cchk = MethodChecker.new(@rpt, 'classname')
+  end
+
+  it 'should report the class name' do
+    @cchk.check_source('def simple(arga, argb, argc, argd) f(3);true end')
+    @rpt.length.should == 1
+    @rpt[0].should == LongParameterList.new(@cchk)
+    @rpt[0].report.should match(/classname#simple/)
+  end
+end
+
+describe LongParameterList, '#report' do
+  it 'should report the method name and num params' do
+    mchk = MethodChecker.new([], 'Class')
+    smell = LongParameterList.new(mchk)
+    smell.report.should match(/Class/)
+  end
+
+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
+    @rpt = Report.new
+    @cchk = MethodChecker.new(@rpt, 'Thing')
+  end
+
+  it 'should ignore :cfunc' do
+    @cchk.check_object(Enumerable)
+  end
+end
+

data/spec/reek/report_spec.rb

@@ -0,0 +1,26 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+require 'reek/method_checker'
+require 'reek/report'
+
+include Reek
+
+describe Report, "to_s" do
+
+  before(:each) do
+    rpt = Report.new
+    chk = MethodChecker.new(rpt, 'Thing')
+    chk.check_source('def simple(arga) arga[3] end')
+    @report = rpt.to_s.split("\n")
+  end
+
+  it 'should place each detailed report on a separate line' do
+    @report.length.should == 2
+  end
+
+  it 'should mention every smell name' do
+    @report[0].should match(/[Utility Function]/)
+    @report[1].should match(/[Feature Envy]/)
+  end
+end
+

data/spec/reek/smell_spec.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+require 'reek/smells'
+
+include Reek
+
+describe Smell, "camel case converter" do
+  it "should convert camel case name" do
+    Smell.convert_camel_case('LongParameterList').should == 'Long Parameter List'
+  end
+  
+  it "should display correct name in report" do
+    mchk = MethodChecker.new([], 'Class')
+    smell = FeatureEnvy.new(mchk, [:lvar, :fred])
+    smell.report.should match(/[#{smell.name}]/)
+  end
+end

data/spec/reek/uncommunicative_name_spec.rb

@@ -0,0 +1,106 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+require 'reek/method_checker'
+require 'reek/report'
+
+include Reek
+
+describe MethodChecker, "uncommunicative method name" do
+
+  before(:each) do
+    @rpt = Report.new
+    @cchk = MethodChecker.new(@rpt, 'Thing')
+  end
+
+  it 'should not report one-word method name' do
+    @cchk.check_source('def help(fred) basics(17) end')
+    @rpt.should be_empty
+  end
+
+  it 'should report one-letter method name' do
+    @cchk.check_source('def x(fred) basics(17) end')
+    @rpt.length.should == 1
+    @rpt[0].detailed_report.should match(/x/)
+    @rpt[0].detailed_report.should match(/method name/)
+  end
+end
+
+describe MethodChecker, "uncommunicative field name" do
+
+  before(:each) do
+    @rpt = Report.new
+    @cchk = MethodChecker.new(@rpt, 'Thing')
+  end
+
+  it 'should not report one-word field name' do
+    @cchk.check_source('def help(fred) @simple end')
+    @rpt.should be_empty
+  end
+
+  it 'should report one-letter fieldname' do
+    @cchk.check_source('def simple(fred) @x end')
+    @rpt.length.should == 1
+    @rpt[0].detailed_report.should match(/@x/)
+    @rpt[0].detailed_report.should match(/field name/)
+  end
+end
+
+describe MethodChecker, "uncommunicative local variable name" do
+
+  before(:each) do
+    @rpt = Report.new
+    @cchk = MethodChecker.new(@rpt, 'Thing')
+  end
+
+  it 'should not report one-word variable name' do
+    @cchk.check_source('def help(fred) simple = jim(45) end')
+    @rpt.should be_empty
+  end
+
+  it 'should report one-letter variable name' do
+    @cchk.check_source('def simple(fred) x = jim(45) end')
+    @rpt.length.should == 1
+    @rpt[0].detailed_report.should match(/x/)
+    @rpt[0].detailed_report.should match(/local variable name/)
+  end
+
+  it 'should report variable name only once' do
+    @cchk.check_source('def simple(fred) x = jim(45); x = y end')
+    @rpt.length.should == 1
+  end
+end
+
+describe MethodChecker, "uncommunicative parameter name" do
+
+  before(:each) do
+    @rpt = Report.new
+    @cchk = MethodChecker.new(@rpt, 'Thing')
+  end
+
+  it 'should recognise short parameter name' do
+    @cchk.check_source('def help(x) basics(17) end')
+    @rpt.length.should == 1
+    @rpt[0].name.should == 'Uncommunicative Name'
+  end
+
+  it 'should not recognise *' do
+    @cchk.check_source('def help(xray, *) basics(17) end')
+    @rpt.length.should == 0
+  end
+
+  it "should report parameter's name" do
+    @cchk.check_source('def help(x) basics(17) end')
+    @rpt[0].detailed_report.should match(/x/)
+    @rpt[0].detailed_report.should match(/parameter name/)
+  end
+end
+
+describe UncommunicativeName, '#report' do
+  it 'should report the bad symbol name' do
+    mchk = MethodChecker.new([], 'Class')
+    smell = UncommunicativeName.new(mchk, 'thing')
+    smell.recognise?(:x).should == true
+    smell.report.should match(/x/)
+    smell.report.should_not match(/:x/)
+  end
+end

data/spec/reek/utility_function_spec.rb

@@ -0,0 +1,32 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+require 'reek/method_checker'
+require 'reek/report'
+
+include Reek
+
+describe MethodChecker, "(Utility Function)" do
+
+  before(:each) do
+    @rpt = Report.new
+    @cchk = MethodChecker.new(@rpt, 'Thing')
+  end
+
+  it 'should not report instance variable reference' do
+    @cchk.check_source('def simple(arga) @yellow end')
+    @rpt.should be_empty
+  end
+
+  it 'should not report vcall' do
+    @cchk.check_source('def simple(arga) y end')
+    @rpt.should be_empty
+  end
+
+  it 'should not report attrset' do
+    class Fred
+      attr_writer :xyz
+    end
+    @cchk.check_object(Fred)
+    @rpt.should be_empty
+  end
+end

data/spec/reek_spec.rb

@@ -0,0 +1,27 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+require 'reek'
+
+describe Reek, "#analyse" do
+
+  class ReekAnalyseInner1
+    def short1(str) f(3);true end
+    def long(arga, argb, argc, argd=4) f(3);27 end
+  end
+
+  class ReekAnalyseInner2
+    def long(arga, argb, argc, argd) f(3);27 end
+    def short2(str) f(3);true end
+  end
+
+  it 'should report Long Parameter List' do
+    rpt = Reek.analyse(ReekAnalyseInner1)
+    rpt.length.should == 1
+  end
+
+  it 'should report all Long Parameter Lists' do
+    rpt = Reek.analyse(ReekAnalyseInner1, ReekAnalyseInner2)
+    rpt.length.should == 2
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

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

data/tasks/rspec.rake

@@ -0,0 +1,40 @@
+require 'rake/clean'
+
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+  require 'spec/rake/verify_rcov'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+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']
+end
+
+Spec::Rake::SpecTask.new(:spec_rcov) do |t|
+  t.spec_files = FileList['spec/**/*.rb']
+  t.rcov = true
+  t.rcov_dir = REPORT_DIR
+  t.rcov_opts = ['--exclude', 'spec,\.autotest']
+end
+
+"runs the specs and reports coverage in #{REPORT_DIR}"
+RCov::VerifyTask.new(:spec => :spec_rcov) do |t|
+  t.index_html = "#{REPORT_DIR}/index.html"
+  t.threshold = 100
+end