nimboids-shoulda 2.11.3

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,154 @@
+= Shoulda - Making tests easy on the fingers and eyes
+
+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.
+
+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.
+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!
+
+  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!
+
+=== 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')
+
+= Rails Installation (Test::Unit)
+
+Specify the gem dependency in your config/environment.rb file:
+
+  Rails::Initializer.run do |config|
+    config.gem "shoulda", :lib => "shoulda"
+  end
+
+Then:
+
+  $ rake gems:install
+  $ rake gems:unpack
+
+= 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 'shoulda',     :lib => false
+
+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.
+
+= 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 and funded by {thoughtbot}[http://thoughtbot.com/community]
+
+= License
+
+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

@@ -0,0 +1,74 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+begin
+  require 'cucumber/rake/task'
+rescue LoadError
+  warn "couldn't load cucumber, skipping"
+end
+
+$LOAD_PATH.unshift("lib")
+require 'shoulda/version'
+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' << 'test'
+  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
+
+eval("$specification = begin; #{IO.read('shoulda.gemspec')}; end")
+Rake::GemPackageTask.new $specification do |pkg|
+  pkg.need_tar = true
+  pkg.need_zip = true
+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 rescue nil
+
+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/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/action_controller/macros.rb

@@ -0,0 +1,221 @@
+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
+
+      # Deprecated: use ActionController::Matchers#set_the_flash instead.
+      #
+      # Macro that creates a test asserting that the flash contains the given
+      # value. Expects a +String+ or +Regexp+.
+      #
+      # 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)
+        ::ActiveSupport::Deprecation.warn("use: should set_the_flash")
+        should set_the_flash.to(val)
+      end
+
+      # Deprecated: use ActionController::Matchers#set_the_flash instead.
+      #
+      # Macro that creates a test asserting that the flash is empty.
+      def should_not_set_the_flash
+        ::ActiveSupport::Deprecation.warn("use: should_not set_the_flash")
+        should_not set_the_flash
+      end
+
+      # Deprecated: use ActionController::Matchers#filter_param instead.
+      #
+      # 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)
+        ::ActiveSupport::Deprecation.warn("use: should filter_param")
+        keys.each do |key|
+          should filter_param(key)
+        end
+      end
+
+      # Deprecated: use ActionController::Matchers#assign_to instead.
+      #
+      # 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)
+        ::ActiveSupport::Deprecation.warn("use: should assign_to")
+        klass = get_options!(names, :class)
+        names.each do |name|
+          matcher = assign_to(name).with_kind_of(klass)
+          matcher = matcher.with(&block) if block
+          should matcher
+        end
+      end
+
+      # Deprecated: use ActionController::Matchers#assign_to instead.
+      #
+      # 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)
+        ::ActiveSupport::Deprecation.warn("use: should_not assign_to")
+        names.each do |name|
+          should_not assign_to(name)
+        end
+      end
+
+      # Deprecated: use ActionController::Matchers#respond_with instead.
+      #
+      # 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)
+        ::ActiveSupport::Deprecation.warn("use: should respond_with")
+        should respond_with(response)
+      end
+
+      # Deprecated: use ActionController::Matchers#respond_with_content_type instead.
+      #
+      # 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)
+        ::ActiveSupport::Deprecation.warn("use: should respond_with_content_type")
+        should respond_with_content_type(content_type)
+      end
+
+      # Deprecated: use ActionController::Matchers#set_session instead.
+      #
+      # 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)
+        ::ActiveSupport::Deprecation.warn("use: should set_session")
+        matcher = set_session(key)
+        matcher = matcher.to(&block) if block
+        should matcher
+      end
+
+      # Deprecated: use ActionController::Matchers#render_template instead.
+      #
+      # Macro that creates a test asserting that the controller rendered the given template.
+      # Example:
+      #
+      #   should_render_template :new
+      def should_render_template(template)
+        ::ActiveSupport::Deprecation.warn("use: should render_template")
+        should render_template(template)
+      end
+
+      # Deprecated: use ActionController::Matchers#render_with_layout instead.
+      #
+      # 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')
+        ::ActiveSupport::Deprecation.warn("use: should render_with_layout")
+        should render_with_layout(expected_layout)
+      end
+
+      # Deprecated: use ActionController::Matchers#render_with_layout instead.
+      #
+      # 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
+        ::ActiveSupport::Deprecation.warn("use: should_not render_with_layout")
+        should_not render_with_layout
+      end
+
+      # Deprecated: use ActionController::Matchers#redirect_to instead.
+      #
+      # 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)
+        ::ActiveSupport::Deprecation.warn("use: should redirect_to")
+        should redirect_to(description, &block)
+      end
+
+      # Deprecated: use ActionController::Matchers#route instead.
+      #
+      # 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)
+        ::ActiveSupport::Deprecation.warn("use: should route")
+        should route(method, path).to(options)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,114 @@
+module Shoulda # :nodoc:
+  module ActionController # :nodoc:
+    module Matchers
+
+      # Ensures that the controller assigned to the named instance variable.
+      #
+      # Options:
+      # * <tt>with_kind_of</tt> - The expected class of the instance variable
+      #   being checked.
+      # * <tt>with</tt> - The value that should be assigned.
+      #
+      # Example:
+      #
+      #   it { should assign_to(:user) }
+      #   it { should_not assign_to(:user) }
+      #   it { should assign_to(:user).with_kind_of(User) }
+      #   it { should assign_to(:user).with(@user) }
+      def assign_to(variable)
+        AssignToMatcher.new(variable)
+      end
+
+      class AssignToMatcher # :nodoc:
+
+        def initialize(variable)
+          @variable    = variable.to_s
+          @check_value = false
+        end
+
+        def with_kind_of(expected_class)
+          @expected_class = expected_class
+          self
+        end
+
+        def with(expected_value = nil, &block)
+          @check_value       = true
+          @expected_value    = expected_value
+          @expectation_block = block
+          self
+        end
+
+        def matches?(controller)
+          @controller = controller
+          @expected_value = @context.instance_eval(&@expectation_block) if @expectation_block
+          assigned_value? && kind_of_expected_class? && equal_to_expected_value?
+        end
+
+        attr_reader :failure_message, :negative_failure_message
+
+        def description
+          description = "assign @#{@variable}"
+          description << " with a kind of #{@expected_class}" if @expected_class
+          description
+        end
+
+        def in_context(context)
+          @context = context
+          self
+        end
+
+        private
+
+        def assigned_value?
+          if !@controller.instance_variables.include?("@#{@variable}")
+            @failure_message =
+              "Expected action to assign a value for @#{@variable}"
+            false
+          else
+            @negative_failure_message =
+              "Didn't expect action to assign a value for @#{@variable}, " <<
+              "but it was assigned to #{assigned_value.inspect}"
+            true
+          end
+        end
+
+        def kind_of_expected_class?
+          return true unless @expected_class
+          if assigned_value.kind_of?(@expected_class)
+            @negative_failure_message =
+              "Didn't expect action to assign a kind of #{@expected_class} " <<
+              "for #{@variable}, but got one anyway"
+            true
+          else
+            @failure_message =
+              "Expected action to assign a kind of #{@expected_class} " <<
+              "for #{@variable}, but got #{@variable.inspect} " <<
+              "(#{@variable.class.name})"
+            false
+          end
+        end
+
+        def equal_to_expected_value?
+          return true unless @check_value
+          if @expected_value == assigned_value
+            @negative_failure_message =
+              "Didn't expect action to assign #{@expected_value.inspect} " <<
+              "for #{@variable}, but got it anyway"
+            true
+          else
+            @failure_message =
+              "Expected action to assign #{@expected_value.inspect} " <<
+              "for #{@variable}, but got #{assigned_value.inspect}"
+            false
+          end
+        end
+
+        def assigned_value
+          @controller.instance_variable_get("@#{@variable}")
+        end
+
+      end
+
+    end
+  end
+end