spec/reek/smell_warning_spec.rb in reek-1.2.0 vs spec/reek/smell_warning_spec.rb in reek-1.2.1

@@ -4,50 +4,116 @@
 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
+  context 'sort order' do
+    context 'smells differing only by masking' 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 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
+    end
 
-  it 'should compare equal when the smell is the same' do
-    @first.should == @second
-  end
+    shared_examples_for 'first sorts ahead of second' do
+      it 'hash differently' do
+        @first.hash.should_not == @second.hash
+      end
+      it 'are not equal' do
+        @first.should_not == @second
+      end
+      it 'sort correctly' do
+        (@first <=> @second).should be < 0
+      end
+    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
+    context 'smells differing only by detector' do
+      before :each do
+        @first = SmellWarning.new(Smells::Duplication.new, "self", "self", true)
+        @second = SmellWarning.new(Smells::FeatureEnvy.new, "self", "self", false)
+      end
+
+      it_should_behave_like 'first sorts ahead of second'
     end
-    def <<(sw)
-      @non_masked += 1
+
+    context 'smells differing only by context' do
+      before :each do
+        @first = SmellWarning.new(Smells::FeatureEnvy.new, "first", "self", true)
+        @second = SmellWarning.new(Smells::FeatureEnvy.new, "second", "self", false)
+      end
+
+      it_should_behave_like 'first sorts ahead of second'
     end
-    
-    def record_masked_smell(sw)
-      @masked += 1
+
+    context 'smells differing only by message' do
+      before :each do
+        @first = SmellWarning.new(Smells::FeatureEnvy.new, "context", "first", true)
+        @second = SmellWarning.new(Smells::FeatureEnvy.new, "context", "second", false)
+      end
+
+      it_should_behave_like 'first sorts ahead of second'
     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
+    context 'message takes precedence over smell name' do
+      before :each do
+        @first = SmellWarning.new(Smells::UtilityFunction.new, "context", "first", true)
+        @second = SmellWarning.new(Smells::FeatureEnvy.new, "context", "second", false)
+      end
+
+      it_should_behave_like 'first sorts ahead of second'
+    end
+
+    context 'smells differing everywhere' do
+      before :each do
+        @first = SmellWarning.new(Smells::UncommunicativeName.new, "Dirty", "has the variable name '@s'", true)
+        @second = SmellWarning.new(Smells::Duplication.new, 'Dirty#a', "calls @s.title twice", false)
+      end
+
+      it_should_behave_like 'first sorts ahead of second'
+    end
   end
+  
+  context 'masked reporting' do
+    class CountingReport
+      attr_reader :masked, :non_masked
+      def initialize
+        @masked = @non_masked = 0
+      end
+      def <<(sw)
+        @non_masked += 1
+      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
+      def record_masked_smell(sw)
+        @masked += 1
+      end
+    end
+
+    before :each do
+      @masked = SmellWarning.new(Smells::FeatureEnvy.new, "self", "self", true)
+      @visible = SmellWarning.new(Smells::FeatureEnvy.new, "self", "self", false)
+    end
+
+    it 'reports as masked when masked' do
+      rpt = CountingReport.new
+      @masked.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
+      @visible.report_on(rpt)
+      rpt.masked.should == 0
+      rpt.non_masked.should == 1
+    end
   end
 end