kevinrutherford-reek 1.1.3.6 → 1.1.3.7

data/History.txt

@@ -1,4 +1,4 @@
-== 1.2 (in git)
+== 1.2 (in progress -- see github)
 
 === Major Changes
 * Reek's RDoc is now hosted at http://rdoc.info/projects/kevinrutherford/reek

data/features/reports.feature

@@ -1,5 +1,5 @@
 @reports
-Feature: Correclty formatted reports
+Feature: Correctly formatted reports
   In order to get the most out of reek
   As a developer
   I want to be able to parse reek's output simply and consistently
@@ -26,3 +26,15 @@ Feature: Correclty formatted reports
 
       """
 
+  Scenario: good files show headers consecutively
+    When I run reek spec/samples/three_clean_files/*.rb
+    Then it succeeds
+    And it reports:
+      """
+      spec/samples/three_clean_files/clean_one.rb -- 0 warnings
+      spec/samples/three_clean_files/clean_three.rb -- 0 warnings
+      spec/samples/three_clean_files/clean_two.rb -- 0 warnings
+
+      """
+
+

data/lib/reek/report.rb

@@ -58,7 +58,8 @@ module Reek
     # this report, with a heading.
     def full_report(desc)
       result = header(desc, @report.length)
-      result += ":\n#{to_s}\n" if length > 0
+      result += ":\n#{to_s}" if length > 0
+      result += "\n"
       result
     end
 

data/lib/reek/spec.rb

@@ -49,7 +49,7 @@ module Reek
         "Expected source to reek, but it didn't"
       end
       def failure_message_for_should_not
-        "Expected no smells, but got:\n#{@source.report}"
+        "Expected no smells, but got:\n#{@source.full_report}"
       end
     end
 
@@ -73,7 +73,7 @@ module Reek
         "Expected #{@source} to reek of #{@klass}, but it didn't"
       end
       def failure_message_for_should_not
-        "Expected #{@source} not to reek of #{@klass}, but got:\n#{@source.report}"
+        "Expected #{@source} not to reek of #{@klass}, but got:\n#{@source.full_report}"
       end
     end
 
@@ -96,7 +96,7 @@ module Reek
         @source.report.length == 1 and @source.has_smell?(@klass, @patterns)
       end
       def failure_message_for_should
-        "Expected source to reek only of #{@klass}, but got:\n#{@source.report}"
+        "Expected source to reek only of #{@klass}, but got:\n#{@source.full_report}"
       end
       def failure_message_for_should_not
         "Expected source not to reek only of #{@klass}, but it did"

data/lib/reek.rb

@@ -1,5 +1,5 @@
 $:.unshift File.dirname(__FILE__)
 
 module Reek # :doc:
-  VERSION = '1.1.3.6'
+  VERSION = '1.1.3.7'
 end

data/reek.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{reek}
-  s.version = "1.1.3.6"
+  s.version = "1.1.3.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kevin Rutherford"]
-  s.date = %q{2009-06-30}
+  s.date = %q{2009-07-02}
   s.default_executable = %q{reek}
   s.description = %q{Code smell detector for Ruby}
   s.email = ["kevin@rutherford-software.com"]
   s.executables = ["reek"]
   s.extra_rdoc_files = ["History.txt", "README.txt"]
-  s.files = ["History.txt", "README.txt", "Rakefile", "bin/reek", "config/defaults.reek", "features/masking_smells.feature", "features/options.feature", "features/rake_task.feature", "features/reports.feature", "features/samples.feature", "features/stdin.feature", "features/step_definitions/reek_steps.rb", "features/support/env.rb", "lib/reek.rb", "lib/reek/block_context.rb", "lib/reek/class_context.rb", "lib/reek/code_context.rb", "lib/reek/code_parser.rb", "lib/reek/exceptions.reek", "lib/reek/if_context.rb", "lib/reek/method_context.rb", "lib/reek/module_context.rb", "lib/reek/name.rb", "lib/reek/object_refs.rb", "lib/reek/object_source.rb", "lib/reek/options.rb", "lib/reek/rake_task.rb", "lib/reek/report.rb", "lib/reek/sexp_formatter.rb", "lib/reek/singleton_method_context.rb", "lib/reek/smell_warning.rb", "lib/reek/smells/control_couple.rb", "lib/reek/smells/duplication.rb", "lib/reek/smells/feature_envy.rb", "lib/reek/smells/large_class.rb", "lib/reek/smells/long_method.rb", "lib/reek/smells/long_parameter_list.rb", "lib/reek/smells/long_yield_list.rb", "lib/reek/smells/nested_iterators.rb", "lib/reek/smells/smell_detector.rb", "lib/reek/smells/uncommunicative_name.rb", "lib/reek/smells/utility_function.rb", "lib/reek/sniffer.rb", "lib/reek/source.rb", "lib/reek/spec.rb", "lib/reek/stop_context.rb", "lib/reek/yield_call_context.rb", "reek.gemspec", "spec/reek/block_context_spec.rb", "spec/reek/class_context_spec.rb", "spec/reek/code_context_spec.rb", "spec/reek/code_parser_spec.rb", "spec/reek/config_spec.rb", "spec/reek/if_context_spec.rb", "spec/reek/method_context_spec.rb", "spec/reek/module_context_spec.rb", "spec/reek/name_spec.rb", "spec/reek/object_refs_spec.rb", "spec/reek/object_source_spec.rb", "spec/reek/options_spec.rb", "spec/reek/report_spec.rb", "spec/reek/singleton_method_context_spec.rb", "spec/reek/smell_warning_spec.rb", "spec/reek/smells/control_couple_spec.rb", "spec/reek/smells/duplication_spec.rb", "spec/reek/smells/feature_envy_spec.rb", "spec/reek/smells/large_class_spec.rb", "spec/reek/smells/long_method_spec.rb", "spec/reek/smells/long_parameter_list_spec.rb", "spec/reek/smells/nested_iterators_spec.rb", "spec/reek/smells/smell_detector_spec.rb", "spec/reek/smells/uncommunicative_name_spec.rb", "spec/reek/smells/utility_function_spec.rb", "spec/samples/corrupt_config_file/corrupt.reek", "spec/samples/corrupt_config_file/dirty.rb", "spec/samples/empty_config_file/dirty.rb", "spec/samples/empty_config_file/empty.reek", "spec/samples/inline.rb", "spec/samples/masked/dirty.rb", "spec/samples/masked/masked.reek", "spec/samples/optparse.rb", "spec/samples/redcloth.rb", "spec/samples/two_smelly_files/dirty_one.rb", "spec/samples/two_smelly_files/dirty_two.rb", "spec/slow/inline_spec.rb", "spec/slow/optparse_spec.rb", "spec/slow/redcloth_spec.rb", "spec/slow/reek_source_spec.rb", "spec/slow/source_list_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/reek.rake", "tasks/test.rake"]
+  s.files = ["History.txt", "README.txt", "Rakefile", "bin/reek", "config/defaults.reek", "features/masking_smells.feature", "features/options.feature", "features/rake_task.feature", "features/reports.feature", "features/samples.feature", "features/stdin.feature", "features/step_definitions/reek_steps.rb", "features/support/env.rb", "lib/reek.rb", "lib/reek/block_context.rb", "lib/reek/class_context.rb", "lib/reek/code_context.rb", "lib/reek/code_parser.rb", "lib/reek/exceptions.reek", "lib/reek/if_context.rb", "lib/reek/method_context.rb", "lib/reek/module_context.rb", "lib/reek/name.rb", "lib/reek/object_refs.rb", "lib/reek/object_source.rb", "lib/reek/options.rb", "lib/reek/rake_task.rb", "lib/reek/report.rb", "lib/reek/sexp_formatter.rb", "lib/reek/singleton_method_context.rb", "lib/reek/smell_warning.rb", "lib/reek/smells/control_couple.rb", "lib/reek/smells/duplication.rb", "lib/reek/smells/feature_envy.rb", "lib/reek/smells/large_class.rb", "lib/reek/smells/long_method.rb", "lib/reek/smells/long_parameter_list.rb", "lib/reek/smells/long_yield_list.rb", "lib/reek/smells/nested_iterators.rb", "lib/reek/smells/smell_detector.rb", "lib/reek/smells/uncommunicative_name.rb", "lib/reek/smells/utility_function.rb", "lib/reek/sniffer.rb", "lib/reek/source.rb", "lib/reek/spec.rb", "lib/reek/stop_context.rb", "lib/reek/yield_call_context.rb", "reek.gemspec", "spec/reek/block_context_spec.rb", "spec/reek/class_context_spec.rb", "spec/reek/code_context_spec.rb", "spec/reek/code_parser_spec.rb", "spec/reek/config_spec.rb", "spec/reek/if_context_spec.rb", "spec/reek/method_context_spec.rb", "spec/reek/module_context_spec.rb", "spec/reek/name_spec.rb", "spec/reek/object_refs_spec.rb", "spec/reek/object_source_spec.rb", "spec/reek/options_spec.rb", "spec/reek/report_spec.rb", "spec/reek/singleton_method_context_spec.rb", "spec/reek/smell_warning_spec.rb", "spec/reek/smells/control_couple_spec.rb", "spec/reek/smells/duplication_spec.rb", "spec/reek/smells/feature_envy_spec.rb", "spec/reek/smells/large_class_spec.rb", "spec/reek/smells/long_method_spec.rb", "spec/reek/smells/long_parameter_list_spec.rb", "spec/reek/smells/nested_iterators_spec.rb", "spec/reek/smells/smell_detector_spec.rb", "spec/reek/smells/uncommunicative_name_spec.rb", "spec/reek/smells/utility_function_spec.rb", "spec/reek/spec_spec.rb", "spec/samples/corrupt_config_file/corrupt.reek", "spec/samples/corrupt_config_file/dirty.rb", "spec/samples/empty_config_file/dirty.rb", "spec/samples/empty_config_file/empty.reek", "spec/samples/inline.rb", "spec/samples/masked/dirty.rb", "spec/samples/masked/masked.reek", "spec/samples/optparse.rb", "spec/samples/redcloth.rb", "spec/samples/three_clean_files/clean_one.rb", "spec/samples/three_clean_files/clean_three.rb", "spec/samples/three_clean_files/clean_two.rb", "spec/samples/two_smelly_files/dirty_one.rb", "spec/samples/two_smelly_files/dirty_two.rb", "spec/slow/inline_spec.rb", "spec/slow/optparse_spec.rb", "spec/slow/redcloth_spec.rb", "spec/slow/reek_source_spec.rb", "spec/slow/source_list_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/reek.rake", "tasks/test.rake"]
   s.homepage = %q{http://wiki.github.com/kevinrutherford/reek}
   s.post_install_message = %q{
 For more information on reek, see http://wiki.github.com/kevinrutherford/reek

data/spec/reek/object_source_spec.rb

@@ -4,6 +4,7 @@ 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
 
@@ -11,4 +12,12 @@ describe Dir do
     src = Dir['spec/samples/two_smelly_files/*.rb'].to_source
     src.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/spec_spec.rb

@@ -0,0 +1,68 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+require 'reek/spec'
+
+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(@smelly_code.to_source.full_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(@smelly_dir.to_source.full_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(@smelly_file.to_source.full_report)
+  end
+end

data/spec/samples/three_clean_files/clean_one.rb

@@ -0,0 +1,6 @@
+class Clean
+  def assign
+    puts @sub.title
+    @sub.map {|para| para.name }
+  end
+end

data/spec/samples/three_clean_files/clean_three.rb

@@ -0,0 +1,6 @@
+class Clean
+  def assign
+    puts @sub.title
+    @sub.map {|para| para.name }
+  end
+end

data/spec/samples/three_clean_files/clean_two.rb

@@ -0,0 +1,6 @@
+class Clean
+  def assign
+    puts @sub.title
+    @sub.map {|para| para.name }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: kevinrutherford-reek
 version: !ruby/object:Gem::Version 
-  version: 1.1.3.6
+  version: 1.1.3.7
 platform: ruby
 authors: 
 - Kevin Rutherford
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-30 00:00:00 -07:00
+date: 2009-07-02 00:00:00 -07:00
 default_executable: reek
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -126,6 +126,7 @@ files:
 - spec/reek/smells/smell_detector_spec.rb
 - spec/reek/smells/uncommunicative_name_spec.rb
 - spec/reek/smells/utility_function_spec.rb
+- spec/reek/spec_spec.rb
 - spec/samples/corrupt_config_file/corrupt.reek
 - spec/samples/corrupt_config_file/dirty.rb
 - spec/samples/empty_config_file/dirty.rb
@@ -135,6 +136,9 @@ files:
 - spec/samples/masked/masked.reek
 - spec/samples/optparse.rb
 - spec/samples/redcloth.rb
+- spec/samples/three_clean_files/clean_one.rb
+- spec/samples/three_clean_files/clean_three.rb
+- spec/samples/three_clean_files/clean_two.rb
 - spec/samples/two_smelly_files/dirty_one.rb
 - spec/samples/two_smelly_files/dirty_two.rb
 - spec/slow/inline_spec.rb