rspec 0.5.12 → 0.5.13

data/CHANGES

@@ -1,12 +1,20 @@
 = RSpec Changelog
 
+== Version 0.5.13
+This release fixes some subtle bugs in the mock API.
+
+* Use fully-qualified class name of Exceptions in failure message. Easier to debug that way.
+* Fixed a bug that caused mocks to yield a one-element array (rather than the element) when one yield arg specified.
+* Mocks not raise AmbiguousReturnError if an explicit return is used at the same time as an expectation block.
+* Blocks passed to yielding mocks can now raise without causing mock verification to fail.
+
 == Version 0.5.12
 This release adds diff support for failure messages, a HTML formatter plus some other
 minor enhancements.
 
 * Added HTML formatter.
 * Added fail_on_error option to spectask.
-* Added support for diffing, using the lcs-diff Rubygem (#2648).
+* Added support for diffing, using the diff-lcs Rubygem (#2648).
 * Remove RSpec on Rails files from backtrace (#4694).
 * All of RSpec's own tests run successfully after translation with test2spec.
 * Added --verbose mode for test2spec - useful for debugging when classes fail to translate.

data/README

@@ -8,12 +8,12 @@ Then you must install the following gems:
 * webgen
 * RedCloth
 * syntax
-* lcs-diff
+* diff-lcs
 
 Note that RSpec itself - once built - doesn't have any dependencies outside the Ruby core 
 and stdlib - with a few exceptions:
 
-* The spec command line uses lcs-diff when --diff is specified.
+* The spec command line uses diff-lcs when --diff is specified.
 * The test2spec command line uses ParseTree and RubyInline.
 * The Spec::Rake::SpecTask needs RCov if RCov is enabled in the task.
 

data/Rakefile

@@ -32,8 +32,12 @@ Spec::Rake::SpecTask.new('failing_examples') do |t|
   t.spec_files = FileList['failing_examples/**/*_spec.rb']
 end
 
+require 'rbconfig'
+windows =  Config::CONFIG['target_os'] == 'mswin32'
 Rake::TestTask.new do |t|
-  t.test_files = FileList['test/**/*_test.rb']
+  tests = FileList['test/**/*_test.rb']
+  tests.exclude 'test/spec/test_to_spec/*.rb' if windows
+  t.test_files = tests
   t.verbose = true
 end
 
@@ -44,21 +48,25 @@ Rcov::RcovTask.new do |t|
 end
 
 desc 'Translate our own tests to specs'
-task :test2spec do
+task :test2spec => :create_test2spec_dir do
   rm_rf 'spec/translated'
   `bin/test2spec --force --template spec/test2spec.erb --specdir spec/translated test`
   # Remove the spec translations that we don't care about.
   rm 'spec/translated/spec/test_to_spec/sexp_transformer_assertion_spec.rb'
   rm 'spec/translated/spec/test_to_spec/sexp_transformer_spec.rb'
 end
+task :create_test2spec_dir do
+  mkdir_p 'doc/output/tools' unless File.exist? 'doc/output/tools'
+end
 
 desc 'Runs all RSpec specs - translated with test2spec from our own tests'
 Spec::Rake::SpecTask.new('test2spec_test' => :test2spec) do |t|
   t.spec_files = FileList['spec/**/*_spec.rb']
-  t.options = ['--diff']
+  t.spec_opts = ["--format", "html", "--diff"]
+  t.out = 'doc/output/tools/rspec_specs.html'
 end
 
-desc 'Generate HTML documentation'
+desc 'Generate HTML documentation for website'
 task :webgen => :test2spec do
   Dir.chdir 'doc' do
     output = nil
@@ -155,7 +163,7 @@ task :tag do
 end
 
 desc "Build the website with rdoc and rcov, but do not publish it"
-task :website => [:clobber, :rcov_verify, :webgen, :failing_examples_with_html, :examples_specdoc, :rdoc]
+task :website => [:clobber, :rcov_verify, :webgen, :failing_examples_with_html, :test2spec_test, :examples_specdoc, :rdoc]
 
 task :verify_user do
   raise "RUBYFORGE_USER environment variable not set!" unless ENV['RUBYFORGE_USER']

data/examples/custom_formatter.rb

@@ -1,8 +1,8 @@
-require 'spec/runner/base_text_formatter'
+require 'spec/runner/formatter/base_text_formatter'
 
 # Example of a custom formatter. Run me with:
 # bin/spec examples -r examples/custom_formatter.rb -f CustomFormatter
-class CustomFormatter < Spec::Runner::BaseTextFormatter
+class CustomFormatter < Spec::Runner::Formatter::BaseTextFormatter
   def add_context(name, first)
     @output << "\n" if first
   end

data/examples/file_accessor.rb

@@ -0,0 +1,18 @@
+class FileAccessor
+  def open_and_handle_with(pathname, processor)
+    pathname.open do |io|
+      processor.process(io)
+    end
+  end
+end
+
+if __FILE__ == $0
+  require File.dirname(__FILE__) + '/io_processor'
+  require 'pathname'
+  
+  accessor = FileAccessor.new
+  io_processor = IoProcessor.new
+  file = Pathname.new ARGV[0]
+
+  accessor.open_and_handle_with(file, io_processor)
+end

data/examples/file_accessor_spec.rb

@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + '/../lib/spec'
+require File.dirname(__FILE__) + '/file_accessor'
+require 'stringio'
+
+context "A FileAccessor" do
+  # This sequence diagram illustrates what this spec specifies.
+  #
+  #                  +--------------+     +----------+     +-------------+
+  #                  | FileAccessor |     | Pathname |     | IoProcessor |
+  #                  +--------------+     +----------+     +-------------+
+  #                         |                  |                  |
+  #   open_and_handle_with  |                  |                  |
+  #   -------------------->| |           open  |                  |
+  #                        | |--------------->| |                 |
+  #                        | | io             | |                 |
+  #                        | |<...............| |                 |
+  #                        | |                 |     process(io)  |
+  #                        | |---------------------------------->| |
+  #                        | |                 |                 | |
+  #                        | |<..................................| |
+  #                         |                  |                  |
+  #
+  specify "should open a file and pass it to the processor's process method" do
+    # This is the primary actor
+    accessor = FileAccessor.new
+
+    # These are the primary actor's neighbours, which we mock.
+    file = mock "Pathname"
+    io_processor = mock "IoProcessor"
+    
+    io = StringIO.new "whatever"
+    file.should_receive(:open).and_yield io
+    io_processor.should_receive(:process).with(io)
+    
+    accessor.open_and_handle_with(file, io_processor)
+  end
+
+end

data/examples/io_processor.rb

@@ -0,0 +1,8 @@
+class DataTooShort < StandardError; end
+
+class IoProcessor
+  # Does some fancy stuff unless the length of +io+ is shorter than 32
+  def process(io)
+    raise DataTooShort if io.read.length < 32
+  end
+end

data/examples/io_processor_spec.rb

@@ -0,0 +1,21 @@
+require File.dirname(__FILE__) + '/../lib/spec'
+require File.dirname(__FILE__) + '/io_processor'
+require 'stringio'
+
+context "An IoProcessor" do
+  setup do
+    @processor = IoProcessor.new
+  end
+
+  specify "should raise nothing when the file is exactly 32 bytes" do
+    lambda {
+      @processor.process(StringIO.new("z"*32))
+    }.should_not_raise
+  end
+
+  specify "should raise an exception when the file length is less than 32 bytes" do
+    lambda {
+      @processor.process(StringIO.new("z"*31))
+    }.should_raise(DataTooShort)
+  end
+end

data/lib/spec/api/exceptions.rb

@@ -5,5 +5,8 @@ module Spec
     
     class MockExpectationError < StandardError
     end
+
+    class AmbiguousReturnError < StandardError
+    end
   end
 end

data/lib/spec/api/mocks/message_expectation.rb

@@ -4,12 +4,12 @@ module Spec
     # Represents the expection of the reception of a message
     class MessageExpectation
     
-      def initialize(mock_name, expectation_ordering, expected_from, sym, block)
+      def initialize(mock_name, expectation_ordering, expected_from, sym, method_block)
         @mock_name = mock_name
         @expected_from = expected_from
         @sym = sym
-        @method_block = block
-        @block = proc {}
+        @method_block = method_block
+        @return_block = lambda {}
         @received_count = 0
         @expected_received_count = 1
         @args_expectation = ArgumentExpectation.new([:any_args])
@@ -67,39 +67,54 @@ module Spec
       end
       
       # This method is called when a method is invoked on a mock
-      def verify_message(args, block)
+      def invoke(args, block)
         
         handle_order_constraint
-        
-        unless @method_block.nil?
-          begin
-            result = @method_block.call(*args)
-          rescue Spec::Api::ExpectationNotMetError => detail
-            Kernel::raise Spec::Api::MockExpectationError, "Call expectation violated with: " + detail
+
+        begin
+          Kernel::raise @exception_to_raise.new unless @exception_to_raise.nil?
+          Kernel::throw @symbol_to_throw unless @symbol_to_throw.nil?
+
+          if !@method_block.nil?
+            return invoke_method_block(args)
+          elsif !@args_to_yield.nil?
+            return invoke_with_yield(block)
+          else
+            return invoke_return_block(args, block)
           end
+        ensure
           @received_count += 1
-          return result
         end
-    
-        Kernel::raise @exception_to_raise.new unless @exception_to_raise.nil?
-        Kernel::throw @symbol_to_throw unless @symbol_to_throw.nil?
-        unless @args_to_yield.nil?
-          if block.nil?
-            Kernel::raise Spec::Api::MockExpectationError, "Expected block to be passed"
-          end
-          if @args_to_yield.length != block.arity
-            Kernel::raise Spec::Api::MockExpectationError, "Wrong arity of passed block. Expected #{@args_to_yield.size}"
-          end
-          block.call @args_to_yield
+      end
+
+      def invoke_method_block(args)
+        begin
+          @method_block.call(*args)
+        rescue Spec::Api::ExpectationNotMetError => detail
+          Kernel::raise Spec::Api::MockExpectationError, "Call expectation violated with: " + detail
+        end
+      end
+      
+      def invoke_with_yield(block)
+        if block.nil?
+          Kernel::raise Spec::Api::MockExpectationError, "Expected block to be passed"
         end
+        if @args_to_yield.length != block.arity
+          Kernel::raise Spec::Api::MockExpectationError, "Wrong arity of passed block. Expected #{@args_to_yield.size}"
+        end
+        block.call *@args_to_yield
+      end
 
+      def invoke_return_block(args, block)
         args << block unless block.nil?
-        @received_count += 1        
-        value = @block.call(*args)
+        value = @return_block.call(*args)
     
-        return value unless @consecutive
-    
-        value[[@received_count, value.size].min - 1]
+        if @consecutive
+          index = [@received_count, value.size-1].min
+          value[index]
+        else
+          value
+        end
       end
 
       def with(*args)
@@ -170,11 +185,12 @@ module Spec
         self
       end
 
-      def return(value=nil,&block)
+      def return(value=nil, &return_block)
+        Kernel::raise AmbiguousReturnError unless @method_block.nil?
         return self unless @and_seen
         @and_seen = false
         @consecutive = value.instance_of? Array
-        @block = block_given? ? block : proc { value }
+        @return_block = block_given? ? return_block : lambda { value }
       end
       
       def raise(exception=Exception)

data/lib/spec/api/mocks/mock.rb

@@ -35,7 +35,7 @@ module Spec
 
       def method_missing(sym, *args, &block)
         if expectation = find_matching_expectation(sym, *args)
-          expectation.verify_message(args, block)
+          expectation.invoke(args, block)
         else
           begin
             # act as null object if method is missing and we ignore them. return value too!

data/lib/spec/api/mocks/order_group.rb

@@ -6,7 +6,7 @@ module Spec
       end
       
       def register(expectation)
-          @ordering << expectation
+        @ordering << expectation
       end
       
       def ready_for?(expectation)

data/lib/spec/runner.rb

@@ -1,3 +1,4 @@
+require 'spec/runner/formatter'
 require 'spec/runner/instance_exec'
 require 'spec/runner/context'
 require 'spec/runner/specification'
@@ -6,9 +7,4 @@ require 'spec/runner/context_runner'
 require 'spec/runner/option_parser'
 require 'spec/runner/backtrace_tweaker'
 require 'spec/runner/reporter'
-require 'spec/runner/base_text_formatter'
-require 'spec/runner/progress_bar_formatter'
-require 'spec/runner/rdoc_formatter'
-require 'spec/runner/specdoc_formatter'
-require 'spec/runner/html_formatter'
 require 'spec/runner/spec_matcher'

data/lib/spec/runner/formatter.rb

@@ -0,0 +1,5 @@
+require 'spec/runner/formatter/base_text_formatter'
+require 'spec/runner/formatter/progress_bar_formatter'
+require 'spec/runner/formatter/rdoc_formatter'
+require 'spec/runner/formatter/specdoc_formatter'
+require 'spec/runner/formatter/html_formatter'

data/lib/spec/runner/formatter/base_text_formatter.rb

@@ -0,0 +1,79 @@
+module Spec
+  module Runner
+    module Formatter
+      # Baseclass for text-based formatters. Can in fact be used for
+      # non-text based ones too - just ignore the +output+ constructor
+      # argument.
+      class BaseTextFormatter
+        def initialize(output, dry_run=false)
+          @dry_run = dry_run
+          @output = output
+        end
+
+        # This method is invoked before any specs are run, right after
+        # they have all been collected. This can be useful for special
+        # formatters that need to provide progress on feedback (graphical ones)
+        #
+        # This method will only be invoked once, and the next one to be invoked
+        # is #add_context
+        def start(spec_count)
+        end
+
+        # This method is invoked at the beginning of the execution of each context.
+        # +name+ is the name of the context and +first+ is true if it is the
+        # first context - otherwise it's false.
+        #
+        # The next method to be invoked after this is #spec_started
+        def add_context(name, first)
+        end
+
+        # This method is invoked right before a spec is executed.
+        # The next method to be invoked after this one is one of #spec_failed
+        # or #spec_passed.
+        def spec_started(name)
+        end
+
+        # This method is invoked when a spec fails, i.e. an exception occurred
+        # inside it (such as a failed should or other exception). +name+ is the name
+        # of the specification. +counter+ is the sequence number of the failure
+        # (starting at 1) and +failure+ is the associated Failure object.
+        def spec_failed(name, counter, failure)
+        end
+
+        # This method is invoked when a spec passes. +name+ is the name of the
+        # specification.
+        def spec_passed(name)
+        end
+
+        # This method is invoked after all of the specs have executed. The next method
+        # to be invoked after this one is #dump_failure (once for each failed spec),
+        def start_dump
+        end
+
+        # Dumps detailed information about a spec failure.
+        # This method is invoked for each failed spec after all specs have run. +counter+ is the sequence number
+        # of the associated spec. +failure+ is a Failure object, which contains detailed
+        # information about the failure.
+        def dump_failure(counter, failure)
+          @output << "\n"
+          @output << counter.to_s << ")\n"
+          @output << "#{failure.header}\n"
+          @output << "#{failure.message}\n"
+          @output << "#{failure.backtrace}\n"
+          @output.flush
+        end
+      
+        # This method is invoked at the very end.
+        def dump_summary(duration, spec_count, failure_count)
+          return if @dry_run
+          @output << "\n"
+          @output << "Finished in " << (duration).to_s << " seconds\n\n"
+          @output << "#{spec_count} specification#{'s' unless spec_count == 1}, "
+          @output << "#{failure_count} failure#{'s' unless failure_count == 1}"
+          @output << "\n"
+          @output.flush
+        end
+      end
+    end
+  end
+end

data/lib/spec/runner/formatter/html_formatter.rb

@@ -0,0 +1,156 @@
+module Spec
+  module Runner
+    module Formatter
+      class HtmlFormatter < BaseTextFormatter
+        def initialize(output, dry_run=false)
+          super
+          @current_count = 0
+        end
+      
+        def start(spec_count)
+          @spec_count = spec_count
+      
+          @output.puts HEADER
+          @output.flush
+        end
+
+        def add_context(name, first)
+          unless first
+            @output.puts "  </ul>"
+            @output.puts "</div>"
+          end
+          @output.puts "<div class=\"context\">"
+          @output.puts "  <div>#{name}</div>"
+          @output.puts "  <ul>"
+        end
+
+        def start_dump
+          @output.puts "  </ul>"
+          @output.puts "</div>"
+          @output.flush
+        end
+
+        def spec_started(name)
+          @current_spec = name
+          @current_count += 1
+        end
+
+        def spec_passed(name)
+          @output.puts "<li class=\"spec passed\">#{escape(@current_spec)}</li>"
+        end
+
+        def spec_failed(name, counter, failure)
+          @output.puts "<li class=\"spec failed\" onclick=\"toggle('failure_#{counter}');return false;\">"
+          @output.puts "  <div>#{escape(@current_spec)}</div>"
+          @output.puts "  <div class=\"failure\" id=\"failure_#{counter}\" style=\"display:none\">"
+          @output.puts "    <div><pre>#{escape(failure.header)}</pre></div>" unless failure.header == ""
+          @output.puts "    <div><pre>#{escape(failure.message)}</pre></div>" unless failure.message == ""
+          @output.puts "    <div><pre>#{escape(failure.backtrace)}</pre></div>" unless failure.backtrace == ""
+          @output.puts "  </div>"
+          @output.puts "</li>"
+          @output.flush
+        end
+    
+        def escape(string)
+          string.gsub(/&/n, '&amp;').gsub(/\"/n, '&quot;').gsub(/>/n, '&gt;').gsub(/</n, '&lt;')
+        end
+    
+        def dump_failure(counter, failure)
+    #      @output << "\n"
+    #      @output << counter.to_s << ")\n"
+    #      @output << "#{failure.header}\n"
+    #      @output << "#{failure.message}\n"
+    #      @output << "#{failure.backtrace}\n"
+    #      @output.flush
+        end
+
+        def dump_summary(duration, spec_count, failure_count)
+          @output << "</body>"
+          @output << "</html>"
+          @output.flush
+        end
+      
+        HEADER = <<-HEADER
+  <?xml version="1.0" encoding="iso-8859-1"?>
+  <!DOCTYPE html 
+       PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+       "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+  <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <title>RSpec results</title>
+    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+    <meta http-equiv="Content-Script-Type" content="text/javascript" />
+    <style type="text/css">
+    body {
+      font-size: 10pt;
+      font: "lucida grande";
+      width: 85%;
+    }
+
+    ul {
+      padding-left: 8px;
+    }
+
+    li.passed {
+      background-color: #DDFFDD;
+    }
+
+    li { 
+      list-style-type: none; 
+      margin: 0;
+    }
+
+    li.failed {
+      background-color: #FFBBBB;
+      font-weight: bold;
+    }
+
+    li.failed:hover {
+      color: #FFFFFF;
+      background-color: #FF0000;
+    }
+
+    li.failed .failure {
+      font-weight: normal;
+      font-size: 9pt;
+    }
+
+    div.context {
+      padding:4px;
+      border:1px solid #000000;
+      margin-top:4px;
+    }
+
+    </style>
+    <script type="text/javascript">
+    // <![CDATA[
+
+    function toggle( id ) {
+      if ( document.getElementById )
+        elem = document.getElementById( id );
+      else if ( document.all )
+        elem = eval( "document.all." + id );
+      else
+        return false;
+
+      elemStyle = elem.style;
+
+      if ( elemStyle.display != "block" ) {
+        elemStyle.display = "block"
+      } else {
+        elemStyle.display = "none"
+      }
+
+      return true;
+    }
+    // ]]>
+    </script>
+
+  </head>
+  <body>
+  HEADER
+      end
+    end
+  end
+end