tpitale-shoulda 2.11.0

data/CONTRIBUTION_GUIDELINES.rdoc

@@ -0,0 +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. 
+
+* 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 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/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,171 @@
+= 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.
+Matchers:: Rspec-compatible matchers providing the same tests as Shoulda macros.
+
+= Usage
+
+=== Context Helpers (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 (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.
+
+  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
+
+= 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:
+
+  Rails::Initializer.run do |config|
+    config.gem "thoughtbot-shoulda", :lib => "shoulda", :source => "http://gems.github.com"
+  end
+
+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-rails', :lib => false
+  config.gem 'thoughtbot-shoulda',
+             :lib => false,
+             :source => 'http://gems.github.com'
+
+Then require shoulda from your spec/spec_helper.rb file, before Spec::Runner is
+configured:
+
+  # requires for RSpec
+  require 'shoulda'
+  Spec::Runner.configure do |config|
+  # ...
+
+You should not need to require anything besides the top-level shoulda library.
+
+= 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,71 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+$LOAD_PATH.unshift("lib")
+require 'shoulda'
+load 'tasks/shoulda.rake'
+
+# Test::Unit::UI::VERBOSE
+test_files_pattern = 'test/{unit,functional,other,matchers}/**/*_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'
+  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              = "tpitale-shoulda"
+  s.version           = Shoulda::VERSION
+  s.summary           = "Making tests easy on the fingers and eyes"
+  s.homepage          = "http://thoughtbot.com/projects/shoulda"
+
+  s.files       = FileList["[A-Z]*", "{bin,lib,rails,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", "--main", "README.rdoc"]
+
+  s.authors = ["Tammer Saleh"]
+  s.email   = "tsaleh@thoughtbot.com"
+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,11 @@
+module Shoulda
+  VERSION = "2.11.0"
+end
+
+if defined? Spec
+  require 'shoulda/rspec'
+elsif defined? MiniTest
+  require 'shoulda/minitest'
+else
+  require 'shoulda/test_unit'
+end

data/lib/shoulda/action_controller.rb

@@ -0,0 +1,26 @@
+require 'shoulda'
+require 'shoulda/action_controller/matchers'
+require 'shoulda/action_controller/macros'
+
+module Test # :nodoc: all
+  module Unit
+    class TestCase
+      include Shoulda::ActionController::Matchers
+      extend Shoulda::ActionController::Macros
+    end
+  end
+end
+
+require 'shoulda/active_record/assertions'
+require 'shoulda/action_mailer/assertions'
+
+module ActionController #:nodoc: all
+  module Integration
+    class Session
+      include Shoulda::Assertions
+      include Shoulda::Helpers
+      include Shoulda::ActiveRecord::Assertions
+      include Shoulda::ActionMailer::Assertions
+    end
+  end
+end

data/lib/shoulda/action_controller/macros.rb

@@ -0,0 +1,240 @@
+module Shoulda # :nodoc:
+  module ActionController # :nodoc:
+    # = Macro test helpers for your controllers
+    #
+    # By using the macro helpers you can quickly and easily create concise and easy to read test suites.
+    #
+    # This code segment:
+    #   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
+    #
+    # Would produce 5 tests for the +show+ action
+    module Macros
+      include Matchers
+
+      # Macro that creates a test asserting that the flash contains the given
+      # value. Expects a +String+ or +Regexp+.
+      #
+      # If the argument is +nil+, it will assert that the flash is not set.
+      # This behavior is deprecated.
+      #
+      # Example:
+      #
+      #   should_set_the_flash_to "Thank you for placing this order."
+      #   should_set_the_flash_to /created/i
+      def should_set_the_flash_to(val)
+        if val
+          matcher = set_the_flash.to(val)
+          should matcher.description do
+            assert_accepts matcher, @controller
+          end
+        else
+          warn "[DEPRECATION] should_set_the_flash_to nil is deprecated. " <<
+               "Use should_not_set_the_flash instead."
+          should_not_set_the_flash
+        end
+      end
+
+      # Macro that creates a test asserting that the flash is empty.
+      def should_not_set_the_flash
+        matcher = set_the_flash
+        should "not #{matcher.description}" do
+          assert_rejects matcher, @controller
+        end
+      end
+
+      # Macro that creates a test asserting that filter_parameter_logging
+      # is set for the specified keys
+      #
+      # Example:
+      #
+      #   should_filter_params :password, :ssn
+      def should_filter_params(*keys)
+        keys.each do |key|
+          matcher = filter_param(key)
+          should matcher.description do
+            assert_accepts matcher, @controller
+          end
+        end
+      end
+
+      # Macro that creates a test asserting that the controller assigned to
+      # each of the named instance variable(s).
+      #
+      # Options:
+      # * <tt>:class</tt> - The expected class of the instance variable being checked.
+      #
+      # If a block is passed, the assigned variable is expected to be equal to
+      # the return value of that block.
+      #
+      # Example:
+      #
+      #   should_assign_to :user, :posts
+      #   should_assign_to :user, :class => User
+      #   should_assign_to(:user) { @user }
+      def should_assign_to(*names, &block)
+        klass = get_options!(names, :class)
+        names.each do |name|
+          matcher = assign_to(name).with_kind_of(klass)
+          should matcher.description do
+            if block
+              expected_value = instance_eval(&block)
+              matcher = matcher.with(expected_value)
+            end
+
+            assert_accepts matcher, @controller
+          end
+        end
+      end
+
+      # Macro that creates a test asserting that the controller did not assign to
+      # any of the named instance variable(s).
+      #
+      # Example:
+      #
+      #   should_not_assign_to :user, :posts
+      def should_not_assign_to(*names)
+        names.each do |name|
+          matcher = assign_to(name)
+          should "not #{matcher.description}" do
+            assert_rejects matcher, @controller
+          end
+        end
+      end
+
+      # Macro that creates a test asserting that the controller responded with a 'response' status code.
+      # Example:
+      #
+      #   should_respond_with :success
+      def should_respond_with(response)
+        should "respond with #{response}" do
+          matcher = respond_with(response)
+          assert_accepts matcher, @controller
+        end
+      end
+
+      # Macro that creates a test asserting that the response content type was 'content_type'.
+      # Example:
+      #
+      #   should_respond_with_content_type 'application/rss+xml'
+      #   should_respond_with_content_type :rss
+      #   should_respond_with_content_type /rss/
+      def should_respond_with_content_type(content_type)
+        matcher = respond_with_content_type(content_type)
+        should matcher.description do
+          assert_accepts matcher, @controller
+        end
+      end
+
+      # Macro that creates a test asserting that a value returned from the
+      # session is correct. Expects the session key as a parameter, and a block
+      # that returns the expected value.
+      #
+      # Example:
+      #
+      #   should_set_session(:user_id) { @user.id }
+      #   should_set_session(:message) { "Free stuff" }
+      def should_set_session(key, &block)
+        matcher = set_session(key)
+        should matcher.description do
+          expected_value = instance_eval(&block)
+          matcher = matcher.to(expected_value)
+          assert_accepts matcher, @controller
+        end
+      end
+
+      # Macro that creates a test asserting that the controller rendered the given template.
+      # Example:
+      #
+      #   should_render_template :new
+      def should_render_template(template)
+        should "render template #{template.inspect}" do
+          assert_template template.to_s
+        end
+      end
+
+      # Macro that creates a test asserting that the controller rendered with the given layout.
+      # Example:
+      #
+      #   should_render_with_layout 'special'
+      def should_render_with_layout(expected_layout = 'application')
+        matcher = render_with_layout(expected_layout)
+        if expected_layout
+          should matcher.description do
+            assert_accepts matcher, @controller
+          end
+        else
+          should "render without layout" do
+            assert_rejects matcher, @controller
+          end
+        end
+      end
+
+      # Macro that creates a test asserting that the controller rendered without a layout.
+      # Same as @should_render_with_layout false@
+      def should_render_without_layout
+        should_render_with_layout nil
+      end
+
+      # Macro that creates a test asserting that the controller returned a
+      # redirect to the given path. The passed description will be used when
+      # generating a test name. Expects a block that returns the expected path
+      # for the redirect.
+      #
+      # Example:
+      #
+      #   should_redirect_to("the user's profile") { user_url(@user) }
+      def should_redirect_to(description, &block)
+        should "redirect to #{description}" do
+          expected_url = instance_eval(&block)
+          assert_redirected_to expected_url
+        end
+      end
+
+      # Macro that creates a routing test. It tries to use the given HTTP
+      # +method+ on the given +path+, and asserts that it routes to the
+      # given +options+.
+      #
+      # If you don't specify a :controller, it will try to guess the controller
+      # based on the current test.
+      #
+      # +to_param+ is called on the +options+ given.
+      #
+      # Examples:
+      #
+      #   should_route :get, "/posts", :controller => :posts, :action => :index
+      #   should_route :get, "/posts/new", :action => :new
+      #   should_route :post, "/posts", :action => :create
+      #   should_route :get, "/posts/1", :action => :show, :id => 1
+      #   should_route :edit, "/posts/1", :action => :show, :id => 1
+      #   should_route :put, "/posts/1", :action => :update, :id => 1
+      #   should_route :delete, "/posts/1", :action => :destroy, :id => 1
+      #   should_route :get, "/users/1/posts/1",
+      #     :action => :show, :id => 1, :user_id => 1
+      #
+      def should_route(method, path, options)
+        unless options[:controller]
+          options[:controller] = self.name.gsub(/ControllerTest$/, '').tableize
+        end
+
+        matcher = route(method, path).to(options)
+
+        should matcher.description do
+          assert_accepts matcher.in_context(self), self
+        end
+      end
+    end
+  end
+end