kevinrutherford-reek 1.0.0 → 1.0.1

data/lib/reek/report.rb

@@ -9,6 +9,9 @@ module Reek
       @report = SortedSet.new
     end
 
+    #
+    # Yields, in turn, each SmellWarning in this report.
+    #
     def each
       @report.each { |smell| yield smell }
     end
@@ -18,11 +21,11 @@ module Reek
       true
     end
     
-    def empty?  # :nodoc:
+    def empty?
       @report.empty?
     end
 
-    def length  # :nodoc:
+    def length
       @report.length
     end
     
@@ -39,4 +42,33 @@ module Reek
     end
   end
 
+  class ReportList
+    include Enumerable
+
+    def initialize(sources)
+      @sources = sources
+    end
+
+    #
+    # Yields, in turn, each SmellWarning in every report in this report.
+    #
+    def each(&blk)
+      @sources.each {|src| src.report.each(&blk) }
+    end
+
+    def empty?
+      length == 0
+    end
+
+    def length
+      @sources.inject(0) {|sum, src| sum + src.report.length }
+    end
+
+    def to_s
+      @sources.select {|src| src.smelly? }.map do |src|
+        warnings = src.report
+        "\"#{src}\" -- #{warnings.length} warnings:\n#{warnings.to_s}\n"
+      end.join("\n")
+    end
+  end
 end

data/lib/reek/source.rb

@@ -107,10 +107,7 @@ module Reek
     end
 
     def report
-      @sources.select {|src| src.smelly? }.map do |src|
-        warnings = src.report
-        "\"#{src}\" -- #{warnings.length} warnings:\n#{warnings.to_s}\n"
-      end.join("\n")
+      ReportList.new(@sources)
     end
   end
 end

data/lib/reek.rb

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

data/reek.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{reek}
-  s.version = "1.0.0"
+  s.version = "1.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kevin Rutherford"]
-  s.date = %q{2009-04-05}
+  s.date = %q{2009-04-06}
   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", "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/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/smells.rb", "lib/reek/smells/uncommunicative_name.rb", "lib/reek/smells/utility_function.rb", "lib/reek/source.rb", "lib/reek/spec.rb", "lib/reek/stop_context.rb", "lib/reek/yield_call_context.rb", "reek.gemspec", "spec/integration/reek_source_spec.rb", "spec/integration/script_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/object_refs_spec.rb", "spec/reek/options_spec.rb", "spec/reek/report_spec.rb", "spec/reek/sexp_formatter_spec.rb", "spec/reek/singleton_method_context_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_spec.rb", "spec/reek/smells/uncommunicative_name_spec.rb", "spec/reek/smells/utility_function_spec.rb", "spec/samples/inline.rb", "spec/samples/inline_spec.rb", "spec/samples/optparse.rb", "spec/samples/optparse_spec.rb", "spec/samples/redcloth.rb", "spec/samples/redcloth_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/reek.rake", "tasks/rspec.rake"]
+  s.files = ["History.txt", "README.txt", "Rakefile", "bin/reek", "config/defaults.reek", "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/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/smells.rb", "lib/reek/smells/uncommunicative_name.rb", "lib/reek/smells/utility_function.rb", "lib/reek/source.rb", "lib/reek/spec.rb", "lib/reek/stop_context.rb", "lib/reek/yield_call_context.rb", "reek.gemspec", "spec/integration/reek_source_spec.rb", "spec/integration/script_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/object_refs_spec.rb", "spec/reek/options_spec.rb", "spec/reek/report_spec.rb", "spec/reek/sexp_formatter_spec.rb", "spec/reek/singleton_method_context_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_spec.rb", "spec/reek/smells/uncommunicative_name_spec.rb", "spec/reek/smells/utility_function_spec.rb", "spec/reek/source_spec.rb", "spec/samples/inline.rb", "spec/samples/inline_spec.rb", "spec/samples/optparse.rb", "spec/samples/optparse_spec.rb", "spec/samples/redcloth.rb", "spec/samples/redcloth_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/reek.rake", "tasks/rspec.rake"]
   s.has_rdoc = true
   s.homepage = %q{http://wiki.github.com/kevinrutherford/reek}
   s.post_install_message = %q{

data/spec/reek/source_spec.rb

@@ -0,0 +1,40 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+require 'reek/source'
+
+include Reek
+
+describe SourceList do
+
+  describe 'with no smells in any source' do
+    before :each do
+      @src = Dir['lib/reek/*.rb'].to_source
+    end
+
+    it 'reports no smells' do
+      @src.report.length.should == 0
+    end
+
+    it 'is empty' do
+      @src.report.should be_empty
+    end
+  end
+
+  describe 'with smells in one source' do
+    before :each do
+      @src = Source.from_pathlist(['spec/samples/inline.rb', 'lib/reek.rb'])
+    end
+
+    it 'reports some smells in the samples' do
+      @src.report.length.should == 32
+    end
+
+    it 'is smelly' do
+      @src.should be_smelly
+    end
+
+    it 'reports an UncommunicativeName' do
+      @src.report.any? {|warning| warning.report =~ /Uncommunicative Name/}.should be_true
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: kevinrutherford-reek
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - Kevin Rutherford
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-05 00:00:00 -07:00
+date: 2009-04-06 00:00:00 -07:00
 default_executable: reek
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -106,6 +106,7 @@ files:
 - spec/reek/smells/smell_spec.rb
 - spec/reek/smells/uncommunicative_name_spec.rb
 - spec/reek/smells/utility_function_spec.rb
+- spec/reek/source_spec.rb
 - spec/samples/inline.rb
 - spec/samples/inline_spec.rb
 - spec/samples/optparse.rb