reek 1.2.3 → 1.2.4

data/lib/reek/version_command.rb

@@ -0,0 +1,14 @@
+
+module Reek
+
+  class VersionCommand
+    def initialize(progname)
+      @progname = progname
+    end
+    def execute(view)
+      view.output("#{@progname} #{Reek::VERSION}")
+      view.report_success
+    end
+  end
+
+end

data/reek.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{reek}
-  s.version = "1.2.3"
+  s.version = "1.2.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kevin Rutherford"]
-  s.date = %q{2009-11-02}
+  s.date = %q{2009-11-17}
   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", "License.txt", "README.rdoc"]
-  s.files = ["History.txt", "License.txt", "README.rdoc", "Rakefile", "bin/reek", "config/defaults.reek", "features/masking_smells.feature", "features/options.feature", "features/profile.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/adapters/application.rb", "lib/reek/adapters/command_line.rb", "lib/reek/adapters/config_file.rb", "lib/reek/adapters/core_extras.rb", "lib/reek/adapters/rake_task.rb", "lib/reek/adapters/report.rb", "lib/reek/adapters/source.rb", "lib/reek/adapters/spec.rb", "lib/reek/block_context.rb", "lib/reek/class_context.rb", "lib/reek/code_context.rb", "lib/reek/code_parser.rb", "lib/reek/configuration.rb", "lib/reek/detector_stack.rb", "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/sexp_formatter.rb", "lib/reek/singleton_method_context.rb", "lib/reek/smell_warning.rb", "lib/reek/smells/attribute.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/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_name.rb", "lib/reek/smells/utility_function.rb", "lib/reek/sniffer.rb", "lib/reek/stop_context.rb", "lib/reek/tree_dresser.rb", "lib/reek/yield_call_context.rb", "reek.gemspec", "spec/reek/adapters/report_spec.rb", "spec/reek/adapters/should_reek_of_spec.rb", "spec/reek/adapters/should_reek_only_of_spec.rb", "spec/reek/adapters/should_reek_spec.rb", "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/configuration_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/singleton_method_context_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/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/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/simulated_polymorphism_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/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", "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 = ["History.txt", "License.txt", "README.rdoc", "Rakefile", "bin/reek", "config/defaults.reek", "features/masking_smells.feature", "features/options.feature", "features/profile.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/adapters/application.rb", "lib/reek/adapters/command_line.rb", "lib/reek/adapters/config_file.rb", "lib/reek/adapters/core_extras.rb", "lib/reek/adapters/rake_task.rb", "lib/reek/adapters/report.rb", "lib/reek/adapters/source.rb", "lib/reek/adapters/spec.rb", "lib/reek/block_context.rb", "lib/reek/class_context.rb", "lib/reek/code_context.rb", "lib/reek/code_parser.rb", "lib/reek/configuration.rb", "lib/reek/detector_stack.rb", "lib/reek/help_command.rb", "lib/reek/if_context.rb", "lib/reek/masking_collection.rb", "lib/reek/method_context.rb", "lib/reek/module_context.rb", "lib/reek/name.rb", "lib/reek/object_refs.rb", "lib/reek/reek_command.rb", "lib/reek/sexp_formatter.rb", "lib/reek/singleton_method_context.rb", "lib/reek/smell_warning.rb", "lib/reek/smells/attribute.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/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_name.rb", "lib/reek/smells/utility_function.rb", "lib/reek/sniffer.rb", "lib/reek/stop_context.rb", "lib/reek/tree_dresser.rb", "lib/reek/version_command.rb", "lib/reek/yield_call_context.rb", "reek.gemspec", "spec/reek/adapters/report_spec.rb", "spec/reek/adapters/should_reek_of_spec.rb", "spec/reek/adapters/should_reek_only_of_spec.rb", "spec/reek/adapters/should_reek_spec.rb", "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/configuration_spec.rb", "spec/reek/help_command_spec.rb", "spec/reek/if_context_spec.rb", "spec/reek/masking_collection_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/reek_command_spec.rb", "spec/reek/singleton_method_context_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/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/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/simulated_polymorphism_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/sniffer_spec.rb", "spec/reek/stop_context_spec.rb", "spec/reek/tree_dresser_spec.rb", "spec/reek/version_command_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

data/spec/reek/adapters/report_spec.rb

@@ -9,7 +9,7 @@ include Reek
 
 describe ReportSection, " when empty" do
   before(:each) do
-    @rpt = ReportSection.new(''.sniff, '%m%c %w (%s)', false)
+    @rpt = ReportSection.new(''.sniff, false)
   end
 
   it 'has an empty quiet_report' do
@@ -19,7 +19,7 @@ end
 
 describe ReportSection, "smell_list" do
   before(:each) do
-    rpt = ReportSection.new('def simple(a) a[3] end'.sniff, false, '%m%c %w (%s)')
+    rpt = ReportSection.new('def simple(a) a[3] end'.sniff, false)
     @lines = rpt.smell_list.split("\n")
   end
 
@@ -32,18 +32,18 @@ end
 
 describe ReportSection, " as a SortedSet" do
   it 'should only add a smell once' do
-    rpt = ReportSection.new(''.sniff, false, '%m%c %w (%s)')
-    rpt << SmellWarning.new(Smells::FeatureEnvy.new, "self", 'too many!', false)
-    rpt << SmellWarning.new(Smells::FeatureEnvy.new, "self", 'too many!', false)
+    rpt = ReportSection.new(''.sniff, false)
+    rpt.found_smell SmellWarning.new(Smells::FeatureEnvy.new, "self", 'too many!', false)
+    rpt.found_smell SmellWarning.new(Smells::FeatureEnvy.new, "self", 'too many!', false)
     lines = rpt.smell_list.split("\n")
     lines.should have(1).lines
   end
 
   it 'should not count an identical masked smell' do
-    rpt = ReportSection.new(''.sniff, false, '%m%c %w (%s)')
+    rpt = ReportSection.new(''.sniff, false)
     # SMELL: Duplication -- the SmellWarning knows whether to call << or record_masked_smell
-    rpt << SmellWarning.new(Smells::FeatureEnvy.new, "self", 'too many!', false)
-    rpt.record_masked_smell(SmellWarning.new(Smells::FeatureEnvy.new, "self", 'too many!', true))
+    rpt.found_smell SmellWarning.new(Smells::FeatureEnvy.new, "self", 'too many!', false)
+    rpt.found_masked_smell(SmellWarning.new(Smells::FeatureEnvy.new, "self", 'too many!', true))
     rpt.header.should == 'string -- 1 warning'
   end
 end

data/spec/reek/adapters/should_reek_of_spec.rb

@@ -11,7 +11,7 @@ describe ReekMatcher do
   before :each do
     smelly_code = Dir['spec/samples/two_smelly_files/*.rb']
     @sniffers = smelly_code.sniff.sniffers
-    @full = FullReport.new(@sniffers, '%c %w (%s)', false).report
+    @full = VerboseReport.new(@sniffers, false).report
   end
 
   it 'reports quietly' do

data/spec/reek/adapters/should_reek_only_of_spec.rb

@@ -44,7 +44,7 @@ describe ShouldReekOnlyOf, 'checking code in a Dir' do
 
   it 'reports the smells when should_not fails' do
     @matcher.matches?(@smelly_dir).should be_true
-    @matcher.failure_message_for_should.should include(QuietReport.new(@smelly_dir.sniff.sniffers, '%m%c %w (%s)').report)
+    @matcher.failure_message_for_should.should include(QuietReport.new(@smelly_dir.sniff.sniffers).report)
   end
 end
 
@@ -65,7 +65,7 @@ describe ShouldReekOnlyOf, 'checking code in a File' do
 
   it 'reports the smells when should_not fails' do
     @matcher.matches?(@smelly_file).should be_true
-    @matcher.failure_message_for_should.should include(QuietReport.new(@smelly_file.sniff, '%m%c %w (%s)').report)
+    @matcher.failure_message_for_should.should include(QuietReport.new(@smelly_file.sniff).report)
   end
 end
 

data/spec/reek/adapters/should_reek_spec.rb

@@ -23,7 +23,7 @@ describe ShouldReek, 'checking code in a string' do
 
   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, '%m%c %w (%s)').report)
+    @matcher.failure_message_for_should_not.should include(QuietReport.new(@smelly_code.sniff).report)
   end
 end
 
@@ -44,7 +44,7 @@ describe ShouldReek, 'checking code in a Dir' do
 
   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, '%m%c %w (%s)').report)
+    @matcher.failure_message_for_should_not.should include(QuietReport.new(@smelly_dir.sniff.sniffers).report)
   end
 end
 
@@ -65,7 +65,7 @@ describe ShouldReek, 'checking code in a File' do
 
   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, '%m%c %w (%s)').report)
+    @matcher.failure_message_for_should_not.should include(QuietReport.new(@smelly_file.sniff).report)
   end
 end
 

data/spec/reek/code_context_spec.rb

@@ -101,20 +101,20 @@ describe CodeContext do
         @ctx = CodeContext.new(nil, ast)
       end
       it 'yields no calls' do
-        @ctx.each(:call, []) {|exp| raise "#{exp} yielded by empty module!"}
+        @ctx.each_node(:call, []) {|exp| raise "#{exp} yielded by empty module!"}
       end
       it 'yields one module' do
         mods = 0
-        @ctx.each(:module, []) {|exp| mods += 1}
+        @ctx.each_node(:module, []) {|exp| mods += 1}
         mods.should == 1
       end
       it "yields the module's full AST" do
-        @ctx.each(:module, []) {|exp| exp[1].should == @module_name.to_sym}
+        @ctx.each_node(:module, []) {|exp| exp[1].should == @module_name.to_sym}
       end
 
       context 'with no block' do
         it 'returns an empty array of ifs' do
-          @ctx.each(:if, []).should be_empty
+          @ctx.each_node(:if, []).should be_empty
         end
       end
     end
@@ -128,24 +128,24 @@ describe CodeContext do
         @ctx = CodeContext.new(nil, ast)
       end
       it 'yields no ifs' do
-        @ctx.each(:if, []) {|exp| raise "#{exp} yielded by empty module!"}
+        @ctx.each_node(:if, []) {|exp| raise "#{exp} yielded by empty module!"}
       end
       it 'yields one module' do
-        @ctx.each(:module, []).length.should == 1
+        @ctx.each_node(:module, []).length.should == 1
       end
       it "yields the module's full AST" do
-        @ctx.each(:module, []) {|exp| exp[1].should == @module_name.to_sym}
+        @ctx.each_node(:module, []) {|exp| exp[1].should == @module_name.to_sym}
       end
       it 'yields one method' do
-        @ctx.each(:defn, []).length.should == 1
+        @ctx.each_node(:defn, []).length.should == 1
       end
       it "yields the method's full AST" do
-        @ctx.each(:defn, []) {|exp| exp[1].should == @method_name.to_sym}
+        @ctx.each_node(:defn, []) {|exp| exp[1].should == @method_name.to_sym}
       end
 
       context 'pruning the traversal' do
         it 'ignores the call inside the method' do
-          @ctx.each(:call, [:defn]).should be_empty
+          @ctx.each_node(:call, [:defn]).should be_empty
         end
       end
     end
@@ -169,7 +169,7 @@ EOS
 
       ast = src.to_reek_source.syntax_tree
       ctx = CodeContext.new(nil, ast)
-      ctx.each(:if, []).length.should == 3
+      ctx.each_node(:if, []).length.should == 3
     end
   end
 end

data/spec/reek/code_parser_spec.rb

@@ -37,91 +37,3 @@ describe CodeParser do
     'def options() ozz.on { |@list| @prompt = !@list } end'.should_not reek
   end
 end
-
-describe CodeParser do
-  context 'with no attributes' do
-    it 'records nothing in the class' do
-      klass = ClassContext.from_s('class Fred; end')
-      klass.attributes.should be_empty
-    end
-    it 'records nothing in the module' do
-      ctx = ModuleContext.from_s('module Fred; end')
-      ctx.attributes.should be_empty
-    end
-  end
-
-  context 'with one attribute' do
-    shared_examples_for 'one attribute found' do
-      it 'records the attribute' do
-        @ctx.attributes.should include(Name.new(:property))
-      end
-      it 'records only that attribute' do
-        @ctx.attributes.length.should == 1
-      end
-    end
-
-    context 'declared in a class' do
-      before :each do
-        @ctx = ClassContext.from_s('class Fred; attr :property; end')
-      end
-
-      it_should_behave_like 'one attribute found'
-    end
-
-    context 'reader in a class' do
-      before :each do
-        @ctx = ClassContext.from_s('class Fred; attr_reader :property; end')
-      end
-
-      it_should_behave_like 'one attribute found'
-    end
-
-    context 'writer in a class' do
-      before :each do
-        @ctx = ClassContext.from_s('class Fred; attr_writer :property; end')
-      end
-
-      it_should_behave_like 'one attribute found'
-    end
-
-    context 'accessor in a class' do
-      before :each do
-        @ctx = ClassContext.from_s('class Fred; attr_accessor :property; end')
-      end
-
-      it_should_behave_like 'one attribute found'
-    end
-
-    context 'declared in a module' do
-      before :each do
-        @ctx = ModuleContext.from_s('module Fred; attr :property; end')
-      end
-
-      it_should_behave_like 'one attribute found'
-    end
-
-    context 'reader in a module' do
-      before :each do
-        @ctx = ModuleContext.from_s('module Fred; attr_reader :property; end')
-      end
-
-      it_should_behave_like 'one attribute found'
-    end
-
-    context 'writer in a module' do
-      before :each do
-        @ctx = ModuleContext.from_s('module Fred; attr_writer :property; end')
-      end
-
-      it_should_behave_like 'one attribute found'
-    end
-
-    context 'accessor in a module' do
-      before :each do
-        @ctx = ModuleContext.from_s('module Fred; attr_accessor :property; end')
-      end
-
-      it_should_behave_like 'one attribute found'
-    end
-  end
-end

data/spec/reek/help_command_spec.rb

@@ -0,0 +1,24 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+require 'reek/help_command'
+
+include Reek
+
+describe HelpCommand do
+  before :each do
+    @text = 'Piece of interesting text'
+    @cmd = HelpCommand.new(@text)
+    @view = mock('view', :null_object => true)
+    @view.should_not_receive(:report_smells)
+  end
+
+  it 'displays the correct text on the view' do
+    @view.should_receive(:output).with(@text)
+    @cmd.execute(@view)
+  end
+
+  it 'tells the view it succeeded' do
+    @view.should_receive(:report_success)
+    @cmd.execute(@view)
+  end
+end

data/spec/reek/masking_collection_spec.rb

@@ -0,0 +1,236 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+require 'reek/masking_collection'
+
+include Reek
+
+describe MaskingCollection do
+  before(:each) do
+    @collection = MaskingCollection.new
+  end
+
+  context 'when empty' do
+    it 'has no visible items' do
+      @collection.num_visible_items.should == 0
+    end
+    it 'has no masked items' do
+      @collection.num_masked_items.should == 0
+    end
+    it 'yields no items' do
+      count = 0
+      @collection.each_item {|item| count+= 1}
+      count.should == 0
+    end
+    it 'yields no visible items' do
+      count = 0
+      @collection.each_visible_item {|item| count+= 1}
+      count.should == 0
+    end
+  end
+
+  shared_examples_for 'one visible item' do
+    it 'has one visible item' do
+      @collection.num_visible_items.should == 1
+    end
+    it 'has no masked items' do
+      @collection.num_masked_items.should == 0
+    end
+    it 'yields one item' do
+      count = 0
+      @collection.each_item do |item|
+        item.should == @item
+        count+= 1
+      end
+      count.should == 1
+    end
+    it 'yields one visible item' do
+      count = 0
+      @collection.each_visible_item do |item|
+        item.should == @item
+        count+= 1
+      end
+      count.should == 1
+    end
+  end
+
+  shared_examples_for 'one masked item' do
+    it 'has no visible items' do
+      @collection.num_visible_items.should == 0
+    end
+    it 'has one masked item' do
+      @collection.num_masked_items.should == 1
+    end
+    it 'yields one item' do
+      count = 0
+      @collection.each_item do |item|
+        item.should == @item
+        count+= 1
+      end
+      count.should == 1
+    end
+    it 'yields no visible items' do
+      count = 0
+      @collection.each_visible_item { |item| count+= 1 }
+      count.should == 0
+    end
+  end
+
+  context 'with one visible item' do
+    before :each do
+      @item = "hello"
+      @collection.add(@item)
+    end
+    it_should_behave_like 'one visible item'
+  end
+
+  context 'with one masked item' do
+    before :each do
+      @item = "hiding!"
+      @collection.add_masked(@item)
+    end
+    it_should_behave_like 'one masked item'
+  end
+
+  context 'with one masked and one visible' do
+    before :each do
+      @visible = "visible"
+      @masked = "masked"
+      @collection.add_masked(@masked)
+      @collection.add(@visible)
+    end
+    it 'has one visible item' do
+      @collection.num_visible_items.should == 1
+    end
+    it 'has one masked item' do
+      @collection.num_masked_items.should == 1
+    end
+    it 'yields both items' do
+      yielded_items = []
+      @collection.each_item { |item| yielded_items << item }
+      yielded_items.length.should == 2
+      yielded_items.should include(@visible)
+      yielded_items.should include(@masked)
+    end
+    it 'yields one visible item' do
+      count = 0
+      @collection.each_visible_item do |item|
+        item.should == @visible
+        count+= 1
+      end
+      count.should == 1
+    end
+    it 'yields the items in sort order' do
+      yielded_items = []
+      @collection.each_item { |item| yielded_items << item }
+      yielded_items.length.should == 2
+      yielded_items[0].should == @masked
+      yielded_items[1].should == @visible
+    end
+  end
+
+  context 'with one visible item added twice' do
+    before :each do
+      @item = "hello"
+      @collection.add(@item)
+      @collection.add(@item)
+    end
+    it_should_behave_like 'one visible item'
+  end
+
+  context 'with one masked item added twice' do
+    before :each do
+      @item = "hello"
+      @collection.add_masked(@item)
+      @collection.add_masked(@item)
+    end
+    it_should_behave_like 'one masked item'
+  end
+
+  context 'with two different visible items' do
+    before :each do
+      @first_item = "hello"
+      @second_item = "goodbye"
+      @collection.add(@first_item)
+      @collection.add(@second_item)
+    end
+    it 'has 2 visible items' do
+      @collection.num_visible_items.should == 2
+    end
+    it 'has no masked items' do
+      @collection.num_masked_items.should == 0
+    end
+    it 'yields both items' do
+      yielded_items = []
+      @collection.each_item { |item| yielded_items << item }
+      yielded_items.length.should == 2
+      yielded_items.should include(@first_item)
+      yielded_items.should include(@second_item)
+    end
+    it 'yields both visible items' do
+      yielded_items = []
+      @collection.each_visible_item { |item| yielded_items << item }
+      yielded_items.length.should == 2
+      yielded_items.should include(@first_item)
+      yielded_items.should include(@second_item)
+    end
+    it 'yields the items in sort order' do
+      yielded_items = []
+      @collection.each_visible_item { |item| yielded_items << item }
+      yielded_items.length.should == 2
+      yielded_items[0].should == @second_item
+      yielded_items[1].should == @first_item
+    end
+  end
+
+  context 'with two different masked items' do
+    before :each do
+      @first_item = "hello"
+      @second_item = "goodbye"
+      @collection.add_masked(@first_item)
+      @collection.add_masked(@second_item)
+    end
+    it 'has 0 visible items' do
+      @collection.num_visible_items.should == 0
+    end
+    it 'has 2 masked items' do
+      @collection.num_masked_items.should == 2
+    end
+    it 'yields both items' do
+      yielded_items = []
+      @collection.each_item { |item| yielded_items << item }
+      yielded_items.length.should == 2
+      yielded_items.should include(@first_item)
+      yielded_items.should include(@second_item)
+    end
+    it 'yields no visible items' do
+      count = 0
+      @collection.each_visible_item { |item| count+= 1 }
+      count.should == 0
+    end
+    it 'yields the items in sort order' do
+      yielded_items = []
+      @collection.each_item { |item| yielded_items << item }
+      yielded_items.length.should == 2
+      yielded_items[0].should == @second_item
+      yielded_items[1].should == @first_item
+    end
+  end
+
+  context 'with one masked item later made visible' do
+    before :each do
+      @item = "hello"
+      @collection.add_masked(@item)
+      @collection.add(@item)
+    end
+    it_should_behave_like 'one visible item'
+  end
+
+  context 'with one visible item later masked' do
+    before :each do
+      @item = "hello"
+      @collection.add(@item)
+      @collection.add_masked(@item)
+    end
+    it_should_behave_like 'one visible item'
+  end
+end