rspec 0.8.2 → 0.9.0

data/UPGRADE

@@ -0,0 +1,31 @@
+= Upgrading existing code to RSpec-0.9
+
+== General (see below for Spec::Rails specifics)
+
+=== New Syntax for should and should_not
+
+* Use translator (should get 90% of your code)
+* Manually fix "parenthesis" warnings
+
+=== Change before_context_eval to before_eval
+
+before_context_eval is an un-published hook used by
+Spec::Rails to create specialized behaviour contexts.
+Most of you don't need to change this, but for those
+who have exploited it, you'll need to change it to
+before_eval.
+
+== Spec::Rails
+
+=== spec_helper.rb
+
+We've added a new way to configure Spec::Runner to do
+things like use_transactional_fixtures and use_instantiated_fixtures.
+You'll need to update spec/spec_helper.rb accordingly. You can either
+just re-generate it:
+
+  script/generate rspec
+  
+Or modify spec_helper.rb based on the template, which can be found at:
+
+  vendor/plugins/rspec_on_rails/generators/rspec/templates/spec_helper.rb

data/bin/spec

@@ -1,4 +1,3 @@
-#!/usr/bin/env ruby
 $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
 require 'spec'
 ::Spec::Runner::CommandLine.run(ARGV, STDERR, STDOUT, true, true)

data/bin/spec_translator

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+require 'spec/translator'
+t = ::Spec::Translator.new
+from = ARGV[0]
+to = ARGV[1]
+t.translate(from, to)

data/examples/auto_spec_description_example.rb

@@ -0,0 +1,19 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+# Run spec w/ -fs to see the output of this file
+
+describe "Examples with no descriptions" do
+  
+  # description is auto-generated as "should equal(5)" based on the last #should
+  it do
+    3.should equal(3)
+    5.should equal(5)
+  end
+  
+  it { 3.should be < 5 }
+  
+  it { ["a"].should include("a") }
+  
+  it { [1,2,3].should respond_to(:size) }
+  
+end

data/examples/{setup_teardown_example.rb → before_and_after_example.rb}

@@ -1,16 +1,16 @@
 $global = 0
 
-context "State created in context_setup" do
-  context_setup do
+describe "State created in before(:all)" do
+  before :all do
     @sideeffect = 1
     $global +=1
   end
 
-  setup do
+  before :each do
     @isolated = 1
   end
   
-  specify "should be accessible from spec" do
+  it "should be accessible from example" do
     @sideeffect.should == 1
     $global.should == 1
     @isolated.should == 1
@@ -19,7 +19,7 @@ context "State created in context_setup" do
     @isolated += 1
   end
 
-  specify "should not have sideffects" do
+  it "should not have sideffects" do
     @sideeffect.should == 1
     $global.should == 1
     @isolated.should == 1
@@ -28,7 +28,7 @@ context "State created in context_setup" do
     @isolated += 1
   end
   
-  context_teardown do
+  after :all do
     $global = 0
   end
 end

data/examples/behave_as_example.rb

@@ -0,0 +1,45 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+def behave_as_electric_musician
+  respond_to(:read_notes, :turn_down_amp)
+end
+
+def behave_as_musician
+  respond_to(:read_notes)
+end
+
+module BehaveAsExample
+  
+  class BluesGuitarist
+    def read_notes; end
+    def turn_down_amp; end
+  end
+  
+  class RockGuitarist
+    def read_notes; end
+    def turn_down_amp; end
+  end
+  
+  class ClassicGuitarist
+    def read_notes; end
+  end
+  
+  describe BluesGuitarist do
+    it "should behave as guitarist" do
+      BluesGuitarist.new.should behave_as_electric_musician
+    end
+  end
+
+  describe RockGuitarist do
+    it "should behave as guitarist" do
+      RockGuitarist.new.should behave_as_electric_musician
+    end
+  end
+
+  describe ClassicGuitarist do
+    it "should not behave as guitarist" do
+      ClassicGuitarist.new.should behave_as_musician
+    end
+  end
+  
+end

data/examples/custom_expectation_matchers.rb

@@ -35,19 +35,20 @@ module Animals
       [:cheese]
     end
   end
-end
 
-context "A mouse" do
-  include AnimalSpecHelper
-  setup do
-    @mouse = Animals::Mouse.new
-  end
+  describe Mouse do
+    include AnimalSpecHelper
+    before(:each) do
+      @mouse = Animals::Mouse.new
+    end
   
-  specify "should eat cheese" do
-    @mouse.should eat(:cheese)
-  end
+    it "should eat cheese" do
+      @mouse.should eat(:cheese)
+    end
   
-  specify "should not eat cat" do
-    @mouse.should_not eat(:cat)
+    it "should not eat cat" do
+      @mouse.should_not eat(:cat)
+    end
   end
-end
+
+end

data/examples/dynamic_spec.rb

@@ -1,8 +1,8 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
-context "The month march" do
+describe "Some integers" do
   (1..10).each do |n|
-    specify "The root of #{n} square should be #{n}" do
+    it "The root of #{n} square should be #{n}" do
       Math.sqrt(n*n).should == n
     end
   end

data/examples/file_accessor_spec.rb

@@ -2,7 +2,7 @@ require File.dirname(__FILE__) + '/spec_helper'
 require File.dirname(__FILE__) + '/file_accessor'
 require 'stringio'
 
-context "A FileAccessor" do
+describe "A FileAccessor" do
   # This sequence diagram illustrates what this spec specifies.
   #
   #                  +--------------+     +----------+     +-------------+
@@ -20,7 +20,7 @@ context "A FileAccessor" do
   #                        | |<..................................| |
   #                         |                  |                  |
   #
-  specify "should open a file and pass it to the processor's process method" do
+  it "should open a file and pass it to the processor's process method" do
     # This is the primary actor
     accessor = FileAccessor.new
 

data/examples/greeter_spec.rb

@@ -16,13 +16,13 @@ class Greeter
   end
 end
 
-context "Greeter" do
-  specify "should say Hi to person" do
+describe "Greeter" do
+  it "should say Hi to person" do
     greeter = Greeter.new("Kevin")
     greeter.greet.should == "Hi Kevin!"
   end
 
-  specify "should say Hi to nobody" do
+  it "should say Hi to nobody" do
     greeter = Greeter.new
     # Uncomment the next line to make Heckle happy
     #greeter.greet.should == "Hi there!"

data/examples/helper_method_example.rb

@@ -1,11 +1,11 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
-context "a context with helper a method" do
+describe "a context with helper a method" do
   def helper_method
     "received call"
   end
   
-  specify "should make that method available to specs" do
+  it "should make that method available to specs" do
     helper_method.should == "received call"
   end
 end

data/examples/io_processor_spec.rb

@@ -2,18 +2,18 @@ require File.dirname(__FILE__) + '/spec_helper'
 require File.dirname(__FILE__) + '/io_processor'
 require 'stringio'
 
-context "An IoProcessor" do
-  setup do
+describe "An IoProcessor" do
+  before(:each) do
     @processor = IoProcessor.new
   end
 
-  specify "should raise nothing when the file is exactly 32 bytes" do
+  it "should raise nothing when the file is exactly 32 bytes" do
     lambda {
       @processor.process(StringIO.new("z"*32))
     }.should_not raise_error
   end
 
-  specify "should raise an exception when the file length is less than 32 bytes" do
+  it "should raise an exception when the file length is less than 32 bytes" do
     lambda {
       @processor.process(StringIO.new("z"*31))
     }.should raise_error(DataTooShort)

data/examples/legacy_spec.rb

@@ -0,0 +1,10 @@
+context "A legacy spec" do
+  setup do
+  end
+  
+  specify "should work fine" do
+  end
+  
+  teardown do
+  end
+end

data/examples/mocking_example.rb

@@ -1,15 +1,15 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
-context "A consumer of a mock" do
-  specify "should be able to send messages to the mock" do
+describe "A consumer of a mock" do
+  it "should be able to send messages to the mock" do
     mock = mock("poke me")
     mock.should_receive(:poke)
     mock.poke
   end
 end
 
-context "a mock" do
-  specify "should be able to mock the same message twice w/ different args" do
+describe "a mock" do
+  it "should be able to mock the same message twice w/ different args" do
     mock = mock("mock")
     mock.should_receive(:msg).with(:arg1).and_return(:val1)
     mock.should_receive(:msg).with(:arg2).and_return(:val2)
@@ -17,7 +17,7 @@ context "a mock" do
     mock.msg(:arg2).should eql(:val2)
   end
 
-  specify "should be able to mock the same message twice w/ different args in reverse order" do
+  it "should be able to mock the same message twice w/ different args in reverse order" do
     mock = mock("mock")
     mock.should_receive(:msg).with(:arg1).and_return(:val1)
     mock.should_receive(:msg).with(:arg2).and_return(:val2)

data/examples/multi_threaded_behaviour_runner.rb

@@ -0,0 +1,25 @@
+
+class MultiThreadedBehaviourRunner < Spec::Runner::BehaviourRunner
+  def initialize(options)
+    super
+    # configure these
+    @thread_count = 4
+    @thread_wait = 0
+  end
+
+  def run_behaviours(behaviours)
+    @threads = []
+    q = Queue.new
+    behaviours.each { |b| q << b}
+    @thread_count.times do
+      @threads << Thread.new(q) do |queue|
+        while not queue.empty?
+          behaviour = queue.pop
+          behaviour.run(@options.reporter, @options.dry_run, @options.reverse)
+        end
+      end
+      sleep @thread_wait
+    end
+    @threads.each {|t| t.join}
+  end
+end

data/examples/partial_mock_example.rb

@@ -6,18 +6,18 @@ class MockableClass
   end
 end
 
-context "A partial mock" do
+describe "A partial mock" do
 
-  specify "should work at the class level" do
+  it "should work at the class level" do
     MockableClass.should_receive(:find).with(1).and_return {:stub_return}
     MockableClass.find(1).should equal(:stub_return)
   end
 
-  specify "should revert to the original after each spec" do
+  it "should revert to the original after each spec" do
     MockableClass.find(1).should equal(:original_return)
   end
 
-  specify "can be mocked w/ ordering" do
+  it "can be mocked w/ ordering" do
     MockableClass.should_receive(:msg_1).ordered
     MockableClass.should_receive(:msg_2).ordered
     MockableClass.should_receive(:msg_3).ordered

data/examples/predicate_example.rb

@@ -10,17 +10,17 @@ class BddFramework
   end
 end
 
-context "BDD framework" do
+describe "BDD framework" do
 
-  setup do
+  before(:each) do
     @bdd_framework = BddFramework.new
   end
 
-  specify "should be adopted quickly" do
+  it "should be adopted quickly" do
     @bdd_framework.should be_adopted_quickly
   end
   
-  specify "should be intuitive" do
+  it "should be intuitive" do
     @bdd_framework.should be_intuitive
   end
 

data/examples/priority.txt

@@ -0,0 +1 @@
+examples/custom_expectation_matchers.rb

data/examples/shared_behaviours_example.rb

@@ -0,0 +1,31 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+module SharedBehaviourExample
+  class OneThing
+    def what_things_do
+      "stuff"
+    end
+  end
+  
+  class AnotherThing
+    def what_things_do
+      "stuff"
+    end
+  end
+  
+  describe "All Things", :shared => true do
+    it "should do what things do" do
+      @thing.what_things_do.should == "stuff"
+    end
+  end
+
+  describe OneThing do
+    it_should_behave_like "All Things"
+    before(:each) { @thing = OneThing.new }
+  end
+
+  describe AnotherThing do
+    it_should_behave_like "All Things"
+    before(:each) { @thing = AnotherThing.new }
+  end
+end

data/examples/stack_spec.rb

@@ -1,113 +1,96 @@
 require File.dirname(__FILE__) + '/spec_helper'
 require File.dirname(__FILE__) + "/stack"
 
-context "A Stack" do
-  setup do
-    @stack = Stack.new
-    ["a","b","c"].each { |x| @stack.push x }
-  end
+describe "non-empty Stack", :shared => true do
+  # NOTE that this one auto-generates the description "should not be empty"
+  it { @stack.should_not be_empty }
   
-  specify "should add to the top when sent #push" do
-    @stack.push "d"
-    @stack.peek.should == "d"
+  it "should return the top item when sent #peek" do
+    @stack.peek.should == @last_item_added
   end
-  
-  specify "should return the top item when sent #peek" do
-    @stack.peek.should == "c"
+
+  it "should NOT remove the top item when sent #peek" do
+    @stack.peek.should == @last_item_added
+    @stack.peek.should == @last_item_added
   end
   
-  specify "should NOT remove the top item when sent #peek" do
-    @stack.peek.should == "c"
-    @stack.peek.should == "c"
+  it "should return the top item when sent #pop" do
+    @stack.pop.should == @last_item_added
   end
   
-  specify "should return the top item when sent #pop" do
-    @stack.pop.should == "c"
+  it "should remove the top item when sent #pop" do
+    @stack.pop.should == @last_item_added
+    unless @stack.empty?
+      @stack.pop.should_not == @last_item_added
+    end
   end
-  
-  specify "should remove the top item when sent #pop" do
-    @stack.pop.should == "c"
-    @stack.pop.should == "b"
+end
+
+describe "non-full Stack", :shared => true do
+  # NOTE that this one auto-generates the description "should not be full"
+  it { @stack.should_not be_full }
+
+  it "should add to the top when sent #push" do
+    @stack.push "newly added top item"
+    @stack.peek.should == "newly added top item"
   end
 end
 
-context "An empty stack" do
-  setup do
+describe Stack, " (empty)" do
+  before(:each) do
     @stack = Stack.new
   end
   
-  # NOTE that this one auto-generates the description "should be_empty"
-  specify { @stack.should be_empty }
+  # NOTE that this one auto-generates the description "should be empty"
+  it { @stack.should be_empty }
   
-  specify "should no longer be empty after #push" do
-    @stack.push "anything"
-    @stack.should_not be_empty
-  end
+  it_should_behave_like "non-full Stack"
   
-  specify "should complain when sent #peek" do
+  it "should complain when sent #peek" do
     lambda { @stack.peek }.should raise_error(StackUnderflowError)
   end
   
-  specify "should complain when sent #pop" do
+  it "should complain when sent #pop" do
     lambda { @stack.pop }.should raise_error(StackUnderflowError)
   end
 end
 
-context "An almost empty stack (with one item)" do
-  setup do
+describe Stack, " (with one item)" do
+  before(:each) do
     @stack = Stack.new
     @stack.push 3
+    @last_item_added = 3
   end
-  
-  # NOTE that this one auto-generates the description "should not be empty"
-  specify { @stack.should_not be_empty }
-  
-  specify "should remain not empty after #peek" do
-    @stack.peek
-    @stack.should_not be_empty
-  end
-  
-  specify "should become empty after #pop" do
-    @stack.pop
-    @stack.should be_empty
-  end
+
+  it_should_behave_like "non-empty Stack"
+  it_should_behave_like "non-full Stack"
+
 end
 
-context "An almost full stack (with one item less than capacity)" do
-  setup do
+describe Stack, " (with one item less than capacity)" do
+  before(:each) do
     @stack = Stack.new
     (1..9).each { |i| @stack.push i }
+    @last_item_added = 9
   end
   
-  # NOTE that this one auto-generates the description "should not be full"
-  specify { @stack.should_not be_full }
-  
-  specify "should become full when sent #push" do
-    @stack.push Object.new
-    @stack.should be_full
-  end
+  it_should_behave_like "non-empty Stack"
+  it_should_behave_like "non-full Stack"
 end
 
-context "A full stack" do
-  setup do
+describe Stack, " (full)" do
+  before(:each) do
     @stack = Stack.new
     (1..10).each { |i| @stack.push i }
+    @last_item_added = 10
   end
-  
+
   # NOTE that this one auto-generates the description "should be full"
-  specify { @stack.should be_full }
-  
-  specify "should remain full after #peek" do
-    @stack.peek
-    @stack.should be_full
-  end
-  
-  specify "should no longer be full after #pop" do
-    @stack.pop
-    @stack.should_not be_full
-  end
+  it { @stack.should be_full }  
+
+  it_should_behave_like "non-empty Stack"
 
-  specify "should complain on #push" do
+  it "should complain on #push" do
     lambda { @stack.push Object.new }.should raise_error(StackOverflowError)
   end
 end