mspec 1.1.1 → 1.2.0

data/spec/runner/example_spec.rb

@@ -0,0 +1,96 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require 'mspec/matchers/base'
+require 'mspec/runner/mspec'
+require 'mspec/mocks/mock'
+require 'mspec/runner/example'
+
+describe ExampleState do
+  it "is initialized with the describe and it strings" do
+    ExampleState.new("This", "does").should be_kind_of(ExampleState)
+  end
+end
+
+describe ExampleState, "#describe" do
+  before :each do
+    @state = ExampleState.new("describe", "it")
+  end
+
+  it "returns the arguments to the #describe block stringified and concatenated" do
+    @state.describe.should == "describe"
+  end
+end
+
+describe ExampleState, "#it" do
+  before :each do
+    @state = ExampleState.new("describe", "it")
+  end
+
+  it "returns the argument to the #it block" do
+    @state.it.should == "it"
+  end
+end
+
+describe ExampleState, "#unfiltered?" do
+  before :each do
+    MSpec.store :include, nil
+    MSpec.store :exclude, nil
+
+    @state = ExampleState.new("describe", "it")
+    @filter = mock("filter")
+  end
+
+  it "returns true if MSpec include filters list is empty" do
+    @state.unfiltered?.should == true
+  end
+
+  it "returns true if MSpec include filters match this spec" do
+    @filter.should_receive(:===).and_return(true)
+    MSpec.register :include, @filter
+    @state.unfiltered?.should == true
+  end
+
+  it "returns false if MSpec include filters do not match this spec" do
+    @filter.should_receive(:===).and_return(false)
+    MSpec.register :include, @filter
+    @state.unfiltered?.should == false
+  end
+
+  it "returns true if MSpec exclude filters list is empty" do
+    @state.unfiltered?.should == true
+  end
+
+  it "returns true if MSpec exclude filters do not match this spec" do
+    @filter.should_receive(:===).and_return(false)
+    MSpec.register :exclude, @filter
+    @state.unfiltered?.should == true
+  end
+
+  it "returns false if MSpec exclude filters match this spec" do
+    @filter.should_receive(:===).and_return(true)
+    MSpec.register :exclude, @filter
+    @state.unfiltered?.should == false
+  end
+
+  it "returns false if MSpec include and exclude filters match this spec" do
+    @filter.should_receive(:===).twice.and_return(true)
+    MSpec.register :include, @filter
+    MSpec.register :exclude, @filter
+    @state.unfiltered?.should == false
+  end
+end
+
+describe ExampleState, "#filtered?" do
+  before :each do
+    @state = ExampleState.new("describe", "it")
+  end
+
+  it "returns true if #unfiltered returns false" do
+    @state.should_receive(:unfiltered?).and_return(false)
+    @state.filtered?.should == true
+  end
+
+  it "returns false if #unfiltered returns true" do
+    @state.should_receive(:unfiltered?).and_return(true)
+    @state.filtered?.should == false
+  end
+end

data/spec/runner/exception_spec.rb

@@ -0,0 +1,110 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require 'mspec/expectations/expectations'
+require 'mspec/runner/example'
+require 'mspec/runner/exception'
+
+describe ExceptionState, "#initialize" do
+  it "takes a state, location (e.g. before :each), and exception" do
+    state = ExampleState.new "Class#method", "does something"
+    exc = Exception.new "Fail!"
+    ExceptionState.new(state, "location", exc).should be_kind_of(ExceptionState)
+  end
+end
+
+describe ExceptionState, "#description" do
+  before :each do
+    @state = ExampleState.new "Class#method", "does something"
+  end
+
+  it "returns the state description if state was not nil" do
+    exc = ExceptionState.new(@state, nil, nil)
+    exc.description.should == "Class#method does something"
+  end
+
+  it "returns the location if it is not nil and description is nil" do
+    exc = ExceptionState.new(nil, "location", nil)
+    exc.description.should == "An exception occurred during: location"
+  end
+
+  it "returns both description and location if neither are nil" do
+    exc = ExceptionState.new(@state, "location", nil)
+    exc.description.should == "An exception occurred during: location\nClass#method does something"
+  end
+end
+
+describe ExceptionState, "#describe" do
+  before :each do
+    @state = ExampleState.new "Class#method", "does something"
+  end
+
+  it "returns the ExampleState#describe string if created with a non-nil state" do
+    ExceptionState.new(@state, nil, nil).describe.should == @state.describe
+  end
+
+  it "returns an empty string if created with a nil state" do
+    ExceptionState.new(nil, nil, nil).describe.should == ""
+  end
+end
+
+describe ExceptionState, "#it" do
+  before :each do
+    @state = ExampleState.new "Class#method", "does something"
+  end
+
+  it "returns the ExampleState#it string if created with a non-nil state" do
+    ExceptionState.new(@state, nil, nil).it.should == @state.it
+  end
+
+  it "returns an empty string if created with a nil state" do
+    ExceptionState.new(nil, nil, nil).it.should == ""
+  end
+end
+
+describe ExceptionState, "#failure?" do
+  before :each do
+    @state = ExampleState.new "C#m", "works"
+  end
+
+  it "returns true if the exception is an ExpectationNotMetError" do
+    exc = ExceptionState.new @state, "", ExpectationNotMetError.new("Fail!")
+    exc.failure?.should be_true
+  end
+
+  it "returns false if the exception is not an ExpectationNotMetError" do
+    exc = ExceptionState.new @state, "", Exception.new("Fail!")
+    exc.failure?.should be_false
+  end
+end
+
+describe ExceptionState, "#message" do
+  it "returns <No message> if the exception message is empty" do
+    exc = ExceptionState.new @state, "", Exception.new("")
+    exc.message.should == "<No message>"
+  end
+
+  it "returns the message without exception class when the exception is ExpectationNotMetError" do
+    exc = ExceptionState.new @state, "", ExpectationNotMetError.new("Fail!")
+    exc.message.should == "Fail!"
+  end
+
+  it "returns the message with exception class when the exception is not ExpectationNotMetError" do
+    exc = ExceptionState.new @state, "", Exception.new("Fail!")
+    exc.message.should == "Exception: Fail!"
+  end
+end
+
+describe ExceptionState, "#backtrace" do
+  before :each do
+    begin
+      raise Exception, "mock backtrace"
+    rescue Exception => @exception
+    end
+  end
+
+  it "returns a string representation of the exception backtrace" do
+    exc = ExceptionState.new @state, "", @exception
+    exc.backtrace.should be_kind_of(String)
+  end
+
+  # TODO: spec the filtering of the backtrace so mspec files don't display
+end

data/spec/runner/formatters/dotted_spec.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/../../spec_helper'
 require 'mspec/runner/formatters/dotted'
 require 'mspec/runner/mspec'
-require 'mspec/runner/state'
+require 'mspec/runner/example'
 
 describe DottedFormatter, "#initialize" do
   it "permits zero arguments" do
@@ -20,6 +20,8 @@ describe DottedFormatter, "#register" do
 
   it "registers self with MSpec for appropriate actions" do
     MSpec.stub!(:register)
+    MSpec.should_receive(:register).with(:exception, @formatter)
+    MSpec.should_receive(:register).with(:before, @formatter)
     MSpec.should_receive(:register).with(:after, @formatter)
     MSpec.should_receive(:register).with(:finish, @formatter)
     @formatter.register
@@ -58,24 +60,106 @@ describe DottedFormatter, "#print" do
   end
 end
 
-describe DottedFormatter, "#message" do
+describe DottedFormatter, "#exception" do
   before :each do
     @formatter = DottedFormatter.new
+    @failure = ExceptionState.new nil, nil, ExpectationNotMetError.new("failed")
+    @error = ExceptionState.new nil, nil, MSpecExampleError.new("boom!")
   end
 
-  it "returns <No message> if the exception message is empty" do
-    exc = Exception.new ""
-    @formatter.message(exc).should == "<No message>"
+  it "sets the #failure? flag" do
+    @formatter.exception @failure
+    @formatter.failure?.should be_true
+    @formatter.exception @error
+    @formatter.failure?.should be_false
   end
 
-  it "returns the message without exception class when the exception is ExpectationNotMetError" do
-    exc = Exception.new "message"
-    @formatter.message(exc).should == "Exception: message"
+  it "sets the #exception? flag" do
+    @formatter.exception @error
+    @formatter.exception?.should be_true
+    @formatter.exception @failure
+    @formatter.exception?.should be_true
   end
 
-  it "returns the message with exception class when the exception is not ExpectationNotMetError" do
-    exc = ExpectationNotMetError.new "message"
-    @formatter.message(exc).should == "message"
+  it "addes the exception to the list of exceptions" do
+    @formatter.exceptions.should == []
+    @formatter.exception @error
+    @formatter.exception @failure
+    @formatter.exceptions.should == [@error, @failure]
+  end
+end
+
+describe DottedFormatter, "#exception?" do
+  before :each do
+    @formatter = DottedFormatter.new
+    @failure = ExceptionState.new nil, nil, ExpectationNotMetError.new("failed")
+    @error = ExceptionState.new nil, nil, MSpecExampleError.new("boom!")
+  end
+
+  it "returns false if there have been no exceptions" do
+    @formatter.exception?.should be_false
+  end
+
+  it "returns true if any exceptions are errors" do
+    @formatter.exception @failure
+    @formatter.exception @error
+    @formatter.exception?.should be_true
+  end
+
+  it "returns true if all exceptions are failures" do
+    @formatter.exception @failure
+    @formatter.exception @failure
+    @formatter.exception?.should be_true
+  end
+
+  it "returns true if all exceptions are errors" do
+    @formatter.exception @error
+    @formatter.exception @error
+    @formatter.exception?.should be_true
+  end
+end
+
+describe DottedFormatter, "#failure?" do
+  before :each do
+    @formatter = DottedFormatter.new
+    @failure = ExceptionState.new nil, nil, ExpectationNotMetError.new("failed")
+    @error = ExceptionState.new nil, nil, MSpecExampleError.new("boom!")
+  end
+
+  it "returns false if there have been no exceptions" do
+    @formatter.failure?.should be_false
+  end
+
+  it "returns false if any exceptions are errors" do
+    @formatter.exception @failure
+    @formatter.exception @error
+    @formatter.failure?.should be_false
+  end
+
+  it "returns true if all exceptions are failures" do
+    @formatter.exception @failure
+    @formatter.exception @failure
+    @formatter.failure?.should be_true
+  end
+end
+
+describe DottedFormatter, "#before" do
+  before :each do
+    @state = ExampleState.new("describe", "it")
+    @formatter = DottedFormatter.new
+    @formatter.exception ExceptionState.new(nil, nil, ExpectationNotMetError.new("Failed!"))
+  end
+
+  it "resets the #failure? flag to false" do
+    @formatter.failure?.should be_true
+    @formatter.before @state
+    @formatter.failure?.should be_false
+  end
+
+  it "resets the #exception? flag to false" do
+    @formatter.exception?.should be_true
+    @formatter.before @state
+    @formatter.exception?.should be_false
   end
 end
 
@@ -83,7 +167,7 @@ describe DottedFormatter, "#after" do
   before :each do
     $stdout = @out = IOStub.new
     @formatter = DottedFormatter.new
-    @state = SpecState.new("describe", "it")
+    @state = ExampleState.new("describe", "it")
   end
 
   after :each do
@@ -96,20 +180,24 @@ describe DottedFormatter, "#after" do
   end
 
   it "prints an 'F' if there was an expectation failure" do
-    @state.exceptions << ["msg", ExpectationNotMetError.new("failed")]
+    exc = ExpectationNotMetError.new "failed"
+    @formatter.exception ExceptionState.new(@state, nil, exc)
     @formatter.after(@state)
     @out.should == "F"
   end
 
   it "prints an 'E' if there was an exception other than expectation failure" do
-    @state.exceptions << ["msg", MSpecExampleError.new("boom!")]
+    exc = MSpecExampleError.new("boom!")
+    @formatter.exception ExceptionState.new(@state, nil, exc)
     @formatter.after(@state)
     @out.should == "E"
   end
 
   it "prints an 'E' if there are mixed exceptions and exepctation failures" do
-    @state.exceptions << ["msg", ExpectationNotMetError.new("failed")]
-    @state.exceptions << ["msg", MSpecExampleError.new("boom!")]
+    exc = ExpectationNotMetError.new "failed"
+    @formatter.exception ExceptionState.new(@state, nil, exc)
+    exc = MSpecExampleError.new("boom!")
+    @formatter.exception ExceptionState.new(@state, nil, exc)
     @formatter.after(@state)
     @out.should == "E"
   end
@@ -123,7 +211,7 @@ describe DottedFormatter, "#finish" do
     TimerAction.stub!(:new).and_return(@timer)
 
     $stdout = @out = IOStub.new
-    @state = SpecState.new("describe", "it")
+    @state = ExampleState.new("Class#method", "runs")
     MSpec.stub!(:register)
     @formatter = DottedFormatter.new
     @formatter.register
@@ -134,15 +222,17 @@ describe DottedFormatter, "#finish" do
   end
 
   it "prints a failure message for an exception" do
-    @state.exceptions << ["msg", MSpecExampleError.new("broken")]
+    exc = ExceptionState.new @state, nil, MSpecExampleError.new("broken")
+    @formatter.exception exc
     @formatter.after @state
     @formatter.finish
-    @out.should =~ /^1\)\ndescribe it ERROR$/
+    @out.should =~ /^1\)\nClass#method runs ERROR$/
   end
 
   it "prints a backtrace for an exception" do
-    @formatter.stub!(:backtrace).and_return("path/to/some/file.rb:35:in method")
-    @state.exceptions << ["msg", MSpecExampleError.new("broken")]
+    exc = ExceptionState.new @state, nil, MSpecExampleError.new("broken")
+    exc.stub!(:backtrace).and_return("path/to/some/file.rb:35:in method")
+    @formatter.exception exc
     @formatter.after @state
     @formatter.finish
     @out.should =~ %r[path/to/some/file.rb:35:in method$]
@@ -161,24 +251,24 @@ describe DottedFormatter, "#finish" do
   end
 
   it "prints errors, backtraces, elapsed time, and tallies" do
-    @state.exceptions << ["msg", MSpecExampleError.new("broken")]
-    @formatter.stub!(:backtrace).and_return("path/to/some/file.rb:35:in method")
+    exc = ExceptionState.new @state, nil, MSpecExampleError.new("broken")
+    exc.stub!(:backtrace).and_return("path/to/some/file.rb:35:in method")
+    @formatter.exception exc
     @timer.should_receive(:format).and_return("Finished in 2.0 seconds")
-    @tally.should_receive(:format).and_return("1 example, 0 failures")
+    @tally.should_receive(:format).and_return("1 example, 1 failure")
     @formatter.after @state
     @formatter.finish
     @out.should ==
 %[E
 
 1)
-describe it ERROR
-MSpecExampleError occurred during: msg
+Class#method runs ERROR
 MSpecExampleError: broken
 path/to/some/file.rb:35:in method
 
 Finished in 2.0 seconds
 
-1 example, 0 failures
+1 example, 1 failure
 ]
   end
 end

data/spec/runner/formatters/html_spec.rb

@@ -2,7 +2,7 @@ require File.dirname(__FILE__) + '/../../spec_helper'
 require 'mspec/guards/guard'
 require 'mspec/runner/formatters/html'
 require 'mspec/runner/mspec'
-require 'mspec/runner/state'
+require 'mspec/runner/example'
 
 describe HtmlFormatter do
   before :each do
@@ -90,11 +90,36 @@ describe HtmlFormatter, "#leave" do
   end
 end
 
+describe HtmlFormatter, "#exception" do
+  before :each do
+    $stdout = @out = IOStub.new
+    @formatter = HtmlFormatter.new
+    @formatter.register
+    @state = ExampleState.new("describe", "it")
+  end
+
+  after :each do
+    $stdout = STDOUT
+  end
+
+  it "prints the #it string once for each exception raised" do
+    exc = ExceptionState.new @state, nil, ExpectationNotMetError.new("disappointing")
+    @formatter.exception exc
+    exc = ExceptionState.new @state, nil, MSpecExampleError.new("painful")
+    @formatter.exception exc
+    @out.should == 
+%[<li class="fail">- it (<a href="#details-1">FAILED - 1</a>)</li>
+<li class="fail">- it (<a href="#details-2">ERROR - 2</a>)</li>
+]
+  end
+end
+
 describe HtmlFormatter, "#after" do
   before :each do
     $stdout = @out = IOStub.new
     @formatter = HtmlFormatter.new
-    @state = SpecState.new("describe", "it")
+    @formatter.register
+    @state = ExampleState.new("describe", "it")
   end
 
   after :each do
@@ -106,16 +131,12 @@ describe HtmlFormatter, "#after" do
     @out.should == %[<li class="pass">- it</li>\n]
   end
 
-  it "prints the #it string once for each exception raised" do
-    @formatter.register
-    @state.exceptions << ["msg", ExpectationNotMetError.new("disappointing")]
-    @state.exceptions << ["msg", MSpecExampleError.new("painful")]
-    @formatter.tally.after @state
+  it "does not print any output if an exception is raised" do
+    exc = ExceptionState.new @state, nil, ExpectationNotMetError.new("disappointing")
+    @formatter.exception exc
+    out = @out.dup
     @formatter.after @state
-    @out.should == 
-%[<li class="fail">- it (<a href="#details-1">FAILED - 1</a>)</li>
-<li class="fail">- it (<a href="#details-2">ERROR - 2</a>)</li>
-]
+    @out.should == out
   end
 end
 
@@ -127,7 +148,7 @@ describe HtmlFormatter, "#finish" do
     TimerAction.stub!(:new).and_return(@timer)
 
     $stdout = @out = IOStub.new
-    @state = SpecState.new("describe", "it")
+    @state = ExampleState.new("describe", "it")
     MSpec.stub!(:register)
     @formatter = HtmlFormatter.new
     @formatter.register
@@ -140,16 +161,16 @@ describe HtmlFormatter, "#finish" do
   end
 
   it "prints a failure message for an exception" do
-    @state.exceptions << ["msg", @exception]
-    @formatter.instance_variable_set :@states, [@state]
+    exc = ExceptionState.new @state, nil, @exception
+    @formatter.exception exc
     @formatter.finish
     @out.should =~ %r[<p>describe it ERROR</p>]
   end
 
   it "prints a backtrace for an exception" do
-    @formatter.stub!(:backtrace).and_return("path/to/some/file.rb:35:in method")
-    @state.exceptions << ["msg", @exception]
-    @formatter.instance_variable_set :@states, [@state]
+    exc = ExceptionState.new @state, nil, @exception
+    exc.stub!(:backtrace).and_return("path/to/some/file.rb:35:in method")
+    @formatter.exception exc
     @formatter.finish
     @out.should =~ %r[<pre>.*path/to/some/file.rb:35:in method.*</pre>]m
   end
@@ -167,14 +188,16 @@ describe HtmlFormatter, "#finish" do
   end
 
   it "prints errors, backtraces, elapsed time, and tallies" do
-    @state.exceptions << ["msg", @exception]
-    @formatter.stub!(:backtrace).and_return("path/to/some/file.rb:35:in method")
+    exc = ExceptionState.new @state, nil, @exception
+    exc.stub!(:backtrace).and_return("path/to/some/file.rb:35:in method")
+    @formatter.exception exc
+    
     @timer.should_receive(:format).and_return("Finished in 2.0 seconds")
     @tally.should_receive(:format).and_return("1 example, 1 failures")
-    @formatter.instance_variable_set :@states, [@state]
     @formatter.finish
     @out.should ==
-%[<hr>
+%[<li class=\"fail\">- it (<a href=\"#details-1\">ERROR - 1</a>)</li>
+<hr>
 <ol id="details">
 <li id="details-1"><p>describe it ERROR</p>
 <p>MSpecExampleError: broken</p>