rspec-rails 2.5.0 → 2.6.0

data/.gitignore

@@ -1,9 +1,14 @@
 tmp
-pkg
-.bundle
-rspec-rails-
 doc
+pkg
 vendor
-.bundle
-Gemfile.lock
+!lib/rspec/rails/vendor
+*.gem
 Gemfile
+Gemfile.lock
+gemfiles/*.lock
+gemfiles/bin/*
+bin
+.rvmrc
+*.rbc
+.gemfile

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,10 @@
+script: "rake --trace 2>&1"
+rvm:
+  - 1.8.7
+  - 1.9.2
+gemfile:
+  - gemfiles/rails-3.0.7
+  - gemfiles/rails-3.1.0.beta1
+  - gemfiles/rails-master
+env:
+  - CI=true

data/README.md

@@ -2,6 +2,8 @@
 
 rspec-2 for rails-3 with lightweight extensions to each
 
+[![build status](http://travis-ci.org/rspec/rspec-rails.png)](http://travis-ci.org/rspec/rspec-rails)
+
 NOTE: rspec-2 does _not_ support rails-2. Use rspec-rails-1.3.x for rails-2.
 
 ## Documentation

data/README_DEV.md

@@ -0,0 +1,43 @@
+# Information for rspec-rails developers
+
+rspec-rails lives in a complicated ecosystem. We need to run it against
+multiple versions of rails and multiple versions of Ruby as well. There are
+several tools already available to manage running against multiple versions of
+Ruby (e.g. rvm), and there are even some multi-rails tools (e.g. multi-rails)
+but we haven't found one that does exactly what we need here, so we've rolled
+our own.
+
+## The short version
+
+thor rails:use 3.0.6
+rake
+
+## The long version
+
+### thor rails:use
+
+The `thor rails:use` task accepts any released version of rails, or either the
+3-0-stable or master branches.
+
+    thor rails:use master
+    thor rails:use 3-0-stable
+    thor rails:use 3.0.6
+    thor rails:use 3.0.5
+    thor rails:use 3.0.4
+    thor rails:use 3.0.3
+    thor rails:use 3.0.2
+    thor rails:use 3.0.1
+    thor rails:use 3.0.0
+
+It then does several things:
+
+* generates a .gemfile file with the version listed. This is used internally by
+  assorted rake tasks.
+* installs the bundle using the appropriate file in the gemfiles directory
+** this includes binstubs, which are stored in ./gemfiles/bin
+* symlinks the gemfiles/bin directory to ./bin (in the project root) to support
+  running bin/rspec from the project root
+
+At any time, if you want to change rails versions, run `thor rails:use` with a
+new version number. To play it safe, you probably want to also run `rake
+clobber` to delete all the code generated by the previous rails version.

data/Rakefile

@@ -1,26 +1,66 @@
-unless File.exist?('./Gemfile')
-  raise <<-MESSAGE
-Could not find a Gemfile. Please run any of:
-  thor rails:use 3-0-stable
-  thor rails:use master
-  thor rails:use 3.0.0
-  thor rails:use 3.0.3
-
-And then run 'bundle install'
-MESSAGE
-end
+require 'pathname'
+ENV["BUNDLE_GEMFILE"] ||= begin
+                            version = if File.exist?("./.gemfile")
+                                        File.read("./.gemfile").chomp
+                                      else
+                                        "rails-3.0.7"
+                                      end
+                            File.expand_path("../gemfiles/#{version}", __FILE__)
+                          end
+puts "Using gemfile: #{ENV["BUNDLE_GEMFILE"].gsub(Pathname.new(__FILE__).dirname.to_s,'').sub(/^\//,'')}"
 require "bundler"
-Bundler.setup
+begin
+  Bundler.setup
+rescue
+  if ENV["CI"]
+    sh "bundle install"
+    Bundler.setup
+  else
+    raise "You need to install a bundle first. Try 'thor gemfile:use 3.0.7'"
+  end
+end
 Bundler::GemHelper.install_tasks
 
+task :build => :raise_if_psych_is_defined
+
+task :raise_if_psych_is_defined do
+  if defined?(Psych)
+    raise <<-MSG
+===============================================================================
+Gems compiled in Ruby environments with Psych loaded are incompatible with Ruby
+environments that don't have Psych loaded. Try building this gem in Ruby 1.8.7
+instead.
+===============================================================================
+MSG
+  end
+end
+
 require 'rake'
 require 'yaml'
 
-require 'rake/rdoctask'
 require 'rspec'
 require 'rspec/core/rake_task'
-require 'cucumber/rake/task'
 
+begin
+  require 'cucumber/rake/task'
+
+  Cucumber::Rake::Task.new(:cucumber)
+
+  namespace :cucumber do
+    desc "Run cucumber features using rcov"
+    Cucumber::Rake::Task.new :rcov => :cleanup_rcov_files do |t|
+      t.cucumber_opts = %w{--format progress}
+      t.rcov = true
+      t.rcov_opts =  %[-Ilib -Ispec --exclude "gems/*,features"]
+      t.rcov_opts << %[--text-report --sort coverage --aggregate coverage.data]
+    end
+  end
+rescue LoadError
+  puts "unable to load cucumber, some tasks unavailable"
+  task :cucumber do
+    # no-op
+  end
+end
 task :cleanup_rcov_files do
   rm_rf 'coverage.data'
 end
@@ -30,7 +70,6 @@ RSpec::Core::RakeTask.new(:spec) do |t|
   t.rspec_opts = %w[--color]
 end
 
-Cucumber::Rake::Task.new(:cucumber)
 
 namespace :spec do
   desc "Run all examples using rcov"
@@ -41,29 +80,33 @@ namespace :spec do
   end
 end
 
-namespace :cucumber do
-  desc "Run cucumber features using rcov"
-  Cucumber::Rake::Task.new :rcov => :cleanup_rcov_files do |t|
-    t.cucumber_opts = %w{--format progress}
-    t.rcov = true
-    t.rcov_opts =  %[-Ilib -Ispec --exclude "gems/*,features"]
-    t.rcov_opts << %[--text-report --sort coverage --aggregate coverage.data]
-  end
-end
-
 namespace :generate do
   desc "generate a fresh app with rspec installed"
   task :app do |t|
     unless File.directory?('./tmp/example_app')
-      sh "bundle exec rails new ./tmp/example_app"
-      sh "cp ./templates/Gemfile-base ./tmp/example_app/"
-      sh "cp ./Gemfile ./tmp/example_app/"
+      sh "rails new ./tmp/example_app --skip-javascript --skip-gemfile --skip-git"
+      bindir = File.expand_path("gemfiles/bin")
+      if test ?d, bindir
+        Dir.chdir("./tmp/example_app") do
+          sh "rm -rf test"
+          sh "ln -s #{bindir}"
+          application_filename = "config/application.rb"
+          application_file = File.read(application_filename)
+          sh "rm #{application_filename}"
+          puts "rewrite #{application_filename} with config.assets.enabled = false"
+          File.open(application_filename, "w") do |f|
+            f.write application_file.gsub("config.assets.enabled = true","config.assets.enabled = false")
+          end
+          "config/initializers/wrap_parameters.rb".tap do |f|
+            sh "rm #{f}" if test ?f, f
+          end
+        end
+      end
     end
   end
 
   desc "generate a bunch of stuff with generators"
   task :stuff do
-    in_example_app "bundle install"
     in_example_app "rake rails:template LOCATION='../../templates/generate_stuff.rb'"
   end
 end
@@ -114,5 +157,3 @@ task :relish, :version do |t, args|
 end
 
 task :default => [:spec, "clobber:app", "generate:app", "generate:stuff", :smoke, :cucumber]
-
-

data/Thorfile

@@ -1,25 +1,40 @@
-class Rails < Thor
-  desc "checkout VERSION", "checks it out"
-  def checkout(version)
-    puts "***** checking out rails at #{version} ..."
-    Dir.chdir("vendor/rails") do
-      `git checkout #{version}`
-      `rm Gemfile.lock` if File.exist?('Gemfile.lock')
-      puts `bundle show`
+class Gemfile < Thor
+  desc "use VERSION", "installs the bundle using gemfiles/rails-VERSION"
+  def use(version)
+    "gemfiles/rails-#{version}".tap do |gemfile|
+      ENV["BUNDLE_GEMFILE"] = File.expand_path(gemfile)
+      say "Using #{gemfile}"
+    end
+    "bundle install --binstubs".tap do |m|
+      say m
+      system m
     end
+    unless version =~ /^\d\.\d\.\d/
+      "bundle update rails".tap do |m|
+        say m
+        system m
+      end
+    end
+    say `ln -s gemfiles/bin` unless File.exist?('bin')
+    `echo rails-#{version} > ./.gemfile`
   end
 
-  desc "fetch", "update vendor/rails"
-  def fetch
-    Dir.chdir("vendor/rails") do
-      `git fetch`
-    end
+  desc "which", "print out the configured gemfile"
+  def which
+    say `cat ./.gemfile`
   end
 
-  desc "use VERSION", "copies the appropriate Gemfile to Gemfile"
-  def use(version)
-    `cp ./Gemfile-#{version} ./Gemfile` 
-    `rm ./Gemfile.lock`
-    system "bundle install"
+  desc "list", "list the available options for 'thor gemfile:use'"
+  def list
+    all = `ls gemfiles`.chomp.split.grep(/^rails/).reject {|i| i =~ /lock$/}
+
+    versions = all.grep(/^rails-\d\.\d/)
+    branches = all - versions
+
+    puts "releases:"
+    versions.sort.reverse.each {|i| puts i}
+    puts
+    puts "branches:"
+    branches.sort.reverse.each {|i| puts i}
   end
 end

data/features/.nav

@@ -4,6 +4,8 @@
 - Autotest.md (Autotest integration)
 - Changelog.md
 - Upgrade.md
+- request_specs:
+  - request_spec.feature
 - model_specs:
   - errors_on.feature
 - controller_specs:

data/features/Autotest.md

@@ -15,3 +15,10 @@ If Bundler is managing any gems for you directly (i.e. you've got `:git` or
 
     bundle exec autotest
 
+If you do, you require Autotest's bundler plugin in a `.autotest` file in the
+project root directory or your home directory:
+
+    require "autotest/bundler"
+
+Now you can just type `autotest`, it should prefix the generated shell command
+with `bundle exec`.

data/features/Changelog.md

@@ -1,3 +1,27 @@
+### 2.6.0 / 2011-05-12
+
+[full changelog](http://github.com/rspec/rspec-rails/compare/v2.5.0...v2.6.0)
+
+* Enhancements
+  * rails 3 shortcuts for routing specs (Joe Fiorini)
+  * support nested resources in generators (Tim McEwan)
+  * require 'rspec/rails/mocks' to use `mock_model` without requiring the whole
+    rails framework
+  * Update the controller spec generated by the rails scaffold generator:
+    * Add documentation to the generated spec
+    * Use `any_instance` to avoid stubbing finders
+    * Use real objects instead of `mock_model`
+  * Update capybara integration to work with capy 0.4 and 1.0.0.beta
+  * Decorate paths passed to `[append|prepend]_view_paths` with empty templates
+    unless rendering views. (Mark Turner)
+
+* Bug fixes
+  * fix typo in "rake spec:statsetup" (Curtis Schofield)
+  * expose named routes in anonymous controller specs (Andy Lindeman)
+  * error when generating namespaced scaffold resources (Andy Lindeman)
+  * Fix load order issue w/ Capybara (oleg dashevskii)
+  * Fix monkey patches that broke due to internal changes in rails-3.1.0.beta1
+
 ### 2.5.0 / 2011-02-05
 
 [full changelog](http://github.com/rspec/rspec-rails/compare/v2.4.1...v2.5.0)
@@ -5,11 +29,11 @@
 * Enhancements
   * use index_helper instead of table_name when generating specs (Reza
     Primardiansyah)
- 
+
 * Bug fixes
   * fixed bug in which `render_views` in a nested group set the value in its
     parent group.
-  * only include MailerExampleGroup when it is defiend (Steve Sloan)
+  * only include MailerExampleGroup when it is defined (Steve Sloan)
   * mock_model.as_null_object.attribute.blank? returns false (Randy Schmidt)
   * fix typo in request specs (Paco Guzman)
 

data/features/Generators.md

@@ -5,4 +5,4 @@ controllers, etc, RSpec specs are generated instead of Test::Unit tests.
 
 Note that the generators are there to help you get started, but they are no
 substitute for writing your own examples, and they are only guaranteed to work
-out of the box for the default scenario (ActiveRecord + Webrat).
+out of the box for with Rails' defaults (ActiveRecord, no Capybara or Webrat).

data/features/GettingStarted.md

@@ -15,6 +15,10 @@ Install Rails-3
 
     $ bundle install
 
+### Bootstrap RSpec
+
+    $ rails generate rspec:install
+
 ### Generate a scaffold
 
     $ rails generate scaffold Widgets name:string
@@ -33,8 +37,48 @@ the files in the `spec` directory to RSpec.
 
 or
 
-    $ rspec spec
+    $ rspec spec --format documentation
 
 If all went well, you should see output ending with:
 
     29 examples, 0 failures, 2 pending
+
+This output also includes the following controller spec:
+
+    WidgetsController
+      GET index
+        assigns all widgets as @widgets
+      GET show
+        assigns the requested widget as @widget
+      GET new
+        assigns a new widget as @widget
+      GET edit
+        assigns the requested widget as @widget
+      POST create
+        with valid params
+          creates a new Widget
+          assigns a newly created widget as @widget
+          redirects to the created widget
+        with invalid params
+          assigns a newly created but unsaved widget as @widget
+          re-renders the 'new' template
+      PUT update
+        with valid params
+          updates the requested widget
+          assigns the requested widget as @widget
+          redirects to the widget
+        with invalid params
+          assigns the widget as @widget
+          re-renders the 'edit' template
+      DELETE destroy
+        destroys the requested widget
+        redirects to the widgets list
+
+Output like this can help to quickly gain a high level understanding of how an
+object behaves. It also exposes which cases have been specified and which have
+not. Note the balance between the examples for the `create` and `update`
+actions. If the `redirects to the widget` example was missing from one or the
+other, it would be easy to spot.
+
+Take a look at the generated `spec/controllers/widgets_controller_spec.rb` to
+get a sense of how to organize your specs to generate output like this.

data/features/Upgrade.md

@@ -14,7 +14,7 @@ There were a few changes to the generated `spec/spec_helper.rb` file. We
 recommend the following:
 
 1. set aside a copy of your existing `spec/spec_helper.rb` file.
-2. run `rails generate spec:install`
+2. run `rails generate rspec:install`
 3. copy any customizations from your old spec_helper to the new one
 
 If you prefer to make the changes manually in the existing spec_helper, here
@@ -28,7 +28,7 @@ is what you need to change:
     end
 
     # rspec-2
-    require 'rspec/core'
+    require 'rspec/rails'
 
     RSpec.configure do |config|
       ...
@@ -72,7 +72,7 @@ action.
 ### `view.should render_template`
 
 Rails changed the way it renders partials, so to set an expectation that a
-partial gets rendered, you need 
+partial gets rendered, you need
 
     render
     view.should render_template(:partial => "widget/_row")
@@ -85,19 +85,20 @@ that is the subject of a view example:
 
     stub_template "widgets/_widget.html.erb" => "This Content"
 
-### No more `have_tag`
+### No more `have_tag` or `have_text`
 
-Before Webrat came along, rspec-rails had its own `have_tag` matcher that
-wrapped Rails' `assert_select`. Webrat included a replacement for `have_tag` as
-well as new matchers (`have_selector` and `have_xpath`), all of which rely on
-Nokogiri to do its work, and are far less brittle than RSpec's `have_tag`.
+Before Webrat came along, rspec-rails had its own `have_tag` and `have_text`
+matchers that wrapped Rails' `assert_select`. Webrat included replacements for
+these methods, as well as new matchers (`have_selector` and `have_xpath`), all
+of which rely on Nokogiri to do its work, and are far less brittle than RSpec's
+`have_tag`.
 
 Capybara has similar matchers, which will soon be available view specs (they
 are already available in controller specs with `render_views`).
 
-Given the brittleness of RSpec's `have_tag` matcher and the presence of new
-Webrat and Capybara matchers that do a better job, `have_tag` was not included
-in rspec-rails-2.
+Given the brittleness of RSpec's `have_tag` and `have_text` matchers and the
+presence of new Webrat and Capybara matchers that do a better job, `have_tag`
+and `have_text` were not included in rspec-rails-2.
 
 ## Mocks, stubs, doubles
 
@@ -106,7 +107,7 @@ in rspec-rails-2.
 Earlier versions of the view generators generated stub_model with `:new_record?
 => true`. That is no longer recognized in rspec-rails-2, so you need to change
 this:
-  
+
     stub_model(Widget, :new_record? => true)
 
 to this:

data/features/controller_specs/README.md

@@ -21,16 +21,24 @@ To specify outcomes, you can use:
   * `response.should redirect_to (wraps assert_redirected_to)`
   * `assigns(:widget).should be_a_new(Widget)`
     
-## Conventions:
-
-### Controller
-
-* pass the controller being specified to the outermost `describe` method.
-
-      describe AccountController do
-        # ...
-
-### Views
+## Examples
+
+    describe TeamsController do
+      describe "GET index" do
+        it "assigns @teams" do
+          team = Team.create
+          get :index
+          assigns(:teams).should eq([team])
+        end
+
+        it "renders the index template" do
+          get :index
+          response.should render_template("index")
+        end
+      end
+    end
+
+## Views
 
 * by default, views are not rendered. See
   [views are stubbed by default](controller-specs/views-are-stubbed-by-default) and

data/features/controller_specs/anonymous_controller.feature

@@ -1,8 +1,8 @@
 Feature: anonymous controller
 
-  As a Rails developer using RSpec
-  In order to specify behaviour of ApplicationController
-  I want a simple DSL for generating anonymous subclasses
+  Use the `controller` method to define an anonymous controller derived from
+  ApplicationController, or any other base controller. This is useful for
+  specifying behavior like global error handling.
 
   Scenario: specify error handling in ApplicationController
     Given a file named "spec/controllers/application_controller_spec.rb" with:
@@ -36,7 +36,7 @@ Feature: anonymous controller
       end
     end
     """
-    When I run "rspec spec"
+    When I run `rspec spec`
     Then the examples should all pass
 
   Scenario: specify error handling in subclass of ApplicationController
@@ -74,5 +74,5 @@ Feature: anonymous controller
       end
     end
     """
-    When I run "rspec spec"
+    When I run `rspec spec`
     Then the examples should all pass

data/features/controller_specs/controller_spec.feature

@@ -1,6 +1,5 @@
 Feature: controller spec
 
-
   Scenario: simple passing example
     Given a file named "spec/controllers/widgets_controller_spec.rb" with:
       """
@@ -15,5 +14,5 @@ Feature: controller spec
         end
       end
       """
-    When I run "rspec spec"
+    When I run `rspec spec`
     Then the example should pass

data/features/controller_specs/isolation_from_views.feature

@@ -5,7 +5,7 @@ Feature: views are stubbed by default
   template an action should try to render regardless of whether the template
   compiles cleanly.
 
-  NOTE: unlike rspec-rails-1.x, the real template must exist. 
+  NOTE: unlike rspec-rails-1.x, the real template must exist.
 
   Scenario: expect template that is rendered by controller action (passes)
     Given a file named "spec/controllers/widgets_controller_spec.rb" with:
@@ -27,7 +27,7 @@ Feature: views are stubbed by default
         end
       end
       """
-    When I run "rspec ./spec"
+    When I run `rspec spec`
     Then the examples should all pass
 
   Scenario: expect template that is not rendered by controller action (fails)
@@ -44,6 +44,52 @@ Feature: views are stubbed by default
         end
       end
       """
-    When I run "rspec ./spec"
+    When I run `rspec spec`
     Then the output should contain "1 example, 1 failure"
 
+  Scenario: expect empty templates to render when view path is changed at runtime (passes)
+    Given a file named "spec/controllers/things_controller_spec.rb" with:
+      """
+      require "spec_helper"
+
+      describe ThingsController do
+        describe "custom_action" do
+          it "renders an empty custom_action template" do
+            controller.prepend_view_path 'app/views'
+            controller.append_view_path 'app/views'
+            get :custom_action
+            response.should render_template("custom_action")
+            response.body.should == ""
+          end
+        end
+      end
+      """
+    When I run `rspec spec`
+    Then the examples should all pass
+
+  Scenario: expect template to render when view path is changed at runtime (fails)
+    Given a file named "spec/controllers/things_controller_spec.rb" with:
+      """
+      require "spec_helper"
+
+      describe ThingsController do
+        describe "custom_action" do
+          it "renders the custom_action template" do
+            render_views
+            controller.prepend_view_path 'app/views'
+            get :custom_action
+            response.should render_template("custom_action")
+            response.body.should == ""
+          end
+
+          it "renders an empty custom_action template" do
+            controller.prepend_view_path 'app/views'
+            get :custom_action
+            response.should render_template("custom_action")
+            response.body.should == ""
+          end
+        end
+      end
+      """
+    When I run `rspec spec`
+    Then the output should contain "2 examples, 1 failure"

data/features/controller_specs/render_views.feature

@@ -19,7 +19,7 @@ Feature: render_views
         end
       end
       """
-    When I run "rspec spec"
+    When I run `rspec spec`
     Then the examples should all pass
 
   Scenario: render_views on and off in nested groups
@@ -71,7 +71,7 @@ Feature: render_views
         end
       end
       """
-    When I run "rspec spec --format documentation"
+    When I run `rspec spec --format documentation`
     Then the output should contain:
       """
       WidgetsController
@@ -109,6 +109,6 @@ Feature: render_views
         end
       end
       """
-    When I run "rspec spec"
+    When I run `rspec spec`
     Then the examples should all pass