rspec 0.5.2 → 0.5.3

data/doc/src/documentation/mocks.page

@@ -9,31 +9,21 @@ RSpec contains a full featured Mock Objects framework.
 h3. Creating a mock
 
 <pre>
-<code>
 mock(<name>)
-</code>
 </pre>
 
-This creates a new mock with the given name (a string) and registers it. When
-the specification finishes, all registered mocks are verified.
+This creates a new mock with the given name (a string) and registers it. When the specification finishes, all registered mocks are verified.
 
 <pre>
-<code>
 mock(<name>, <options>)
-</code>
 </pre>
 
-As above, but allows you to specific options to tweak the mock's behaviour.
-The <code>options</code> argument is a hash. Currently the only supported option is
-<code>:null_object</code>. Setting this to true (i.e. <code>:null_object => true</code>) instructs the
-mock to ignore (quietly consume) any messages it hasn't been told to expect.
+As above, but allows you to specific options to tweak the mock's behaviour. The <code>options</code> argument is a hash. Currently the only supported option is <code>:null_object</code>. Setting this to true (i.e. <code>:null_object => true</code>) instructs the mock to ignore (quietly consume) any messages it hasn't been told to expect.
 
 h3. Expecting Messages
 
 <pre>
-<code>
 mock.should.receive(<message>)
-</code>
 </pre>
 
 The <code>message</code> argument is a symbol that is the name of a message that you want
@@ -46,9 +36,7 @@ by the mock, the block is evaluated, and passed any arguments. The result is
 the return value of the message. For example:
 
 <pre>
-<code>
 @mock.should.receive(:random_call) {| a | a.should.be true}
-</code>
 </pre>
 
 This allows arbitrary argument validation and result computation.
@@ -56,27 +44,21 @@ This allows arbitrary argument validation and result computation.
 h3. Expecting Arguments
 
 <pre>
-<code>
 mock.should.receive(:msg).with(<args>)
 mock.should.receive(:msg).with(1, 2, 3)
-</code>
 </pre>
 
 The <code>args</code> argument is a series of arguments (e..g. 1, 2, 3) that are expected
 to be passed as arguments to the associated message.
 
 <pre>
-<code>
 mock.should.receive(:msg).with(:no_args)
-</code>
 </pre>
 
 No arguments are to be accepted by the message.
 
 <pre>
-<code>
 mock.should.receive(:msg).with(:any_args)
-</code>
 </pre>
 
 Any arguments are to be accepted by the message. This includes cases where no
@@ -92,9 +74,7 @@ h4. :anything
 accepts any value for this argument
 
 <pre>
-<code>
 mock.should.receive(:msg).with(1, :anything, "A")
-</code>
 </pre>
 
 h4. :numeric
@@ -102,9 +82,7 @@ h4. :numeric
 accepts any numeric value for this argument
 
 <pre>
-<code>
 mock.should.receive(:msg).with(a, :numeric, "b")
-</code>
 </pre>
 
 h4. :boolean
@@ -112,9 +90,7 @@ h4. :boolean
 accepts a boolean value for this argument
 
 <pre>
-<code>
 mock.should.receive(:msg).with(a, :boolean, "b")
-</code>
 </pre>
 
 h4. :string
@@ -122,74 +98,65 @@ h4. :string
 accepts any string for this argument
 
 <pre>
-<code>
 mock.should.receive(:msg).with(a, :string, "b")
-</code>
 </pre>
 	
+h4. duck_type(message(s))
+
+accepts any object that responds to the prescribed message(s)
+
+<pre>
+#accepts a Fixnum for the second arg
+mock.should.receive(:msg).with(a, duck_type(:abs, :div), "b") 
+</pre>
+
 h3. Receive Counts
 
 <pre>
-<code>
 mock.should.receive(:msg).never
-</code>
 </pre>
 
 A problem is reported if the message is ever received.
 
 <pre>
-<code>
 mock.should.receive(:msg).any.number.of.times
-</code>
 </pre>
 
 The message can be received 0 or more times.
 
 <pre>
-<code>
 mock.should.receive(:msg).once
-</code>
 </pre>
 
 A problem is reported is the message is never received, or it is received more
 than once.
 
 <pre>
-<code>
 mock.should.receive(:msg).twice
-</code>
 </pre>
 
 A problem is reported is the message is received anything but two times.
 
 <pre>
-<code>
 mock.should.receive(:msg).exactly(n).times
-</code>
 </pre>
 
 A problem is reported is the message is received anything but n times.
 
 <pre>
-<code>
 mock.should.receive(:msg).at.least(:once)
-</code>
 </pre>
 
 A problem is reported if the message is never received.
 
 <pre>
-<code>
 mock.should.receive(:msg).at.least(:twice)
-</code>
 </pre>
 
 A problem is reported is the message is never received or is received only once.
 
 <pre>
-<code>
 mock.should.receive(:msg).at.least(n).times
-</code>
 </pre>
 
 A problem is reported is the message is received fewer than n times.
@@ -197,27 +164,21 @@ A problem is reported is the message is received fewer than n times.
 h3. Return Values
 
 <pre>
-<code>
 mock.should.receive(:msg).once.and.return(<value>)
-</code>
 </pre>
 
 When the expected message is received, <code>value</code> will be returned as the result.
 
 <pre>
-<code>
 and.return([<value-1>, <value-2>, ..., <value-n>])
-</code>
 </pre>
 
 When the expected message is received, <code>value-i</code> will be returned as the result
-for the ith reception of the message. Once i > n, <code>value-n</code> is returned for all
+for the ith reception of the message. Once <code>i > n</code>, <code>value-n</code> is returned for all
 subsequent receives of the message.
 
 <pre>
-<code>
 mock.should.receive(:msg).once.and.return {...} 
-</code>
 </pre>
 
 When the expected message is received, the result of evaluating the supplied
@@ -226,18 +187,14 @@ as parts of the message. This capability can be used to compute return values
 based on the arguments.  For example:
 
 <pre>
-<code>
 mock.should.receive(:msg).once.and.return {|a, b| a + b}
-</code>
 </pre>
 
 h3. Raising and Throwing
 
 <pre>
-<code>
 mock.should.receive(:msg).once.and.raise(<exception>)
 mock.should.receive(:msg).once.and.throw(<symbol>) 
-</code>
 </pre>
 
 These instruct the mock to raise an exception or throw a symbol instead of returning a value.

data/doc/src/meta.info

@@ -11,7 +11,10 @@ documentation:
   title: Documentation
   orderInfo: 4
 
-download.page:
+download.html:
+  title: Download
+  inMenu: true
+  dest: http://rubyforge.org/frs/?group_id=797
   orderInfo: 5
 
 tools:

data/examples/airport_spec.rb

@@ -19,7 +19,6 @@ module Kernel
   alias topic context
 end
 
-
 topic "Airport at home" do
   setup do
     @airport = Airport.new

data/examples/empty_stack_spec.rb

@@ -1,3 +1,4 @@
+require File.dirname(__FILE__) + '/../lib/spec'
 require File.dirname(__FILE__) + "/stack"
 
 context "An empty stack" do

data/examples/stack_spec.rb

@@ -1,3 +1,4 @@
+require File.dirname(__FILE__) + '/../lib/spec'
 require File.dirname(__FILE__) + "/stack"
 
 context "An empty stack" do

data/examples/team_spec.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/../lib/spec'
+
+class Team
+  attr_reader :players
+  def initialize
+    @players = Players.new
+  end
+end
+
+class Players
+  def size
+    0
+  end
+end
+
+context "A new team" do
+  
+  setup do
+    @team = Team.new
+  end
+  
+  specify "should have 3 players (failing example)" do
+    @team.should.have(3).players
+  end
+  
+  specify "should have 1 player (failing example)" do
+    @team.players.size.should.be 1
+  end
+  
+end

data/lib/spec/api.rb

@@ -1,4 +1,5 @@
 require 'spec/api/exceptions'
 require 'spec/api/mock'
+require 'spec/api/duck_type'
 require 'spec/api/expectations'
 require 'spec/api/helper'

data/lib/spec/api/duck_type.rb

@@ -0,0 +1,16 @@
+module Spec
+  module Api
+
+    class DuckType
+      def initialize(*methods_to_respond_do)
+        @methods_to_respond_do = methods_to_respond_do
+      end
+  
+      def walks_like?(obj)
+        @methods_to_respond_do.each { |sym| return false unless obj.respond_to? sym }
+        return true
+      end
+    end
+  
+  end
+end

data/lib/spec/api/expectations.rb

@@ -1,9 +1,9 @@
 module Spec
   module ObjectExpectations
-		def should
-			ShouldHelper.new self
-		end
-	end
+    def should
+      ShouldHelper.new self
+    end
+  end
 end
 
 class Object

data/lib/spec/api/mock.rb

@@ -88,6 +88,7 @@ module Spec
           next if @expected_params[i] == :numeric and args[i].is_a?Numeric
           next if @expected_params[i] == :boolean and args[i].is_a?TrueClass or args[i].is_a?FalseClass
           next if @expected_params[i] == :string and args[i].is_a?String
+          next if @expected_params[i].is_a? DuckType and @expected_params[i].walks_like? args[i]
           return false unless args[i] == @expected_params[i]
         end
         return true

data/lib/spec/runner/backtrace_tweaker.rb

@@ -5,8 +5,7 @@ module Spec
         return if error.backtrace.nil?
         error.backtrace.collect! do |line|
           line = line.split(':in')[0] + ":in `#{spec_name}'" if line.include?('__instance_exec')
-          line = nil if line.include? '/lib/spec/api/helper/should_base.rb'
-          line = nil if line.include? '/lib/spec/api/helper/should_negator.rb' unless line.nil?
+          line = nil if line =~ /\/lib\/spec\/api\/helper\/.+[helper|base|negator].rb/
           line
         end
         error.backtrace.compact!

data/lib/spec/runner/context.rb

@@ -13,13 +13,12 @@ module Spec
         @specifications = []
         @name = name
         instance_exec(&context_block)
-        @@context_runner.add_context(self) unless @@context_runner.nil?
         ContextRunner.standalone(self) if @@context_runner.nil?
-        @calling_line = caller(0)[2].split(":in")[0]
+        @@context_runner.add_context(self) unless @@context_runner.nil?
       end
 
       def run(reporter)
-        reporter.add_context(@name, @calling_line)
+        reporter.add_context(@name)
         @specifications.each do |specification|
           specification.run(reporter, @setup_block, @teardown_block)
         end

data/lib/spec/runner/context_runner.rb

@@ -4,8 +4,8 @@ module Spec
   module Runner
     class ContextRunner
       
-      def self.standalone context
-        context_runner = ContextRunner.new(ARGV, true)
+      def self.standalone(context, args=ARGV)
+        context_runner = ContextRunner.new(args, true)
         context_runner.add_context context
         context_runner.run
       end

data/lib/spec/runner/execution_context.rb

@@ -11,6 +11,10 @@ module Spec
         mock
       end
       
+      def duck_type(*args)
+        return Api::DuckType.new(*args)
+      end
+      
       def violated(message="")
         raise Spec::Api::ExpectationNotMetError.new(message)
       end

data/lib/spec/runner/option_parser.rb

@@ -15,7 +15,8 @@ module Spec
           opts.separator ""
 
           opts.on("-o", "--of [FILE]", "Set the output file (defaults to STDOUT)") do |outfile|
-            options.out = outfile unless outfile.nil?
+            options.out = StringIO.new if outfile == "stringio"
+            options.out = outfile unless outfile.nil? or outfile == "stringio"
             exit if outfile.nil?
           end
 
@@ -33,7 +34,7 @@ module Spec
           end
 
           opts.on_tail("-h", "--help", "Show this message") do
-            err.puts opts
+            out.puts opts
             exit if out == $stdout
           end
 

data/lib/spec/runner/simple_text_reporter.rb

@@ -6,24 +6,23 @@ module Spec
         @context_names = []
         @errors = []
         @spec_names = []
-        @failures = []
         @verbose = verbose
         @backtrace_tweaker = backtrace_tweaker
       end
   
-      def add_context(name, calling_line=nil)
+      def add_context(name)
         @output << "\n" if @context_names.empty? unless @verbose
         @output << "\n#{name}\n" if @verbose
-        @context_names << [name, calling_line]
+        @context_names << name
       end
       
-      def add_spec(name, calling_line, errors=[])
+      def add_spec(name, errors=[])
         if errors.empty?
           spec_passed(name)
         else
           errors.each { |error| @backtrace_tweaker.tweak_backtrace(error, name) }
           # only show the first one (there might be more)
-          spec_failed(name, calling_line, errors[0])
+          spec_failed(name, errors[0])
         end
       end
       
@@ -37,7 +36,7 @@ module Spec
   
       def dump
         @output << "\n"
-        dump_failures
+        dump_errors
         @output << "\n\n" unless @errors.empty?
         @output << "\n" if @errors.empty?
         @output << "Finished in " << (duration).to_s << " seconds\n\n"
@@ -47,16 +46,14 @@ module Spec
         @output << "\n"
       end
 
-      def dump_failures
+      def dump_errors
         return if @errors.empty?
         @output << "\n"
-        @failures.inject(1) do |index, failure|
+        @errors.inject(1) do |index, error|
           @output << "\n\n" if index > 1
           @output << index.to_s << ")\n"
-          @output << "#{failure.error.message} (#{failure.error.class.name})\n"
-          @output << "Context: #{failure.context_name} [#{failure.context_line}]\n"
-          @output << "Specification: #{failure.spec_name} [#{failure.spec_line}]\n"
-          dump_backtrace(failure.error.backtrace)
+          @output << "#{error.message} (#{error.class.name})\n"
+          dump_backtrace(error.backtrace)
           index + 1
         end
       end
@@ -78,25 +75,14 @@ module Spec
           @output << '.' unless @verbose
         end
 
-        def spec_failed(name, calling_line, error)
+        def spec_failed(name, error)
           @spec_names << name
           @errors << error
-          @failures << Failure.new(@context_names.last[0], @context_names.last[1], name, calling_line, error)
-          @output << "- #{name} (FAILED - #{@failures.length})\n" if @verbose
+          @output << "- #{name} (FAILED - #{@errors.length})\n" if @verbose
           @output << 'F' unless @verbose
         end
 
     end
     
-    class Failure
-      attr_reader :context_name, :context_line, :spec_name, :spec_line, :error
-      def initialize(context_name, context_line, spec_name, spec_line, error)
-        @context_name = context_name
-        @context_line = context_line
-        @spec_name = spec_name
-        @spec_line = spec_line
-        @error = error
-      end
-    end
   end
 end