rspec 1.0.8 → 1.1.0

data/spec/spec/runner/formatter/profile_formatter_spec.rb

@@ -0,0 +1,65 @@
+require File.dirname(__FILE__) + '/../../../spec_helper.rb'
+require 'spec/runner/formatter/profile_formatter'
+
+module Spec
+  module Runner
+    module Formatter
+      describe ProfileFormatter do
+        attr_reader :io, :formatter
+        before(:each) do
+          @io = StringIO.new
+          options = mock('options')
+          options.stub!(:colour).and_return(true)
+          @formatter = ProfileFormatter.new(options, io)
+        end
+        
+        it "should print a heading" do
+          formatter.start(0)
+          io.string.should eql("Profiling enabled.\n")
+        end
+        
+        it "should record the current time when starting a new example" do
+          now = Time.now
+          Time.stub!(:now).and_return(now)
+          formatter.example_started('should foo')
+          formatter.instance_variable_get("@time").should == now
+        end
+        
+        it "should correctly record a passed example" do
+          now = Time.now
+          Time.stub!(:now).and_return(now)
+          parent_example_group = Class.new(ExampleGroup).describe('Parent')
+          child_example_group = Class.new(parent_example_group).describe('Child')
+
+          formatter.add_example_group(child_example_group)
+          
+          formatter.example_started('when foo')
+          Time.stub!(:now).and_return(now+1)
+          formatter.example_passed(stub('foo', :description => 'i like ice cream'))
+
+          formatter.start_dump
+          io.string.should include('Parent Child')
+        end
+        
+        it "should sort the results in descending order" do
+          formatter.instance_variable_set("@example_times", [['a', 'a', 0.1], ['b', 'b', 0.3], ['c', 'c', 0.2]])
+          formatter.start_dump
+          formatter.instance_variable_get("@example_times").should == [ ['b', 'b', 0.3], ['c', 'c', 0.2], ['a', 'a', 0.1]]
+        end
+        
+        it "should print the top 10 results" do
+          example_group = Class.new(::Spec::Example::ExampleGroup).describe("ExampleGroup")
+          formatter.add_example_group(example_group)
+          formatter.instance_variable_set("@time", Time.now)
+          
+          15.times do 
+            formatter.example_passed(stub('foo', :description => 'i like ice cream'))
+          end
+          
+          io.should_receive(:print).exactly(10)
+          formatter.start_dump
+        end
+      end
+    end
+  end
+end

data/spec/spec/runner/formatter/progress_bar_formatter_spec.rb

@@ -1,4 +1,5 @@
 require File.dirname(__FILE__) + '/../../../spec_helper.rb'
+require 'spec/runner/formatter/progress_bar_formatter'
 
 module Spec
   module Runner
@@ -6,7 +7,10 @@ module Spec
       describe ProgressBarFormatter do
         before(:each) do
           @io = StringIO.new
-          @formatter = ProgressBarFormatter.new(@io)
+          @options = mock('options')
+          @options.stub!(:dry_run).and_return(false)
+          @options.stub!(:colour).and_return(false)
+          @formatter = ProgressBarFormatter.new(@options, @io)
         end
 
         it "should produce line break on start dump" do
@@ -20,44 +24,41 @@ module Spec
         end
         
         it "should produce standard summary" do
-          @formatter.example_pending("behaviour", "example", "message")  
+          @formatter.example_pending("example_group", ExampleGroup.new("example"), "message")
           @io.rewind
           @formatter.dump_summary(3, 2, 1, 1)
           @io.string.should eql(%Q|
 Finished in 3 seconds
 
 2 examples, 1 failure, 1 pending
-
-Pending:
-behaviour example (message)
 |)
         end
 
         it "should push green dot for passing spec" do
           @io.should_receive(:tty?).and_return(true)
-          @formatter.colour = true
+          @options.should_receive(:colour).and_return(true)
           @formatter.example_passed("spec")
           @io.string.should == "\e[32m.\e[0m"
         end
 
         it "should push red F for failure spec" do
           @io.should_receive(:tty?).and_return(true)
-          @formatter.colour = true
+          @options.should_receive(:colour).and_return(true)
           @formatter.example_failed("spec", 98, Reporter::Failure.new("c s", Spec::Expectations::ExpectationNotMetError.new))
           @io.string.should eql("\e[31mF\e[0m")
         end
 
         it "should push magenta F for error spec" do
           @io.should_receive(:tty?).and_return(true)
-          @formatter.colour = true
+          @options.should_receive(:colour).and_return(true)
           @formatter.example_failed("spec", 98, Reporter::Failure.new("c s", RuntimeError.new))
           @io.string.should eql("\e[35mF\e[0m")
         end
 
         it "should push blue F for fixed pending spec" do
           @io.should_receive(:tty?).and_return(true)
-          @formatter.colour = true
-          @formatter.example_failed("spec", 98, Reporter::Failure.new("c s", Spec::DSL::PendingFixedError.new))
+          @options.should_receive(:colour).and_return(true)
+          @formatter.example_failed("spec", 98, Reporter::Failure.new("c s", Spec::Example::PendingExampleFixedError.new))
           @io.string.should eql("\e[34mF\e[0m")
         end
 
@@ -83,17 +84,18 @@ EOE
         end
         
         it "should dump pending" do
-          @formatter.example_pending("behaviour", "example", "message")
+          @formatter.example_pending("example_group", ExampleGroup.new("example"), "message")
           @formatter.dump_pending
-          @io.string.should =~ /Pending\:\nbehaviour example \(message\)\n/
+          @io.string.should =~ /Pending\:\nexample_group example \(message\)\n/
         end
       end
       
       describe "ProgressBarFormatter outputting to custom out" do
         before(:each) do
           @out = mock("out")
+          @options = mock('options')
           @out.stub!(:puts)
-          @formatter = ProgressBarFormatter.new(@out)
+          @formatter = ProgressBarFormatter.new(@options, @out)
           @formatter.class.send :public, :output_to_tty?
         end
 
@@ -106,6 +108,20 @@ EOE
           @formatter.output_to_tty?.should be_false
         end
       end
+
+      describe ProgressBarFormatter, "dry run" do
+        before(:each) do
+          @io = StringIO.new
+          options = mock('options')
+          options.stub!(:dry_run).and_return(true)
+          @formatter = ProgressBarFormatter.new(options, @io)
+        end
+      
+        it "should not produce summary on dry run" do
+          @formatter.dump_summary(3, 2, 1, 0)
+          @io.string.should eql("")
+        end
+      end
     end
   end
 end

data/spec/spec/runner/formatter/snippet_extractor_spec.rb

@@ -1,11 +1,18 @@
 require File.dirname(__FILE__) + '/../../../spec_helper.rb'
+require 'spec/runner/formatter/snippet_extractor'
 
-describe Spec::Runner::Formatter::SnippetExtractor do
-  it "should fall back on a default message when it doesn't understand a line" do
-    Spec::Runner::Formatter::SnippetExtractor.new.snippet_for("blech").should == ["# Couldn't get snippet for blech", 1]
-  end
+module Spec
+  module Runner
+    module Formatter
+      describe SnippetExtractor do
+        it "should fall back on a default message when it doesn't understand a line" do
+          SnippetExtractor.new.snippet_for("blech").should == ["# Couldn't get snippet for blech", 1]
+        end
 
-  it "should fall back on a default message when it doesn't find the file" do
-    Spec::Runner::Formatter::SnippetExtractor.new.lines_around("blech", 8).should == "# Couldn't get snippet for blech"
+        it "should fall back on a default message when it doesn't find the file" do
+          SnippetExtractor.new.lines_around("blech", 8).should == "# Couldn't get snippet for blech"
+        end
+      end
+    end
   end
-end
+end

data/spec/spec/runner/formatter/spec_mate_formatter_spec.rb

@@ -0,0 +1,103 @@
+require File.dirname(__FILE__) + '/../../../spec_helper'
+require 'hpricot' # Needed to compare generated with wanted HTML
+require 'spec/runner/formatter/text_mate_formatter'
+
+module Spec
+  module Runner
+    module Formatter
+      describe TextMateFormatter do
+        attr_reader :root, :suffix, :expected_file
+        before do
+          @root = File.expand_path(File.dirname(__FILE__) + '/../../../..')
+          @suffix = jruby? ? '-jruby' : ''
+          @expected_file = File.dirname(__FILE__) + "/text_mate_formatted-#{::VERSION}#{suffix}.html"
+        end
+
+        def jruby?
+          PLATFORM == 'java'
+        end
+
+        def produces_html_identical_to_manually_designed_document(opt)
+          root = File.expand_path(File.dirname(__FILE__) + '/../../../..')
+
+          Dir.chdir(root) do
+            args = [
+              'failing_examples/mocking_example.rb',
+                'failing_examples/diffing_spec.rb',
+                'examples/pure/stubbing_example.rb',
+                'examples/pure/pending_example.rb',
+                '--format',
+                'textmate',
+                opt
+            ]
+            err = StringIO.new
+            out = StringIO.new
+            options = ::Spec::Runner::OptionParser.parse(args, err, out)
+            Spec::Runner::CommandLine.run(options)
+
+            yield(out.string)
+          end          
+        end
+
+        # # Uncomment this spec temporarily in order to overwrite the expected with actual.
+        # # Use with care!!!
+        # describe TextMateFormatter, "functional spec file generator" do
+        #   it "generates a new comparison file" do
+        #     Dir.chdir(root) do
+        #       args = ['failing_examples/mocking_example.rb', 'failing_examples/diffing_spec.rb', 'examples/pure/stubbing_example.rb',  'examples/pure/pending_example.rb', '--format', 'textmate', '--diff']
+        #       err = StringIO.new
+        #       out = StringIO.new
+        #       Spec::Runner::CommandLine.run(
+        #         ::Spec::Runner::OptionParser.parse(args, err, out)
+        #       )
+        #
+        #       seconds = /\d+\.\d+ seconds/
+        #       html = out.string.gsub seconds, 'x seconds'
+        #
+        #       File.open(expected_file, 'w') {|io| io.write(html)}
+        #     end
+        #   end
+        # end
+
+         describe "functional spec using --diff" do
+           it "should produce HTML identical to the one we designed manually with --diff" do
+             produces_html_identical_to_manually_designed_document("--diff") do |html|
+               suffix = jruby? ? '-jruby' : ''
+               expected_file = File.dirname(__FILE__) + "/text_mate_formatted-#{::VERSION}#{suffix}.html"
+               unless File.file?(expected_file)
+                 raise "There is no HTML file with expected content for this platform: #{expected_file}"
+               end
+               expected_html = File.read(expected_file)
+
+               seconds = /\d+\.\d+ seconds/
+               html.gsub! seconds, 'x seconds'
+               expected_html.gsub! seconds, 'x seconds'
+
+               doc = Hpricot(html)
+               backtraces = doc.search("div.backtrace/a")
+               doc.search("div.backtrace").remove
+
+               expected_doc = Hpricot(expected_html)
+               expected_doc.search("div.backtrace").remove
+
+               doc.inner_html.should == expected_doc.inner_html
+
+               backtraces.each do |backtrace_link|
+                 backtrace_link[:href].should include("txmt://open?url=")
+               end
+             end
+           end
+
+         end
+
+         describe "functional spec using --dry-run" do
+           it "should produce HTML identical to the one we designed manually with --dry-run" do
+             produces_html_identical_to_manually_designed_document("--dry-run") do |html, expected_html|
+               html.should =~ /This was a dry-run/m
+             end
+           end
+         end
+      end
+    end
+  end
+end

data/spec/spec/runner/formatter/specdoc_formatter_spec.rb

@@ -1,61 +1,125 @@
 require File.dirname(__FILE__) + '/../../../spec_helper.rb'
+require 'spec/runner/formatter/specdoc_formatter'
 
 module Spec
   module Runner
     module Formatter
-      describe "SpecdocFormatter" do
+      describe SpecdocFormatter do
+        it_should_behave_like "sandboxed rspec_options"
+        attr_reader :io, :options, :formatter, :example_group
         before(:each) do
           @io = StringIO.new
-          @formatter = SpecdocFormatter.new(@io)
+          options.stub!(:dry_run).and_return(false)
+          options.stub!(:colour).and_return(false)
+          @formatter = SpecdocFormatter.new(options, io)
+          @example_group = Class.new(::Spec::Example::ExampleGroup).describe("ExampleGroup")
         end
 
-        it "should produce standard summary without pending when pending has a 0 count" do
-          @formatter.dump_summary(3, 2, 1, 0)
-          @io.string.should eql("\nFinished in 3 seconds\n\n2 examples, 1 failure\n")
-        end
+        describe "where ExampleGroup has no superclasss with a description" do
+          before do
+            formatter.add_example_group(example_group)
+          end
 
-        it "should produce standard summary" do
-          @formatter.dump_summary(3, 2, 1, 4)
-          @io.string.should eql("\nFinished in 3 seconds\n\n2 examples, 1 failure, 4 pending\n")
-        end
+          it "should produce standard summary without pending when pending has a 0 count" do
+            formatter.dump_summary(3, 2, 1, 0)
+            io.string.should have_example_group_output("\nFinished in 3 seconds\n\n2 examples, 1 failure\n")
+          end
 
-        it "should push context name" do
-          @formatter.add_behaviour(Spec::DSL::Description.new("context"))
-          @io.string.should eql("\ncontext\n")
-        end
+          it "should produce standard summary" do
+            formatter.dump_summary(3, 2, 1, 4)
+            io.string.should have_example_group_output("\nFinished in 3 seconds\n\n2 examples, 1 failure, 4 pending\n")
+          end
 
-        it "should push failing spec name and failure number" do
-          @formatter.example_failed(DSL::Example.new("spec"), 98, Reporter::Failure.new("c s", RuntimeError.new))
-          @io.string.should eql("- spec (ERROR - 98)\n")
-        end
+          it "should push ExampleGroup name" do
+            io.string.should eql("\nExampleGroup\n")
+          end
 
-        it "should push nothing on start" do
-          @formatter.start(5)
-          @io.string.should eql("")
-        end
+          it "when having an error, should push failing spec name and failure number" do
+            formatter.example_failed(
+            example_group.it("spec"),
+            98,
+            Reporter::Failure.new("c s", RuntimeError.new)
+            )
+            io.string.should have_example_group_output("- spec (ERROR - 98)\n")
+          end
 
-        it "should push nothing on start dump" do
-          @formatter.start_dump
-          @io.string.should eql("")
-        end
+          it "when having an expectation failure, should push failing spec name and failure number" do
+            formatter.example_failed(
+            example_group.it("spec"),
+            98,
+            Reporter::Failure.new("c s", Spec::Expectations::ExpectationNotMetError.new)
+            )
+            io.string.should have_example_group_output("- spec (FAILED - 98)\n")
+          end
 
-        it "should push passing spec name" do
-          @formatter.example_passed(DSL::Example.new("spec"))
-          @io.string.should eql("- spec\n")
-        end
+          it "should push nothing on start" do
+            formatter.start(5)
+            io.string.should have_example_group_output("")
+          end
 
-        it "should push pending example name and message" do
-          @formatter.example_pending('behaviour', 'example','reason')
-          @io.string.should eql("- example (PENDING: reason)\n")
-        end
+          it "should push nothing on start dump" do
+            formatter.start_dump
+            io.string.should have_example_group_output("")
+          end
 
-        it "should dump pending" do
-          @formatter.example_pending('behaviour', 'example','reason')
-          @io.rewind
-          @formatter.dump_pending
-          @io.string.should =~ /Pending\:\nbehaviour example \(reason\)\n/
+          it "should push passing spec name" do
+            formatter.example_passed(example_group.it("spec"))
+            io.string.should have_example_group_output("- spec\n")
+          end
+
+          it "should push pending example name and message" do
+            formatter.example_pending('example_group', ExampleGroup.new("example"), 'reason')
+            io.string.should have_example_group_output("- example (PENDING: reason)\n")
+          end
+
+          it "should dump pending" do
+            formatter.example_pending('example_group', ExampleGroup.new("example"), 'reason')
+            io.rewind
+            formatter.dump_pending
+            io.string.should =~ /Pending\:\nexample_group example \(reason\)\n/
+          end
+
+          def have_example_group_output(expected_output)
+            expected = "\nExampleGroup\n#{expected_output}"
+            ::Spec::Matchers::SimpleMatcher.new(expected) do |actual|
+              actual == expected
+            end
+          end
         end
 
+        describe "where ExampleGroup has two superclasses with a description" do
+          attr_reader :child_example_group, :grand_child_example_group
+          before do
+            @child_example_group = Class.new(example_group).describe("Child ExampleGroup")
+            @grand_child_example_group = Class.new(child_example_group).describe("GrandChild ExampleGroup")
+            formatter.add_example_group(grand_child_example_group)
+          end
+
+          specify "when having an error, should push failing spec name and failure number" do
+            formatter.example_failed(
+              example_group.it("spec"),
+              98,
+              Reporter::Failure.new("c s", RuntimeError.new)
+            )
+            io.string.should have_nested_example_group_output("- spec (ERROR - 98)\n")
+          end
+
+          specify "when having an expectation failure, should push failing spec name and failure number" do
+            formatter.example_failed(
+              example_group.it("spec"),
+              98,
+              Reporter::Failure.new("c s", Spec::Expectations::ExpectationNotMetError.new)
+            )
+            io.string.should have_nested_example_group_output("- spec (FAILED - 98)\n")
+          end
+
+          def have_nested_example_group_output(expected_output)
+            expected_full_output = "\nExampleGroup Child ExampleGroup GrandChild ExampleGroup\n#{expected_output}"
+            ::Spec::Matchers::SimpleMatcher.new(expected_full_output) do |actual|
+              actual == expected_full_output
+            end
+          end
+        end
       end
     end
   end