shoulda 2.11.0 → 2.11.1

data/CONTRIBUTION_GUIDELINES.rdoc

@@ -1,10 +1,10 @@
-We're using GitHub[http://github.com/thoughtbot/shoulda/tree/master], and we've been getting any combination of github pull requests, tickets, patches, emails, etc.  We need to normalize this workflow to make sure we don't miss any fixes. 
+We're using GitHub[http://github.com/thoughtbot/shoulda/tree/master], and we've been getting any combination of github pull requests, tickets, patches, emails, etc.  We need to normalize this workflow to make sure we don't miss any fixes.
 
 * Make sure you're accessing the source from the {official repository}[http://github.com/thoughtbot/shoulda/tree/master].
 * We prefer git branches over patches, but we can take either.
-* If you're using git, please make a branch for each separate contribution.  We can cherry pick your commits, but pulling from a branch is easier. 
+* If you're using git, please make a branch for each separate contribution.  We can cherry pick your commits, but pulling from a branch is easier.
 * If you're submitting patches, please cut each fix or feature into a separate patch.
-* There should be an issue[http://github.com/thoughtbot/shoulda/issues] for any submission.  If you've found a bug and want to fix it, open a new ticket at the same time. 
-* Please <b>don't send pull requests</b>  Just update the issue with the url for your fix (or attach the patch) when it's ready.  The github pull requests pretty much get dropped on the floor until someone with commit rights notices them in the mailbox. 
-* Contributions without tests won't be accepted.  The file <tt>/test/README</tt> explains the testing system pretty thoroughly. 
+* There should be an issue[http://github.com/thoughtbot/shoulda/issues] for any submission.  If you've found a bug and want to fix it, open a new ticket at the same time.
+* Please <b>don't send pull requests</b>  Just update the issue with the url for your fix (or attach the patch) when it's ready.  The github pull requests pretty much get dropped on the floor until someone with commit rights notices them in the mailbox.
+* Contributions without tests won't be accepted.  The file <tt>/test/README</tt> explains the testing system pretty thoroughly.
 

data/README.rdoc

@@ -1,16 +1,64 @@
 = Shoulda - Making tests easy on the fingers and eyes
 
-Shoulda makes it easy to write elegant, understandable, and maintainable tests.  Shoulda consists of test macros, assertions, and helpers added on to the Test::Unit framework.  It's fully compatible with your existing tests, and requires no retooling to use.
+Shoulda makes it easy to write elegant, understandable, and maintainable tests. Shoulda consists of matchers, test helpers, and assertions. It's fully compatible with your existing tests in Test::Unit or RSpec, and requires no retooling to use.
 
-Helpers:: #context and #should give you RSpec like test blocks.
+Matchers:: Test::Unit- and RSpec-compatible one-liners that test common Rails functionality.
+           These tests would otherwise be much longer, more complex, and error-prone.
+Helpers:: #context and #should give you RSpec like test blocks in Test::Unit.
           In addition, you get nested contexts and a much more readable syntax.
-Macros:: Generate hundreds of lines of Controller and ActiveRecord tests with these powerful macros.
-         They get you started quickly, and can help you ensure that your application is conforming to best practices.
-Assertions:: Many common rails testing idioms have been distilled into a set of useful assertions.
-Matchers:: Rspec-compatible matchers providing the same tests as Shoulda macros.
+Assertions:: Many common Rails testing idioms have been distilled into a set of useful assertions.
 
 = Usage
 
+=== ActiveRecord Tests (Shoulda::ActiveRecord::Matchers)
+
+Test your ActiveRecord associations and validations with these powerful matchers:
+
+  class PostTest < Test::Unit::TestCase
+    should belong_to(:user)
+    should have_many(:tags).through(:taggings)
+
+    should validate_uniqueness_of(:title)
+    should validate_presence_of(:body).with_message(/wtf/)
+    should validate_presence_of(:title)
+    should validate_numericality_of(:user_id)
+  end
+
+  class UserTest < Test::Unit::TestCase
+    should have_many(:posts)
+
+    should_not allow_value("blah").for(:email)
+    should_not allow_value("b lah").for(:email)
+    should allow_value("a@b.com").for(:email)
+    should allow_value("asdf@asdf.com").for(:email)
+    should ensure_inclusion_of(:email).in_range(1..100)
+    should ensure_inclusion_of(:age).in_range(1..100)
+    should_not allow_mass_assignment_of(:password)
+  end
+
+Makes TDD so much easier.
+
+=== Controller Tests (Shoulda::Controller::Matchers)
+
+Matchers to test the most common controller patterns...
+
+  class PostsControllerTest < ActionController::TestCase
+    context "on GET to :show for first record" do
+      setup do
+        get :show, :id => 1
+      end
+
+      should assign_to(:user)
+      should respond_with(:success)
+      should render_template(:show)
+      should_not set_the_flash
+
+      should "do something else really cool" do
+        assert_equal 1, assigns(:user).id
+      end
+    end
+  end
+
 === Context Helpers (Shoulda::Context)
 
 Stop killing your fingers with all of those underscores...  Name your tests with plain sentences!
@@ -44,55 +92,6 @@ Produces the following test methods:
 
 So readable!
 
-=== ActiveRecord Tests (Shoulda::ActiveRecord::Macros)
-
-Quick macro tests for your ActiveRecord associations and validations:
-
-  class PostTest < Test::Unit::TestCase
-    fixtures :all
-
-    should_belong_to :user
-    should_have_many :tags, :through => :taggings
-
-    should_validate_uniqueness_of :title
-    should_validate_presence_of :body, :message => /wtf/
-    should_validate_presence_of :title
-    should_validate_numericality_of :user_id
-  end
-
-  class UserTest < Test::Unit::TestCase
-    should_have_many :posts
-
-    should_not_allow_values_for :email, "blah", "b lah"
-    should_allow_values_for :email, "a@b.com", "asdf@asdf.com"
-    should_ensure_length_in_range :email, 1..100
-    should_ensure_value_in_range :age, 1..100
-    should_not_allow_mass_assignment_of :password
-  end
-
-Makes TDD so much easier.
-
-=== Controller Tests (Shoulda::Controller::Macros)
-
-Macros to test the most common controller patterns...
-  
-  class PostsControllerTest < ActionController::TestCase
-    context "on GET to :show for first record" do
-      setup do
-        get :show, :id => 1
-      end
-
-      should_assign_to :user
-      should_respond_with :success
-      should_render_template :show
-      should_not_set_the_flash
-
-      should "do something else really cool" do
-        assert_equal 1, assigns(:user).id
-      end
-    end
-  end
-  
 === Helpful Assertions (Shoulda::Assertions)
 
 More to come here, but have fun with what's there.
@@ -101,26 +100,12 @@ More to come here, but have fun with what's there.
   assert_contains(['a', '1'], /\d/)
   assert_contains(['a', '1'], 'a')
 
-=== 3rd Party and Application Specific Macros
-
-Any *.rb file under RAILS_ROOT/test/shoulda_macros/ or vendor/(plugins|gems)/gem_name/shoulda_macros/ will be automatically required when you run your tests.  This allows you to distribute macros with your plugins, or to organize the macros inside your application.  Remember to add your macro to Test::Unit::TestCase in the macro file:
-
-  # test/shoulda_macros/security.rb
-  class Test::Unit::TestCase
-    def self.should_be_denied(opts = {})
-      should_set_the_flash_to(opts[:flash] || /Please log in/i)
-      should_redirect_to(opts[:redirect]   || 'login_url')
-    end
-  end
-
 = Rails Installation (Test::Unit)
 
-=== As a Gem
-
-Use this if you prefer to use versioned releases of shoulda.  Specify the gem dependency in your config/environment.rb file:
+Specify the gem dependency in your config/environment.rb file:
 
   Rails::Initializer.run do |config|
-    config.gem "thoughtbot-shoulda", :lib => "shoulda", :source => "http://gems.github.com"
+    config.gem "shoulda", :lib => "shoulda"
   end
 
 Then:
@@ -128,29 +113,15 @@ Then:
   $ rake gems:install
   $ rake gems:unpack
 
-=== As a Plugin
-
-Use this if you prefer to use the edge version of shoulda:
-
-  $ script/plugin install git://github.com/thoughtbot/shoulda.git
-
-=== As a Plugin (using git submodules)
-
-Use this if you prefer the idea of being able to easily switch between using edge or a tagged version of shoulda:
-
-  $ git submodule add git://github.com/thoughtbot/shoulda.git vendor/plugins/shoulda
-
 = Rails Installation (RSpec)
 
 If you're using Shoulda with RSpec, we recommend that you add config.gem lines
 for RSpec and Shoulda in your config/environment/test.rb file, but do not ask
 Rails to load the RSpec and Shoulda libraries:
 
-  config.gem 'rspec', :lib => false
+  config.gem 'rspec',       :lib => false
   config.gem 'rspec-rails', :lib => false
-  config.gem 'thoughtbot-shoulda',
-             :lib => false,
-             :source => 'http://gems.github.com'
+  config.gem 'shoulda',     :lib => false
 
 Then require shoulda from your spec/spec_helper.rb file, before Spec::Runner is
 configured:
@@ -162,10 +133,22 @@ configured:
 
 You should not need to require anything besides the top-level shoulda library.
 
+= Rails 3 Installation (RSpec)
+
+With Rails 3 and Bundler, requiring Shoulda is as easy as adding it to your Gemfile:
+
+  group :test do
+    gem "shoulda"
+    gem "rspec-rails", "2.0.0.beta.12"
+  end
+
+Shoulda will automatically include matchers into the appropriate example
+groups.
+
 = Credits
 
-Shoulda is maintained by {Tammer Saleh}[mailto:tsaleh@thoughtbot.com], and is funded by Thoughtbot[http://www.thoughtbot.com], inc.
+Shoulda is maintained and funded by {thougthbot}[http://thoughtbot.com/community]
 
 = License
 
-Shoulda is Copyright © 2006-2008 Tammer Saleh, Thoughtbot. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.
+Shoulda is Copyright © 2006-2010 Tammer Saleh, Thoughtbot. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.

data/Rakefile

@@ -1,10 +1,12 @@
+require 'rubygems'
 require 'rake'
 require 'rake/testtask'
 require 'rake/rdoctask'
 require 'rake/gempackagetask'
+require 'cucumber/rake/task'
 
 $LOAD_PATH.unshift("lib")
-require 'shoulda'
+require 'shoulda/version'
 load 'tasks/shoulda.rake'
 
 # Test::Unit::UI::VERBOSE
@@ -30,18 +32,6 @@ task :coverage do
   system "rcov --rails --sort coverage -Ilib #{files.join(' ')}"
 end
 
-desc 'Update documentation on website'
-task :sync_docs => 'rdoc' do
-  `rsync -ave ssh doc/ dev@dev.thoughtbot.com:/home/dev/www/dev.thoughtbot.com/shoulda`
-end
-
-desc 'Default: run tests for all supported versions of Rails'
-task :default do
-  %w(2.3.8 3.0.0.beta3).each do |version|
-    system("RAILS_VERSION=#{version} rake -s test;")
-  end
-end
-
 eval("$specification = begin; #{IO.read('shoulda.gemspec')}; end")
 Rake::GemPackageTask.new $specification do |pkg|
   pkg.need_tar = true
@@ -51,3 +41,30 @@ end
 desc "Clean files generated by rake tasks"
 task :clobber => [:clobber_rdoc, :clobber_package]
 
+namespace :cucumber do
+  Cucumber::Rake::Task.new(:rails2, "Run the cucumber features in Rails 2") do |t|
+    t.fork = true
+    t.cucumber_opts = ['--format', (ENV['CUCUMBER_FORMAT'] || 'progress')]
+    t.profile = 'rails2'
+  end
+
+  Cucumber::Rake::Task.new(:rails3, "Run the cucumber features in Rails 3") do |t|
+    t.fork = true
+    t.cucumber_opts = ['--format', (ENV['CUCUMBER_FORMAT'] || 'progress')]
+    t.profile = 'rails3'
+  end
+end
+
+desc "Run the cucumber features in both Rails 2 and 3"
+task :cucumber => ["cucumber:rails2", "cucumber:rails3"]
+
+desc 'run tests for all supported versions of Rails'
+task :test_all do
+  %w(2.3.8 3.0.0.beta4).each do |version|
+    system("RAILS_VERSION=#{version} rake -s test;")
+  end
+end
+
+desc 'Default: run test and cucumber features for support versions'
+task :default => [:test_all, :cucumber]
+

data/lib/shoulda.rb

@@ -1,7 +1,9 @@
 require 'shoulda/version'
 
-if defined? Spec
-  require 'shoulda/rspec'
+if defined?(RSpec)
+  require 'shoulda/integrations/rspec2'
+elsif defined?(Spec)
+  require 'shoulda/integrations/rspec'
 else
-  require 'shoulda/test_unit'
+  require 'shoulda/integrations/test_unit'
 end

data/lib/shoulda/action_controller/matchers.rb

@@ -14,24 +14,24 @@ module Shoulda # :nodoc:
 
     # By using the macro helpers you can quickly and easily create concise and
     # easy to read test suites.
-    # 
+    #
     # This code segment:
-    # 
+    #
     #   describe UsersController, "on GET to show with a valid id" do
     #     before(:each) do
     #       get :show, :id => User.first.to_param
     #     end
-    # 
+    #
     #     it { should assign_to(:user) }
     #     it { should respond_with(:success) }
     #     it { should render_template(:show) }
     #     it { should not_set_the_flash) }
-    # 
+    #
     #     it "should do something else really cool" do
     #       assigns[:user].id.should == 1
     #     end
     #   end
-    # 
+    #
     # Would produce 5 tests for the show action
     module Matchers
     end

data/lib/shoulda/action_controller/matchers/assign_to_matcher.rb

@@ -63,7 +63,7 @@ module Shoulda # :nodoc:
               "Expected action to assign a value for @#{@variable}"
             false
           else
-            @negative_failure_message = 
+            @negative_failure_message =
               "Didn't expect action to assign a value for @#{@variable}, " <<
               "but it was assigned to #{assigned_value.inspect}"
             true

data/lib/shoulda/action_controller/matchers/respond_with_content_type_matcher.rb

@@ -34,7 +34,7 @@ module Shoulda # :nodoc:
         def description
           "respond with content type of #{@content_type}"
         end
-        
+
         def matches?(controller)
           @controller = controller
           if @content_type.is_a?(Regexp)
@@ -43,32 +43,32 @@ module Shoulda # :nodoc:
             response_content_type == @content_type
           end
         end
-        
+
         def failure_message
           "Expected #{expectation}"
         end
-        
+
         def negative_failure_message
           "Did not expect #{expectation}"
         end
-        
+
         protected
-        
+
         def response_content_type
           @controller.response.content_type.to_s
         end
-        
+
         def lookup_by_extension(extension)
           Mime::Type.lookup_by_extension(extension.to_s).to_s
         end
-        
+
         def expectation
           "content type to be #{@content_type}, " <<
           "but was #{response_content_type}"
         end
-        
+
       end
-      
+
     end
   end
 end

data/lib/shoulda/action_controller/matchers/respond_with_matcher.rb

@@ -24,16 +24,16 @@ module Shoulda # :nodoc:
         def initialize(status)
           @status = symbol_to_status_code(status)
         end
-        
+
         def matches?(controller)
           @controller = controller
           correct_status_code? || correct_status_code_range?
         end
-        
+
         def failure_message
           "Expected #{expectation}"
         end
-        
+
         def negative_failure_message
           "Did not expect #{expectation}"
         end
@@ -41,29 +41,29 @@ module Shoulda # :nodoc:
         def description
           "respond with #{@status}"
         end
-        
+
         protected
-        
+
         def correct_status_code?
           response_code == @status
         end
-        
+
         def correct_status_code_range?
           @status.is_a?(Range) &&
             @status.include?(response_code)
         end
-        
+
         def response_code
           @controller.response.response_code
         end
-        
+
         def symbol_to_status_code(potential_symbol)
           case potential_symbol
           when :success  then 200
           when :redirect then 300..399
           when :missing  then 404
           when :error    then 500..599
-          when Symbol 
+          when Symbol
             if defined?(::Rack::Utils::SYMBOL_TO_STATUS_CODE)
               ::Rack::Utils::SYMBOL_TO_STATUS_CODE[potential_symbol]
             else
@@ -73,13 +73,13 @@ module Shoulda # :nodoc:
             potential_symbol
           end
         end
-        
+
         def expectation
           "response to be a #{@status}, but was #{response_code}"
         end
-        
+
       end
-      
+
     end
   end
 end