rspec 0.5.4 → 0.5.5

data/CHANGES

@@ -1,7 +1,15 @@
 = RSpec Changelog
 
-== Version 0.5.4 (in SVN)
-Release notes go here
+== Version 0.5.5
+This release adds initial support for Ruby on Rails in the rspec_generator gem.
+
+* [Rails] Reorganised Lachie's original code to be a generator packaged as a gem rather than a plugin.
+* [Rails] Imported code from http://lachie.info/svn/projects/rails_plugins/rspec_on_rails (Written by Lachie Cox)
+* Remove stack trace lines from TextMate's Ruby bundle
+* Better error message from spectask when no spec files are found.
+
+== Version 0.5.4
+The "the tutorial is ahead of the gem" release
 
 * Support for running a single spec with --spec
 * Exitcode is now 1 unless all specs pass, in which case it's 0.

data/EXAMPLES.rd

@@ -0,0 +1,34 @@
+# Airport at home
+# * should always work
+# * not need cables
+# * not need electricity
+# BDD framework
+# * should be adopted quickly
+# * should be intuitive
+# Mocker
+# * should be able to call mock()
+# An empty stack
+# * should accept an item when sent push
+# * should complain when sent top
+# * should complain when sent pop
+# A stack with one item
+# * should accept an item when sent push
+# * should return top when sent top
+# * should not remove top when sent top
+# * should return top when sent pop
+# * should remove top when sent pop
+# An almost full stack (with one item less than capacity)
+# * should accept an item when sent push
+# * should return top when sent top
+# * should not remove top when sent top
+# * should return top when sent pop
+# * should remove top when sent pop
+# A full stack
+# * should complain on push
+# * should return top when sent top
+# * should not remove top when sent top
+# * should return top when sent pop
+# * should remove top when sent pop
+# Underscore sugar
+# * should be available for regular objects
+# * should be available for mocks

data/README

@@ -1 +1 @@
-See http://rspec.rubyforge.org
+See http://rspec.rubyforge.org for detailed documentation.

data/Rakefile

@@ -8,7 +8,7 @@ require 'rake/rdoctask'
 require 'spec/version'
 require 'spec/rake/spectask'
 require 'spec/rake/rcov_verify'
-require 'test/rcov/rcov_testtask'
+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'
@@ -17,12 +17,6 @@ load File.dirname(__FILE__) + '/test/tasks/examples_with_rcov.rake'
 load File.dirname(__FILE__) + '/test/tasks/rcov_verify.rake'
 
 PKG_NAME = "rspec"
-# Versioning scheme: MAJOR.MINOR.PATCH
-# MAJOR bumps when API is broken backwards
-# MINOR bumps when the API is broken backwards in a very slight/subtle (but not fatal) way
-# -OR when a new release is made and propaganda is sent out.
-# PATCH is bumped for every API addition and/or bugfix (ideally for every commit)
-
 PKG_VERSION   = Spec::VERSION::STRING
 PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
 PKG_FILES = FileList[
@@ -45,9 +39,10 @@ Rake::TestTask.new do |t|
   t.verbose = true
 end
 
-RCov::TestTask.new do |t|
+Rcov::RcovTask.new do |t|
   t.test_files = FileList['test/**/*_test.rb']
-  t.verbose = true
+  t.output_dir = 'doc/output/coverage'
+  t.rcov_opts = []
 end
 
 desc 'Generate HTML documentation'
@@ -66,11 +61,11 @@ end
 spec = Gem::Specification.new do |s|
   s.name = PKG_NAME
   s.version = PKG_VERSION
-  s.summary = "Behaviour Specification Framework for Ruby"
+  s.summary = Spec::VERSION::DESCRIPTION
   s.description = <<-EOF
-    RSpec is a behaviour specification framework for Ruby.  RSpec was created in
-    response to Dave Astels' article _A New Look at Test Driven Development_ which
-    can be read at: http://daveastels.com/index.php?p=5  RSpec is intended to
+    RSpec is a behaviour driven development (BDD) framework for Ruby.  RSpec was 
+    created in response to Dave Astels' article _A New Look at Test Driven Development_ 
+    which can be read at: http://daveastels.com/index.php?p=5  RSpec is intended to
     provide the features discussed in Dave's article.
   EOF
 
@@ -90,8 +85,8 @@ spec = Gem::Specification.new do |s|
   s.bindir = "bin"
   s.executables = ["spec", "test2rspec"]
   s.default_executable = "spec"
-  s.author = "Steven Baker" 
-  s.email = "srbaker@pobox.com"
+  s.author = "Steven Baker, Aslak Hellesoy, Dave Astels, David Chelimsky" 
+  s.email = "rspec-devel@rubyforge.org"
   s.homepage = "http://rspec.rubyforge.org"
   s.rubyforge_project = "rspec"
 end
@@ -121,24 +116,16 @@ task :todo do
 end
 
 task :clobber do
-  rm_rf 'coverage'
   rm_rf 'doc/output'
 end
 
 task :release => [:clobber, :verify_user, :verify_password, :test, :publish_packages, :publish_website, :publish_news]
 
 desc "Build the website with rdoc and rcov, but do not publish it"
-task :website => [:clobber, :copy_rcov_report, :doc, :examples_specdoc, :rdoc]
-
-task :copy_rcov_report => [:test_with_rcov, :rcov_verify] do
-  rm_rf 'doc/output/coverage'
-  mkdir 'doc/output' unless File.exists? 'doc/output'
-  mv 'coverage', 'doc/output'
-end
+task :website => [:clobber, :rcov_verify, :doc, :examples_specdoc, :rdoc]
 
 task :verify_user do
   raise "RUBYFORGE_USER environment variable not set!" unless ENV['RUBYFORGE_USER']
-  raise "BEHAVIOURDRIVEN_USER environment variable not set!" unless ENV['BEHAVIOURDRIVEN_USER']
 end
 
 task :verify_password do
@@ -148,22 +135,30 @@ end
 desc "Upload Website to RubyForge"
 task :publish_website => [:verify_user, :website] do
   publisher = Rake::SshDirPublisher.new(
-    "#{ENV['BEHAVIOURDRIVEN_USER']}@www.behaviourdriven.org",
-    "/var/www/behaviourdriven.org/htdocs/#{PKG_NAME}",
+    "#{ENV['RUBYFORGE_USER']}@rubyforge.org",
+    "/var/www/gforge-projects/#{PKG_NAME}",
     "doc/output"
   )
 
   publisher.upload
 end
 
+task :package_rails do
+  Dir.chdir 'vendor/rspec_on_rails/vendor/generators/rspec' do    
+    `rake clobber gem`
+    raise "Failed to package RSpec on Rails" if $? != 0
+  end
+end
+
 desc "Publish gem+tgz+zip on RubyForge. You must make sure lib/version.rb is aligned with the CHANGELOG file"
-task :publish_packages => [:verify_user, :verify_password, :package] do
+task :publish_packages => [:verify_user, :verify_password, :package, :package_rails] do
   require 'meta_project'
   require 'rake/contrib/xforge'
   release_files = FileList[
     "pkg/#{PKG_FILE_NAME}.gem",
     "pkg/#{PKG_FILE_NAME}.tgz",
-    "pkg/#{PKG_FILE_NAME}.zip"
+    "pkg/#{PKG_FILE_NAME}.zip",
+    "vendor/rspec_on_rails/vendor/generators/rspec/pkg/rspec_generator-#{Spec::VERSION::STRING}.gem"
   ]
 
   Rake::XForge::Release.new(MetaProject::Project::XForge::RubyForge.new(PKG_NAME)) do |xf|

data/bin/spec

@@ -1,5 +1,4 @@
 #!/usr/bin/env ruby
-
 require File.expand_path(File.dirname(__FILE__) + "/../lib/spec") # better stack traces this way
 
 $context_runner = ::Spec::Runner::OptionParser.create_context_runner(ARGV, false, STDERR, STDOUT)

data/doc/src/core_team.page

@@ -10,13 +10,22 @@ h2. The Core Team
 * David Chelimsky
 * Aslak Hellesoy
 
+<notextile>
 <table>
-<tr>
-<td><img src="images/David_and_Aslak.jpg"></td>
-<td><img src="images/Whats_That_Dude.jpg"></td>
-</tr>
-<tr>
-<td align="center">David and Aslak getting ready for 1.0</td>
-<td align="center">What's that, Dude?</td>
-</tr>
-</table>
+  <tr>
+    <td><img src="images/David_and_Aslak.jpg" /></td>
+    <td><img src="images/Whats_That_Dude.jpg" /></td>
+    <td><img src="http://static.flickr.com/1/127260733_84714abc76_o_d.png" /></td>
+  </tr>
+  <tr>
+    <td align="center">David and Aslak tweaking backtraces</td>
+    <td align="center">What's that, Dude?</td>
+    <td align="center">Dave Astels</td>
+  </tr>
+</table>
+</notextile>
+
+h2. Contributors
+
+* Lachie Cox (Rails support)
+* Rich Kilmer (Underscore syntactic sugar)

data/doc/src/tools/rails.page

@@ -1,9 +1,75 @@
 ---
-title: Rails Integration
+title: RSpec on Rails
 inMenu: true
 ---
-h2. Rails Integration
+h2. RSpec on Rails
 
-Rspec's support for Rails is in a very early and experimental stage.
-If you are adventurous, you can check out the branches/ar_fixtures_facade branch in Subversion.
-See the downloads page for details.
+RSpec's rspec_generator Rubygem brings RSpec to Rails.
+
+h3. Features
+
+* Integrated fixture loading
+* Uses many of the controller-test integration features
+* Special generators for models and controllers that generate specs instead of tests.
+
+h3. Installation
+
+RSpec support for rails lives in a separate gem. Install that gem:
+<pre>
+gem install rspec_generator
+</pre>
+
+Once the gem is installed, you must configure you Rails app. Stand in the root of your Rails app and run:
+<pre>
+ruby script/generate rspec
+</pre>
+
+Now, you can generate models and controllers in a similar fashion to Rails' builtin generators. Example:
+
+<pre>
+ruby script/generate rspec_model person
+</pre>
+
+or
+
+<pre>
+ruby script/generate rspec_controller person
+</pre>
+
+For more information on each generator, just run them without any arguments.
+
+h3. Running specs
+
+Model specs can be run with
+<pre>
+rake spec:models
+</pre>
+
+Controller specs can be run with
+<pre>
+rake spec:controllers
+</pre>
+
+To see all the RSpec related tasks, run
+<pre>
+rake --tasks spec
+</pre>
+
+h3. Naming conventions
+
+When you use Rails without RSpec (with Test::Unit), tests for models end up in tests/unit and tests for controllers
+end up in tests/functional.
+
+In order to make things more consistent, RSpec chooses a slightly different naming convention for direcotries and
+Rake tasks. So you will find model specs under specs/models, and controller specs under specs/controllers. The
+Rake tasks are named accordingly.
+
+h3. Examples
+
+RSpec on Rails adds several methods to your specs with a look and feel similar to Test::Unit. Example:
+
+Model:
+<ruby file="../vendor/rspec_on_rails/spec/models/person_spec.rb"/>
+
+Controller:
+<ruby file="../vendor/rspec_on_rails/spec/controllers/person_controller_spec.rb"/>

data/doc/src/tools/rake.page

@@ -4,21 +4,18 @@ inMenu: true
 ---
 h2. Rake Task
 
-RSpec's Rake task allows you to do many things.
-(See the <notextile><a href="../rdoc/classes/Spec/Rake/SpecTask.html">RDoc</a></notextile> for details)
+RSpec coomes with a Rake task for executing specs.
+See "Spec::Rake::SpecTask":../rdoc/classes/Spec/Rake/SpecTask.html for details.
 
 h3. Run specs
 
 <ruby file="../test/tasks/examples.rake"/>
 
-h3. Run specs with RCov
-
-<ruby file="../test/tasks/examples_with_rcov.rake"/>
-
-This will generate a coverage report like <notextile><a href="../coverage/index.html">this</a></notextile>.
+Also see the "RCov":rcov.html page for info about how to generate a coverage report.
 
 h3. Generate specdocs
 
 <ruby file="../test/tasks/examples_specdoc.rake"/>
 
-This will output the specdocs to a file, which can be included in your RDoc. Just like <notextile><a href="../rdoc/files/EXAMPLES_rd.html">this</a></notextile>.
+This will output the specdocs to a file, which can be included in your RDoc. 
+Just like "this":../rdoc/files/EXAMPLES_rd.html.

data/doc/src/tools/rcov.page

@@ -4,16 +4,25 @@ inMenu: true
 ---
 h2. RCov
 
-RSpec has tight integration with <a href="http://eigenclass.org/hiki.rb?rcov=">RCov</a>. If you have RCov installed you can
-use the rake task to generate a coverage report. See the <a href="../rake.html">Rake</a> for details.
+RSpec has tight integration with "RCov":http://eigenclass.org/hiki.rb?rcov=.
+
+h3. Run specs with RCov
+
+<ruby file="../test/tasks/examples_with_rcov.rake"/>
+
+By adding rcov=true to the rake task, specs will be run with rcov
+instead of ruby, and a coverage report like "this":../coverage/index.html will be generated.
+
+See "Spec::Rake::SpecTask":../rdoc/classes/Spec/Rake/SpecTask.html for details.
 
 h3. Coverage threshold
 
-You can guard your codebase's coverage from dropping by adding the 
-<notextile><a href="../rdoc/classes/RCov/VerifyTask.html">RCov::VerifyTask</a></notextile>
-task to your Rakefile. Example:
+You can guard your codebase's coverage from dropping below a certain threshold
+by using RSpec's built-in task for verification of the total RCov coverage.
 
 <ruby file="../test/tasks/rcov_verify.rake"/>
 
 This will give you a :rcov_verify task that will fail your build if the
 coverage drops below the threshold you define (the higher the better).
+
+See "RCov::VerifyTask":../rdoc/classes/RCov/VerifyTask.html for details.

data/doc/src/tools/spec.page

@@ -32,8 +32,8 @@ Any number of files and/or directories can be provided, all ruby source files
 that are found are loaded. Running spec on the previous example results in:
 
 <pre>
-bin/spec
-{execute: ../bin/spec ../examples}
+bin/spec examples
+{execute: ruby ../bin/spec ../examples}
 </pre>
 
 Very simple and to the point. Passing specifications are indicated by a '.',
@@ -55,23 +55,10 @@ Additional command line options can be passed to customize the output and behavi
 The following options apply whether specs are run in standalone mode (by executing the .rb files directly), 
 or using the spec command.
 
-h3. -v, --verbose
+h3. -f, --format [specdoc|s|rdoc|r|]
 
-Using this option tells the formatter (which by default is specdoc) to produce more verbose output:
-
-<pre>
-$ bin/spec failing_examples/team_spec.rb -v
-
-{execute: ../bin/spec ../failing_examples/team_spec.rb -v}
-</pre>
-
-The spec command does double duty as documentation generation from a set of
-specifications as well as running them against your code.
-
-h3. -f, --format [specdoc|rdoc]
-
-Specify the output format. Most formats will produce some form of "testdox":http://agiledox.sourceforge.net/
-output. The --verbose and --dry-run options may also affect the output format.
+Specify the output format. Default format is "progress bar" ("." for pass, "F" for fail). Most formats will produce some form of "testdox":http://agiledox.sourceforge.net/
+output. The --dry-run options may also affect the output format.
 
 For example, by setting the formatter to rdoc, we can output the kind of input that RDoc
 needs to produce something like "this":../rdoc/files/EXAMPLES_rd.html 
@@ -97,3 +84,31 @@ $ bin/spec failing_examples/team_spec.rb -b
 
 {execute: ../bin/spec ../failing_examples/team_spec.rb -b}
 </pre>
+
+h3. -s, --spec &lt;name of context and/or specification&gt;
+
+Enter the name of a context, spec, or both to run:
+
+all the specs in a context ...
+
+<pre>
+$ bin/spec examples --spec "A stack with one item" -f s
+
+{execute: ../bin/spec ../examples --spec "A stack with one item" -f s}
+</pre>
+
+... any spec in any context with a given name ...
+
+<pre>
+$ bin/spec examples --spec "should return top when sent top" -f s
+
+{execute: ../bin/spec ../examples --spec "should return top when sent top" -f s}
+</pre>
+
+... or a specific spec in a specific context:
+
+<pre>
+$ bin/spec examples --spec "A stack with one item should return top when sent top" -f s
+
+{execute: ../bin/spec ../examples --spec "A stack with one item should return top when sent top" -f s}
+</pre>

data/doc/src/tutorials/meta.info

@@ -25,7 +25,12 @@ stack_04.page:
 
 stack_05.page:
   title: '5'
-  inMenu: true
+  inMenu: false
   orderInfo: 15
 
+stack_05.page:
+  title: '6'
+  inMenu: false
+  orderInfo: 16
+
   

data/doc/src/tutorials/stack.rb

@@ -8,4 +8,4 @@ class Stack
   def top
      @item
   end
-end
+end