rspec 1.2.0 → 1.2.1

data/.document

@@ -1,7 +1,7 @@
 features/**/*.feature
 lib/**/*.rb
-History.txt
+History.rdoc
 License.txt
-README.txt
-Ruby1.9.markdown
-Upgrade.markdown
+README.rdoc
+Ruby1.9.rdoc
+Upgrade.rdoc

data/{History.txt → History.rdoc}

@@ -1,6 +1,27 @@
-=== Version 1.2.0
+=== Version 1.2.1 / 2009-03-22
+
+* enhancments
+
+  * matchers, including the new DSL, easily added to your test/unit tests
+  * added support for 0 to n args in matcher DSL
+  * restored loading rubygems when necessary
+    * if you really don't want to use rubygems, you
+      can set an NO_RUBYGEMS environment
+      variable, and RSpec won't force it on you.
+  * added -u/--debugger option (Rick DeNatale) #262.
+    * just add "debugger" anywhere in your code and run spec path/to/code --debugger
+  * rename ExampleDescription to ExampleProxy
+  * pass ExampleProxy to example_started(). Closes #738, #743
+    * thanks to Tobias Grimm (Eclipse) fort the patch and Roman Chernyatchik
+      (JetBrains, RubyMine) for the assist
+  
+* bug fixes
+
+  * subject (implicit or explicit) is now properly inherited by nested groups. Closes #744.
 
-WARNINGS:
+=== Version 1.2.0 / 2009-03-15
+
+* 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
@@ -20,11 +41,13 @@ WARNINGS:
     matchers, or using extension libraries that do, this should not affect
     you. If you run into trouble, you'll just need to change:
     
-    * failure_message          => failure_message_for_should
-    * negative_failure_message => failure_message_for_should_not
+      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.
   
+    * NOTE that they have been restored in 1.2.1, above
+  
     * See http://gist.github.com/54177 for rationale and suggestions on
       alternative approaches to loading rubygems
 

data/Manifest.txt

@@ -1,13 +1,13 @@
 .autotest
 .document
-History.txt
+History.rdoc
 License.txt
 Manifest.txt
-README.txt
+README.rdoc
 Rakefile
-Ruby1.9.markdown
+Ruby1.9.rdoc
 TODO.txt
-Upgrade.markdown
+Upgrade.rdoc
 bin/autospec
 bin/spec
 cucumber.yml
@@ -66,12 +66,15 @@ features/interop/examples_and_tests_together.feature
 features/interop/test_but_not_test_unit.feature
 features/interop/test_case_with_should_methods.feature
 features/matchers/create_matcher.feature
+features/matchers/create_matcher_outside_rspec.feature
 features/mock_framework_integration/use_flexmock.feature
 features/mock_framework_integration/use_mocha.feature
 features/mock_framework_integration/use_rr.feature
 features/mocks/mix_stubs_and_mocks.feature
 features/pending/pending_examples.feature
 features/step_definitions/running_rspec.rb
+features/subject/explicit_subject.feature
+features/subject/implicit_subject.feature
 features/support/env.rb
 features/support/matchers/smart_match.rb
 init.rb
@@ -85,17 +88,17 @@ lib/spec/adapters/mock_frameworks/rspec.rb
 lib/spec/autorun.rb
 lib/spec/dsl.rb
 lib/spec/dsl/main.rb
-lib/spec/dsl/matchers.rb
 lib/spec/example.rb
 lib/spec/example/before_and_after_hooks.rb
 lib/spec/example/errors.rb
-lib/spec/example/example_description.rb
 lib/spec/example/example_group.rb
 lib/spec/example/example_group_factory.rb
 lib/spec/example/example_group_hierarchy.rb
 lib/spec/example/example_group_methods.rb
+lib/spec/example/example_group_proxy.rb
 lib/spec/example/example_matcher.rb
 lib/spec/example/example_methods.rb
+lib/spec/example/example_proxy.rb
 lib/spec/example/module_reopening_fix.rb
 lib/spec/example/pending.rb
 lib/spec/example/predicate_matchers.rb
@@ -103,6 +106,7 @@ lib/spec/example/shared_example_group.rb
 lib/spec/example/subject.rb
 lib/spec/expectations.rb
 lib/spec/expectations/differs/default.rb
+lib/spec/expectations/differs/load-diff-lcs.rb
 lib/spec/expectations/errors.rb
 lib/spec/expectations/extensions.rb
 lib/spec/expectations/extensions/object.rb
@@ -120,6 +124,7 @@ lib/spec/matchers/be_instance_of.rb
 lib/spec/matchers/be_kind_of.rb
 lib/spec/matchers/change.rb
 lib/spec/matchers/compatibility.rb
+lib/spec/matchers/dsl.rb
 lib/spec/matchers/eql.rb
 lib/spec/matchers/equal.rb
 lib/spec/matchers/errors.rb
@@ -134,6 +139,7 @@ lib/spec/matchers/match_array.rb
 lib/spec/matchers/matcher.rb
 lib/spec/matchers/method_missing.rb
 lib/spec/matchers/operator_matcher.rb
+lib/spec/matchers/pretty.rb
 lib/spec/matchers/raise_error.rb
 lib/spec/matchers/respond_to.rb
 lib/spec/matchers/satisfy.rb
@@ -165,6 +171,7 @@ lib/spec/runner/command_line.rb
 lib/spec/runner/configuration.rb
 lib/spec/runner/drb_command_line.rb
 lib/spec/runner/example_group_runner.rb
+lib/spec/runner/extensions/kernel.rb
 lib/spec/runner/formatter/base_formatter.rb
 lib/spec/runner/formatter/base_text_formatter.rb
 lib/spec/runner/formatter/failing_example_groups_formatter.rb
@@ -204,19 +211,21 @@ spec/rspec_suite.rb
 spec/ruby_forker.rb
 spec/spec.opts
 spec/spec/dsl/main_spec.rb
-spec/spec/dsl/matchers_spec.rb
 spec/spec/example/example_group_class_definition_spec.rb
 spec/spec/example/example_group_factory_spec.rb
 spec/spec/example/example_group_methods_spec.rb
+spec/spec/example/example_group_proxy_spec.rb
 spec/spec/example/example_group_spec.rb
 spec/spec/example/example_matcher_spec.rb
 spec/spec/example/example_methods_spec.rb
+spec/spec/example/example_proxy_spec.rb
 spec/spec/example/helper_method_spec.rb
 spec/spec/example/nested_example_group_spec.rb
 spec/spec/example/pending_module_spec.rb
 spec/spec/example/predicate_matcher_spec.rb
 spec/spec/example/shared_example_group_spec.rb
 spec/spec/example/subclassing_example_group_spec.rb
+spec/spec/example/subject_spec.rb
 spec/spec/expectations/differs/default_spec.rb
 spec/spec/expectations/extensions/object_spec.rb
 spec/spec/expectations/fail_with_spec.rb
@@ -241,6 +250,7 @@ spec/spec/matchers/be_spec.rb
 spec/spec/matchers/change_spec.rb
 spec/spec/matchers/compatibility_spec.rb
 spec/spec/matchers/description_generation_spec.rb
+spec/spec/matchers/dsl_spec.rb
 spec/spec/matchers/eql_spec.rb
 spec/spec/matchers/equal_spec.rb
 spec/spec/matchers/exist_spec.rb
@@ -251,6 +261,7 @@ spec/spec/matchers/match_array_spec.rb
 spec/spec/matchers/match_spec.rb
 spec/spec/matchers/matcher_methods_spec.rb
 spec/spec/matchers/matcher_spec.rb
+spec/spec/matchers/matchers_spec.rb
 spec/spec/matchers/operator_matcher_spec.rb
 spec/spec/matchers/raise_error_spec.rb
 spec/spec/matchers/respond_to_spec.rb

data/Rakefile

@@ -1,18 +1,13 @@
 # -*- ruby -*-
+gem 'hoe', '>=1.9.0'
+require 'hoe'
 
 $:.unshift(File.join(File.dirname(__FILE__), 'lib'))
-require 'hoe'
+
 require 'spec/version'
 require 'spec/rake/spectask'
 require 'cucumber/rake/task'
 
-class Hoe
-  def extra_deps
-    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
-    @extra_deps
-  end
-end
-
 Hoe.new('rspec', Spec::VERSION::STRING) do |p|
   p.summary = Spec::VERSION::SUMMARY
   p.url = 'http://rspec.info/'
@@ -22,6 +17,18 @@ Hoe.new('rspec', Spec::VERSION::STRING) do |p|
   p.extra_dev_deps = [["cucumber",">= 0.1.13"]]
   p.remote_rdoc_dir = "rspec/#{Spec::VERSION::STRING}"
   p.rspec_options = ['--options', 'spec/spec.opts']
+  p.history_file = 'History.rdoc'
+  p.readme_file  = 'README.rdoc'
+  p.post_install_message = <<-POST_INSTALL_MESSAGE
+#{'*'*50}
+
+  Thank you for installing rspec-#{Spec::VERSION::STRING}
+
+  Please be sure to read History.rdoc and Upgrade.rdoc
+  for useful information about this release.
+
+#{'*'*50}
+POST_INSTALL_MESSAGE
 end
 
 ['audit','test','test_deps','default','post_blog'].each do |task|
@@ -47,7 +54,7 @@ namespace :spec do
     t.spec_opts = ['--options', 'spec/spec.opts']
     t.rcov = true
     t.rcov_dir = 'coverage'
-    t.rcov_opts = ['--exclude', "instance_exec\.rb,lib/spec.rb,lib/spec/runner.rb,spec/spec,bin/spec,examples,/gems,/Library/Ruby,\.autotest,#{ENV['GEM_HOME']}"]
+    t.rcov_opts = ['--exclude', "kernel,load-diff-lcs\.rb,instance_exec\.rb,lib/spec.rb,lib/spec/runner.rb,spec/spec,bin/spec,examples,/gems,/Library/Ruby,\.autotest,#{ENV['GEM_HOME']}"]
   end
 end
 

data/{Ruby1.9.markdown → Ruby1.9.rdoc}

@@ -1,13 +1,13 @@
-# RSpec and Ruby 1.9
+= 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
+== Test::Unit
 
 RSpec/Test::Unit interop will run with the test-unit-1.2.3 gem, but you must install it.
 
-## Class Variables
+== Class Variables
 
 Due to changes in scoping rules, class variables within example groups are not
 supported in Ruby 1.9.

data/TODO.txt

@@ -1,7 +1,5 @@
 == Refactoring
 
-Refactoring for 1.2.0
-
 ** 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
@@ -13,11 +11,6 @@ Refactoring for 1.2.0
   * 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'

data/Upgrade.rdoc

@@ -0,0 +1,110 @@
+= Upgrade to rspec-1.2.1 (in dev)
+
+== What's Changed
+
+=== <tt>require 'rubygems' unless ENV['NO_RUBYGEMS']</tt>
+
+After minor public outcry and confusion, we restored necessary references to
+rubygems in rspec. If you use a different mechanism for managing gems, just
+set a <tt>NO_RUBYGEMS</tt> environment variable (to any non-nil value).
+
+=== Proxies and locations
+
+This is probably only interesting to you if you use custom formatters.
+
+Formatters now receive Spec::Example::ExampleGroupProxy and
+Spec::Example::ExampleGroup objects with cohesive APIs for reporting. See the
+RDoc for those classes and Spec::Runner::Formatter::BaseFormatter for more
+information.
+
+== What's new
+
+=== The new matcher DSL works with test/unit (without the rest of rspec)
+
+We'll be separating this out to its own gem for rspec 2.0, but for now, just install
+rspec >= 1.2.1 and add the following to your <tt>test_helper</tt> file:
+  
+    require 'spec/expectations'
+    class Test::Unit::TestCase
+      include Spec::Matchers
+    end
+    
+This will add <tt>should()</tt> and <tt>should_not()</tt> to your objects, make all of
+rspec's built-in matchers available to your tests, INCLUDING rspec's DSL for
+creating matchers (see below, under Upgrade to rspec-1.2.0)
+
+=== debugger
+
+If you have ruby-debug installed, you can set a breakpoint by adding <tt>debugger()</tt>
+in your code:
+
+    # some code .....
+    debugger
+    # some more code ....
+    
+... and using the <tt>--debugger</tt> or <tt>-u</tt> command line option.
+
+    spec path/to/file.rb --debugger
+    
+= 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
+for useful information.
+
+=== Improved heckle integration
+
+RSpec works with heckle again! 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 <tt>features/matchers/create_matcher.feature</tt> for more examples

data/features/matchers/create_matcher.feature

@@ -113,3 +113,43 @@ Feature: custom matcher shortcut
     And the stdout should match "2 examples, 0 failures"
     And the stdout should match "should be multiple of 3"
     And the stdout should match "should not be multiple of 4"
+
+  Scenario: with no args
+    Given the following spec:
+      """
+      Spec::Matchers.create :have_7_fingers do
+        match do |thing|
+          thing.fingers.length == 7
+        end
+      end
+      
+      class Thing
+        def fingers; (1..7).collect {"finger"}; end
+      end
+
+      describe Thing do
+        it {should have_7_fingers}
+      end
+      """
+    When I run it with the spec command --format specdoc
+    Then the exit code should be 0
+    And the stdout should match "1 example, 0 failures"
+    And the stdout should match "should have 7 fingers"
+  
+  Scenario: with multiple args
+    Given the following spec:
+      """
+      Spec::Matchers.create :be_the_sum_of do |a,b,c,d|
+        match do |sum|
+          a + b + c + d == sum
+        end
+      end
+
+      describe 10 do
+        it {should be_the_sum_of(1,2,3,4)}
+      end
+      """
+    When I run it with the spec command --format specdoc
+    Then the exit code should be 0
+    And the stdout should match "1 example, 0 failures"
+    And the stdout should match "should be the sum of 1, 2, 3, and 4"

data/features/matchers/create_matcher_outside_rspec.feature

@@ -0,0 +1,39 @@
+Feature: custom matcher shortcut
+
+  In order to express my domain clearly in my code examples
+  As a non-rspec user
+  I want a shortcut for create custom matchers
+
+  Scenario: creating a matcher with default messages
+    Given a file named test_multiples.rb with:
+      """
+      $:.unshift File.join(File.dirname(__FILE__), "/../lib")
+      require 'test/unit'
+      require 'spec/expectations'
+      
+      Spec::Matchers.create :be_a_multiple_of do |expected|
+        match do |actual|
+          actual % expected == 0
+        end
+      end
+      
+      class Test::Unit::TestCase
+        include Spec::Matchers
+      end
+      
+      class TestMultiples < Test::Unit::TestCase
+      
+        def test_9_should_be_a_multiple_of_3
+          9.should be_a_multiple_of(3)
+        end
+
+        def test_9_should_be_a_multiple_of_4
+          9.should be_a_multiple_of(4)
+        end
+        
+      end
+      """
+    When I run it with the ruby interpreter
+    Then the exit code should be 256
+    And the stdout should match "expected 9 to be a multiple of 4"
+    And the stdout should match "2 tests, 0 assertions, 1 failures, 0 errors"