rspec 0.6.4 → 0.7.0

data/CHANGES

@@ -1,10 +1,99 @@
 = RSpec Changelog
 
+== Version 0.7.0 (in SVN)
+
+This is the "Grow up and eat your own dog food release". RSpec is now used on itself and
+we're no longer using Test::Unit to test it. Although, we are still extending Test::Unit
+for the rails plugin (indirectly - through ZenTest)
+
+IMPORTANT NOTE: THIS RELEASE IS NOT 100% BACKWARDS COMPATIBLE TO 0.6.x
+
+There are a few changes that will require that you change your existing specs.
+
+--------------------------------------------------
+RSpec now handles equality exactly like ruby does:
+
+# actual.should_equal(expected) will pass if actual.equal?(expected) returns true
+# actual.should_eql(expected) will pass if actual.eql?(expected) returns true
+# actual.should == expected will pass if actual == expected) returns true
+
+At the high level, eql? implies equivalence, while equal? implies object identity. For more
+information on how ruby deals w/ equality, you should do this:
+
+ri equal?
+
+or look at this:
+
+http://www.ruby-doc.org/core/classes/Object.html#M001057
+
+Also, we left in should_be as a synonym for should_equal, so the only specs that should break are the
+ones using should_equal (which used to use <code>==</code> instead of <code>.equal?</code>).
+
+Lastly, should_be used to handle true and false differently from any other values. We've removed
+this special handling, so now actual.should_be true will fail for any value other than true (it
+used to pass for any non-nil, non-false value), and actual.should_be false will fail for any
+value other than false (it used to pass for nil or false).
+
+Here's what you'll need to do to update your specs:
+* search for "should_equal" and replace with "should_eql"
+* run specs
+
+If any specs still fail, they are probably related to should_be(true) or should_be(false) using
+non-boolean values. Those you'll just have to inspect manually and adjust appropriately (sorry!).
+
+--------------------------------------------------
+Specifying multiple return values in mocks now works like this:
+
+mock.should_receive(:message).and_return(1,2,3)
+
+It used to work like this:
+
+mock.should_receive(:message).and_return([1,2,3])
+
+but we decided that was counter intuitive and otherwise lame.
+
+Here's what you'll need to do to update your specs:
+* search for "and_return(["
+* get rid of the "[" and "]"
+
+--------------------------------------------------
+RSpec on Rails now supports the following (thanks to ZenTest upon which it is built):
+
+* Separate specs for models, views, controllers and helpers
+* Controller specs are completely decoupled from the views by default (though you can tell them to couple themselves if you prefer)
+* View specs are completely decoupled from app-specific controllers
+
+See http://rspec.rubyforge.org/documentation/rails/index.html for more information
+--------------------------------------------------
+As usual, there are also other new features and bug fixes:
+
+* Added lots of documentation on mocks/stubs and the rails plugin.
+* Added support for assigns[key] syntax for controller specs (to align w/ pre-existing syntax for view specs)
+* Added support for controller.should_redirect_to
+* RSpec on Rails automatically checks whether it's compatible with the installed RSpec
+* Applied [#6393] rspec_on_rails uses deprecated '@response' instead of the accessor
+* RSpec now has 100% spec coverage(!)
+* Added support for stubbing and partial mocking
+* Progress (....F..F.) is now coloured. Tweaked patch from KAKUTANI Shintaro.
+* Backtrace now excludes the rcov runner (/usr/local/bin/rcov)
+* Fixed [#5539] predicates do not work w/ rails
+* Added [#6091] support for Regexp matching messages sent to should_raise
+* Added [#6333] support for Regexp matching in mock arguments
+* Applied [#6283] refactoring of diff support to allow selectable formats and custom differs
+* Fixed [#5564] "ruby spec_file.rb" doesn't work the same way as "spec spec_file.rb"
+* Fixed [#6056] Multiple output of failing-spec notice
+* Fixed [#6233] Colours in specdoc
+* Applied [#6207] Allows --diff option to diff target and expected's #inspect output (Patch by Lachie Cox)
+* Fixed [#6203] Failure messages are misleading - consider using inspect.
+* Added [#6334] subject.should_have_xyz will try to call subject.has_xyz? - use this for hash.should_have_key(key)
+* Fixed [#6017] Rake task should ignore empty or non-existent spec-dirs
+
 == Version 0.6.4
 
 In addition to a number of bug fixes and patches, this release begins to formalize the support for
 RSpec on Rails.
 
+* Added Christopher Petrilli's TextMate bundle to vendor/textmate/RSpec.tmbundle
 * Fixed [#5909], once again supporting multi_word_predicates
 * Applied [#5873] - response.should_have_rjs (initial patch from Jake Howerton, based on ARTS by Kevin Clark)
 * Added generation of view specs for rspec_on_rails
@@ -75,7 +164,7 @@ This release improves Rails support and test2spec translation.
 * Fixed underscore problems that occurred when RSpec was used in Rails
 * Simplified the Rails support by packaging it as a plugin instead of a generator gem.
 * Fixed [#5063] 'rspec_on_rails' require line in spec_helper.rb
-* Added pre_commit rake task to reduce risk of regressions. Useful for rspec developers and patchers.
+* Added pre_commit rake task to reduce risk of regressions. Useful for RSpec developers and patchers.
 * Added failure_message to RSpec Rake task
 * test2spec now defines converted helper methods outside of the setup block (bug #5057).
 

data/EXAMPLES.rd

@@ -1,11 +1,23 @@
 # A FileAccessor
 # * should open a file and pass it to the processor's process method
-# Rspec
-# * should allow you to define helper methods
+# a context with helper a method
+# * should make that method available to specs
 # An IoProcessor
 # * should raise nothing when the file is exactly 32 bytes
 # * should raise an exception when the file length is less than 32 bytes
-# A stack (in general)
+# A consumer of a mock
+# * should be able to send messages to the mock
+# a mock
+# * should be able to mock the same message twice w/ different args
+# * should be able to mock the same message twice w/ different args in reverse order
+# A partial mock
+# * should work at the class level
+# * should revert to the original after each spec
+# * can be mocked w/ ordering
+# BDD framework
+# * should be adopted quickly
+# * should be intuitive
+# A stack which is neither empty nor full
 # * should add to the top when sent 'push'
 # * should return the top item when sent 'peek'
 # * should NOT remove the top item when sent 'peek'
@@ -28,7 +40,17 @@
 # * should remain full after 'peek'
 # * should no longer be full after 'pop'
 # * should complain on 'push'
-# Rspec should integrate with Test::Unit::TestCase
+# A consumer of a stub
+# * should be able to stub methods on any Object
+# A stubbed method on a class
+# * should return the stubbed value
+# * should revert to the original method after each spec
+# * can stub! and mock the same message
+# A mock
+# * can stub!
+# * can stub! and mock
+# * can stub! and mock the same message
+# RSpec should integrate with Test::Unit::TestCase
 # * TestCase#setup should be called.
-# * Rspec should be able to access TestCase methods
-# * Rspec should be able to accept included modules
+# * RSpec should be able to access TestCase methods
+# * RSpec should be able to accept included modules

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2005-2006 The RSpec Development Team
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -1,15 +1,21 @@
-In order to run RSpec's full test suite (rake pre_commit) you must install the following gems:
+== Building the RSpec gem ==
+rake gem
+gem install pkg/rspec-0.x.x.gem (you may have to sudo)
 
-* rake
-* rcov
-* ParseTree   (Ignore the message: test/test_parse_tree.rb:190:38: ':' not followed by identified or operator)
-* RubyInline
-* webgen
-* RedCloth
-* syntax
-* diff-lcs
-* meta_project
-* sqlite3-ruby
+== Running the specs ==
+In order to run RSpec's full suite of specs (rake pre_commit) you must install the following gems:
+
+* rake          # Runs the build script
+* rcov          # Verifies that the code is 100% covered by specs
+* webgen        # Generates the static HTML website
+* RedCloth      # Required by webgen
+* syntax        # Required by our own custom webgen extension to highlight ruby code
+* diff-lcs      # Required if you use the --diff switch
+* win32console  # Required by the --colour switch if you're on Windows
+* meta_project  # Required in order to make releases at RubyForge
+* sqlite3-ruby  # Required by RSpec on Rails specs
+* ZenTest       # Required by RSpec on Rails specs
+* Rails         # Required by RSpec on Rails specs
 
 You must also install SQLite - which is needed to test the Rails plugin.
 
@@ -17,7 +23,7 @@ Note that RSpec itself - once built - doesn't have any dependencies outside the
 and stdlib - with a few exceptions:
 
 * The spec command line uses diff-lcs when --diff is specified.
-* The test2spec command line uses ParseTree and RubyInline.
 * The Spec::Rake::SpecTask needs RCov if RCov is enabled in the task.
+* RSpec on Rails needs the ZenTest gem to be installed (and Rails and its dependencies of course)
 
 See http://rspec.rubyforge.org for further documentation.

data/Rakefile

@@ -3,17 +3,15 @@ require 'rubygems'
 require 'rake/gempackagetask'
 require 'rake/contrib/rubyforgepublisher'
 require 'rake/clean'
-require 'rake/testtask'
 require 'rake/rdoctask'
 require 'spec/version'
-require 'rcov/rcovtask'
 
 # Some of the tasks are in separate files since they are also part of the website documentation
-load File.dirname(__FILE__) + '/test/tasks/examples.rake'
-load File.dirname(__FILE__) + '/test/tasks/examples_specdoc.rake'
-load File.dirname(__FILE__) + '/test/tasks/examples_with_rcov.rake'
-load File.dirname(__FILE__) + '/test/tasks/failing_examples_with_html.rake'
-load File.dirname(__FILE__) + '/test/tasks/rcov_verify.rake'
+load File.dirname(__FILE__) + '/tasks/examples.rake'
+load File.dirname(__FILE__) + '/tasks/examples_specdoc.rake'
+load File.dirname(__FILE__) + '/tasks/examples_with_rcov.rake'
+load File.dirname(__FILE__) + '/tasks/failing_examples_with_html.rake'
+load File.dirname(__FILE__) + '/tasks/verify_rcov.rake'
 
 PKG_NAME = "rspec"
 PKG_VERSION   = Spec::VERSION::STRING
@@ -29,50 +27,22 @@ PKG_FILES = FileList[
   'vendor/selenium/*.txt'
 ]
 
-task :default => :test
+task :default => [:spec, :verify_rcov]
+
+desc "Run all specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = ['--diff','--color','--backtrace']
+  t.rcov = true
+  t.rcov_dir = 'doc/output/coverage'
+  t.rcov_opts = ['--exclude', 'spec\/spec,bin\/spec']
+end
 
 desc "Run all failing examples"
 Spec::Rake::SpecTask.new('failing_examples') do |t|
   t.spec_files = FileList['failing_examples/**/*_spec.rb']
 end
 
-require 'rbconfig'
-windows =  Config::CONFIG['target_os'] == 'mswin32'
-Rake::TestTask.new do |t|
-  tests = FileList['test/**/*_test.rb']
-  tests.exclude 'test/spec/test_to_spec/*.rb' if windows
-  t.test_files = tests
-  t.verbose = true
-#  t.warning = true
-end
-
-Rcov::RcovTask.new do |t|
-  t.test_files = FileList['test/**/*_test.rb']
-  t.output_dir = 'doc/output/coverage'
-  t.rcov_opts = ['--text-report']
-end
-
-desc 'Translate our own tests to specs'
-task :test2spec => :create_test2spec_dir do
-  rm_rf 'spec/translated'
-  `bin/test2spec --force --template spec/test2spec.erb --specdir spec/translated test`
-  # Remove the spec translations that we don't care about.
-  rm 'spec/translated/spec/test_to_spec/sexp_transformer_assertion_spec.rb'
-  rm 'spec/translated/spec/test_to_spec/sexp_transformer_spec.rb'
-  rm 'spec/translated/r2_r_spec.rb'
-end
-task :create_test2spec_dir do
-  mkdir_p 'doc/output/tools' unless File.exist? 'doc/output/tools'
-end
-
-desc 'Runs all RSpec specs - translated with test2spec from our own tests'
-Spec::Rake::SpecTask.new('test2spec_test' => :test2spec) do |t|
-  t.spec_files = FileList['spec/**/*_spec.rb']
-  t.spec_opts = ["--format", "html", "--diff"]
-  t.out = 'doc/output/tools/rspec_specs.html'
-  t.failure_message = "**** Translated specs failed. See doc/output/tools/rspec_specs.html ****"
-end
-
 desc 'Verify that no warnings occur'
 task :verify_warnings do
   `ruby -w #{File.dirname(__FILE__) + '/bin/spec'} --help 2> warnings.txt`
@@ -82,7 +52,7 @@ task :verify_warnings do
 end
 
 desc 'Generate HTML documentation for website'
-task :webgen => :test2spec do
+task :webgen do
   Dir.chdir 'doc' do
     output = nil
     IO.popen('webgen 2>&1') do |io|
@@ -122,9 +92,9 @@ spec = Gem::Specification.new do |s|
   s.require_path = 'lib'
   s.autorequire = 'spec'
   s.bindir = "bin"
-  s.executables = ["spec", "test2spec"]
+  s.executables = ["spec"]
   s.default_executable = "spec"
-  s.author = "Steven Baker, Aslak Hellesoy, Dave Astels, David Chelimsky" 
+  s.author = ["Steven Baker", "Aslak Hellesoy", "Dave Astels", "David Chelimsky", "Brian Takita"]
   s.email = "rspec-devel@rubyforge.org"
   s.homepage = "http://rspec.rubyforge.org"
   s.rubyforge_project = "rspec"
@@ -151,15 +121,44 @@ end
 
 desc "Look for TODO and FIXME tags in the code"
 task :todo do
-  egrep /#.*(FIXME|TODO|TBD)/
+  egrep /(FIXME|TODO|TBD)/
 end
 
 task :clobber do
   rm_rf 'doc/output'
-  rm_rf 'spec/translated'
 end
 
-task :release => [:clobber, :test2spec_test, :verify_committed, :verify_user, :verify_password, :test, :publish_packages, :tag, :publish_website, :publish_news]
+desc "Touches files storing revisions so that svn will update $LastChangedRevision"
+task :touch_revision_storing_files do
+  # See http://svnbook.red-bean.com/en/1.0/ch07s02.html - the section on svn:keywords
+  files = [
+    'lib/spec/version.rb', 
+    'vendor/rspec_on_rails/vendor/plugins/rspec/lib/spec/rails/version.rb'
+  ]
+  touch_needed = false
+  IO.popen('svn stat') do |io|
+    io.each_line do |line|
+      if line =~ /^M\s*(.*)/
+        touch_needed = !files.index($1)
+        break if touch_needed
+      end
+    end
+  end
+  
+  if touch_needed
+    new_token = rand
+    files.each do |path|
+      abs_path = File.join(File.dirname(__FILE__), path)
+      content = File.open(abs_path).read
+      touched_content = content.gsub(/# RANDOM_TOKEN: (.*)\n/n, "# RANDOM_TOKEN: #{new_token}\n")
+      File.open(abs_path, 'w') do |io|
+        io.write touched_content
+      end
+    end
+  end
+end
+
+task :release => [:clobber, :verify_committed, :verify_user, :verify_password, :spec, :publish_packages, :tag, :publish_website, :publish_news]
 
 desc "Verifies that there is no uncommitted code"
 task :verify_committed do
@@ -178,7 +177,14 @@ task :tag do
 end
 
 desc "Run this task before you commit. You should see 'OK TO COMMIT'"
-task :pre_commit => [:verify_warnings, :website, :examples, :failing_examples_with_html, :rails_pre_commit, :commit_ok]
+task :pre_commit => [
+  :touch_revision_storing_files, 
+  :verify_warnings, 
+  :website, 
+  :examples, 
+  :failing_examples_with_html, 
+  :rails_pre_commit, 
+  :commit_ok]
 
 task :rails_pre_commit do
   Dir.chdir 'vendor/rspec_on_rails' do    
@@ -191,8 +197,8 @@ task :commit_ok do |t|
   puts "OK TO COMMIT"
 end
 
-desc "Build the website with rdoc and rcov, but do not publish it"
-task :website => [:clobber, :rcov_verify, :webgen, :failing_examples_with_html, :test2spec_test, :examples_specdoc, :rdoc]
+desc "Build the website, but do not publish it"
+task :website => [:clobber, :verify_rcov, :webgen, :failing_examples_with_html, :spec, :examples_specdoc, :rdoc]
 
 task :verify_user do
   raise "RUBYFORGE_USER environment variable not set!" unless ENV['RUBYFORGE_USER']

data/examples/custom_formatter.rb

@@ -5,18 +5,18 @@ require 'spec/runner/formatter/base_text_formatter'
 # bin/spec failing_examples -r examples/custom_formatter.rb -f CustomFormatter
 class CustomFormatter < Spec::Runner::Formatter::BaseTextFormatter
   def add_context(name, first)
-    @output << "\n" if first
+    @output.print "\n" if first
   end
   
   def spec_failed(name, counter, failure)
-    @output << 'X'
+    @output.print 'X'
   end
   
   def spec_passed(name)
-    @output << '_'
+    @output.print '_'
   end
   
   def start_dump
-    @output << "\n"
+    @output.print "\n"
   end
 end

data/examples/helper_method_example.rb

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

data/examples/mocking_example.rb

@@ -1,11 +1,28 @@
 require File.dirname(__FILE__) + '/../lib/spec'
 
 context "A consumer of a mock" do
-
   specify "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
+    mock = mock("mock")
+    mock.should_receive(:msg).with(:arg1).and_return(:val1)
+    mock.should_receive(:msg).with(:arg2).and_return(:val2)
+    mock.msg(:arg1).should_eql(:val1)
+    mock.msg(:arg2).should_eql(:val2)
+  end
 
-end
+  specify "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)
+    mock.msg(:arg2).should_eql(:val2)
+    mock.msg(:arg1).should_eql(:val1)
+  end
+end
+