reek 1.2.7.2 → 1.2.7.3

data/lib/reek/smells/utility_function.rb

@@ -35,6 +35,9 @@ module Reek
     #
     class UtilityFunction < SmellDetector
 
+      SMELL_SUBCLASS = self.name.split(/::/)[-1]
+      SMELL_CLASS = 'LowCohesion'
+
       # The name of the config field that sets the maximum number of
       # calls permitted within a helper method. Any method with more than
       # this number of method calls on other objects will be considered a
@@ -62,12 +65,12 @@ module Reek
       #
       def examine_context(method_ctx)
         return false if method_ctx.num_statements == 0
-        return false if depends_on_instance?(method_ctx.exp.body)
+        return false if depends_on_instance?(method_ctx.exp)
         return false if num_helper_methods(method_ctx) <= value(HELPER_CALLS_LIMIT_KEY, method_ctx, DEFAULT_HELPER_CALLS_LIMIT)
           # SMELL: loads of calls to value{} with the above pattern
-        smell = SmellWarning.new('LowCohesion', method_ctx.full_name, [method_ctx.exp.line],
-          "doesn't depend on instance state", @masked,
-          @source, 'UtilityFunction')
+        smell = SmellWarning.new(SMELL_CLASS, method_ctx.full_name, [method_ctx.exp.line],
+          "doesn't depend on instance state",
+          @source, SMELL_SUBCLASS)
         @smells_found << smell
         #SMELL: serious duplication
       end

data/lib/reek/source/reference_collector.rb

@@ -1,7 +1,14 @@
 
 module Reek
   module Source
+
+    #
+    # Locates references to the current object within a portion
+    # of an abstract syntax tree.
+    #
     class ReferenceCollector
+      STOP_NODES = [:class, :module, :defn, :defs]
+
       def initialize(ast)
         @ast = ast
       end
@@ -9,9 +16,9 @@ module Reek
       def num_refs_to_self
         result = 0
         [:self, :zsuper, :ivar, :iasgn].each do |node_type|
-          @ast.look_for(node_type, [:class, :module, :defn, :defs]) { result += 1}
+          @ast.look_for(node_type, STOP_NODES) { result += 1}
         end
-        @ast.look_for(:call, [:class, :module, :defn, :defs]) do |call|
+        @ast.look_for(:call, STOP_NODES) do |call|
           result += 1 unless call.receiver
         end
         result

data/lib/reek/source/source_locator.rb

@@ -2,6 +2,10 @@ require File.join(File.dirname(File.expand_path(__FILE__)), 'core_extras')
 
 module Reek
   module Source
+
+    #
+    # Finds Ruby source files in a filesystem.
+    #
     class SourceLocator
       def initialize(paths)
         @paths = paths
@@ -11,6 +15,8 @@ module Reek
         valid_paths.map {|path| File.new(path).to_reek_source }
       end
 
+    private
+
       def all_ruby_source_files(paths)
         paths.map do |path|
           if test 'd', path

data/lib/reek/spec/should_reek.rb

@@ -1,4 +1,5 @@
 require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'examiner')
+require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'cli', 'report')
 
 module Reek
   module Spec
@@ -15,12 +16,8 @@ module Reek
         "Expected #{@examiner.description} to reek, but it didn't"
       end
       def failure_message_for_should_not
-        "Expected no smells, but got:\n#{list_smells(@examiner)}"
-      end
-      def list_smells(examiner)
-        examiner.smells.map do |smell|
-          "#{smell.report('%c %w (%s)')}"
-        end.join("\n")
+        rpt = Cli::ReportFormatter.format_list(@examiner.smells)
+        "Expected no smells, but got:\n#{rpt}"
       end
     end
 

data/lib/reek/spec/should_reek_only_of.rb

@@ -1,4 +1,5 @@
 require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'examiner')
+require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'cli', 'report')
 
 module Reek
   module Spec
@@ -13,11 +14,11 @@ module Reek
       end
       def matches_examiner?(examiner)
         @examiner = examiner
-        @all_smells = @examiner.smells
-        @all_smells.length == 1 and @all_smells[0].matches?(@klass, @patterns)
+        @warnings = @examiner.smells
+        @warnings.length == 1 and @warnings[0].matches?(@klass, @patterns)
       end
       def failure_message_for_should
-        rpt = @all_smells.map { |smell| "#{smell.report('%c %w (%s)')}" }.join("\n")
+        rpt = Cli::ReportFormatter.format_list(@warnings)
         "Expected #{@examiner.description} to reek only of #{@klass}, but got:\n#{rpt}"
       end
       def failure_message_for_should_not

data/reek.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{reek}
-  s.version = "1.2.7.2"
+  s.version = "1.2.7.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kevin Rutherford"]
-  s.date = %q{2010-03-05}
+  s.date = %q{2010-03-29}
   s.default_executable = %q{reek}
   s.description = %q{Reek is a tool that examines Ruby classes, modules and methods
 and reports any code smells it finds.
@@ -14,7 +14,7 @@ and reports any code smells it finds.
   s.email = ["kevin@rutherford-software.com"]
   s.executables = ["reek"]
   s.extra_rdoc_files = ["History.txt", "License.txt"]
-  s.files = [".yardopts", "History.txt", "License.txt", "README.md", "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", "features/yaml.feature", "lib/reek.rb", "lib/reek/cli/application.rb", "lib/reek/cli/command_line.rb", "lib/reek/cli/help_command.rb", "lib/reek/cli/reek_command.rb", "lib/reek/cli/report.rb", "lib/reek/cli/version_command.rb", "lib/reek/cli/yaml_command.rb", "lib/reek/core/class_context.rb", "lib/reek/core/code_context.rb", "lib/reek/core/code_parser.rb", "lib/reek/core/detector_stack.rb", "lib/reek/core/masking_collection.rb", "lib/reek/core/method_context.rb", "lib/reek/core/module_context.rb", "lib/reek/core/object_refs.rb", "lib/reek/core/singleton_method_context.rb", "lib/reek/core/smell_configuration.rb", "lib/reek/core/sniffer.rb", "lib/reek/core/stop_context.rb", "lib/reek/examiner.rb", "lib/reek/rake/task.rb", "lib/reek/smell_warning.rb", "lib/reek/smells.rb", "lib/reek/smells/attribute.rb", "lib/reek/smells/boolean_parameter.rb", "lib/reek/smells/class_variable.rb", "lib/reek/smells/control_couple.rb", "lib/reek/smells/data_clump.rb", "lib/reek/smells/duplication.rb", "lib/reek/smells/feature_envy.rb", "lib/reek/smells/irresponsible_module.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/simulated_polymorphism.rb", "lib/reek/smells/smell_detector.rb", "lib/reek/smells/uncommunicative_method_name.rb", "lib/reek/smells/uncommunicative_module_name.rb", "lib/reek/smells/uncommunicative_parameter_name.rb", "lib/reek/smells/uncommunicative_variable_name.rb", "lib/reek/smells/utility_function.rb", "lib/reek/source.rb", "lib/reek/source/code_comment.rb", "lib/reek/source/config_file.rb", "lib/reek/source/core_extras.rb", "lib/reek/source/reference_collector.rb", "lib/reek/source/sexp_formatter.rb", "lib/reek/source/source_code.rb", "lib/reek/source/source_file.rb", "lib/reek/source/source_locator.rb", "lib/reek/source/tree_dresser.rb", "lib/reek/spec.rb", "lib/reek/spec/should_reek.rb", "lib/reek/spec/should_reek_of.rb", "lib/reek/spec/should_reek_only_of.rb", "reek.gemspec", "spec/reek/cli/help_command_spec.rb", "spec/reek/cli/reek_command_spec.rb", "spec/reek/cli/report_spec.rb", "spec/reek/cli/version_command_spec.rb", "spec/reek/cli/yaml_command_spec.rb", "spec/reek/core/class_context_spec.rb", "spec/reek/core/code_context_spec.rb", "spec/reek/core/code_parser_spec.rb", "spec/reek/core/config_spec.rb", "spec/reek/core/masking_collection_spec.rb", "spec/reek/core/method_context_spec.rb", "spec/reek/core/module_context_spec.rb", "spec/reek/core/object_refs_spec.rb", "spec/reek/core/singleton_method_context_spec.rb", "spec/reek/core/smell_configuration_spec.rb", "spec/reek/core/stop_context_spec.rb", "spec/reek/examiner_spec.rb", "spec/reek/smell_warning_spec.rb", "spec/reek/smells/attribute_spec.rb", "spec/reek/smells/behaves_like_variable_detector.rb", "spec/reek/smells/boolean_parameter_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", "spec/reek/smells/feature_envy_spec.rb", "spec/reek/smells/irresponsible_module_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/long_yield_list_spec.rb", "spec/reek/smells/nested_iterators_spec.rb", "spec/reek/smells/simulated_polymorphism_spec.rb", "spec/reek/smells/smell_detector_shared.rb", "spec/reek/smells/uncommunicative_method_name_spec.rb", "spec/reek/smells/uncommunicative_module_name_spec.rb", "spec/reek/smells/uncommunicative_parameter_name_spec.rb", "spec/reek/smells/uncommunicative_variable_name_spec.rb", "spec/reek/smells/utility_function_spec.rb", "spec/reek/source/code_comment_spec.rb", "spec/reek/source/object_source_spec.rb", "spec/reek/source/reference_collector_spec.rb", "spec/reek/source/source_code_spec.rb", "spec/reek/source/tree_dresser_spec.rb", "spec/reek/spec/should_reek_of_spec.rb", "spec/reek/spec/should_reek_only_of_spec.rb", "spec/reek/spec/should_reek_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", "spec/samples/clean_due_to_masking/clean_one.rb", "spec/samples/clean_due_to_masking/clean_three.rb", "spec/samples/clean_due_to_masking/clean_two.rb", "spec/samples/clean_due_to_masking/dirty_one.rb", "spec/samples/clean_due_to_masking/dirty_two.rb", "spec/samples/clean_due_to_masking/masked.reek", "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/exceptions.reek", "spec/samples/inline.rb", "spec/samples/masked/dirty.rb", "spec/samples/masked/masked.reek", "spec/samples/mixed_results/clean_one.rb", "spec/samples/mixed_results/clean_three.rb", "spec/samples/mixed_results/clean_two.rb", "spec/samples/mixed_results/dirty_one.rb", "spec/samples/mixed_results/dirty_two.rb", "spec/samples/not_quite_masked/dirty.rb", "spec/samples/not_quite_masked/masked.reek", "spec/samples/optparse.rb", "spec/samples/overrides/masked/dirty.rb", "spec/samples/overrides/masked/lower.reek", "spec/samples/overrides/upper.reek", "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/spec.opts", "spec/spec_helper.rb", "tasks/reek.rake", "tasks/test.rake"]
+  s.files = [".yardopts", "History.txt", "License.txt", "README.md", "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", "features/yaml.feature", "lib/reek.rb", "lib/reek/cli/application.rb", "lib/reek/cli/command_line.rb", "lib/reek/cli/help_command.rb", "lib/reek/cli/reek_command.rb", "lib/reek/cli/report.rb", "lib/reek/cli/version_command.rb", "lib/reek/cli/yaml_command.rb", "lib/reek/core/code_context.rb", "lib/reek/core/code_parser.rb", "lib/reek/core/method_context.rb", "lib/reek/core/module_context.rb", "lib/reek/core/object_refs.rb", "lib/reek/core/singleton_method_context.rb", "lib/reek/core/smell_configuration.rb", "lib/reek/core/sniffer.rb", "lib/reek/core/stop_context.rb", "lib/reek/core/warning_collector.rb", "lib/reek/examiner.rb", "lib/reek/rake/task.rb", "lib/reek/smell_warning.rb", "lib/reek/smells.rb", "lib/reek/smells/attribute.rb", "lib/reek/smells/boolean_parameter.rb", "lib/reek/smells/class_variable.rb", "lib/reek/smells/control_couple.rb", "lib/reek/smells/data_clump.rb", "lib/reek/smells/duplication.rb", "lib/reek/smells/feature_envy.rb", "lib/reek/smells/irresponsible_module.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/simulated_polymorphism.rb", "lib/reek/smells/smell_detector.rb", "lib/reek/smells/uncommunicative_method_name.rb", "lib/reek/smells/uncommunicative_module_name.rb", "lib/reek/smells/uncommunicative_parameter_name.rb", "lib/reek/smells/uncommunicative_variable_name.rb", "lib/reek/smells/utility_function.rb", "lib/reek/source.rb", "lib/reek/source/code_comment.rb", "lib/reek/source/config_file.rb", "lib/reek/source/core_extras.rb", "lib/reek/source/reference_collector.rb", "lib/reek/source/sexp_formatter.rb", "lib/reek/source/source_code.rb", "lib/reek/source/source_file.rb", "lib/reek/source/source_locator.rb", "lib/reek/source/tree_dresser.rb", "lib/reek/spec.rb", "lib/reek/spec/should_reek.rb", "lib/reek/spec/should_reek_of.rb", "lib/reek/spec/should_reek_only_of.rb", "reek.gemspec", "spec/reek/cli/help_command_spec.rb", "spec/reek/cli/reek_command_spec.rb", "spec/reek/cli/report_spec.rb", "spec/reek/cli/version_command_spec.rb", "spec/reek/cli/yaml_command_spec.rb", "spec/reek/core/code_context_spec.rb", "spec/reek/core/code_parser_spec.rb", "spec/reek/core/config_spec.rb", "spec/reek/core/method_context_spec.rb", "spec/reek/core/module_context_spec.rb", "spec/reek/core/object_refs_spec.rb", "spec/reek/core/singleton_method_context_spec.rb", "spec/reek/core/smell_configuration_spec.rb", "spec/reek/core/stop_context_spec.rb", "spec/reek/core/warning_collector_spec.rb", "spec/reek/examiner_spec.rb", "spec/reek/smell_warning_spec.rb", "spec/reek/smells/attribute_spec.rb", "spec/reek/smells/behaves_like_variable_detector.rb", "spec/reek/smells/boolean_parameter_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", "spec/reek/smells/feature_envy_spec.rb", "spec/reek/smells/irresponsible_module_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/long_yield_list_spec.rb", "spec/reek/smells/nested_iterators_spec.rb", "spec/reek/smells/simulated_polymorphism_spec.rb", "spec/reek/smells/smell_detector_shared.rb", "spec/reek/smells/uncommunicative_method_name_spec.rb", "spec/reek/smells/uncommunicative_module_name_spec.rb", "spec/reek/smells/uncommunicative_parameter_name_spec.rb", "spec/reek/smells/uncommunicative_variable_name_spec.rb", "spec/reek/smells/utility_function_spec.rb", "spec/reek/source/code_comment_spec.rb", "spec/reek/source/object_source_spec.rb", "spec/reek/source/reference_collector_spec.rb", "spec/reek/source/source_code_spec.rb", "spec/reek/source/tree_dresser_spec.rb", "spec/reek/spec/should_reek_of_spec.rb", "spec/reek/spec/should_reek_only_of_spec.rb", "spec/reek/spec/should_reek_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", "spec/samples/clean_due_to_masking/clean_one.rb", "spec/samples/clean_due_to_masking/clean_three.rb", "spec/samples/clean_due_to_masking/clean_two.rb", "spec/samples/clean_due_to_masking/dirty_one.rb", "spec/samples/clean_due_to_masking/dirty_two.rb", "spec/samples/clean_due_to_masking/masked.reek", "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/exceptions.reek", "spec/samples/inline.rb", "spec/samples/masked/dirty.rb", "spec/samples/masked/masked.reek", "spec/samples/mixed_results/clean_one.rb", "spec/samples/mixed_results/clean_three.rb", "spec/samples/mixed_results/clean_two.rb", "spec/samples/mixed_results/dirty_one.rb", "spec/samples/mixed_results/dirty_two.rb", "spec/samples/not_quite_masked/dirty.rb", "spec/samples/not_quite_masked/masked.reek", "spec/samples/optparse.rb", "spec/samples/overrides/masked/dirty.rb", "spec/samples/overrides/masked/lower.reek", "spec/samples/overrides/upper.reek", "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/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
@@ -22,7 +22,7 @@ For more information on reek, see http://wiki.github.com/kevinrutherford/reek
   s.rdoc_options = ["--main", "README.md"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{reek}
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{Code smell detector for Ruby}
 
   if s.respond_to? :specification_version then

data/spec/reek/cli/reek_command_spec.rb

@@ -14,11 +14,11 @@ describe ReekCommand do
   context 'with smells' do
     before :each do
       examiner = Examiner.new('def x(); end')
-      @cmd = ReekCommand.new([examiner], QuietReport)
+      @cmd = ReekCommand.new(QuietReport, ['def x(); end'])
     end
 
     it 'displays the correct text on the view' do
-      @view.should_receive(:output).with(/Uncommunicative Name/)
+      @view.should_receive(:output).with(/UncommunicativeName/)
       @cmd.execute(@view)
     end
 
@@ -30,8 +30,7 @@ describe ReekCommand do
 
   context 'with no smells' do
     before :each do
-      examiner = Examiner.new('def clean(); end')
-      @cmd = ReekCommand.new([examiner], QuietReport)
+      @cmd = ReekCommand.new(QuietReport, ['def clean(); end'])
     end
 
     it 'displays nothing on the view' do

data/spec/reek/cli/report_spec.rb

@@ -5,20 +5,24 @@ require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expan
 include Reek
 include Reek::Cli
 
-describe ReportSection, " when empty" do
+describe QuietReport, " when empty" do
   context 'empty source' do
     it 'has an empty quiet_report' do
       examiner = Examiner.new('')
-      ReportSection.new(examiner).quiet_report.should == ''
+      QuietReport.new(examiner).report.should == ''
     end
   end
 
   context 'with a couple of smells' do
-    it 'should mention every smell name' do
+    before :each do
       examiner = Examiner.new('def simple(a) a[3] end')
-      rpt = ReportSection.new(examiner)
-      @lines = rpt.smell_list.split("\n")
-      @lines.should have_at_least(2).lines
+      rpt = QuietReport.new(examiner)
+      @lines = rpt.report.split("\n")
+    end
+    it 'has a header and a list of smells' do
+      @lines.should have_at_least(3).lines
+    end
+    it 'should mention every smell name' do
       @lines[0].should match('[Utility Function]')
       @lines[1].should match('[Feature Envy]')
     end

data/spec/reek/cli/yaml_command_spec.rb

@@ -29,7 +29,7 @@ describe YamlCommand do
 
   context 'with smells' do
     before :each do
-      @smell = SmellWarning.new('UncommunicativeName', "self", 27, "self", true)
+      @smell = SmellWarning.new('UncommunicativeName', "self", 27, "self")
       @examiner.should_receive(:smells).and_return([@smell])
       @cmd = YamlCommand.new([@examiner])
     end

data/spec/reek/core/code_context_spec.rb

@@ -1,5 +1,4 @@
 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', 'core', 'class_context')
 require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'core', 'method_context')
 require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'core', 'module_context')
 require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'core', 'stop_context')
@@ -56,8 +55,7 @@ describe CodeContext do
       stop = StopContext.new
       def stop.bananas(arg1, arg2) arg1 + arg2 + 43 end
       element = ModuleContext.new(stop, 'mod', s(:module, :mod, nil))
-      class_element = ClassContext.new(element, [0, :klass], s())
-      element = MethodContext.new(class_element, [0, :bad])
+      element = MethodContext.new(element, [0, :bad])
       element.bananas(17, -5).should == 55
     end
   end

data/spec/reek/core/module_context_spec.rb

@@ -6,7 +6,7 @@ include Reek::Core
 
 describe ModuleContext do
   it 'should report module name for smell in method' do
-    'module Fred; def simple(x) true; end; end'.should reek_of(:UncommunicativeParameterName, /x/, /simple/, /Fred/)
+    'module Fred; def simple(x) true; end; end'.should reek_of(:UncommunicativeParameterName, /x/, /simple/)
   end
 
   it 'should not report module with empty class' do

data/spec/reek/core/warning_collector_spec.rb

@@ -0,0 +1,27 @@
+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', 'core', 'warning_collector')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'smell_warning')
+
+include Reek::Core
+
+describe WarningCollector do
+  before(:each) do
+    @collector = WarningCollector.new
+  end
+
+  context 'when empty' do
+    it 'reports no warnings' do
+      @collector.warnings.should == []
+    end
+  end
+
+  context 'with one warning' do
+    before :each do
+      @warning = Reek::SmellWarning.new('ControlCouple', 'fred', [1,2,3], 'hello')
+      @collector.found_smell(@warning)
+    end
+    it 'reports that warning' do
+      @collector.warnings.should == [@warning]
+    end
+  end
+end

data/spec/reek/examiner_spec.rb

@@ -3,40 +3,101 @@ require File.join(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE
 
 include Reek
 
+shared_examples_for 'supports the deprecated api' do
+  it 'returns all smells as active' do
+    @examiner.all_active_smells.should == @examiner.smells
+  end
+  it 'returns all smells as active' do
+    @examiner.all_smells.should == @examiner.smells
+  end
+  it 'counts all smells as active smells' do
+    @examiner.num_active_smells.should == @examiner.smells.length
+  end
+  it 'never reports masked smells' do
+    @examiner.num_masked_smells.should == 0
+  end
+end
+
+shared_examples_for 'no smells found' do
+  it 'is not smelly' do
+    @examiner.should_not be_smelly
+  end
+  it 'finds no smells' do
+    @examiner.smells.length.should == 0
+  end
+
+  it_should_behave_like 'supports the deprecated api'
+end
+
+shared_examples_for 'one smell found' do
+  it 'is smelly' do
+    @examiner.should be_smelly
+  end
+  it 'reports the smell' do
+    @examiner.smells.length.should == 1
+  end
+  it 'reports the correct smell' do
+    @examiner.smells[0].smell_class.should == @expected_first_smell
+  end
+
+  it_should_behave_like 'supports the deprecated api'
+end
+
 describe Examiner do
-  it 'detects smells in a file' do
-    dirty_file = Dir['spec/samples/two_smelly_files/*.rb'][0]
-    Examiner.new(File.new(dirty_file)).should be_smelly
+  before :each do
+    @expected_first_smell = 'NestedIterators'
   end
-  it 'doesnt match a fragrant String' do
-    examiner = Examiner.new('def good() true; end')
-    examiner.smells.should == []
+
+  context 'with a fragrant String' do
+    before :each do
+      @examiner = Examiner.new('def good() true; end')
+    end
+
+    it_should_behave_like 'no smells found'
   end
-  it 'matches a smelly String' do
-    Examiner.new('def fine() y = 4; end').smells.length.should == 1
+
+  context 'with a smelly String' do
+    before :each do
+      @examiner = Examiner.new('def fine() y = 4; end')
+      @expected_first_smell = 'UncommunicativeName'
+    end
+
+    it_should_behave_like 'one smell found'
   end
 
-  context 'checking code in a Dir' do
-    it 'matches a smelly Dir' do
+  context 'with a smelly Dir' do
+    before :each do
       smelly_dir = Dir['spec/samples/all_but_one_masked/*.rb']
-      Examiner.new(smelly_dir).smells.length.should == 1
+      @examiner = Examiner.new(smelly_dir)
     end
-    it 'doesnt match a fragrant Dir' do
+
+    it_should_behave_like 'one smell found'
+  end
+
+  context 'with a fragrant Dir' do
+    before :each do
       clean_dir = Dir['spec/samples/three_clean_files/*.rb']
-      Examiner.new(clean_dir).smells.length.should == 0
+      @examiner = Examiner.new(clean_dir)
     end
+
+    it_should_behave_like 'no smells found'
   end
 
-  context 'checking code in a File' do
-    it 'matches a smelly File' do
+  context 'with a smelly File' do
+    before :each do
       smelly_file = File.new(Dir['spec/samples/all_but_one_masked/d*.rb'][0])
-      Examiner.new(smelly_file).smells.length.should == 1
+      @examiner = Examiner.new(smelly_file)
     end
 
-    it 'doesnt match a fragrant File' do
+    it_should_behave_like 'one smell found'
+  end
+
+  context 'with a fragrant File' do
+    before :each do
       clean_file = File.new(Dir['spec/samples/three_clean_files/*.rb'][0])
-      Examiner.new(clean_file).smells.length.should == 0
+      @examiner = Examiner.new(clean_file)
     end
-  end
 
+    it_should_behave_like 'no smells found'
+  end
 end

data/spec/reek/smell_warning_spec.rb

@@ -5,27 +5,6 @@ include Reek
 
 describe SmellWarning do
   context 'sort order' do
-    context 'smells differing only by masking' do
-      before :each do
-        @first = SmellWarning.new('FeatureEnvy', "self", 27, "self", true)
-        @second = SmellWarning.new('FeatureEnvy', "self", 27, "self", false)
-      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
-      it 'matches using eql?' do
-        @first.should eql(@second)
-        @second.should eql(@first)
-      end
-    end
-
     shared_examples_for 'first sorts ahead of second' do
       it 'hash differently' do
         @first.hash.should_not == @second.hash
@@ -88,48 +67,12 @@ describe SmellWarning do
     end
   end
 
-  context 'masked reporting' do
-    class CountingReport
-      attr_reader :masked, :non_masked
-      def initialize
-        @masked = @non_masked = 0
-      end
-      def found_smell(sw)
-        @non_masked += 1
-      end
-
-      def found_masked_smell(sw)
-        @masked += 1
-      end
-    end
-
-    before :each do
-      @masked = SmellWarning.new('FeatureEnvy', 'Fred', 27, "self", true)
-      @visible = SmellWarning.new('FeatureEnvy', 'Fred', 27, "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
-
   context 'YAML representation' do
     before :each do
       @message = 'test message'
       @lines = [24, 513]
       @class = 'FeatureEnvy'
       @context_name = 'Module::Class#method/block'
-      @is_active = true
       # Use a random string and a random bool
     end
 
@@ -144,7 +87,7 @@ describe SmellWarning do
         @yaml.should match(/message:\s*#{@message}/)
       end
       it 'indicates the masking' do
-        @yaml.should match(/is_active:\s*#{@is_active}/)
+        @yaml.should match(/is_active:\s*true/)
       end
       it 'includes the line numbers' do
         @lines.each do |line|
@@ -158,9 +101,9 @@ describe SmellWarning do
         @source = 'a/ruby/source/file.rb'
         @subclass = 'TooManyParties'
         @parameters = {'one' => 34, 'two' => 'second'}
-        warning = SmellWarning.new(@class, @context_name, @lines, @message, @is_masked,
+        @warning = SmellWarning.new(@class, @context_name, @lines, @message,
           @source, @subclass, @parameters)
-        @yaml = warning.to_yaml
+        @yaml = @warning.to_yaml
       end
 
       it_should_behave_like 'common fields'
@@ -180,7 +123,7 @@ describe SmellWarning do
 
     context 'with all defaults used' do
       before :each do
-        warning = SmellWarning.new(@class, @context_name, @lines, @message, @is_masked)
+        warning = SmellWarning.new(@class, @context_name, @lines, @message)
         @yaml = warning.to_yaml
       end