shoulda 2.0.0

data/CONTRIBUTION_GUIDELINES.rdoc

@@ -0,0 +1,12 @@
+We're using GitHub[http://github.com/thoughtbot/shoulda/tree/master] and Lighthouse[http://thoughtbot.lighthouseapp.com/projects/5807], and we've been getting any combination of github pull requests, Lighthouse 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 submitting patches, please cut each fix or feature into a separate patch.
+* There should be a Lighthouse[http://thoughtbot.lighthouseapp.com/projects/5807] ticket for any submission.  If you've found a bug and want to fix it, open a new ticket at the same time. 
+* We've got github/lighthouse integration going, so you can update tickets when you commit.  {This blog post}[http://hoth.entp.com/2008/4/11/github-and-lighthouse-sitting-in-a-tree] explains the commit options pretty well.
+* Please <b>don't send pull requests</b>  Just update the lighthouse ticket 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/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2007, Tammer Saleh, Thoughtbot, Inc.
+
+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.rdoc

@@ -0,0 +1,132 @@
+= 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.
+
+Helpers:: #context and #should give you rSpec like test blocks.
+          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.
+
+= Usage
+
+=== Context Helpers (ThoughtBot::Shoulda::Context)
+
+Stop killing your fingers with all of those underscores...  Name your tests with plain sentences!
+
+  class UserTest << Test::Unit::TestCase
+    context "A User instance" do
+      setup do
+        @user = User.find(:first)
+      end
+
+      should "return its full name" do
+        assert_equal 'John Doe', @user.full_name
+      end
+
+      context "with a profile" do
+        setup do
+          @user.profile = Profile.find(:first)
+        end
+
+        should "return true when sent #has_profile?" do
+          assert @user.has_profile?
+        end
+      end
+    end
+  end
+
+Produces the following test methods:
+
+  "test: A User instance should return its full name."
+  "test: A User instance with a profile should return true when sent #has_profile?."
+
+So readable!
+
+=== ActiveRecord Tests (ThoughtBot::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_require_unique_attributes :title
+    should_require_attributes :body, :message => /wtf/
+    should_require_attributes :title
+    should_only_allow_numeric_values_for :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_protect_attributes :password
+  end
+
+Makes TDD so much easier.
+
+=== Controller Tests (ThoughtBot::Shoulda::Controller::Macros)
+
+Macros to test the most common controller patterns...
+
+  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
+
+Test entire controllers in a few lines...
+
+  class PostsControllerTest < Test::Unit::TestCase
+    should_be_restful do |resource|
+      resource.parent = :user
+
+      resource.create.params = { :title => "first post", :body => 'blah blah blah'}
+      resource.update.params = { :title => "changed" }
+    end
+  end
+
+should_be_restful generates 40 tests on the fly, for both html and xml requests.
+
+=== Helpful Assertions (ThoughtBot::Shoulda::Assertions)
+
+More to come here, but have fun with what's there.
+
+  assert_same_elements([:a, :b, :c], [:c, :a, :b])
+  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
+
+= Credits
+
+Shoulda is maintained by {Tammer Saleh}[mailto:tsaleh@thoughtbot.com], and is funded by Thoughtbot[http://www.thoughtbot.com], inc.
+
+= 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.

data/Rakefile

@@ -0,0 +1,72 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'lib/shoulda/context'
+load 'tasks/shoulda.rake'
+
+# Test::Unit::UI::VERBOSE
+test_files_pattern = 'test/{unit,functional,other}/**/*_test.rb'
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.pattern = test_files_pattern
+  t.verbose = false
+end
+
+Rake::RDocTask.new { |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = "Shoulda -- Making tests easy on the fingers and eyes"
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.template = "#{ENV['template']}.rb" if ENV['template']
+  rdoc.rdoc_files.include('README.rdoc', 'CONTRIBUTION_GUIDELINES.rdoc', 'lib/**/*.rb')
+}
+
+desc "Run code-coverage analysis using rcov"
+task :coverage do
+  rm_rf "coverage"
+  files = Dir[test_files_pattern]
+  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.'
+task :default => ['test']
+
+spec = Gem::Specification.new do |s|
+  s.name              = "shoulda"
+  s.version           = Thoughtbot::Shoulda::VERSION
+  s.summary           = "Making tests easy on the fingers and eyes"
+  s.homepage          = "http://thoughtbot.com/projects/shoulda"
+  s.rubyforge_project = "shoulda"
+
+  s.files       = FileList["[A-Z]*", "{bin,lib,test}/**/*"]
+  s.executables = s.files.grep(/^bin/) { |f| File.basename(f) }
+
+  s.has_rdoc         = true
+  s.extra_rdoc_files = ["README.rdoc", "CONTRIBUTION_GUIDELINES.rdoc"]
+  s.rdoc_options     = ["--line-numbers", "--inline-source", "--main", "README.rdoc"]
+
+  s.authors = ["Tammer Saleh"]
+  s.email   = "tsaleh@thoughtbot.com"
+
+  s.add_dependency "activesupport", ">= 2.0"
+end
+
+Rake::GemPackageTask.new spec do |pkg|
+  pkg.need_tar = true
+  pkg.need_zip = true
+end
+
+desc "Clean files generated by rake tasks"
+task :clobber => [:clobber_rdoc, :clobber_package]
+
+desc "Generate a gemspec file for GitHub"
+task :gemspec do
+  File.open("#{spec.name}.gemspec", 'w') do |f|
+    f.write spec.to_ruby
+  end
+end

data/bin/convert_to_should_syntax

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+require 'tmpdir'
+
+TMP = Dir::tmpdir
+
+def usage(msg = nil)
+  puts "Error: #{msg}" if msg
+  puts if msg
+  puts "Usage: #{File.basename(__FILE__)} normal_test_file.rb"
+  puts
+  puts "Will convert an existing test file with names like "
+  puts
+  puts "  def test_should_do_stuff"
+  puts "    ..."
+  puts "  end"
+  puts
+  puts "to one using the new syntax: "
+  puts
+  puts "  should \"be super cool\" do"
+  puts "    ..."
+  puts "  end"
+  puts
+  puts "A copy of the old file will be left under #{TMP} in case\nthis script just seriously screws up"
+  puts
+  exit (msg ? 2 : 0)
+end
+
+usage("Wrong number of arguments.") unless ARGV.size == 1
+usage("Temp directory '#{TMP}' is not valid. Set TMPDIR environment variable to a writeable directory.") unless File.directory?(TMP) && File.writable?(TMP)
+
+file = ARGV.shift
+tmpfile = File.join(TMP, File.basename(file))
+usage("File '#{file}' doesn't exist") unless File.exists?(file)
+
+FileUtils.cp(file, tmpfile)
+contents = File.read(tmpfile)
+contents.gsub!(/def test_should_(\S+)/) {|line| "should \"#{$1.tr('_', ' ')}\" do"}
+contents.gsub!(/def test_(\S+)/) {|line| "should \"RENAME ME: test #{$1.tr('_', ' ')}\" do"}
+File.open(file, 'w') { |f| f.write(contents) }
+
+puts "File '#{file}' has been converted to 'should' syntax.  Old version has been stored in '#{tmpfile}'"

data/lib/shoulda.rb

@@ -0,0 +1,16 @@
+require 'shoulda/context'
+require 'shoulda/proc_extensions'
+require 'shoulda/assertions'
+require 'shoulda/macros'
+require 'shoulda/helpers'
+
+module Test # :nodoc: all
+  module Unit
+    class TestCase
+      extend Thoughtbot::Shoulda
+      include ThoughtBot::Shoulda::Assertions
+      extend ThoughtBot::Shoulda::Macros
+      include ThoughtBot::Shoulda::Helpers
+    end
+  end
+end

data/lib/shoulda/action_mailer.rb

@@ -0,0 +1,10 @@
+require 'shoulda'
+require 'shoulda/action_mailer/assertions'
+
+module Test # :nodoc: all
+  module Unit
+    class TestCase
+      include ThoughtBot::Shoulda::ActionMailer::Assertions
+    end
+  end
+end

data/lib/shoulda/action_mailer/assertions.rb

@@ -0,0 +1,39 @@
+module ThoughtBot # :nodoc:
+  module Shoulda # :nodoc:
+    module ActionMailer # :nodoc:
+      module Assertions
+        # Asserts that an email was delivered.  Can take a block that can further
+        # narrow down the types of emails you're expecting.
+        #
+        #  assert_sent_email
+        #
+        # Passes if ActionMailer::Base.deliveries has an email
+        #
+        #  assert_sent_email do |email|
+        #    email.subject =~ /hi there/ && email.to.include?('none@none.com')
+        #  end
+        #
+        # Passes if there is an email with subject containing 'hi there' and
+        # 'none@none.com' as one of the recipients.
+        #
+        def assert_sent_email
+          emails = ::ActionMailer::Base.deliveries
+          assert !emails.empty?, "No emails were sent"
+          if block_given?
+            matching_emails = emails.select {|email| yield email }
+            assert !matching_emails.empty?, "None of the emails matched."
+          end
+        end
+
+        # Asserts that no ActionMailer mails were delivered
+        #
+        #  assert_did_not_send_email
+        def assert_did_not_send_email
+          msg = "Sent #{::ActionMailer::Base.deliveries.size} emails.\n"
+          ::ActionMailer::Base.deliveries.each { |m| msg << "  '#{m.subject}' sent to #{m.to.to_sentence}\n" }
+          assert ::ActionMailer::Base.deliveries.empty?, msg
+        end
+      end
+    end
+  end
+end

data/lib/shoulda/active_record.rb

@@ -0,0 +1,12 @@
+require 'shoulda'
+require 'shoulda/active_record/assertions'
+require 'shoulda/active_record/macros'
+
+module Test # :nodoc: all
+  module Unit
+    class TestCase
+      include ThoughtBot::Shoulda::ActiveRecord::Assertions
+      extend ThoughtBot::Shoulda::ActiveRecord::Macros
+    end
+  end
+end

data/lib/shoulda/active_record/assertions.rb

@@ -0,0 +1,85 @@
+module ThoughtBot # :nodoc:
+  module Shoulda # :nodoc:
+    module ActiveRecord # :nodoc:
+      module Assertions
+        # Asserts that the given object can be saved
+        #
+        #  assert_save User.new(params)
+        def assert_save(obj)
+          assert obj.save, "Errors: #{pretty_error_messages obj}"
+          obj.reload
+        end
+
+        # Asserts that the given object is valid
+        #
+        #  assert_valid User.new(params)
+        def assert_valid(obj)
+          assert obj.valid?, "Errors: #{pretty_error_messages obj}"
+        end
+
+        # Asserts that an Active Record model validates with the passed
+        # <tt>value</tt> by making sure the <tt>error_message_to_avoid</tt> is not
+        # contained within the list of errors for that attribute.
+        #
+        #   assert_good_value(User.new, :email, "user@example.com")
+        #   assert_good_value(User.new, :ssn, "123456789", /length/)
+        #
+        # If a class is passed as the first argument, a new object will be
+        # instantiated before the assertion.  If an instance variable exists with
+        # the same name as the class (underscored), that object will be used
+        # instead.
+        #
+        #   assert_good_value(User, :email, "user@example.com")
+        #
+        #   @product = Product.new(:tangible => false)
+        #   assert_good_value(Product, :price, "0")
+        def assert_good_value(object_or_klass, attribute, value, error_message_to_avoid = //)
+          object = get_instance_of(object_or_klass)
+          object.send("#{attribute}=", value)
+          object.valid?
+          assert_does_not_contain(object.errors.on(attribute), error_message_to_avoid, "when set to #{value.inspect}")
+        end
+
+        # Asserts that an Active Record model invalidates the passed
+        # <tt>value</tt> by making sure the <tt>error_message_to_expect</tt> is
+        # contained within the list of errors for that attribute.
+        #
+        #   assert_bad_value(User.new, :email, "invalid")
+        #   assert_bad_value(User.new, :ssn, "123", /length/)
+        #
+        # If a class is passed as the first argument, a new object will be
+        # instantiated before the assertion.  If an instance variable exists with
+        # the same name as the class (underscored), that object will be used
+        # instead.
+        #
+        #   assert_bad_value(User, :email, "invalid")
+        #
+        #   @product = Product.new(:tangible => true)
+        #   assert_bad_value(Product, :price, "0")
+        def assert_bad_value(object_or_klass, attribute, value,
+                             error_message_to_expect = DEFAULT_ERROR_MESSAGES[:invalid])
+          object = get_instance_of(object_or_klass)
+          object.send("#{attribute}=", value)
+          assert !object.valid?, "#{object.class} allowed #{value.inspect} as a value for #{attribute}"
+          assert object.errors.on(attribute), "There are no errors on #{attribute} after being set to #{value.inspect}"
+          assert_contains(object.errors.on(attribute), error_message_to_expect, "when set to #{value.inspect}")
+        end
+
+        def pretty_error_messages(obj)
+          obj.errors.map { |a, m| "#{a} #{m} (#{obj.send(a).inspect})" }
+        end
+
+        private
+
+        def get_instance_of(object_or_klass)
+          if object_or_klass.is_a?(Class)
+            klass = object_or_klass
+            instance_variable_get("@#{klass.to_s.underscore}") || klass.new
+          else
+            object_or_klass
+          end
+        end
+      end
+    end
+  end
+end