rspec-instructure 1.3.3

data/spec/spec/runner/formatter/html_formatter_spec.rb

@@ -0,0 +1,118 @@
+# require 'spec_helper'
+
+begin # See rescue all the way at the bottom
+
+require 'nokogiri' # Needed to compare generated with wanted HTML
+require 'spec/runner/formatter/html_formatter'
+
+module Spec
+  module Runner
+    module Formatter
+      describe HtmlFormatter do
+
+        treats_method_missing_as_private
+
+        attr_reader :root, :expected_file, :expected_html
+          
+        before do
+          @root = File.expand_path("#{File.dirname(__FILE__)}/../../../..")
+          suffix = jruby? ? '-jruby' : ''
+          @expected_file = "#{File.dirname(__FILE__)}/html_formatted-#{::RUBY_VERSION}#{suffix}.html"
+          raise "There is no HTML file with expected content for this platform: #{expected_file}" unless File.file?(expected_file)
+          @expected_html = File.read(expected_file)
+        end
+
+       # Uncomment this line temporarily in order to overwrite the expected with actual.
+       # Use with care!!!
+       # describe "file generator" do
+       #   it "generates a new comparison file" do
+       #     Dir.chdir(root) do
+       #       args = [
+       #         'examples/failing/mocking_example.rb',
+       #         'examples/failing/diffing_spec.rb',
+       #         'examples/passing/stubbing_example.rb',
+       #         'examples/passing/pending_example.rb',
+       #         '--format',
+       #         'html',
+       #         "--diff"
+       #       ]
+       #       err = StringIO.new
+       #       out = StringIO.new
+       #       run_with ::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
+
+        it "should produce HTML identical to the one we designed manually with --diff" do
+          Dir.chdir(root) do
+            args = [
+              'examples/failing/mocking_example.rb',
+              'examples/failing/diffing_spec.rb',
+              'examples/passing/stubbing_example.rb',
+              'examples/passing/pending_example.rb',
+              '--format',
+              'html',
+              "--diff"
+            ]
+            err = StringIO.new
+            out = StringIO.new
+            run_with ::Spec::Runner::OptionParser.parse(args, err, out)
+
+            seconds = /\d+\.\d+ seconds/
+            html = out.string.gsub seconds, 'x seconds'
+            expected_html.gsub! seconds, 'x seconds'
+
+            doc = Nokogiri::HTML(html)
+            backtraces = doc.search("div.backtrace").collect {|e| e.at("pre").inner_html}
+            doc.css("div.backtrace").remove
+
+            expected_doc = Nokogiri::HTML(expected_html)
+            expected_backtraces = expected_doc.search("div.backtrace").collect {|e| e.at("pre").inner_html}
+            expected_doc.search("div.backtrace").remove
+
+            doc.inner_html.should == expected_doc.inner_html
+
+            expected_backtraces.each_with_index do |expected_line, i|
+              expected_path, expected_line_number, expected_suffix = expected_line.split(':')
+              actual_path, actual_line_number, actual_suffix = backtraces[i].split(':')
+              File.expand_path(actual_path).should == File.expand_path(expected_path)
+              actual_line_number.should == expected_line_number
+            end
+          end
+        end
+
+        it "should produce HTML identical to the one we designed manually with --dry-run" do
+          Dir.chdir(root) do
+            args = [
+              'examples/failing/mocking_example.rb',
+              'examples/failing/diffing_spec.rb',
+              'examples/passing/stubbing_example.rb',
+              'examples/passing/pending_example.rb',
+              '--format',
+              'html',
+              "--dry-run"
+            ]
+            err = StringIO.new
+            out = StringIO.new
+            run_with ::Spec::Runner::OptionParser.parse(args, err, out)
+
+            seconds = /\d+\.\d+ seconds/
+            html = out.string.gsub seconds, 'x seconds'
+            expected_html.gsub! seconds, 'x seconds'
+
+            html.should =~ /This was a dry-run/m
+          end
+        end
+      end
+    end
+  end
+end
+
+rescue LoadError
+  warn "nokogiri not loaded -- skipping HtmlFormatter specs"
+end

data/spec/spec/runner/formatter/nested_text_formatter_spec.rb

@@ -0,0 +1,329 @@
+require 'spec_helper'
+require 'spec/runner/formatter/nested_text_formatter'
+
+module Spec
+  module Runner
+    module Formatter
+      describe NestedTextFormatter do
+        with_sandboxed_options do
+          attr_reader :io, :options, :formatter, :example_group
+          before(:each) do
+            @io = StringIO.new
+            @formatter = NestedTextFormatter.new(options, io)
+            @example_group = Class.new(::Spec::Example::ExampleGroupDouble).describe("ExampleGroup")
+            @example_group.example("example") {}
+          end
+
+          describe "where ExampleGroup has no superclass with a description" do
+            def example_group_started
+              formatter.example_group_started(Spec::Example::ExampleGroupProxy.new(example_group))
+            end
+
+            before(:each) do
+              example_group_started
+            end
+
+            describe "#dump_summary" do
+              it "produces standard summary without pending when pending has a 0 count" do
+                formatter.dump_summary(3, 2, 1, 0)
+                io.string.should == <<-OUT
+ExampleGroup
+
+Finished in 3 seconds
+
+2 examples, 1 failure
+OUT
+              end
+
+              it "produces standard summary" do
+                formatter.dump_summary(3, 2, 1, 4)
+                io.string.should == <<-OUT
+ExampleGroup
+
+Finished in 3 seconds
+
+2 examples, 1 failure, 4 pending
+OUT
+              end
+            end
+
+            describe "#example_group_started" do
+
+              describe "when ExampleGroup has a nested description" do
+
+                describe "when ExampleGroup has no parents with nested description" do
+                  it "pushes ExampleGroup name" do
+                    io.string.should eql("ExampleGroup\n")
+                  end
+                end
+
+                describe "when ExampleGroup has one parent with nested description" do
+                  attr_reader :child_example_group
+                  def example_group_started
+                    @child_example_group = Class.new(example_group).describe("Child ExampleGroup")
+                  end
+
+                  describe "and parent ExampleGroups have not been printed" do
+                    before do
+                      formatter.example_group_started(Spec::Example::ExampleGroupProxy.new(child_example_group))
+                    end
+
+                    it "pushes ExampleGroup name with two spaces of indentation" do
+                      io.string.should == <<-OUT
+ExampleGroup
+  Child ExampleGroup
+OUT
+                    end
+                  end
+
+                  describe "and parent ExampleGroups have been printed" do
+                    before do
+                      formatter.example_group_started(Spec::Example::ExampleGroupProxy.new(example_group))
+                      io.string = ""
+                      formatter.example_group_started(Spec::Example::ExampleGroupProxy.new(child_example_group))
+                    end
+
+                    it "should print only the indented ExampleGroup" do
+                      io.string.should == <<-OUT
+  Child ExampleGroup
+OUT
+                    end
+                  end
+                end
+
+                describe "when ExampleGroup has two parents with nested description" do
+                  attr_reader :child_example_group, :grand_child_example_group
+                  def example_group_started
+                    @child_example_group = Class.new(example_group).describe("Child ExampleGroup")
+                    @grand_child_example_group = Class.new(child_example_group).describe("GrandChild ExampleGroup")
+                  end
+
+                  describe "and parent ExampleGroups have not been printed" do
+                    before do
+                      formatter.example_group_started(Spec::Example::ExampleGroupProxy.new(grand_child_example_group))
+                    end
+
+                    it "prints the entire nested ExampleGroup heirarchy" do
+                      io.string.should == <<-OUT
+ExampleGroup
+  Child ExampleGroup
+    GrandChild ExampleGroup
+OUT
+                    end
+                  end
+
+                  describe "and parent ExampleGroups have been printed" do
+                    before do
+                      formatter.example_group_started(Spec::Example::ExampleGroupProxy.new(child_example_group))
+                      io.string = ""
+                      formatter.example_group_started(Spec::Example::ExampleGroupProxy.new(grand_child_example_group))
+                    end
+
+                    it "should print only the indented ExampleGroup" do
+                      io.string.should == <<-OUT
+    GrandChild ExampleGroup
+OUT
+                    end
+                  end
+                end
+              end
+
+              describe "when ExampleGroup nested description is blank" do
+                attr_reader :child_example_group
+
+                describe "and parent ExampleGroups have not been printed" do
+                  def example_group_started
+                    @child_example_group = Class.new(example_group)
+                    formatter.example_group_started(Spec::Example::ExampleGroupProxy.new(child_example_group))
+                  end
+
+                  it "should render only the parent ExampleGroup" do
+                    io.string.should == <<-OUT
+ExampleGroup
+OUT
+                  end
+                end
+
+                describe "and parent ExampleGroups have been printed" do
+                  def example_group_started
+                    @child_example_group = Class.new(example_group)
+                    formatter.example_group_started(Spec::Example::ExampleGroupProxy.new(example_group))
+                    io.string = ""
+                    formatter.example_group_started(Spec::Example::ExampleGroupProxy.new(child_example_group))
+                  end
+
+                  it "should not render anything" do
+                    io.string.should == ""
+                  end
+                end
+              end
+
+              describe "when ExampleGroup nested description is blank" do
+                def example_group_started
+                  example_group.set_description
+                  super
+                end
+
+                it "should not render anything" do
+                  io.string.should == ""
+                end
+              end
+
+              describe "with parallel groups" do
+                def make_group(name, parent=::Spec::Example::ExampleGroupDouble)
+                  Class.new(parent).describe(name)
+                end
+
+                it "excludes duplicated group" do
+                  parent_1 = make_group("ExampleGroup") 
+                  child_1 = make_group("Child ExampleGroup", parent_1) 
+                  grandchild_1 = make_group("GrandChild ExampleGroup", child_1) 
+
+                  parent_2 = make_group("ExampleGroup") 
+                  child_2 = make_group("Child ExampleGroup 2", parent_2) 
+                  grandchild_2 = make_group("GrandChild ExampleGroup", child_2) 
+
+                  formatter.example_group_started(Spec::Example::ExampleGroupProxy.new(grandchild_1))
+                  formatter.example_group_started(Spec::Example::ExampleGroupProxy.new(grandchild_2))
+                  io.string.should == <<-OUTPUT
+ExampleGroup
+  Child ExampleGroup
+    GrandChild ExampleGroup
+  Child ExampleGroup 2
+    GrandChild ExampleGroup
+OUTPUT
+                end
+              end
+            end
+
+            describe "#example_failed" do
+              describe "where ExampleGroup has no superclasss with a description" do
+                describe "when having an error" do
+                  it "should push failing spec name and failure number" do
+                    formatter.example_failed(
+                      example_group.it("spec"),
+                      98,
+                      ::Spec::Runner::Reporter::Failure.new("g", "c s", RuntimeError.new)
+                    )
+                    io.string.should == <<-OUT
+ExampleGroup
+  spec (FAILED - 98)
+OUT
+                  end
+                end
+
+                describe "when having an expectation failure" do
+                  it "should push failing spec name and failure number" do
+                    formatter.example_failed(
+                      example_group.it("spec"),
+                      98,
+                      ::Spec::Runner::Reporter::Failure.new("g", "c s", Spec::Expectations::ExpectationNotMetError.new)
+                    )
+                    io.string.should == <<-OUT
+ExampleGroup
+  spec (FAILED - 98)
+OUT
+                  end
+                end
+              end
+
+              describe "where ExampleGroup has two superclasses with a description" do
+                attr_reader :child_example_group, :grand_child_example_group
+
+                def example_group_started
+                  @child_example_group = Class.new(example_group).describe("Child ExampleGroup")
+                  @grand_child_example_group = Class.new(child_example_group).describe("GrandChild ExampleGroup")
+                  formatter.example_group_started(Spec::Example::ExampleGroupProxy.new(grand_child_example_group))
+                end
+
+                describe "when having an error" do
+                  it "should push failing spec name and failure number" do
+                    formatter.example_failed(
+                      grand_child_example_group.it("spec"),
+                      98,
+                      ::Spec::Runner::Reporter::Failure.new("g", "c s", RuntimeError.new)
+                    )
+                    io.string.should == <<-OUT
+ExampleGroup
+  Child ExampleGroup
+    GrandChild ExampleGroup
+      spec (FAILED - 98)
+OUT
+                  end
+                end
+
+                describe "when having an expectation" do
+                  it "should push failing spec name and failure number" do
+                    formatter.example_failed(
+                      grand_child_example_group.it("spec"),
+                      98,
+                      ::Spec::Runner::Reporter::Failure.new("g", "c s", Spec::Expectations::ExpectationNotMetError.new)
+                    )
+                    io.string.should == <<-OUT
+ExampleGroup
+  Child ExampleGroup
+    GrandChild ExampleGroup
+      spec (FAILED - 98)
+OUT
+                  end
+                end
+              end
+            end
+
+            describe "#start" do
+              it "should push nothing on start" do
+                formatter.start(5)
+                io.string.should == <<-OUT
+ExampleGroup
+OUT
+              end
+            end
+
+            describe "#start_dump" do
+              it "should push nothing on start dump" do
+                formatter.start_dump
+                io.string.should == <<-OUT
+ExampleGroup
+OUT
+              end
+            end
+
+            describe "#example_passed" do
+              it "should push passing spec name" do
+                formatter.example_passed(example_group.it("spec"))
+                io.string.should == <<-OUT
+ExampleGroup
+  spec
+OUT
+              end
+            end
+
+            describe "#example_pending" do
+              it "should push pending example name and message" do
+                formatter.example_pending(example_group.examples.first, 'reason', "#{__FILE__}:#{__LINE__}")
+                io.string.should == <<-OUT
+ExampleGroup
+  example (PENDING: reason)
+OUT
+              end
+
+              it "should dump pending" do
+                formatter.example_pending(example_group.examples.first, 'reason', "#{__FILE__}:#{__LINE__}")
+                io.rewind
+                formatter.dump_pending
+                io.string.should =~ /Pending\:\n\nExampleGroup example \(reason\)\n/
+              end
+            end
+
+            def have_single_level_example_group_output(expected_output)
+              expected = "ExampleGroup\n  #{expected_output}"
+              ::Spec::Matchers::SimpleMatcher.new(expected) do |actual|
+                actual == expected
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+require 'spec_helper'
+require 'spec/runner/formatter/profile_formatter'
+
+module Spec
+  module Runner
+    module Formatter
+      describe ProfileFormatter do
+
+        treats_method_missing_as_private
+
+        attr_reader :io, :formatter
+        before(:each) do
+          @io = StringIO.new
+          options = mock('options')
+          options.stub!(:colour).and_return(true)
+          options.stub!(:autospec).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(::Spec::Example::ExampleGroupDouble).describe('Parent')
+          child_example_group = Class.new(parent_example_group).describe('Child')
+
+          formatter.example_group_started(Spec::Example::ExampleGroupProxy.new(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.example_group_started(Spec::Example::ExampleGroupProxy.new(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