reek 1.1.3 → 1.2.0

data/spec/reek/adapters/should_reek_spec.rb

@@ -0,0 +1,92 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+require 'reek/adapters/report'
+require 'reek/adapters/spec'
+
+include Reek
+include Reek::Spec
+
+describe ShouldReek, 'checking code in a string' do
+  before :each do
+    @clean_code = 'def good() true; end'
+    @smelly_code = 'def x() y = 4; end'
+    @matcher = ShouldReek.new
+  end
+
+  it 'matches a smelly String' do
+    @matcher.matches?(@smelly_code).should be_true
+  end
+
+  it 'doesnt match a fragrant String' do
+    @matcher.matches?(@clean_code).should be_false
+  end
+
+  it 'reports the smells when should_not fails' do
+    @matcher.matches?(@smelly_code).should be_true
+    @matcher.failure_message_for_should_not.should include(Report.new(@smelly_code.sniff).quiet_report)
+  end
+end
+
+describe ShouldReek, 'checking code in a Dir' do
+  before :each do
+    @clean_dir = Dir['spec/samples/three_clean_files/*.rb']
+    @smelly_dir = Dir['spec/samples/two_smelly_files/*.rb']
+    @matcher = ShouldReek.new
+  end
+
+  it 'matches a smelly String' do
+    @matcher.matches?(@smelly_dir).should be_true
+  end
+
+  it 'doesnt match a fragrant String' do
+    @matcher.matches?(@clean_dir).should be_false
+  end
+
+  it 'reports the smells when should_not fails' do
+    @matcher.matches?(@smelly_dir).should be_true
+    @matcher.failure_message_for_should_not.should include(Report.new(@smelly_dir.sniff.sniffers).quiet_report)
+  end
+end
+
+describe ShouldReek, 'checking code in a File' do
+  before :each do
+    @clean_file = File.new(Dir['spec/samples/three_clean_files/*.rb'][0])
+    @smelly_file = File.new(Dir['spec/samples/two_smelly_files/*.rb'][0])
+    @matcher = ShouldReek.new
+  end
+
+  it 'matches a smelly String' do
+    @matcher.matches?(@smelly_file).should be_true
+  end
+
+  it 'doesnt match a fragrant String' do
+    @matcher.matches?(@clean_file).should be_false
+  end
+
+  it 'reports the smells when should_not fails' do
+    @matcher.matches?(@smelly_file).should be_true
+    @matcher.failure_message_for_should_not.should include(Report.new(@smelly_file.sniff).quiet_report)
+  end
+end
+
+describe ShouldReek, 'report formatting' do
+  before :each do
+    sn_clean = 'def clean() @thing = 4; end'.sniff
+    sn_dirty = 'def dirty() thing.cool + thing.cool; end'.sniff
+    sniffers = SnifferSet.new([sn_clean, sn_dirty], '')
+    @matcher = ShouldReek.new
+    @matcher.matches?(sniffers)
+    @lines = @matcher.failure_message_for_should_not.split("\n").map {|str| str.chomp}
+    @error_message = @lines.shift
+    @smells = @lines.grep(/^  /)
+    @headers = (@lines - @smells)
+  end
+
+  it 'mentions every smell in the report' do
+    @smells.should have(2).warnings
+  end
+
+  it 'doesnt mention the clean files' do
+    @headers.should have(1).headers
+  end
+end

data/spec/reek/block_context_spec.rb

@@ -27,7 +27,7 @@ describe BlockContext do
   end
 
   it "should not pass parameters upward" do
-    mc = MethodContext.new(StopContext.new, s(:defn, :help))
+    mc = MethodContext.new(StopContext.new, s(:defn, :help, s(:args)))
     element = BlockContext.new(mc, s(s(:lasgn, :x)))
     mc.variable_names.should be_empty
   end
@@ -37,4 +37,10 @@ describe BlockContext do
     bctx.record_local_variable(:q2)
     bctx.variable_names.should include(Name.new(:q2))
   end
+
+  it 'copes with a yield to an ivar' do
+    scope = BlockContext.new(StopContext.new, [s(:iasgn, :@list), s(:self)])
+    scope.record_instance_variable(:@list)
+    scope.variable_names.should == [:@list]
+  end
 end

data/spec/reek/class_context_spec.rb

@@ -20,6 +20,7 @@ class Fred
   def simply(arga, argb, argc, argd) f(3);false end
 end
 EOEX
+
     src.should reek_of(:LongParameterList, /Fred/, /simple/)
     src.should reek_of(:LongParameterList, /Fred/, /simply/)
   end
@@ -33,23 +34,24 @@ class Fred
     def textile_popup_help(name, windowW, windowH) f(3);end
 end
 EOEX
+    
     src.should reek_of(:LongParameterList, /Fred/, /textile_bq/)
     src.should reek_of(:LongParameterList, /Fred/, /textile_fn_/)
     src.should reek_of(:LongParameterList, /Fred/, /textile_p/)
   end
 end
 
+class Above
+  def above() end
+  def both() end
+end
+
+class Below < Above
+  def both() end
+  def below() end
+end
+
 describe ClassContext, 'overridden methods' do
-  class Above
-    def above() end
-    def both() end
-  end
-  
-  class Below < Above
-    def both() end
-    def below() end
-  end
-  
   describe 'of loaded class' do
     before :each do
       @ctx = ClassContext.create(StopContext.new, [0, :Below])
@@ -97,16 +99,16 @@ describe 'Integration defect:' do
   end
 end
 
-describe CodeContext, 'find class' do
-  module Mod1
-    class Klass1
-      module Mod2
-        class Klass2
-        end
+module Mod1
+  class Klass1
+    module Mod2
+      class Klass2
       end
     end
   end
+end
 
+describe CodeContext, 'find class' do
   before :each do
     @stop = StopContext.new
     @mod1 = ModuleContext.create(@stop, [0, :Mod1])
@@ -166,4 +168,25 @@ describe ClassContext do
     element = ClassContext.create(StopContext.new, [:colon2, [:colon2, [:const, :Treetop], :Runtime], :SyntaxNode])
     element.num_methods.should == 0
   end
+
+  it 'counts conditionals correctly' do
+    src = <<EOS
+class Scrunch
+  def first
+    return @field == :sym ? 0 : 3;
+  end
+  def second
+    if @field == :sym
+      @other += " quarts"
+    end
+  end
+  def third
+    raise 'flu!' unless @field == :sym
+  end
+end
+EOS
+
+    ctx = ClassContext.from_s(src)
+    ctx.conditionals.length.should == 3
+  end
 end

data/spec/reek/code_context_spec.rb

@@ -13,7 +13,7 @@ describe CodeContext, 'to_s' do
 
   it "should report full context" do
     element = StopContext.new
-    element = ModuleContext.new(element, [0, :mod])
+    element = ModuleContext.new(element, Name.new(:mod))
     element = ClassContext.new(element, [0, :klass])
     element = MethodContext.new(element, [0, :bad])
     element = BlockContext.new(element, nil)
@@ -40,7 +40,7 @@ end
 describe CodeContext, 'instance variables' do
   it 'should pass instance variables down to the first class' do
     element = StopContext.new
-    element = ModuleContext.new(element, [0, :mod])
+    element = ModuleContext.new(element, Name.new(:mod))
     class_element = ClassContext.new(element, [0, :klass])
     element = MethodContext.new(class_element, [0, :bad])
     element = BlockContext.new(element, nil)
@@ -54,7 +54,7 @@ describe CodeContext, 'generics' do
   it 'should pass unknown method calls down the stack' do
     stop = StopContext.new
     def stop.bananas(arg1, arg2) arg1 + arg2 + 43 end
-    element = ModuleContext.new(stop, [0, :mod])
+    element = ModuleContext.new(stop, Name.new(:mod))
     class_element = ClassContext.new(element, [0, :klass])
     element = MethodContext.new(class_element, [0, :bad])
     element = BlockContext.new(element, nil)
@@ -65,19 +65,19 @@ end
 describe CodeContext do
   it 'should recognise itself in a collection of names' do
     element = StopContext.new
-    element = ModuleContext.new(element, [0, :mod])
+    element = ModuleContext.new(element, Name.new(:mod))
     element.matches?(['banana', 'mod']).should == true
   end
 
   it 'should recognise itself in a collection of REs' do
     element = StopContext.new
-    element = ModuleContext.new(element, [0, :mod])
+    element = ModuleContext.new(element, Name.new(:mod))
     element.matches?([/banana/, /mod/]).should == true
   end
 
   it 'should recognise its fq name in a collection of names' do
     element = StopContext.new
-    element = ModuleContext.new(element, [0, :mod])
+    element = ModuleContext.new(element, Name.new(:mod))
     element = ClassContext.create(element, [0, :klass])
     element.matches?(['banana', 'mod']).should == true
     element.matches?(['banana', 'mod::klass']).should == true
@@ -85,7 +85,7 @@ describe CodeContext do
 
   it 'should recognise its fq name in a collection of names' do
     element = StopContext.new
-    element = ModuleContext.new(element, [0, :mod])
+    element = ModuleContext.new(element, Name.new(:mod))
     element = ClassContext.create(element, [0, :klass])
     element.matches?([/banana/, /mod/]).should == true
     element.matches?([/banana/, /mod::klass/]).should == true

data/spec/reek/code_parser_spec.rb

@@ -1,7 +1,6 @@
 require File.dirname(__FILE__) + '/../spec_helper.rb'
 
 require 'reek/code_parser'
-require 'reek/report'
 
 include Reek
 
@@ -32,3 +31,9 @@ end'
     source.should_not reek
   end
 end
+
+describe CodeParser do
+  it 'copes with a yield to an ivar' do
+    'def options() ozz.on { |@list| @prompt = !@list } end'.should_not reek
+  end
+end

data/spec/reek/config_spec.rb

@@ -1,11 +1,11 @@
 require File.dirname(__FILE__) + '/../spec_helper.rb'
 
-require 'reek/smells/smells'
+require 'reek/sniffer'
 require 'yaml'
 
 include Reek
 
-describe 'Config' do
+describe Hash do
   before :each do
     @first = {
       'one' => {'two' => 3, 'three' => 4},
@@ -32,7 +32,7 @@ describe 'Config' do
   end
 end
 
-describe Config, 'merging arrays' do
+describe Hash, 'merging arrays' do
   it 'should merge array values' do
     first = {'key' => {'one' => [1,2,3]}}
     second = {'key' => {'one' => [4,5]}}

data/spec/reek/configuration_spec.rb

@@ -0,0 +1,12 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+require 'reek/configuration'
+
+include Reek
+
+describe SmellConfiguration do
+  it 'returns the default value when key not found' do
+    cf = SmellConfiguration.new({})
+    cf.value('fred', nil, 27).should == 27
+  end
+end

data/spec/reek/method_context_spec.rb

@@ -24,8 +24,8 @@ end
 describe MethodContext, 'matching fq names' do
   before :each do
     element = StopContext.new
-    element = ModuleContext.new(element, [0, :mod])
-    element = ClassContext.new(element, [0, :klass])
+    element = ModuleContext.new(element, Name.new(:mod))
+    element = ClassContext.new(element, Name.new(:klass))
     @element = MethodContext.new(element, [0, :meth])
   end
 

data/spec/reek/name_spec.rb

@@ -11,3 +11,27 @@ describe Name, 'resolving symbols' do
     res[1].should == "LargeClass"
   end
 end
+
+describe Name do
+  it 'compares correctly' do
+    a1 = [Name.new('conts'), Name.new('p1'), Name.new('p2'), Name.new('p3')]
+    a2 = [Name.new('name'), Name.new('windowH'), Name.new('windowW')]
+    (a1 & a2).should == []
+  end
+
+  it do
+    [Name.new(:fred)].should include(Name.new(:fred))
+  end
+
+  it do
+    set = Set.new
+    set << Name.new(:fred)
+    set.should include(Name.new(:fred))
+  end
+
+  it do
+    fred = Name.new(:fred)
+    fred.should eql(fred)
+    fred.should eql(Name.new(:fred))
+  end
+end

data/spec/reek/object_source_spec.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+include Reek
+
+describe Dir do
+  it 'reports correct smells via the Dir matcher' do
+    Dir['spec/samples/two_smelly_files/*.rb'].should reek
+    Dir['spec/samples/two_smelly_files/*.rb'].should reek_of(:UncommunicativeName)
+  end
+
+  it 'reports correct smells via Dir' do
+    sniffer = Dir['spec/samples/two_smelly_files/*.rb'].sniff
+    sniffer.has_smell?(:UncommunicativeName).should be_true
+  end
+
+  it 'copes with daft file specs' do
+    Dir["spec/samples/two_smelly_files/*/.rb"].should_not reek
+  end
+
+  it 'copes with empty array' do
+    [].should_not reek
+  end
+end

data/spec/reek/singleton_method_context_spec.rb

@@ -10,8 +10,8 @@ describe SingletonMethodContext, 'outer_name' do
 
   it "should report full context" do
     element = StopContext.new
-    element = ModuleContext.new(element, [0, :mod])
-    element = SingletonMethodContext.new(element,  [:defs, [:call, nil, :a, [:arglist]], :b, nil])
+    element = ModuleContext.new(element, Name.new(:mod))
+    element = SingletonMethodContext.new(element, s(:defs, s(:call, nil, :a, s(:arglist)), :b, s(:args)))
     element.outer_name.should match(/mod::a\.b/)
   end
 end

data/spec/reek/smell_warning_spec.rb

@@ -0,0 +1,53 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+require 'reek/smell_warning'
+require 'reek/smells/feature_envy'
+
+include Reek
+
+describe SmellWarning, 'equality' do
+  before :each do
+    @first = SmellWarning.new(Smells::FeatureEnvy.new, "self", "self", true)
+    @second = SmellWarning.new(Smells::FeatureEnvy.new, "self", "self", false)
+  end
+
+  it 'should hash equal when the smell is the same' do
+    @first.hash.should == @second.hash
+  end
+
+  it 'should compare equal when the smell is the same' do
+    @first.should == @second
+  end
+
+  it 'should compare equal when using <=>' do
+    (@first <=> @second).should == 0
+  end
+  
+  class CountingReport
+    attr_reader :masked, :non_masked
+    def initialize
+      @masked = @non_masked = 0
+    end
+    def <<(sw)
+      @non_masked += 1
+    end
+    
+    def record_masked_smell(sw)
+      @masked += 1
+    end
+  end
+
+  it 'reports as masked when masked' do
+    rpt = CountingReport.new
+    @first.report_on(rpt)
+    rpt.masked.should == 1
+    rpt.non_masked.should == 0
+  end
+
+  it 'reports as non-masked when non-masked' do
+    rpt = CountingReport.new
+    @second.report_on(rpt)
+    rpt.masked.should == 0
+    rpt.non_masked.should == 1
+  end
+end