rspec 1.1.12 → 1.2.0

data/Ruby1.9.markdown

@@ -0,0 +1,32 @@
+# RSpec and Ruby 1.9
+
+Currently, RSpec (core) is mostly compatible with Ruby 1.9.1. There are still
+outstanding issues, some of which we plan to address and some we don't.
+
+## Test::Unit
+
+RSpec/Test::Unit interop will run with the test-unit-1.2.3 gem, but you must install it.
+
+## Class Variables
+
+Due to changes in scoping rules, class variables within example groups are not
+supported in Ruby 1.9.
+
+    describe "a class variable" do
+      @@class_variable = "a class variable"
+  
+      it "can access class variables in examples in Ruby 1.8" do
+        with_ruby 1.8 do
+          @@class_variable.should == "a class variable"
+        end
+      end
+  
+      it "can NOT access class variables in examples in Ruby 1.9" do
+        with_ruby 1.9 do
+          lambda do
+            @@class_variable.should == "a class variable"
+          end.should raise_error(NameError)
+        end
+      end
+    end
+

data/TODO.txt

@@ -2,7 +2,6 @@
 
 Refactoring for 1.2.0
 
-* eliminate dependency from Spec::Example to Spec::Runner
 ** global predictate matchers should be stored in run_options
 * eliminate dependency on global options and configuration
 ** the only place they should exist is in the Runner, which should manage them
@@ -10,9 +9,16 @@ Refactoring for 1.2.0
 == Future
 
 * do SOMETHING with the website
-* extract spec/story to rspec-stories (new gem)
-* rename top level namespace to Rspec and commands to 'rspec' and 'autorspec'
-  * continue to support Spec 'spec' and 'autospec' as aliases for a reasonable time
 * separate the underlying framework from the DSL
   * be able to do everything with classes and methods
 * tweak raise_error rdoc to show only one arg
+
+== Ruby 1.9.1
+
+* one example remains failing
+* cucumber isn't working yet
+
+== rspec-2.0
+
+* rename top level namespace to Rspec and commands to 'rspec' and 'autorspec'
+  * continue to support Spec 'spec' and 'autospec' as aliases for a reasonable time

data/Upgrade.markdown

@@ -0,0 +1,63 @@
+# Upgrade to rspec-1.2.0
+
+## What's Changed
+
+### WARNINGS
+
+* If you use the ruby command to run specs instead of the spec command, you'll
+  need to require 'spec/autorun' or they won't run. This won't affect you if
+  you use the spec command or the Spec::Rake::SpecTask that ships with RSpec.
+
+* require 'spec/test/unit' to invoke test/unit interop if you're using
+  RSpec's core (this is handled implicitly with spec-rails)
+
+* setup and teardown are gone - use before and after instead
+
+  * you can still use setup and teardown if you're using
+    Test::Unit::TestCase as the base ExampleGroup class (which is implicit
+    in rspec-rails)
+
+* The matcher protocol has been improved. The old protocol is still supported,
+  but we added support for two new methods that speak a bit more clearly:
+  
+  * ``failure_message          => failure_message_for_should``
+  * ``negative_failure_message => failure_message_for_should_not``
+
+* All references to rubygems have been removed from within rspec's code.
+
+  * See http://gist.github.com/54177 for rationale and suggestions on
+    alternative approaches to loading rubygems
+
+## What's new
+
+### Ruby 1.9
+
+RSpec now works with Ruby 1.9.1. See
+[http://wiki.github.com/dchelimsky/rspec/ruby-191](http://wiki.github.com/dchelimsky/rspec/ruby-191)
+for useful information.
+
+### Improved heckle integration
+
+RSpec works with heckle again [1]! Gotta use heckle >= 1.4.2 for this to work
+though, and it only works with ruby-1.8.6 and 1.8.7 (heckle doesn't support
+1.9.1 yet).
+
+    [sudo] gem install heckle --version ">=1.4.2"
+    spec spec/game/mastermind.rb --heckle Game::Mastermind
+
+### New Matcher DSL
+
+We've added a new DSL for generating custom matchers very simply and cleanly.
+We'll still support the simple_matcher method, so never fear if you're using
+that, but we recommend that you start developing your new matchers with this
+new syntax.
+
+    Spec::Matchers.create do :be_a_multiple_of |smaller|
+      match do |bigger|
+        bigger % smaller == 0
+      end
+    end
+
+    9.should be_a_multiple_of(3)
+
+See ``features/matchers/create_matcher_.feature`` for more examples

data/bin/spec

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

data/cucumber.yml

@@ -0,0 +1,3 @@
+default: --require features features
+pending: --require features features-pending
+no_heckle: --require features features --exclude heckle

data/examples/failing/pending_example.rb

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+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/spec_helper.rb

@@ -1,3 +1,3 @@
 lib_path = File.expand_path(File.dirname(__FILE__) + "/../../lib")
 $LOAD_PATH.unshift lib_path unless $LOAD_PATH.include?(lib_path)
-require "spec"
+require 'spec/autorun'

data/examples/passing/filtered_formatter.rb

@@ -0,0 +1,18 @@
+$:.unshift File.join(File.dirname(__FILE__), "/../../lib")
+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/passing/implicit_docstrings_example.rb

@@ -0,0 +1,18 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+# 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/passing/spec_helper.rb

@@ -1,3 +1,3 @@
 lib_path = File.expand_path("#{File.dirname(__FILE__)}/../../lib")
 $LOAD_PATH.unshift lib_path unless $LOAD_PATH.include?(lib_path)
-require 'spec'
+require 'spec/autorun'

data/examples/ruby1.9.compatibility/access_to_constants_spec.rb

@@ -12,33 +12,33 @@ module Foo
     def method_in_enclosing_module;end
     CONSTANT_IN_ENCLOSING_MODULE = 0
 
-    describe "Examples trying to access constants defined in an enclosing module" do 
+    describe "Examples trying to access constants defined in an enclosing module" do
 
-      it "can access Modules" do 
+      it "can access Modules" do
         ModuleInEnclosingModule
       end
-      it "can access Classes" do 
+      it "can access Classes" do
         ClassInEnclosingModule.new
       end
-      it "can access CONSTANTS" do 
+      it "can access CONSTANTS" do
         CONSTANT_IN_ENCLOSING_MODULE
       end
-      it "can NOT access methods" do 
+      it "can NOT access methods" do
         lambda {method_in_enclosing_module}.should raise_error(/undefined/)
       end
 
-      describe "from a nested example group" do 
+      describe "from a nested example group" do
 
-        it "can access Modules" do 
+        it "can access Modules" do
           ModuleInEnclosingModule
         end
-        it "can access Classes" do 
+        it "can access Classes" do
           ClassInEnclosingModule.new
         end
-        it "can access CONSTANTS" do 
+        it "can access CONSTANTS" do
           CONSTANT_IN_ENCLOSING_MODULE
         end
-        it "can NOT access methods" do 
+        it "can NOT access methods" do
           lambda {method_in_enclosing_module}.should raise_error(/undefined/)
         end
 
@@ -46,7 +46,7 @@ module Foo
 
     end
     
-    describe "Examples trying to access constants defined in the example group" do 
+    describe "Examples trying to access constants defined in the example group" do
       
       module ModuleDefinedInGroup;end
       class ClassDefinedInGroup; end 
@@ -56,13 +56,13 @@ module Foo
       it "can access Modules" do
         ModuleDefinedInGroup
       end
-      it "can access Classes" do 
+      it "can access Classes" do
         ClassDefinedInGroup.new
       end
-      it "can access CONSTANTS" do 
+      it "can access CONSTANTS" do
         CONSTANT_DEFINED_IN_GROUP
       end
-      it "can access methods" do 
+      it "can access methods" do
         method_defined_in_group
       end
       
@@ -70,17 +70,16 @@ module Foo
         it "can access Modules" do
           ModuleDefinedInGroup
         end
-        it "can access Classes" do 
+        it "can access Classes" do
           ClassDefinedInGroup.new
         end
-        it "can access CONSTANTS" do 
+        it "can access CONSTANTS" do
           CONSTANT_DEFINED_IN_GROUP
         end
-        it "can access methods" do 
+        it "can access methods" do
           method_defined_in_group
         end
       end
     end 
   end 
 end
-

data/features/before_and_after_blocks/before_and_after_blocks.feature

@@ -57,7 +57,7 @@ Feature: before and after blocks
         end
       end
       """
-  	When I run it with the spec script
+  	When I run it with the spec command
     Then the stdout should match "3 examples, 0 failures"
   
   Scenario: define before(:all) block in example group
@@ -89,7 +89,7 @@ Feature: before and after blocks
         end
       end
       """
-  	When I run it with the spec script
+  	When I run it with the spec command
     Then the stdout should match "3 examples, 0 failures"
   
   Scenario: define before and after blocks in configuration
@@ -125,7 +125,7 @@ Feature: before and after blocks
         end
       end
       """
-    When I run it with the spec script
+    When I run it with the spec command
     Then the stdout should match "3 examples, 0 failures"
 
   Scenario: before/after blocks are run in order
@@ -163,6 +163,6 @@ Feature: before and after blocks
       end
       """
 
-    When I run it with the spec script
+    When I run it with the spec command
     Then the stdout should match /before suite\nbefore all\nbefore each\nafter each\n\.after all\n.*after suite/m
 

data/features/example_groups/example_group_with_should_methods.feature

@@ -12,6 +12,6 @@ Feature: Spec::ExampleGroup with should methods
 
   Scenario: Run with spec
   Given the file ../../resources/spec/example_group_with_should_methods.rb
-    When I run it with the spec script
+    When I run it with the spec command
     Then the exit code should be 256
     And the stdout should match "2 examples, 1 failure"

data/features/example_groups/{autogenerated_docstrings.feature → implicit_docstrings.feature}

@@ -1,21 +1,20 @@
-Feature: autogenerated docstrings
+Feature: implicit docstrings
 
   As an RSpec user
   I want examples to generate their own names
   So that I can reduce duplication between example names and example code
 
   Scenario: run passing examples with ruby
-    Given the file ../../examples/passing/autogenerated_docstrings_example.rb
+    Given the file ../../examples/passing/implicit_docstrings_example.rb
 
     When I run it with the ruby interpreter -fs
 
-    Then the stdout should match /should equal 5/
     And the stdout should match /should be < 5/
     And the stdout should match /should include "a"/
     And the stdout should match /should respond to #size/
 
   Scenario: run failing examples with ruby
-    Given the file ../../examples/failing/failing_autogenerated_docstrings_example.rb
+    Given the file ../../examples/failing/failing_implicit_docstrings_example.rb
 
     When I run it with the ruby interpreter -fs
 
@@ -25,19 +24,18 @@ Feature: autogenerated docstrings
     And the stdout should match /should not respond to #size/
 
   Scenario: run passing examples with spec
-    Given the file ../../examples/passing/autogenerated_docstrings_example.rb
+    Given the file ../../examples/passing/implicit_docstrings_example.rb
 
-    When I run it with the spec script -fs
+    When I run it with the spec command -fs
 
-    Then the stdout should match /should equal 5/
     And the stdout should match /should be < 5/
     And the stdout should match /should include "a"/
     And the stdout should match /should respond to #size/
 
   Scenario: run failing examples with spec
-    Given the file ../../examples/failing/failing_autogenerated_docstrings_example.rb
+    Given the file ../../examples/failing/failing_implicit_docstrings_example.rb
 
-    When I run it with the spec script -fs
+    When I run it with the spec command -fs
 
     Then the stdout should match /should equal 2/
     And the stdout should match /should be > 5/

data/features/example_groups/nested_groups.feature

@@ -12,6 +12,6 @@ Feature: Nested example groups
 
   Scenario: Run with spec
     Given the file ../../examples/passing/stack_spec_with_nested_example_groups.rb
-    When I run it with the spec script -fs
+    When I run it with the spec command -fs
     Then the stdout should match /Stack \(empty\)/
     And the stdout should match /Stack \(full\)/

data/features/heckle/heckle.feature

@@ -0,0 +1,56 @@
+Feature: heckle a class
+
+  As an RSpec user who wants to verify that
+    my specs cover what I think it covers
+  I want to heckle a class
+
+  Scenario: Heckle finds problems
+    Given the following spec:
+      """
+      class Thing
+        def a_or_b
+          if true
+            "a"
+          else
+            "b"
+          end
+        end
+      end
+      
+      describe Thing do
+        it "returns a for true" do
+          Thing.new.a_or_b.should == "a"
+        end
+      end
+      """
+    When I run it with the spec command --heckle Thing
+    Then the stdout should match "The following mutations didn't cause test failures:"
+    But the stdout should not match "FAILED"
+    
+  Scenario: Heckle does not find a problem
+    Given the following spec:
+      """
+      class Thing
+        def a_or_b(key)
+          if key
+            "a"
+          else
+            "b"
+          end
+        end
+      end
+
+      describe Thing do
+        it "returns a for true" do
+          Thing.new.a_or_b(true).should == "a"
+        end
+
+        it "returns b for false" do
+          Thing.new.a_or_b(false).should == "b"
+        end
+      end
+      """
+    When I run it with the spec command --heckle Thing
+    Then the stdout should match "No mutants survived"
+    But the stdout should not match "FAILED"
+