reek 1.2.0 → 1.2.1

data/spec/reek/smell_warning_spec.rb

@@ -6,48 +6,114 @@ 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

data/spec/reek/smells/class_variable_spec.rb

@@ -0,0 +1,81 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+require 'reek/smells/class_variable'
+require 'reek/class_context'
+
+include Reek
+include Reek::Smells
+
+describe ClassVariable do
+  shared_examples_for 'a class variable container' do
+    context 'no class variables' do
+      it "doesn't record a smell" do
+        @detector.examine_context(@ctx)
+        @detector.num_smells.should == 0
+      end
+    end
+
+    context 'one class variable' do
+      before :each do
+        @ctx.record_class_variable(:@@cvar)
+        @detector.examine_context(@ctx)
+      end
+
+      it 'records a smell' do
+        @detector.num_smells.should == 1
+      end
+      it 'mentions the variable name in the report' do
+        @detector.should have_smell([/@@cvar/])
+      end
+    end
+
+    context 'one class variable encountered twice' do
+      before :each do
+        @ctx.record_class_variable(:@@cvar)
+        @ctx.record_class_variable(:@@cvar)
+        @detector.examine_context(@ctx)
+      end
+
+      it 'records only one smell' do
+        @detector.num_smells.should == 1
+      end
+      it 'mentions the variable name in the report' do
+        @detector.should have_smell([/@@cvar/])
+      end
+    end
+
+    context 'two class variables' do
+      before :each do
+        @ctx.record_class_variable(:@@cvar)
+        @ctx.record_class_variable(:@@another)
+        @detector.examine_context(@ctx)
+      end
+
+      it 'records a smell' do
+        @detector.num_smells.should == 2
+      end
+      it 'mentions both variable names in the report' do
+        @detector.should have_smell([/@@cvar/])
+        @detector.should have_smell([/@@another/])
+      end
+    end
+  end
+
+  context 'in a class' do
+    before :each do
+      @ctx = ClassContext.create(StopContext.new, "Fred")
+      @detector = ClassVariable.new
+    end
+
+    it_should_behave_like 'a class variable container'
+  end
+
+  context 'in a module' do
+    before :each do
+      @ctx = ModuleContext.create(StopContext.new, "Fred")
+      @detector = ClassVariable.new
+    end
+
+    it_should_behave_like 'a class variable container'
+  end
+end

data/spec/reek/stop_context_spec.rb

@@ -0,0 +1,27 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+require 'reek/stop_context'
+
+include Reek
+include Reek::Smells
+
+describe StopContext do
+  before :each do
+    @stop = StopContext.new
+  end
+
+  context 'with a module that is not loaded' do
+    it 'does not find the module' do
+      @stop.find_module('CGI').should == nil
+    end
+    it 'does not find an unqualified class in the module' do
+      @stop.find_module('HtmlExtension').should == nil
+    end
+  end
+
+  context 'with a module that is loaded' do
+    it 'finds the module' do
+      @stop.find_module('Reek').name.should == 'Reek'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -8,6 +8,8 @@ rescue LoadError
   require 'spec/expectations'
 end
 
+require 'spec/autorun'
+
 require 'reek/adapters/spec'
 
 SAMPLES_DIR = 'spec/samples' unless Object.const_defined?('SAMPLES_DIR')

data/tasks/reek.rake

@@ -8,3 +8,8 @@ begin
   end
 rescue Gem::LoadError
 end
+
+begin
+  require 'metric_fu'
+rescue LoadError
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: reek
 version: !ruby/object:Gem::Version 
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors: 
 - Kevin Rutherford
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-20 00:00:00 +01:00
+date: 2009-10-03 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -69,6 +69,7 @@ files:
 - features/support/env.rb
 - lib/reek.rb
 - lib/reek/adapters/application.rb
+- lib/reek/adapters/command_line.rb
 - lib/reek/adapters/config_file.rb
 - lib/reek/adapters/core_extras.rb
 - lib/reek/adapters/object_source.rb
@@ -80,7 +81,6 @@ files:
 - lib/reek/class_context.rb
 - lib/reek/code_context.rb
 - lib/reek/code_parser.rb
-- lib/reek/command_line.rb
 - lib/reek/configuration.rb
 - lib/reek/detector_stack.rb
 - lib/reek/exceptions.reek
@@ -92,6 +92,7 @@ files:
 - lib/reek/sexp_formatter.rb
 - lib/reek/singleton_method_context.rb
 - lib/reek/smell_warning.rb
+- lib/reek/smells/class_variable.rb
 - lib/reek/smells/control_couple.rb
 - lib/reek/smells/data_clump.rb
 - lib/reek/smells/duplication.rb
@@ -128,6 +129,7 @@ files:
 - spec/reek/object_source_spec.rb
 - spec/reek/singleton_method_context_spec.rb
 - spec/reek/smell_warning_spec.rb
+- spec/reek/smells/class_variable_spec.rb
 - spec/reek/smells/control_couple_spec.rb
 - spec/reek/smells/data_clump_spec.rb
 - spec/reek/smells/duplication_spec.rb
@@ -141,6 +143,7 @@ files:
 - spec/reek/smells/uncommunicative_name_spec.rb
 - spec/reek/smells/utility_function_spec.rb
 - spec/reek/sniffer_spec.rb
+- spec/reek/stop_context_spec.rb
 - spec/samples/all_but_one_masked/clean_one.rb
 - spec/samples/all_but_one_masked/dirty.rb
 - spec/samples/all_but_one_masked/masked.reek
@@ -189,7 +192,7 @@ post_install_message: |
 
 rdoc_options: 
 - --main
-- README.txt
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement