shoulda 2.0.0

data/test/README

@@ -0,0 +1,36 @@
+The Shoulda test suite (in particular - the tests that test shoulda)
+
+Quick overview:
+
+The test directory contains the following files and subdirectories:
+
+* rails_root - contains the stripped down rails application that the tests run against.  The rails root contains:
+** the models, controllers, and views defined under app/
+** the sqlite3.rb environment file
+** a migration file for each model
+** a shoulda initializer that simulates loading the plugin but without relying on vendor/plugins
+* fixtures - contain the sample DB data for each model
+* functional - controller tests for each of the controllers under rails_root/app
+* unit - model tests for each of the models under rails_root/app
+* other - tests for the shoulda contexts, should statements, and assertions
+* test_helper.rb - responsible for initializing the test environment
+** sets the rails_env to sqlite3
+** sets the rails_root
+** runs all the migrations against the in-memory sqlite3 db
+** adds some magic to load the right fixture files
+
+In order to add a new model (or controller) to the test suite:
+
+* add that model to rails_root/app/models
+* add a migration for that model
+* add a fixture file
+* add a test for that file under test/units
+
+Dependencies:
+
+* Rails gem installed in the host system
+* A working sqlite3 installation.
+
+If you have problems running these tests, please notify the mailing list:  shoulda@googlegroups.com
+
+- Tammer Saleh <tsaleh@thoughtbot.com>

data/test/fixtures/addresses.yml

@@ -0,0 +1,3 @@
+first:
+  title: Home
+  addressable: first (User)

data/test/fixtures/posts.yml

@@ -0,0 +1,5 @@
+first:
+  id: 1
+  title: My Cute Kitten!
+  body: This is totally a cute kitten
+  user_id: 1

data/test/fixtures/tags.yml

@@ -0,0 +1,9 @@
+first:
+  id: 1
+  name: Stuff
+second:
+  id: 2
+  name: Rails
+third:
+  id: 3
+  name: Nothing

data/test/fixtures/users.yml

@@ -0,0 +1,6 @@
+first:
+  id: 1
+  name: Some dude
+  age: 2
+  email: none@none.com
+  ssn: 123456789

data/test/functional/posts_controller_test.rb

@@ -0,0 +1,104 @@
+require File.dirname(__FILE__) + '/../test_helper'
+require 'posts_controller'
+
+# Re-raise errors caught by the controller.
+class PostsController; def rescue_action(e) raise e end; end
+
+class PostsControllerTest < Test::Unit::TestCase
+  fixtures :all
+
+  def setup
+    @controller = PostsController.new
+    @request    = ActionController::TestRequest.new
+    @response   = ActionController::TestResponse.new
+    @post       = Post.find(:first)
+  end
+  
+  # autodetects the :controller
+  should_route :get,    '/posts',     :action => :index
+  # explicitly specify :controller
+  should_route :post,   '/posts',     :controller => :posts, :action => :create
+  # non-string parameter
+  should_route :get,    '/posts/1',   :action => :show, :id => 1
+  # string-parameter
+  should_route :put,    '/posts/1',   :action => :update, :id => "1"
+  should_route :delete, '/posts/1',   :action => :destroy, :id => 1
+  should_route :get,    '/posts/new', :action => :new
+  
+  # Test the nested routes
+  should_route :get,    '/users/5/posts',     :action => :index, :user_id => 5
+  should_route :post,   '/users/5/posts',     :action => :create, :user_id => 5
+  should_route :get,    '/users/5/posts/1',   :action => :show, :id => 1, :user_id => 5
+  should_route :delete, '/users/5/posts/1',   :action => :destroy, :id => 1, :user_id => 5
+  should_route :get,    '/users/5/posts/new', :action => :new, :user_id => 5
+  should_route :put,    '/users/5/posts/1',   :action => :update, :id => 1, :user_id => 5
+
+  context "The public" do
+    setup do
+      @request.session[:logged_in] = false
+    end
+
+    should_be_restful do |resource|
+      resource.parent = :user
+
+      resource.denied.actions = [:index, :show, :edit, :new, :create, :update, :destroy]
+      resource.denied.flash = /what/i
+      resource.denied.redirect = '"/"'
+    end
+  end
+
+  context "Logged in" do
+    setup do
+      @request.session[:logged_in] = true
+    end
+
+    should_be_restful do |resource|
+      resource.parent = :user
+
+      resource.create.params = { :title => "first post", :body => 'blah blah blah'}
+      resource.update.params = { :title => "changed" }
+    end
+
+    context "viewing posts for a user" do
+      setup do
+        get :index, :user_id => users(:first)
+      end
+      should_respond_with :success
+      should_assign_to :user, :class => User, :equals => 'users(:first)'
+      should_fail do
+        should_assign_to :user, :class => Post
+      end
+      should_fail do
+        should_assign_to :user, :equals => 'posts(:first)'
+      end
+      should_assign_to :posts
+      should_not_assign_to :foo, :bar
+    end
+
+    context "viewing posts for a user with rss format" do
+      setup do
+        get :index, :user_id => users(:first), :format => 'rss'
+        @user = users(:first)
+      end
+      should_respond_with :success
+      should_respond_with_content_type 'application/rss+xml'
+      should_respond_with_content_type :rss
+      should_respond_with_content_type /rss/
+      should_return_from_session :special, "'$2 off your next purchase'"
+      should_return_from_session :special_user_id, '@user.id'
+      should_assign_to :user, :posts
+      should_not_assign_to :foo, :bar
+    end
+
+    context "viewing a post on GET to #show" do
+      setup { get :show, :user_id => users(:first), :id => posts(:first) }
+      should_render_with_layout 'wide'
+    end
+
+    context "on GET to #new" do
+      setup { get :new, :user_id => users(:first) }
+      should_render_without_layout
+    end
+  end
+
+end

data/test/functional/users_controller_test.rb

@@ -0,0 +1,36 @@
+require File.dirname(__FILE__) + '/../test_helper'
+require 'users_controller'
+
+# Re-raise errors caught by the controller.
+class UsersController; def rescue_action(e) raise e end; end
+
+class UsersControllerTest < Test::Unit::TestCase
+  fixtures :all
+
+  def setup
+    @controller = UsersController.new
+    @request    = ActionController::TestRequest.new
+    @response   = ActionController::TestResponse.new
+    @user       = User.find(:first)
+  end
+
+  should_be_restful do |resource|
+    resource.identifier = :id
+    resource.klass      = User
+    resource.object     = :user
+    resource.parent     = []
+    resource.actions    = [:index, :show, :new, :edit, :update, :create, :destroy]
+    resource.formats    = [:html, :xml]
+
+    resource.create.params = { :name => "bob", :email => 'bob@bob.com', :age => 13, :ssn => "123456789"}
+    resource.update.params = { :name => "sue" }
+
+    resource.create.redirect  = "user_url(@user)"
+    resource.update.redirect  = "user_url(@user)"
+    resource.destroy.redirect = "users_url"
+
+    resource.create.flash  = /created/i
+    resource.update.flash  = /updated/i
+    resource.destroy.flash = /removed/i
+  end
+end

data/test/other/context_test.rb

@@ -0,0 +1,145 @@
+require File.join(File.dirname(__FILE__), '..', 'test_helper')
+
+class ContextTest < Test::Unit::TestCase # :nodoc:
+  
+  def self.context_macro(&blk)
+    context "with a subcontext made by a macro" do
+      setup { @context_macro = :foo }
+
+      merge_block &blk 
+    end
+  end
+
+  # def self.context_macro(&blk)
+  #   context "with a subcontext made by a macro" do
+  #     setup { @context_macro = :foo }
+  #     yield # <- this doesn't work.
+  #   end
+  # end
+
+  context "context with setup block" do
+    setup do
+      @blah = "blah"
+    end
+    
+    should "run the setup block" do
+      assert_equal "blah", @blah
+    end
+    
+    should "have name set right" do
+      assert_match(/^test: context with setup block/, self.to_s)
+    end
+
+    context "and a subcontext" do
+      setup do
+        @blah = "#{@blah} twice"
+      end
+      
+      should "be named correctly" do
+        assert_match(/^test: context with setup block and a subcontext should be named correctly/, self.to_s)
+      end
+      
+      should "run the setup blocks in order" do
+        assert_equal @blah, "blah twice"
+      end
+    end
+
+    context_macro do
+      should "have name set right" do
+        assert_match(/^test: context with setup block with a subcontext made by a macro should have name set right/, self.to_s)
+      end
+
+      should "run the setup block of that context macro" do
+        assert_equal :foo, @context_macro
+      end
+
+      should "run the setup block of the main context" do
+        assert_equal "blah", @blah
+      end
+    end
+
+  end
+
+  context "another context with setup block" do
+    setup do
+      @blah = "foo"
+    end
+    
+    should "have @blah == 'foo'" do
+      assert_equal "foo", @blah
+    end
+
+    should "have name set right" do
+      assert_match(/^test: another context with setup block/, self.to_s)
+    end
+  end
+  
+  context "context with method definition" do
+    setup do
+      def hello; "hi"; end
+    end
+    
+    should "be able to read that method" do
+      assert_equal "hi", hello
+    end
+
+    should "have name set right" do
+      assert_match(/^test: context with method definition/, self.to_s)
+    end
+  end
+  
+  context "another context" do
+    should "not define @blah" do
+      assert_nil @blah
+    end
+  end
+    
+  context "context with multiple setups and/or teardowns" do
+    
+    cleanup_count = 0
+        
+    2.times do |i|
+      setup { cleanup_count += 1 }
+      teardown { cleanup_count -= 1 }
+    end
+    
+    2.times do |i|
+      should "call all setups and all teardowns (check ##{i + 1})" do
+        assert_equal 2, cleanup_count
+      end
+    end
+    
+    context "subcontexts" do
+      
+      2.times do |i|
+        setup { cleanup_count += 1 }
+        teardown { cleanup_count -= 1 }
+      end
+                  
+      2.times do |i|
+        should "also call all setups and all teardowns in parent and subcontext (check ##{i + 1})" do
+          assert_equal 4, cleanup_count
+        end
+      end
+      
+    end
+    
+  end
+  
+  should_eventually "pass, since it's unimplemented" do
+    flunk "what?"
+  end
+
+  should_eventually "not require a block when using should_eventually"
+  should "pass without a block, as that causes it to piggyback to should_eventually"
+  
+  context "context for testing should piggybacking" do
+    should "call should_eventually as we are not passing a block"
+  end
+
+  context "context" do
+    context "with nested subcontexts" do
+      should_eventually "only print this statement once for a should_eventually"
+    end
+  end
+end

data/test/other/convert_to_should_syntax_test.rb

@@ -0,0 +1,63 @@
+require 'test/unit'
+
+class ConvertToShouldSyntaxTest < Test::Unit::TestCase # :nodoc:
+
+  BEFORE_FIXTURE = <<-EOS
+    class DummyTest < Test::Unit::TestCase
+
+      should "Not change this_word_with_underscores" do
+      end
+
+      def test_should_be_working
+        assert true
+      end
+
+      def test_some_cool_stuff
+        assert true
+      end
+
+      def non_test_method
+      end
+
+    end
+  EOS
+
+  AFTER_FIXTURE = <<-EOS
+    class DummyTest < Test::Unit::TestCase
+
+      should "Not change this_word_with_underscores" do
+      end
+
+      should "be working" do
+        assert true
+      end
+
+      should "RENAME ME: test some cool stuff" do
+        assert true
+      end
+
+      def non_test_method
+      end
+
+    end
+  EOS
+  
+  FIXTURE_PATH = "./convert_to_should_syntax_fixture.dat"
+
+  RUBY = ENV['RUBY'] || 'ruby'
+
+  def test_convert_to_should_syntax
+    File.open(FIXTURE_PATH, "w") {|f| f.write(BEFORE_FIXTURE)}
+    cmd = "#{RUBY} #{File.join(File.dirname(__FILE__), '../../bin/convert_to_should_syntax')} #{FIXTURE_PATH}"
+    output = `#{cmd}`
+    File.unlink($1) if output.match(/has been stored in '([^']+)/)
+    assert_match(/has been converted/, output)
+    result = IO.read(FIXTURE_PATH)
+    assert_equal result, AFTER_FIXTURE
+  end
+
+  def teardown
+    File.unlink(FIXTURE_PATH)
+  end
+
+end

data/test/other/helpers_test.rb

@@ -0,0 +1,183 @@
+require File.join(File.dirname(__FILE__), '..', 'test_helper')
+require 'action_mailer'
+require 'mocha'
+
+class HelpersTest < Test::Unit::TestCase # :nodoc:
+
+  context "given delivered emails" do
+    setup do
+      email1 = stub(:subject => "one", :to => ["none1@email.com"])
+      email2 = stub(:subject => "two", :to => ["none2@email.com"])
+      ActionMailer::Base.stubs(:deliveries).returns([email1, email2])
+    end
+
+    should "have sent an email" do
+      assert_sent_email
+
+      assert_raises(Test::Unit::AssertionFailedError) do
+        assert_did_not_send_email
+      end
+    end
+
+    should "find email one" do
+      assert_sent_email do |e|
+        e.subject =~ /one/
+      end
+    end
+
+    should "not find an email that doesn't exist" do
+      assert_raises(Test::Unit::AssertionFailedError) do
+        assert_sent_email do |e|
+          e.subject =~ /whatever/
+        end
+      end
+    end
+  end
+
+  context "when there are no emails" do
+    setup do
+      ActionMailer::Base.stubs(:deliveries).returns([])
+    end
+
+    should "not have sent an email" do
+      assert_did_not_send_email
+
+      assert_raises(Test::Unit::AssertionFailedError) do
+        assert_sent_email
+      end
+    end
+  end
+
+  context "an array of values" do
+    setup do
+      @a = ['abc', 'def', 3]
+    end
+
+    [/b/, 'abc', 3].each do |x|
+      should "contain #{x.inspect}" do
+        assert_raises(Test::Unit::AssertionFailedError) do
+          assert_does_not_contain @a, x
+        end
+        assert_contains @a, x
+      end
+    end
+
+    should "not contain 'wtf'" do
+      assert_raises(Test::Unit::AssertionFailedError) {assert_contains @a, 'wtf'}
+      assert_does_not_contain @a, 'wtf'
+    end
+
+    should "be the same as another array, ordered differently" do
+      assert_same_elements(@a, [3, "def", "abc"])
+      assert_raises(Test::Unit::AssertionFailedError) do
+        assert_same_elements(@a, [3, 3, "def", "abc"])
+      end
+      assert_raises(Test::Unit::AssertionFailedError) do
+        assert_same_elements([@a, "abc"].flatten, [3, 3, "def", "abc"])
+      end
+    end
+  end
+
+  context "an array of values" do
+    setup do
+      @a = [1, 2, "(3)"]
+    end
+
+    context "after adding another value" do
+      setup do
+        @a.push(4)
+      end
+
+      should_change "@a.length", :by => 1
+      should_change "@a.length", :from => 3
+      should_change "@a.length", :to => 4
+      should_change "@a[0]", :by => 0
+      should_not_change "@a[0]"
+    end
+
+    context "after replacing it with an array of strings" do
+      setup do
+        @a = %w(a b c d e f)
+      end
+
+      should_change "@a.length", :by => 3
+      should_change "@a.length", :from => 3, :to => 6, :by => 3
+      should_change "@a[0]"
+      should_change "@a[1]", :from => 2, :to => "b"
+      should_change "@a[2]", :from => /\d/, :to => /\w/
+      should_change "@a[3]", :to => String
+    end
+  end
+
+  context "assert_good_value" do
+    should "validate a good email address" do
+      assert_good_value User.new, :email, "good@example.com"
+    end
+
+    should "validate a good SSN with a custom message" do
+      assert_good_value User.new, :ssn, "xxxxxxxxx", /length/
+    end
+
+    should "fail to validate a bad email address" do
+      assert_raises Test::Unit::AssertionFailedError do
+        assert_good_value User.new, :email, "bad"
+      end
+    end
+
+    should "fail to validate a bad SSN that is too short" do
+      assert_raises Test::Unit::AssertionFailedError do
+        assert_good_value User.new, :ssn, "x", /length/
+      end
+    end
+
+    should "accept a class as the first argument" do
+      assert_good_value User, :email, "good@example.com"
+    end
+
+    context "with an instance variable" do
+      setup do
+        @product = Product.new(:tangible => true)
+      end
+
+      should "use that instance variable" do
+        assert_good_value Product, :price, "9999", /included/
+      end
+    end
+  end
+
+  context "assert_bad_value" do
+    should "invalidate a bad email address" do
+      assert_bad_value User.new, :email, "bad"
+    end
+
+    should "invalidate a bad SSN with a custom message" do
+      assert_bad_value User.new, :ssn, "x", /length/
+    end
+
+    should "fail to invalidate a good email address" do
+      assert_raises Test::Unit::AssertionFailedError do
+        assert_bad_value User.new, :email, "good@example.com"
+      end
+    end
+
+    should "fail to invalidate a good SSN" do
+      assert_raises Test::Unit::AssertionFailedError do
+        assert_bad_value User.new, :ssn, "xxxxxxxxx", /length/
+      end
+    end
+
+    should "accept a class as the first argument" do
+      assert_bad_value User, :email, "bad"
+    end
+
+    context "with an instance variable" do
+      setup do
+        @product = Product.new(:tangible => true)
+      end
+
+      should "use that instance variable" do
+        assert_bad_value Product, :price, "0", /included/
+      end
+    end
+  end
+end