reek 1.2.6 → 1.2.7

data/spec/reek/spec/should_reek_of_spec.rb

@@ -0,0 +1,76 @@
+require File.join(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__)))), 'spec_helper')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'spec')
+
+include Reek
+include Reek::Spec
+
+describe ShouldReekOf do
+  context 'rdoc demo example' do
+    before :each do
+      @ruby = 'def double_thing() @other.thing.foo + @other.thing.foo end'
+    end
+
+    it 'reports duplicate calls to @other.thing' do
+      @ruby.should reek_of(:Duplication, /@other.thing[^\.]/)
+    end
+    it 'reports duplicate calls to @other.thing.foo' do
+      @ruby.should reek_of(:Duplication, /@other.thing.foo/)
+    end
+    it 'does not report any feature envy' do
+      @ruby.should_not reek_of(:FeatureEnvy)
+    end
+  end
+
+  context 'checking code in a string' do
+    before :each do
+      @clean_code = 'def good() true; end'
+      @smelly_code = 'def x() y = 4; end'
+      @matcher = ShouldReekOf.new(:UncommunicativeVariableName, [/x/, /y/])
+    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 match('UncommunicativeVariableName')
+    end
+  end
+
+  context '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 = ShouldReekOf.new(:UncommunicativeVariableName, [/Dirty/, /@s/])
+    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
+  end
+
+  context '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 = ShouldReekOf.new(:UncommunicativeVariableName, [/Dirty/, /@s/])
+    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
+  end
+end

data/spec/reek/spec/should_reek_only_of_spec.rb

@@ -0,0 +1,89 @@
+require File.join(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__)))), 'spec_helper')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'spec')
+
+include Reek
+include Reek::Spec
+
+describe ShouldReekOnlyOf do
+  before :each do
+    @expected_smell_class = :NestedIterators
+    @expected_context_name = 'SmellyClass#big_method'
+    @matcher = ShouldReekOnlyOf.new(@expected_smell_class, [/#{@expected_context_name}/])
+    @examiner = mock('examiner', :null_object => true)
+    @examiner.should_receive(:all_active_smells).and_return {smells}
+    @match = @matcher.matches_examiner?(@examiner)
+  end
+
+  shared_examples_for 'no match' do
+    it 'does not match' do
+      @match.should be_false
+    end
+    context 'when a match was expected' do
+      before :each do
+        @source = 'the_path/to_a/source_file.rb'
+        @examiner.should_receive(:description).and_return(@source)
+      end
+      it 'reports the source' do
+        @matcher.failure_message_for_should.should match(@source)
+      end
+      it 'reports the expected smell class' do
+        @matcher.failure_message_for_should.should match(@expected_smell_class.to_s)
+      end
+    end
+  end
+
+  context 'with no smells' do
+    def smells
+      []
+    end
+
+    it_should_behave_like 'no match'
+  end
+
+  context 'with 1 non-matching smell' do
+    def smells
+      [SmellWarning.new('ControlCouple', 'context', [1], 'any old message', false)]
+    end
+
+    it_should_behave_like 'no match'
+  end
+
+  context 'with 2 non-matching smells' do
+    def smells
+      [
+        SmellWarning.new('ControlCouple', 'context', [1], 'any old message', false),
+        SmellWarning.new('FeatureEnvy', 'context', [1], 'any old message', false)
+        ]
+    end
+
+    it_should_behave_like 'no match'
+  end
+
+  context 'with 1 non-matching and 1 matching smell' do
+    def smells
+      [
+        SmellWarning.new('ControlCouple', 'context', [1], 'any old message', false),
+        SmellWarning.new(@expected_smell_class.to_s, 'context', [1], "message mentioning #{@expected_context_name}", false)
+        ]
+    end
+
+    it_should_behave_like 'no match'
+  end
+
+  context 'with 1 matching smell' do
+    def smells
+      [SmellWarning.new(@expected_smell_class.to_s, nil, [1], "message mentioning #{@expected_context_name}", false)]
+    end
+    it 'matches' do
+      @match.should be_true
+    end
+    it 'reports the expected smell when no match was expected' do
+      @matcher.failure_message_for_should_not.should match(@expected_smell_class.to_s)
+    end
+    it 'reports the source when no match was expected' do
+      source = 'the_path/to_a/source_file.rb'
+      @examiner.should_receive(:description).and_return(source)
+      @matcher.failure_message_for_should_not.should match(source)
+    end
+  end
+end

data/spec/reek/{adapters → spec}/should_reek_spec.rb

@@ -1,7 +1,5 @@
-require File.dirname(__FILE__) + '/../../spec_helper.rb'
-
-require 'reek/adapters/report'
-require 'reek/adapters/spec'
+require File.join(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__)))), 'spec_helper')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'spec')
 
 include Reek
 include Reek::Spec
@@ -22,8 +20,8 @@ describe ShouldReek, 'checking code in a string' do
   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(QuietReport.new(@smelly_code.sniff).report)
+    @matcher.matches?(@smelly_code)
+    @matcher.failure_message_for_should_not.should match('Uncommunicative Name')
   end
 end
 
@@ -43,8 +41,8 @@ describe ShouldReek, 'checking code in a Dir' do
   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(QuietReport.new(@smelly_dir.sniff.sniffers).report)
+    @matcher.matches?(@smelly_dir)
+    @matcher.failure_message_for_should_not.should match('Uncommunicative Name')
   end
 end
 
@@ -64,29 +62,7 @@ describe ShouldReek, 'checking code in a File' do
   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(QuietReport.new(@smelly_file.sniff).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
+    @matcher.matches?(@smelly_file)
+    @matcher.failure_message_for_should_not.should match('Uncommunicative Name')
   end
 end

data/spec/samples/all_but_one_masked/clean_one.rb

@@ -1,3 +1,4 @@
+# clean class for testing purposes
 class Clean
   def assign
     puts @sub.title

data/spec/samples/all_but_one_masked/dirty.rb

@@ -1,3 +1,4 @@
+# smelly class for testing purposes
 class Dirty
   def a
     puts @s.title

data/spec/samples/all_but_one_masked/masked.reek

@@ -1,5 +1,9 @@
 ---
 Duplication:
   enabled: false
-UncommunicativeName:
+UncommunicativeVariableName:
+  enabled: false
+UncommunicativeMethodName:
+  enabled: false
+UncommunicativeParameterName:
   enabled: false

data/spec/samples/clean_due_to_masking/clean_one.rb

@@ -1,3 +1,4 @@
+# clean class for testing purposes
 class Clean
   def assign
     puts @sub.title

data/spec/samples/clean_due_to_masking/clean_three.rb

@@ -1,3 +1,4 @@
+# clean class for testing purposes
 class Clean
   def assign
     puts @sub.title

data/spec/samples/clean_due_to_masking/clean_two.rb

@@ -1,3 +1,4 @@
+# clean class for testing purposes
 class Clean
   def assign
     puts @sub.title

data/spec/samples/clean_due_to_masking/dirty_one.rb

@@ -1,7 +1,7 @@
 class Dirty
   def a
     puts @s.title
-    @s.map {|x| x.each {|key| key += 3}}
+    @s = fred.map {|x| x.each {|key| key += 3}}
     puts @s.title
   end
 end

data/spec/samples/clean_due_to_masking/dirty_two.rb

@@ -1,7 +1,7 @@
 class Dirty
   def a
     puts @s.title
-    @s.map {|x| x.each {|key| key += 3}}
+    @s = fred.map {|x| x.each {|key| key += 3}}
     puts @s.title
   end
 end

data/spec/samples/clean_due_to_masking/masked.reek

@@ -1,7 +1,11 @@
 ---
 Duplication:
   enabled: false
+IrresponsibleModule:
+  enabled: false
 NestedIterators:
   enabled: false
-UncommunicativeName:
+UncommunicativeVariableName:
+  enabled: false
+UncommunicativeMethodName:
   enabled: false

data/spec/samples/corrupt_config_file/dirty.rb

@@ -1,7 +1,7 @@
 class Dirty
   def a
     puts @s.title
-    @s.map {|x| x.each {|key| key += 3}}
+    @s = fred.map {|x| x.each {|key| key += 3}}
     puts @s.title
   end
 end

data/spec/samples/empty_config_file/dirty.rb

@@ -1,7 +1,8 @@
+# smelly class for testing purposes
 class Dirty
   def a
     puts @s.title
-    @s.map {|x| x.each {|key| key += 3}}
+    @s = fred.map {|x| x.each {|key| key += 3}}
     puts @s.title
   end
 end

data/spec/samples/exceptions.reek

@@ -1,4 +1,4 @@
 ---
-UncommunicativeName:
+UncommunicativeVariableName:
   accept:
   - md5

data/spec/samples/masked/dirty.rb

@@ -1,7 +1,8 @@
+# smelly class for testing purposes
 class Dirty
   def a
     puts @s.title
-    @s.map {|x| x.each {|key| key += 3}}
+    @s = fred.map {|x| x.each {|key| key += 3}}
     puts @s.title
   end
 end

data/spec/samples/masked/masked.reek

@@ -1,3 +1,5 @@
 ---
-UncommunicativeName:
+UncommunicativeVariableName:
+  enabled: false
+UncommunicativeMethodName:
   enabled: false

data/spec/samples/mixed_results/clean_one.rb

@@ -1,3 +1,4 @@
+# clean class for testing purposes
 class Clean
   def assign
     puts @sub.title

data/spec/samples/mixed_results/clean_three.rb

@@ -1,3 +1,4 @@
+# clean class for testing purposes
 class Clean
   def assign
     puts @sub.title

data/spec/samples/mixed_results/clean_two.rb

@@ -1,3 +1,4 @@
+# clean class for testing purposes
 class Clean
   def assign
     puts @sub.title

data/spec/samples/mixed_results/dirty_one.rb

@@ -1,3 +1,4 @@
+# smelly class for testing purposes
 class Dirty
   def a
     puts @s.title

data/spec/samples/mixed_results/dirty_two.rb

@@ -1,3 +1,4 @@
+# smelly class for testing purposes
 class Dirty
   def a
     puts @s.title

data/spec/samples/not_quite_masked/dirty.rb

@@ -1,9 +1,10 @@
+# smelly class for testing purposes
 class Dirty
   attr_reader :property
 
   def a
     puts @s.title
-    @s.map {|x| x.each {|key| key += 3}}
+    @s = fred.map {|x| x.each {|key| key += 3}}
     puts @s.title
   end
 end

data/spec/samples/not_quite_masked/masked.reek

@@ -1,5 +1,5 @@
 ---
-UncommunicativeName:
+UncommunicativeVariableName:
   accept:
     - x
 

data/spec/samples/overrides/masked/dirty.rb

@@ -1,7 +1,8 @@
+# smelly class for testing purposes
 class Dirty
   def a
     puts @s.title
-    @s.map {|x| x.each {|key| key += 3}}
+    @s = fred.map {|x| x.each {|key| key += 3}}
     puts @s.title
   end
 end

data/spec/samples/overrides/masked/lower.reek

@@ -1,5 +1,7 @@
 ---
 Duplication:
   enabled: true
-UncommunicativeName:
+UncommunicativeVariableName:
+  enabled: false
+UncommunicativeMethodName:
   enabled: false

data/spec/samples/three_clean_files/clean_one.rb

@@ -1,3 +1,4 @@
+# clean class for testing purposes
 class Clean
   def assign
     puts @sub.title

data/spec/samples/three_clean_files/clean_three.rb

@@ -1,3 +1,4 @@
+# clean class for testing purposes
 class Clean
   def assign
     puts @sub.title

data/spec/samples/three_clean_files/clean_two.rb

@@ -1,3 +1,4 @@
+# clean class for testing purposes
 class Clean
   def assign
     puts @sub.title

data/spec/samples/two_smelly_files/dirty_one.rb

@@ -1,7 +1,8 @@
+# smelly class for testing purposes
 class Dirty
   def a
     puts @s.title
-    @s.map {|x| x.each {|key| key += 3}}
+    @s = puts.map {|x| x.each {|key| key += 3}}
     puts @s.title
   end
 end