rspec 0.5.1 → 0.5.2

data/doc/src/download.page

@@ -1,7 +1,6 @@
 ---
 title: Download
 inMenu: true
-ordering: 5
 ---
 h2. Download
 

data/doc/src/examples.page

@@ -1,9 +1,8 @@
 ---
 title: Examples
 inMenu: true
-ordering: 5
 ---
 h2. Examples
 
 Here is an example of an RSpec spec:
-{ruby_inline: {filename: ../examples/spec_framework_spec.rb}}
+{ruby_inline: {filename: ../examples/stack_spec.rb}}

data/doc/src/index.page

@@ -1,7 +1,6 @@
 ---
 title: Overview
 inMenu: true
-ordering: 1
 ---
 h2. RSpec
 

data/doc/src/meta.info

@@ -0,0 +1,23 @@
+index.page:
+  orderInfo: 1
+  
+why_rspec.page:
+  orderInfo: 2
+
+examples.page:
+  orderInfo: 3
+  
+documentation:
+  title: Documentation
+  orderInfo: 4
+
+download.page:
+  orderInfo: 5
+
+tools:
+  title: Tools
+  orderInfo: 6
+  
+community.page:
+  orderInfo: 7
+

data/doc/src/tools/index.page

@@ -1,8 +1,143 @@
 ---
-title: Tools
+title: Spec Runner
 inMenu: true
-ordering: 1
 ---
-h2. Tools
+h2. Processing Specifications
 
-Look at my tools
+The spec command processes specification files.  The general form of the command is
+
+<pre>
+<code>
+spec [options] (FILE|DIRECTORY)+
+</code>
+</pre>
+
+Any number of files and/or directories can be provided, all ruby source files
+that are found are loaded. Running spec on the previous example results in:
+
+<pre>
+<code>
+..................
+
+Finished in 0.007523 seconds
+
+4 contexts, 18 specifications, 0 failures
+</code>
+</pre>
+
+Very simple and to the point. Passing specifications are indicated by a '.',
+failing ones by a 'F'. Note that failure indicates a violated expectation as
+well as an unexpected exception being raised.  Here's an example with a failing specification:
+
+<pre>
+<code>
+F.
+
+1)
+SpecFramework #<SpecFramework:0x3d73dc> should be adopted_quickly (Spec::Api::ExpectationNotMetError)
+Context: Spec framework [./examples/spec_framework_spec.rb:13]
+Specification: should be adopted quickly [./examples/spec_framework_spec.rb:19]
+./examples/spec_framework_spec.rb:21:in `should be adopted quickly'
+
+Finished in 0.001565 seconds
+
+1 context, 2 specifications, 1 failure
+</code>
+</pre>
+
+h3. -v, --verbose
+
+Using this option provides more information:
+
+<pre>
+<code>
+An empty stack

+- should accept an item when sent push

+- should complain when sent top

+- should complain when sent pop


+
+A stack with one item

+- should accept an item when sent push

+- should return top when sent top

+- should not remove top when sent top

+- should return top when sent pop

+- should remove top when sent pop


+
+An almost full stack (with one item less than capacity)

+- should accept an item when sent push

+- should return top when sent top

+- should not remove top when sent top

+- should return top when sent pop

+- should remove top when sent pop


+
+A full stack

+- should complain on push

+- should return top when sent top

+- should not remove top when sent top

+- should return top when sent pop

+- should remove top when sent pop
+
+Finished in 0.013635 seconds
+
+4 contexts, 18 specifications, 0 failures
+</code>
+</pre>
+
+Similar, here is a failing specification when the verbose opton is used:
+
+<pre>
+<code>
+Spec framework
+- should be adopted quickly (FAILED - 1)
+- should be intuitive
+
+
+1)
+SpecFramework #<SpecFramework:0x3d7238> should be adopted_quickly (Spec::Api::ExpectationNotMetError)
+Context: Spec framework [./examples/spec_framework_spec.rb:13]
+Specification: should be adopted quickly [./examples/spec_framework_spec.rb:19]
+./examples/spec_framework_spec.rb:21:in `should be adopted quickly'
+
+Finished in 0.002726 seconds
+
+1 context, 2 specifications, 1 failure
+</code>
+</pre>
+
+The spec command does double duty as documentation generation from a set of
+specifications as well as running them against your code.
+
+h3.-d, --doc
+
+Process the specifications in documentation generation mode. This will produce
+an rdoc input file. For example here is the result of running spec -d on the
+previous example:
+
+<pre>
+<code>
+# An empty stack

+# * should accept an item when sent push

+# * should complain when sent top

+# * should complain when sent pop

+# A stack with one item

+# * should accept an item when sent push

+# * should return top when sent top

+# * should not remove top when sent top

+# * should return top when sent pop

+# * should remove top when sent pop

+# An almost full stack (with one item less than capacity)

+# * should accept an item when sent push

+# * should return top when sent top

+# * should not remove top when sent top

+# * should return top when sent pop

+# * should remove top when sent pop

+# A full stack

+# * should complain on push

+# * should return top when sent top

+# * should not remove top when sent top

+# * should return top when sent pop

+# * should remove top when sent pop
+</code>
+</pre>
+
+Rdoc renders this as "this":rdoc-output/index.html.

data/doc/src/tools/meta.info

@@ -0,0 +1,12 @@
+index.page:
+  orderInfo: 10
+
+test2rspec.page:
+  orderInfo: 11
+
+rake.page:
+  orderInfo: 12
+  
+rails.page:
+  orderInfo: 13
+

data/doc/src/tools/rails.page

@@ -1,7 +1,6 @@
 ---
 title: Rails Integration
 inMenu: true
-ordering: 5
 ---
 h2. Rails Integration
 

data/doc/src/tools/rake.page

@@ -1,7 +1,6 @@
 ---
 title: Rake Integration
 inMenu: true
-ordering: 5
 ---
 h2. Rake Integration
 

data/doc/src/tools/test2rspec.page

@@ -1,8 +1,15 @@
 ---
-title: Test::Unit migration
+title: Test::Unit Migration
 inMenu: true
-ordering: 5
 ---
 h2. Test::Unit migration
 
-lalalala
+rSpec provides a tool for converting Test::Unit files into specifications.  Anything that cannot be converted is left in it's original form.  The command line is:
+
+<pre>
+<code>
+test2rspec SRC [DEST]
+</code>
+</pre>
+
+If DEST is not supplied, output is sent to STDOUT.

data/doc/src/why_rspec.page

@@ -1,7 +1,6 @@
 ---
 title: Why RSpec
 inMenu: true
-ordering: 2
 ---
 h2. Why RSpec
 

data/examples/airport_spec.rb

@@ -10,20 +10,30 @@ class Airport
   end
 end
 
-context "Airport at home" do
+class Spec::Runner::Context
+  alias should specify
+  alias must specify
+  alias fact specify
+end
+module Kernel
+  alias topic context
+end
+
+
+topic "Airport at home" do
   setup do
     @airport = Airport.new
   end
   
-  specify "should always work" do
+  fact "should always work" do
     @airport.should.be.working
   end
 
-  specify "should not need cables" do
+  must "not need cables" do
     @airport.should.not.need :cables
   end
 
-  specify "should not need electricity" do
+  must "not need electricity" do
     # This will fail...
     @airport.should.not.need :electricity
   end

data/examples/empty_stack_spec.rb

@@ -0,0 +1,21 @@
+require File.dirname(__FILE__) + "/stack"
+
+context "An empty stack" do
+  
+  setup do
+    @stack = Stack.new
+  end
+  
+  specify "should accept an item when sent push" do
+    lambda { @stack.push Object.new }.should.not.raise
+  end
+  
+  specify "should complain when sent top" do
+    lambda { @stack.top }.should.raise StackUnderflowError
+  end
+  
+  specify "should complain when sent pop" do
+    lambda { @stack.pop }.should.raise StackUnderflowError
+  end
+  
+end

data/examples/stack_spec.rb

@@ -1,3 +1,5 @@
+require File.dirname(__FILE__) + "/stack"
+
 context "An empty stack" do
   
   setup do
@@ -18,7 +20,7 @@ context "An empty stack" do
   
 end
 
-context "A stack with one item" do
+  context "A stack with one item" do
   setup do
     @stack = Stack.new
     @stack.push 3
@@ -77,6 +79,7 @@ context "An almost full stack (with one item less than capacity)" do
   end
   
 end
+
 context "A full stack" do
   
   setup do

data/lib/spec.rb

@@ -1,5 +1,6 @@
 $LOAD_PATH.push File.dirname(__FILE__) + '/../lib'
 
+require 'spec/version'
 require 'spec/api'
 require 'spec/runner'
-require 'spec/runner/kernel_ext'
+require 'spec/runner/kernel_ext'

data/lib/spec/api/helper/should_helper.rb

@@ -14,16 +14,17 @@ module Spec
       HaveHelper.new(@target, expected_number)
     end
 	
-		def satisfy
-      fail_with_message "Supplied expectation was not satisfied" if (!yield @target)
+		def satisfy(&block)
+		  return if block.call(@target)
+      fail_with_message "Supplied expectation was not satisfied"
     end
 				
 	  def equal(expected)
     	fail_with_message(default_message("should equal", expected)) unless (@target == expected)
     end
 
-    def be(expected = :no_arg)
-      return self if (expected == :no_arg)
+    def be(expected = :___no_arg)
+      return self if (expected == :___no_arg)
       return if (expected == false and @target.nil?)
 			return if (expected == true and (!@target.nil?) and (@target != false))
     	fail_with_message(default_message("should be", expected)) unless (@target.equal?(expected))

data/lib/spec/api/helper/should_negator.rb

@@ -51,6 +51,7 @@ module Spec
       rescue exception
         fail_with_message(default_message("should not raise", exception.inspect))
       rescue
+        true
       end
     end
     
@@ -62,6 +63,7 @@ module Spec
         end
         fail_with_message(default_message("should not throw", symbol.inspect))
       rescue NameError
+        true
       end
     end
     

data/lib/spec/api/mock.rb

@@ -81,8 +81,9 @@ module Spec
       end
       
       def constraints_match?(args)
+        return true if @expected_params.length == 1 and @expected_params[0] == :any_args
         return false if args.length != @expected_params.length
-        for i in 0...@expected_params.length
+        @expected_params.each_index do |i|
           next if @expected_params[i] == :anything
           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
@@ -144,10 +145,6 @@ module Spec
           return result
         end
     
-        unless @expected_params.nil? or @expected_params == args or constraints_match?(args)
-          Kernel::raise Spec::Api::MockExpectationError,
-            "#{@sym}: Parameter mismatch: Expected <#{@expected_params}>, got <#{args}>" 
-        end
         args << block unless block.nil?
         @received_count += 1
         
@@ -162,8 +159,8 @@ module Spec
       end
 
       def with(*args)
-        if args == [:anything] then @expected_params = nil
-        elsif args == [:nothing] then @expected_params = []
+        if args == [:any_args] then @expected_params = nil
+        elsif args == [:no_args] then @expected_params = []
         else @expected_params = args
         end
 

data/lib/spec/runner/backtrace_tweaker.rb

@@ -3,14 +3,13 @@ module Spec
     class BacktraceTweaker
       def tweak_backtrace error, spec_name
         return if error.backtrace.nil?
-        tweaked_backtrace = []
-        error.backtrace.each do |line|
+        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?
-          tweaked_backtrace.push line unless line.nil?
+          line
         end
-        error.set_backtrace tweaked_backtrace
+        error.backtrace.compact!
       end
     end
   end

data/lib/spec/runner/execution_context.rb

@@ -10,6 +10,10 @@ module Spec
         @spec.add_mock(mock)
         mock
       end
+      
+      def violated(message="")
+        raise Spec::Api::ExpectationNotMetError.new(message)
+      end
     end
   end
 end