mspec 1.1.1 → 1.2.0

data/lib/mspec/runner/formatters/html.rb

@@ -43,36 +43,30 @@ EOH
     print "</ul>\n</div>\n"
   end
 
+  def exception(exception)
+    super
+    outcome = exception.failure? ? "FAILED" : "ERROR"
+    print %[<li class="fail">- #{exception.it} (<a href="#details-#{@count}">]
+    print %[#{outcome} - #{@count}</a>)</li>\n]
+  end
+
   def after(state)
-    desc = "- #{state.it}"
-    if state.exception?
-      @states << state
-      count = @counter.failures + @counter.errors - state.exceptions.size
-      state.exceptions.each do |msg, exc|
-        outcome = state.failure?(exc) ? "FAILED" : "ERROR"
-        count += 1
-        print %[<li class="fail">#{desc} (<a href="#details-#{count}">#{outcome} - #{count}</a>)</li>\n]
-      end
-    else
-      print %[<li class="pass">#{desc}</li>\n]
-    end
+    print %[<li class="pass">- #{state.it}</li>\n] unless exception?
   end
 
   def finish
-    success = @states.empty?
+    success = @exceptions.empty?
     unless success
       print "<hr>\n"
       print %[<ol id="details">]
       count = 0
-      @states.each do |state|
-        state.exceptions.each do |msg, exc|
-          outcome = failure?(state) ? "FAILED" : "ERROR"
-          print %[\n<li id="details-#{count += 1}"><p>#{escape(state.description)} #{outcome}</p>\n<p>]
-          print escape(message(exc))
-          print "</p>\n<pre>\n"
-          print escape(backtrace(exc))
-          print "</pre>\n</li>\n"
-        end
+      @exceptions.each do |exc|
+        outcome = exc.failure? ? "FAILED" : "ERROR"
+        print %[\n<li id="details-#{count += 1}"><p>#{escape(exc.description)} #{outcome}</p>\n<p>]
+        print escape(exc.message)
+        print "</p>\n<pre>\n"
+        print escape(exc.backtrace)
+        print "</pre>\n</li>\n"
       end
       print "</ol>\n"
     end

data/lib/mspec/runner/formatters/specdoc.rb

@@ -7,21 +7,34 @@ class SpecdocFormatter < DottedFormatter
     MSpec.register :enter, self
   end
 
+  # Callback for the MSpec :enter event. Prints the
+  # +describe+ block string.
   def enter(describe)
     print "\n#{describe}\n"
   end
 
+  # Callback for the MSpec :before event. Prints the
+  # +it+ block string.
+  def before(state)
+    print "- #{state.it}"
+  end
+
+  # Callback for the MSpec :exception event. Prints
+  # either 'ERROR - X' or 'FAILED - X' where _X_ is
+  # the sequential number of the exception raised. If
+  # there has already been an exception raised while
+  # evaluating this example, it prints another +it+
+  # block description string so that each discription
+  # string has an associated 'ERROR' or 'FAILED'
+  def exception(exception)
+    print "\n- #{exception.it}" if exception?
+    super
+    print " (#{exception.failure? ? 'FAILED' : 'ERROR'} - #{@count})"
+  end
+
+  # Callback for the MSpec :after event. Prints a
+  # newline to finish the description string output.
   def after(state)
-    desc = "- #{state.it}"
-    if state.exception?
-      @states << state
-      count = @counter.failures + @counter.errors - state.exceptions.size
-      state.exceptions.each do |msg, exc|
-        outcome = state.failure?(exc) ? "FAILED" : "ERROR"
-        print "#{desc} (#{outcome} - #{count += 1})\n"
-      end
-    else
-      print "#{desc}\n"
-    end
+    print "\n"
   end
 end

data/lib/mspec/runner/formatters/spinner.rb

@@ -9,11 +9,13 @@ class SpinnerFormatter < DottedFormatter
   MIN = 60
 
   def initialize(out=nil)
+    @exception = @failure = false
+    @exceptions = []
+    @count = 0
     @out = $stdout
 
-    @states = []
     @which = 0
-    @count = 0
+    @loaded = 0
     self.length = 40
     @percent = 0
     @start = Time.now
@@ -51,7 +53,7 @@ class SpinnerFormatter < DottedFormatter
   end
 
   def percentage
-    @percent = @count * 100 / @total
+    @percent = @loaded * 100 / @total
     bar = ("=" * (@percent / @ratio)).ljust @length
     label = "%d%%" % @percent
     bar[@position, label.size] = label
@@ -69,21 +71,29 @@ class SpinnerFormatter < DottedFormatter
     end
   end
 
+  # Callback for the MSpec :start event. Stores the total
+  # number of files that will be processed.
   def start
     @total = MSpec.retrieve(:files).size
   end
 
+  # Callback for the MSpec :load event. Increments the number
+  # of files that have been loaded.
   def load
-    @count += 1
+    @loaded += 1
   end
 
-  def after(state)
-    if state.exception?
-      @fail_color =  "31" if @counter.failures > 0
-      @error_color = "33" if @counter.errors > 0
-      @states << state
-    end
+  # Callback for the MSpec :exception event. Changes the color
+  # used to display the tally of errors and failures
+  def exception(exception)
+    super
+    @fail_color =  "31" if exception.failure?
+    @error_color = "33" unless exception.failure?
+  end
 
+  # Callback for the MSpec :after event. Updates the spinner
+  # and progress bar.
+  def after(state)
     spin
   end
 end

data/lib/mspec/runner/formatters/summary.rb

@@ -2,7 +2,10 @@ require 'mspec/expectations/expectations'
 require 'mspec/runner/formatters/dotted'
 
 class SummaryFormatter < DottedFormatter
+  # Callback for the MSpec :after event. Overrides the
+  # callback provided by +DottedFormatter+ and does not
+  # print any output for each example evaluated.
   def after(state)
-    @states << state if state.exception?
+    # do nothing
   end
 end

data/lib/mspec/runner/formatters/unit.rb

@@ -5,15 +5,11 @@ class UnitdiffFormatter < DottedFormatter
   def finish
     print "\n\n#{@timer.format}\n"
     count = 0
-    @states.each do |state|
-      state.exceptions.each do |msg, exc|
-        outcome = failure?(state) ? "FAILED" : "ERROR"
-        print "\n#{count += 1})\n#{state.description} #{outcome}\n"
-        print "Exception occurred during: #{msg}\n" if msg
-        print((exc.message.empty? ? "<No message>" : exc.message) + ": \n")
-        print backtrace(exc)
-        print "\n"
-      end
+    @exceptions.each do |exc|
+      outcome = exc.failure? ? "FAILED" : "ERROR"
+      print "\n#{count += 1})\n#{exc.description} #{outcome}\n"
+      print exc.message, ": \n"
+      print exc.backtrace, "\n"
     end
     print "\n#{@tally.format}\n"
   end

data/lib/mspec/runner/formatters/yaml.rb

@@ -3,7 +3,9 @@ require 'mspec/runner/formatters/dotted'
 
 class YamlFormatter < DottedFormatter
   def initialize(out=nil)
-    @states = []
+    @exception = @failure = false
+    @exceptions = []
+    @count = 0
     @out = $stdout
 
     if out.nil?
@@ -17,20 +19,19 @@ class YamlFormatter < DottedFormatter
     @out = @finish
   end
 
+  def after(state)
+  end
+
   def finish
     switch
 
     print "---\n"
     print "exceptions:\n"
-    @states.each do |state|
-      state.exceptions.each do |msg, exc|
-        outcome = failure?(state) ? "FAILED" : "ERROR"
-        str =  "#{state.description} #{outcome}\n"
-        str << "#{exc.class.name} occurred during: #{msg}\n" if msg
-        str << message(exc)
-        str << backtrace(exc)
-        print "- ", str.inspect, "\n"
-      end
+    @exceptions.each do |exc|
+      outcome = exc.failure? ? "FAILED" : "ERROR"
+      str =  "#{exc.description} #{outcome}\n"
+      str << exc.message << "\n" << exc.backtrace
+      print "- ", str.inspect, "\n"
     end
 
     print "time: ",         @timer.elapsed,              "\n"

data/lib/mspec/runner/mspec.rb

@@ -1,4 +1,5 @@
-require 'mspec/runner/state'
+require 'mspec/runner/context'
+require 'mspec/runner/exception'
 require 'mspec/runner/tag'
 require 'fileutils'
 
@@ -21,7 +22,7 @@ module MSpec
   @expectation = nil
 
   def self.describe(mod, msg=nil, &block)
-    stack.push RunState.new
+    stack.push ContextState.new
 
     current.describe(mod, msg, &block)
     current.process
@@ -55,6 +56,17 @@ module MSpec
     actions.each { |obj| obj.send action, *args } if actions
   end
 
+  def self.protect(location, &block)
+    begin
+      @env.instance_eval(&block)
+      return true
+    rescue Exception => exc
+      register_exit 1
+      actions :exception, ExceptionState.new(current && current.state, location, exc)
+      return false
+    end
+  end
+
   def self.register_exit(code)
     store :exit, code
   end
@@ -97,6 +109,7 @@ module MSpec
   #   :enter        before a describe block is run
   #   :before       before a single spec is run
   #   :expectation  before a 'should', 'should_receive', etc.
+  #   :exception    after an exception is rescued
   #   :after        after a single spec is run
   #   :leave        after a describe block is run
   #   :unload       after a spec file is run
@@ -125,20 +138,6 @@ module MSpec
     end
   end
 
-  def self.protect(msg, &block)
-    begin
-      @env.instance_eval(&block)
-    rescue Exception => e
-      register_exit 1
-      if current and current.state
-        current.state.exceptions << [msg, e]
-      else
-        STDERR.write "\nAn exception occurred in #{msg}:\n#{e.class}: #{e.message.inspect}\n"
-        STDERR.write "#{e.backtrace.join "\n"}"
-      end
-    end
-  end
-
   def self.stack
     @stack ||= []
   end

data/lib/mspec/version.rb

@@ -1,3 +1,3 @@
 module MSpec
-  VERSION = '1.1.1'
+  VERSION = '1.2.0'
 end

data/spec/runner/actions/debug_spec.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/../../spec_helper'
 require 'mspec/runner/actions/debug'
 require 'mspec/runner/mspec'
-require 'mspec/runner/state'
+require 'mspec/runner/example'
 
 describe DebugAction do
   before :each do
@@ -18,7 +18,7 @@ end
 describe DebugAction, "#before" do
   before :each do
     MSpec.stub!(:read_tags).and_return([])
-    @state = SpecState.new "Catch#me", "if you can"
+    @state = ExampleState.new "Catch#me", "if you can"
   end
 
   it "does not invoke the debugger if the description does not match" do

data/spec/runner/actions/gdb_spec.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/../../spec_helper'
 require 'mspec/runner/actions/gdb'
 require 'mspec/runner/mspec'
-require 'mspec/runner/state'
+require 'mspec/runner/example'
 
 describe GdbAction do
   before :each do
@@ -18,7 +18,7 @@ end
 describe GdbAction, "#before" do
   before :each do
     MSpec.stub!(:read_tags).and_return([])
-    @state = SpecState.new "Catch#me", "if you can"
+    @state = ExampleState.new "Catch#me", "if you can"
   end
 
   it "does not invoke the debugger if the description does not match" do

data/spec/runner/actions/tag_spec.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/../../spec_helper'
 require 'mspec/runner/actions/tag'
 require 'mspec/runner/mspec'
-require 'mspec/runner/state'
+require 'mspec/runner/example'
 require 'mspec/runner/tag'
 
 describe TagAction do
@@ -38,49 +38,83 @@ describe TagAction, "#===" do
   end
 end
 
+describe TagAction, "#exception?" do
+  before :each do
+    @action = TagAction.new :add, :fail, nil, nil, nil, nil
+  end
+
+  it "returns false if no exception has been raised while evaluating an example" do
+    @action.exception?.should be_false
+  end
+
+  it "returns true if an exception was raised while evaluating an example" do
+    @action.exception ExceptionState.new nil, nil, Exception.new("failed")
+    @action.exception?.should be_true
+  end
+end
+
 describe TagAction, "#outcome?" do
   before :each do
     MSpec.stub!(:read_tags).and_return([])
-    @state = SpecState.new "describe", "it"
-    @exception = [nil, Exception.new("failed")]
+    @exception = ExceptionState.new nil, nil, Exception.new("failed")
   end
 
   it "returns true if outcome is :fail and the spec fails" do
     action = TagAction.new :add, :fail, nil, nil, nil, nil
-    @state.exceptions << @exception
-    action.outcome?(@state).should == true
+    action.exception @exception
+    action.outcome?.should == true
   end
 
   it "returns false if the outcome is :fail and the spec passes" do
     action = TagAction.new :add, :fail, nil, nil, nil, nil
-    action.outcome?(@state).should == false
+    action.outcome?.should == false
   end
 
   it "returns true if the outcome is :pass and the spec passes" do
     action = TagAction.new :del, :pass, nil, nil, nil, nil
-    action.outcome?(@state).should == true
+    action.outcome?.should == true
   end
 
   it "returns false if the outcome is :pass and the spec fails" do
     action = TagAction.new :del, :pass, nil, nil, nil, nil
-    @state.exceptions << @exception
-    action.outcome?(@state).should == false
+    action.exception @exception
+    action.outcome?.should == false
   end
 
   it "returns true if the outcome is :all" do
     action = TagAction.new :add, :all, nil, nil, nil, nil
-    @state.exceptions << @exception
-    action.outcome?(@state).should == true
+    action.exception @exception
+    action.outcome?.should == true
+  end
+end
+
+describe TagAction, "#before" do
+  it "resets the #exception? flag to false" do
+    action = TagAction.new :add, :fail, nil, nil, nil, nil
+    action.exception?.should be_false
+    action.exception ExceptionState.new(nil, nil, Exception.new("Fail!"))
+    action.exception?.should be_true
+    action.before(ExampleState.new("describe", "it"))
+    action.exception?.should be_false
+  end
+end
+
+describe TagAction, "#exception" do
+  it "sets the #exception? flag" do
+    action = TagAction.new :add, :fail, nil, nil, nil, nil
+    action.exception?.should be_false
+    action.exception ExceptionState.new(nil, nil, Exception.new("Fail!"))
+    action.exception?.should be_true
   end
 end
 
 describe TagAction, "#after when action is :add" do
   before :each do
     MSpec.stub!(:read_tags).and_return([])
-    @state = SpecState.new "Catch#me", "if you can"
+    @state = ExampleState.new "Catch#me", "if you can"
     @tag = SpecTag.new "tag(comment):Catch#me if you can"
     SpecTag.stub!(:new).and_return(@tag)
-    @exception = [nil, Exception.new("failed")]
+    @exception = ExceptionState.new nil, nil, Exception.new("failed")
   end
 
   it "does not write a tag if the description does not match" do
@@ -98,14 +132,14 @@ describe TagAction, "#after when action is :add" do
   it "writes a tag if the outcome is :fail and the spec failed" do
     MSpec.should_receive(:write_tag).with(@tag)
     action = TagAction.new :add, :fail, "tag", "comment", nil, "can"
-    @state.exceptions << @exception
+    action.exception @exception
     action.after @state
   end
 
   it "does not write a tag if outcome is :pass and the spec failed" do
     MSpec.should_not_receive(:write_tag)
     action = TagAction.new :add, :pass, "tag", "comment", nil, "can"
-    @state.exceptions << @exception
+    action.exception @exception
     action.after @state
   end
 
@@ -125,10 +159,10 @@ end
 describe TagAction, "#after when action is :del" do
   before :each do
     MSpec.stub!(:read_tags).and_return([])
-    @state = SpecState.new "Catch#me", "if you can"
+    @state = ExampleState.new "Catch#me", "if you can"
     @tag = SpecTag.new "tag(comment):Catch#me if you can"
     SpecTag.stub!(:new).and_return(@tag)
-    @exception = [nil, Exception.new("failed")]
+    @exception = ExceptionState.new nil, nil, Exception.new("failed")
   end
 
   it "does not delete a tag if the description does not match" do
@@ -146,14 +180,14 @@ describe TagAction, "#after when action is :del" do
   it "deletes a tag if the outcome is :fail and the spec failed" do
     MSpec.should_receive(:delete_tag).with(@tag)
     action = TagAction.new :del, :fail, "tag", "comment", nil, "can"
-    @state.exceptions << @exception
+    action.exception @exception
     action.after @state
   end
 
   it "does not delete a tag if outcome is :pass and the spec failed" do
     MSpec.should_not_receive(:delete_tag)
     action = TagAction.new :del, :pass, "tag", "comment", nil, "can"
-    @state.exceptions << @exception
+    action.exception @exception
     action.after @state
   end
 
@@ -173,7 +207,7 @@ end
 describe TagAction, "#finish" do
   before :each do
     $stdout = @out = IOStub.new
-    @state = SpecState.new "Catch#me", "if you can"
+    @state = ExampleState.new "Catch#me", "if you can"
     MSpec.stub!(:write_tag).and_return(true)
     MSpec.stub!(:delete_tag).and_return(true)
   end
@@ -232,8 +266,17 @@ describe TagAction, "#register" do
     @action = TagAction.new :add, :all, nil, nil, nil, nil
   end
 
-  it "registers itself with MSpec for the :after action" do
+  it "registers itself with MSpec for the :after event" do
     MSpec.should_receive(:register).with(:after, @action)
+    @action.register
+  end
+
+  it "registers itself with MSpec for the :exception event" do
+    MSpec.should_receive(:register).with(:exception, @action)
+    @action.register
+  end
+
+  it "registers itself with MSpec for the :finish event" do
     MSpec.should_receive(:register).with(:finish, @action)
     @action.register
   end
@@ -246,8 +289,19 @@ describe TagAction, "#unregister" do
     @action = TagAction.new :add, :all, nil, nil, nil, nil
   end
 
-  it "unregisters itself with MSpec for the :after action" do
+  it "unregisters itself with MSpec for the :after event" do
+    MSpec.should_receive(:unregister).with(:exception, @action)
     MSpec.should_receive(:unregister).with(:after, @action)
     @action.unregister
   end
+
+  it "unregisters itself with MSpec for the :exception event" do
+    MSpec.should_receive(:unregister).with(:exception, @action)
+    @action.unregister
+  end
+
+  it "unregisters itself with MSpec for the :finish event" do
+    MSpec.should_receive(:unregister).with(:finish, @action)
+    @action.unregister
+  end
 end