rspec 1.0.0 → 1.3.1

data/bin/spec

@@ -1,3 +1,5 @@
-$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
-require 'spec'
-::Spec::Runner::CommandLine.run(ARGV, STDERR, STDOUT, true, true)
+#!/usr/bin/env ruby
+rspec_dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(rspec_dir) unless $LOAD_PATH.include?(rspec_dir)
+require 'spec/autorun'
+exit ::Spec::Runner::CommandLine.run

data/cucumber.yml

@@ -0,0 +1,5 @@
+default: --require features features -t ~@wip
+pending: --require features features-pending
+no_heckle: --require features features --exclude heckle
+focus: --require features features -t focus
+wip: --require features features -t @wip

data/examples/failing/README.txt

@@ -0,0 +1,11 @@
+"Why have failing examples?", you might ask.
+
+They allow us to see failure messages. RSpec wants to provide meaningful and
+helpful failure messages. The failures in this directory not only provide you
+a way of seeing the failure messages, but they provide RSpec's own specs a way
+of describing what they should look like and ensuring they stay correct.
+
+To see the types of messages you can expect, stand in the root directory and
+run:
+
+bin/spec examples/failing/*.rb

data/examples/failing/diffing_spec.rb

@@ -0,0 +1,36 @@
+describe "Running specs with --diff" do
+  it "should print diff of different strings" do
+    uk = <<-EOF
+RSpec is a
+behaviour driven development
+framework for Ruby
+EOF
+    usa = <<-EOF
+RSpec is a
+behavior driven development
+framework for Ruby
+EOF
+    usa.should == uk
+  end
+
+  class Animal
+    def initialize(name,species)
+      @name,@species = name,species
+    end
+
+    def inspect
+      <<-EOA
+<Animal
+name=#{@name},
+species=#{@species}
+>
+      EOA
+    end
+  end
+
+  it "should print diff of different objects' pretty representation" do
+    expected = Animal.new "bob", "giraffe"
+    actual   = Animal.new "bob", "tortoise"
+    expected.should eql(actual)
+  end
+end

data/examples/failing/failing_implicit_docstrings_example.rb

@@ -0,0 +1,17 @@
+# Run spec w/ -fs to see the output of this file
+
+describe "Failing examples with no descriptions" do
+
+  # description is auto-generated as "should equal(5)" based on the last #should
+  it do
+    3.should equal(2)
+    5.should equal(5)
+  end
+
+  it { 3.should be > 5 }
+
+  it { ["a"].should include("b") }
+
+  it { [1,2,3].should_not respond_to(:size) }
+
+end

data/examples/failing/failure_in_after.rb

@@ -0,0 +1,10 @@
+describe "This example" do
+  
+  it "should be listed as failing in after" do
+  end
+  
+  after(:each) do
+    NonExistentClass.new
+  end
+  
+end

data/examples/failing/failure_in_before.rb

@@ -0,0 +1,10 @@
+describe "This example" do
+  
+  before(:each) do
+    NonExistentClass.new
+  end
+  
+  it "should be listed as failing in each" do
+  end
+  
+end

data/examples/failing/mocking_example.rb

@@ -0,0 +1,38 @@
+describe "Mocker" do
+
+  it "should be able to call mock()" do
+    mock = mock("poke me")
+    mock.should_receive(:poke)
+    mock.poke
+  end
+
+  it "should fail when expected message not received" do
+    mock = mock("poke me")
+    mock.should_receive(:poke)
+  end
+  
+  it "should fail when messages are received out of order" do
+    mock = mock("one two three")
+    mock.should_receive(:one).ordered
+    mock.should_receive(:two).ordered
+    mock.should_receive(:three).ordered
+    mock.one
+    mock.three
+    mock.two
+  end
+
+  it "should get yelled at when sending unexpected messages" do
+    mock = mock("don't talk to me")
+    mock.should_not_receive(:any_message_at_all)
+    mock.any_message_at_all
+  end
+
+  it "has a bug we need to fix" do
+    pending "here is the bug" do
+      # Actually, no. It's fixed. This will fail because it passes :-)
+      mock = mock("Bug")
+      mock.should_receive(:hello)
+      mock.hello
+    end
+  end
+end

data/examples/failing/mocking_with_flexmock.rb

@@ -0,0 +1,26 @@
+# stub frameworks like to gum up Object, so this is deliberately
+# set NOT to run so that you don't accidentally run it when you
+# run this dir.
+
+# To run it, stand in this directory and say:
+#
+#   RUN_FLEXMOCK_EXAMPLE=true ruby ../bin/spec mocking_with_flexmock.rb
+
+if ENV['RUN_FLEXMOCK_EXAMPLE']
+  Spec::Runner.configure do |config|
+    config.mock_with :flexmock
+  end
+
+  describe "Flexmocks" do
+    it "should fail when the expected message is received with wrong arguments" do
+      m = flexmock("now flex!")
+      m.should_receive(:msg).with("arg").once
+      m.msg("other arg")
+    end
+
+    it "should fail when the expected message is not received at all" do
+      m = flexmock("now flex!")
+      m.should_receive(:msg).with("arg").once
+    end
+  end
+end

data/examples/failing/mocking_with_mocha.rb

@@ -0,0 +1,25 @@
+# stub frameworks like to gum up Object, so this is deliberately
+# set NOT to run so that you don't accidentally run it when you
+# run this dir.
+
+# To run it, stand in this directory and say:
+#
+#   RUN_MOCHA_EXAMPLE=true ruby ../bin/spec mocking_with_mocha.rb
+
+if ENV['RUN_MOCHA_EXAMPLE']
+  Spec::Runner.configure do |config|
+    config.mock_with :mocha
+  end
+  describe "Mocha framework" do
+    it "should should be made available by saying config.mock_with :mocha" do
+      m = mock()
+      m.expects(:msg).with("arg")
+      m.msg
+    end
+    it "should should be made available by saying config.mock_with :mocha" do
+      o = Object.new
+      o.expects(:msg).with("arg")
+      o.msg
+    end
+  end
+end

data/examples/failing/mocking_with_rr.rb

@@ -0,0 +1,27 @@
+# stub frameworks like to gum up Object, so this is deliberately
+# set NOT to run so that you don't accidentally run it when you
+# run this dir.
+
+# To run it, stand in this directory and say:
+#
+#   RUN_RR_EXAMPLE=true ruby ../bin/spec mocking_with_rr.rb
+
+if ENV['RUN_RR_EXAMPLE']
+  Spec::Runner.configure do |config|
+    config.mock_with :rr
+  end
+  describe "RR framework" do
+    it "should should be made available by saying config.mock_with :rr" do
+      o = Object.new
+      mock(o).msg("arg")
+      o.msg
+    end
+    it "should should be made available by saying config.mock_with :rr" do
+      o = Object.new
+      mock(o) do |m|
+        m.msg("arg")
+      end
+      o.msg
+    end
+  end
+end

data/examples/failing/partial_mock_example.rb

@@ -0,0 +1,18 @@
+class MockableClass
+  def self.find id
+    return :original_return
+  end
+end
+
+describe "A partial mock" do
+
+  it "should work at the class level (but fail here due to the type mismatch)" do
+    MockableClass.should_receive(:find).with(1).and_return {:stub_return}
+    MockableClass.find("1").should equal(:stub_return)
+  end
+
+  it "should revert to the original after each spec" do
+    MockableClass.find(1).should equal(:original_return)
+  end
+
+end

data/examples/failing/pending_example.rb

@@ -0,0 +1,7 @@
+describe "pending example (which is fixed)" do
+  it %Q|reports "FIXED ... Expected ... to fail.  No Error was raised."| do
+    pending("for some reason") do
+      # success
+    end
+  end
+end

data/examples/failing/predicate_example.rb

@@ -0,0 +1,32 @@
+class BddFramework
+  def intuitive?
+    true
+  end
+
+  def adopted_quickly?
+    #this will cause failures because it reallly SHOULD be adopted quickly
+    false
+  end
+end
+
+describe "BDD framework" do
+
+  before(:each) do
+    @bdd_framework = BddFramework.new
+  end
+
+  it "should be adopted quickly" do
+    #this will fail because it reallly SHOULD be adopted quickly
+    @bdd_framework.should be_adopted_quickly
+  end
+
+  it "should be intuitive" do
+    @bdd_framework.should be_intuitive
+  end
+
+  it "should not respond to test" do
+    #this will fail
+    @bdd_framework.test
+  end
+
+end

data/examples/failing/raising_example.rb

@@ -0,0 +1,47 @@
+describe "This example" do
+  
+  it "should show that a NoMethodError is raised but an Exception was expected" do
+    proc { ''.nonexistent_method }.should raise_error
+  end
+  
+  it "should pass" do
+    proc { ''.nonexistent_method }.should raise_error(NoMethodError)
+  end
+  
+  it "should show that a NoMethodError is raised but a SyntaxError was expected" do
+    proc { ''.nonexistent_method }.should raise_error(SyntaxError)
+  end
+  
+  it "should show that nothing is raised when SyntaxError was expected" do
+    proc { }.should raise_error(SyntaxError)
+  end
+
+  it "should show that a NoMethodError is raised but a Exception was expected" do
+    proc { ''.nonexistent_method }.should_not raise_error
+  end
+  
+  it "should show that a NoMethodError is raised" do
+    proc { ''.nonexistent_method }.should_not raise_error(NoMethodError)
+  end
+  
+  it "should also pass" do
+    proc { ''.nonexistent_method }.should_not raise_error(SyntaxError)
+  end
+  
+  it "should show that a NoMethodError is raised when nothing expected" do
+    proc { ''.nonexistent_method }.should_not raise_error(Exception)
+  end
+  
+  it "should show that the wrong message was received" do
+    proc { raise StandardError.new("what is an enterprise?") }.should raise_error(StandardError, "not this")
+  end
+  
+  it "should show that the unexpected error/message was thrown" do
+    proc { raise StandardError.new("abc") }.should_not raise_error(StandardError, "abc")
+  end
+  
+  it "should pass too" do
+    proc { raise StandardError.new("abc") }.should_not raise_error(StandardError, "xyz")
+  end
+  
+end

data/examples/failing/syntax_error_example.rb

@@ -0,0 +1,7 @@
+describe "when passing a block to a matcher" do
+  it "you should use {} instead of do/end" do
+    Object.new.should satisfy do
+      "this block is being passed to #should instead of #satisfy - use {} instead"
+    end
+  end
+end

data/examples/failing/team_spec.rb

@@ -0,0 +1,41 @@
+class Team
+  attr_reader :players
+  def initialize
+    @players = Players.new
+  end
+end
+
+class Players
+  def initialize
+    @players = []
+  end
+  def size
+    @players.size
+  end
+  def include? player
+    raise "player must be a string" unless player.is_a?(String)
+    @players.include? player
+  end
+end
+
+describe "A new team" do
+  
+  before(:each) do
+    @team = Team.new
+  end
+  
+  it "should have 3 players (failing example)" do
+    @team.should have(3).players
+  end
+  
+  it "should include some player (failing example)" do
+    @team.players.should include("Some Player")
+  end
+
+  it "should include 5 (failing example)" do
+    @team.players.should include(5)
+  end
+  
+  it "should have no players"
+  
+end

data/examples/failing/timeout_behaviour.rb

@@ -0,0 +1,5 @@
+describe "Something really slow" do
+  it "should be failed by RSpec when it takes longer than --timeout" do
+    sleep(2)
+  end
+end

data/examples/{custom_formatter.rb → passing/custom_formatter.rb}

@@ -1,7 +1,7 @@
 require 'spec/runner/formatter/progress_bar_formatter'
 
 # Example of a formatter with custom bactrace printing. Run me with:
-# ruby bin/spec failing_examples -r examples/custom_formatter.rb -f CustomFormatter
+# ruby bin/spec examples/failing -r examples/passing/custom_formatter.rb -f CustomFormatter
 class CustomFormatter < Spec::Runner::Formatter::ProgressBarFormatter
   def backtrace_line(line)
     line.gsub(/([^:]*\.rb):(\d*)/) do

data/examples/passing/dynamic_spec.rb

@@ -0,0 +1,7 @@
+describe "The square root" do
+  (1..10).each do |n|
+    it "of #{n*n} should be #{n}" do
+      Math.sqrt(n*n).should == n
+    end
+  end
+end

data/examples/{file_accessor.rb → passing/file_accessor.rb}

@@ -1,18 +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
+class FileAccessor
+  def open_and_handle_with(pathname, processor)
+    pathname.open do |io|
+      processor.process(io)
+    end
+  end
+end
+
+if __FILE__ == $0
+  require 'examples/passing/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 → passing/file_accessor_spec.rb}

@@ -1,38 +1,37 @@
-require File.dirname(__FILE__) + '/spec_helper'
-require File.dirname(__FILE__) + '/file_accessor'
-require 'stringio'
-
-describe "A FileAccessor" do
-  # This sequence diagram illustrates what this spec specifies.
-  #
-  #                  +--------------+     +----------+     +-------------+
-  #                  | FileAccessor |     | Pathname |     | IoProcessor |
-  #                  +--------------+     +----------+     +-------------+
-  #                         |                  |                  |
-  #   open_and_handle_with  |                  |                  |
-  #   -------------------->| |           open  |                  |
-  #                        | |--------------->| |                 |
-  #                        | | io             | |                 |
-  #                        | |<...............| |                 |
-  #                        | |                 |     process(io)  |
-  #                        | |---------------------------------->| |
-  #                        | |                 |                 | |
-  #                        | |<..................................| |
-  #                         |                  |                  |
-  #
-  it "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
+require 'examples/passing/file_accessor'
+require 'stringio'
+
+describe "A FileAccessor" do
+  # This sequence diagram illustrates what this spec specifies.
+  #
+  #                  +--------------+     +----------+     +-------------+
+  #                  | FileAccessor |     | Pathname |     | IoProcessor |
+  #                  +--------------+     +----------+     +-------------+
+  #                         |                  |                  |
+  #   open_and_handle_with  |                  |                  |
+  #   -------------------->| |           open  |                  |
+  #                        | |--------------->| |                 |
+  #                        | | io             | |                 |
+  #                        | |<...............| |                 |
+  #                        | |                 |     process(io)  |
+  #                        | |---------------------------------->| |
+  #                        | |                 |                 | |
+  #                        | |<..................................| |
+  #                         |                  |                  |
+  #
+  it "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/passing/filtered_formatter.rb

@@ -0,0 +1,17 @@
+require 'spec/runner/formatter/nested_text_formatter'
+
+class FilteredFormatter < Spec::Runner::Formatter::NestedTextFormatter
+  def add_example_group(example_group)
+    if example_group.options[:show] == false
+      @showing = false
+    else
+      @showing = true
+      puts example_group.description 
+    end
+  end
+  
+  def example_passed(example)
+    puts "  " << example.description if @showing unless example.options[:show] == false
+  end
+end
+

data/examples/passing/filtered_formatter_example.rb

@@ -0,0 +1,31 @@
+# This demonstrates how you can write custom formatters to handle arbitrary
+# options passed to the +describe+ and +it+ methods. To see it in action, stand
+# in the project root and say:
+# 
+#   bin/spec -r examples/passing/filtered_formatter.rb examples/passing/filtered_formatter_example.rb -f FilteredFormatter
+#   
+# You should only see the examples and groups below that are not explicitly
+# marked :show => false
+#
+#   group 1
+#     example 1 a
+#   group 3
+#     example 3
+
+
+describe "group 1", :show => true do
+  it "example 1 a", :show => true do
+  end
+  it "example 1 b", :show => false do
+  end
+end
+
+describe "group 2", :show => false do
+  it "example 2" do
+  end
+end
+
+describe "group 3" do
+  it "example 3" do
+  end
+end

data/examples/{greeter_spec.rb → passing/greeter_spec.rb}

@@ -27,4 +27,4 @@ describe "Greeter" do
     # Uncomment the next line to make Heckle happy
     #greeter.greet.should == "Hi there!"
   end
-end
+end

data/examples/passing/helper_method_example.rb

@@ -0,0 +1,12 @@
+module HelperMethodExample
+  describe "an example group with helper a method" do
+    def helper_method
+      "received call"
+    end
+  
+    it "should make that method available to specs" do
+      helper_method.should == "received call"
+    end
+  end
+end
+

data/examples/passing/implicit_docstrings_example.rb

@@ -0,0 +1,16 @@
+# Run "spec implicit_docstrings_example.rb --format specdoc" to see the output of this file
+
+describe "Examples with no docstrings generate their own:" do
+
+  specify { 3.should be < 5 }
+
+  specify { ["a"].should include("a") }
+
+  specify { [1,2,3].should respond_to(:size) }
+
+end
+
+describe 1 do
+  it { should == 1 }
+  it { should be < 2}
+end

data/examples/{io_processor.rb → passing/io_processor.rb}

@@ -1,8 +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
+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 → passing/io_processor_spec.rb}

@@ -1,5 +1,4 @@
-require File.dirname(__FILE__) + '/spec_helper'
-require File.dirname(__FILE__) + '/io_processor'
+require 'examples/passing/io_processor'
 require 'stringio'
 
 describe "An IoProcessor" do
@@ -18,4 +17,4 @@ describe "An IoProcessor" do
       @processor.process(StringIO.new("z"*31))
     }.should raise_error(DataTooShort)
   end
-end
+end

data/examples/{mocking_example.rb → passing/mocking_example.rb}

@@ -1,5 +1,3 @@
-require File.dirname(__FILE__) + '/spec_helper'
-
 describe "A consumer of a mock" do
   it "should be able to send messages to the mock" do
     mock = mock("poke me")