nimboids-shoulda 2.11.3

data/lib/shoulda/assertions.rb

@@ -0,0 +1,79 @@
+module Shoulda # :nodoc:
+  module Assertions
+    # Asserts that two arrays contain the same elements, the same number of times.  Essentially ==, but unordered.
+    #
+    #   assert_same_elements([:a, :b, :c], [:c, :a, :b]) => passes
+    def assert_same_elements(a1, a2, msg = nil)
+      [:select, :inject, :size].each do |m|
+        [a1, a2].each {|a| assert_respond_to(a, m, "Are you sure that #{a.inspect} is an array?  It doesn't respond to #{m}.") }
+      end
+
+      assert a1h = a1.inject({}) { |h,e| h[e] = a1.select { |i| i == e }.size; h }
+      assert a2h = a2.inject({}) { |h,e| h[e] = a2.select { |i| i == e }.size; h }
+
+      assert_equal(a1h, a2h, msg)
+    end
+
+    # Asserts that the given collection contains item x.  If x is a regular expression, ensure that
+    # at least one element from the collection matches x.  +extra_msg+ is appended to the error message if the assertion fails.
+    #
+    #   assert_contains(['a', '1'], /\d/) => passes
+    #   assert_contains(['a', '1'], 'a') => passes
+    #   assert_contains(['a', '1'], /not there/) => fails
+    def assert_contains(collection, x, extra_msg = "")
+      collection = [collection] unless collection.is_a?(Array)
+      msg = "#{x.inspect} not found in #{collection.to_a.inspect} #{extra_msg}"
+      case x
+      when Regexp
+        assert(collection.detect { |e| e =~ x }, msg)
+      else
+        assert(collection.include?(x), msg)
+      end
+    end
+
+    # Asserts that the given collection does not contain item x.  If x is a regular expression, ensure that
+    # none of the elements from the collection match x.
+    def assert_does_not_contain(collection, x, extra_msg = "")
+      collection = [collection] unless collection.is_a?(Array)
+      msg = "#{x.inspect} found in #{collection.to_a.inspect} " + extra_msg
+      case x
+      when Regexp
+        assert(!collection.detect { |e| e =~ x }, msg)
+      else
+        assert(!collection.include?(x), msg)
+      end
+    end
+
+    # Asserts that the given matcher returns true when +target+ is passed to #matches?
+    def assert_accepts(matcher, target, options = {})
+      if matcher.respond_to?(:in_context)
+        matcher.in_context(self)
+      end
+
+      if matcher.matches?(target)
+        assert_block { true }
+        if options[:message]
+          assert_match options[:message], matcher.negative_failure_message
+        end
+      else
+        assert_block(matcher.failure_message) { false }
+      end
+    end
+
+    # Asserts that the given matcher returns false when +target+ is passed to #matches?
+    def assert_rejects(matcher, target, options = {})
+      if matcher.respond_to?(:in_context)
+        matcher.in_context(self)
+      end
+
+      unless matcher.matches?(target)
+        assert_block { true }
+        if options[:message]
+          assert_match options[:message], matcher.failure_message
+        end
+      else
+        assert_block(matcher.negative_failure_message) { false }
+      end
+    end
+  end
+end

data/lib/shoulda/autoload_macros.rb

@@ -0,0 +1,46 @@
+module Shoulda # :nodoc:
+  # Call autoload_macros when you want to load test macros automatically in a non-Rails
+  # project (it's done automatically for Rails projects).
+  # You don't need to specify ROOT/test/shoulda_macros explicitly. Your custom macros
+  # are loaded automatically when you call autoload_macros.
+  #
+  # The first argument is the path to you application's root directory.
+  # All following arguments are directories relative to your root, which contain
+  # shoulda_macros subdirectories. These directories support the same kinds of globs as the
+  # Dir class.
+  #
+  # Basic usage (from a test_helper):
+  # Shoulda.autoload_macros(File.dirname(__FILE__) + '/..')
+  # will load everything in
+  # - your_app/test/shoulda_macros
+  #
+  # To load vendored macros as well:
+  # Shoulda.autoload_macros(APP_ROOT, 'vendor/*')
+  # will load everything in
+  # - APP_ROOT/vendor/*/shoulda_macros
+  # - APP_ROOT/test/shoulda_macros
+  #
+  # To load macros in an app with a vendor directory laid out like Rails':
+  # Shoulda.autoload_macros(APP_ROOT, 'vendor/{plugins,gems}/*')
+  # or
+  # Shoulda.autoload_macros(APP_ROOT, 'vendor/plugins/*', 'vendor/gems/*')
+  # will load everything in
+  # - APP_ROOT/vendor/plugins/*/shoulda_macros
+  # - APP_ROOT/vendor/gems/*/shoulda_macros
+  # - APP_ROOT/test/shoulda_macros
+  #
+  # If you prefer to stick testing dependencies away from your production dependencies:
+  # Shoulda.autoload_macros(APP_ROOT, 'vendor/*', 'test/vendor/*')
+  # will load everything in
+  # - APP_ROOT/vendor/*/shoulda_macros
+  # - APP_ROOT/test/vendor/*/shoulda_macros
+  # - APP_ROOT/test/shoulda_macros
+  def self.autoload_macros(root, *dirs)
+    dirs << File.join('test')
+    complete_dirs = dirs.map{|d| File.join(root, d, 'shoulda_macros')}
+    all_files     = complete_dirs.inject([]){ |files, dir| files + Dir[File.join(dir, '*.rb')] }
+    all_files.each do |file|
+      require file
+    end
+  end
+end

data/lib/shoulda/context.rb

@@ -0,0 +1,441 @@
+module Shoulda
+  class << self
+    attr_accessor :contexts
+    def contexts # :nodoc:
+      @contexts ||= []
+    end
+
+    def current_context # :nodoc:
+      self.contexts.last
+    end
+
+    def add_context(context) # :nodoc:
+      self.contexts.push(context)
+    end
+
+    def remove_context # :nodoc:
+      self.contexts.pop
+    end
+  end
+
+  module ClassMethods
+    # == Should statements
+    #
+    # Should statements are just syntactic sugar over normal Test::Unit test
+    # methods.  A should block contains all the normal code and assertions
+    # you're used to seeing, with the added benefit that they can be wrapped
+    # inside context blocks (see below).
+    #
+    # === Example:
+    #
+    #  class UserTest < Test::Unit::TestCase
+    #
+    #    def setup
+    #      @user = User.new("John", "Doe")
+    #    end
+    #
+    #    should "return its full name"
+    #      assert_equal 'John Doe', @user.full_name
+    #    end
+    #
+    #  end
+    #
+    # ...will produce the following test:
+    # * <tt>"test: User should return its full name. "</tt>
+    #
+    # Note: The part before <tt>should</tt> in the test name is gleamed from the name of the Test::Unit class.
+    #
+    # Should statements can also take a Proc as a <tt>:before </tt>option.  This proc runs after any
+    # parent context's setups but before the current context's setup.
+    #
+    # === Example:
+    #
+    #  context "Some context" do
+    #    setup { puts("I run after the :before proc") }
+    #
+    #    should "run a :before proc", :before => lambda { puts("I run before the setup") }  do
+    #      assert true
+    #    end
+    #  end
+    #
+    # Should statements can also wrap matchers, making virtually any matcher
+    # usable in a macro style. The matcher's description is used to generate a
+    # test name and failure message, and the test will pass if the matcher
+    # matches the subject.
+    #
+    # === Example:
+    #
+    #   should validate_presence_of(:first_name).with_message(/gotta be there/)
+    #
+
+    def should(name_or_matcher, options = {}, &blk)
+      if Shoulda.current_context
+        Shoulda.current_context.should(name_or_matcher, options, &blk)
+      else
+        context_name = self.name.gsub(/Test/, "")
+        context = Shoulda::Context.new(context_name, self) do
+          should(name_or_matcher, options, &blk)
+        end
+        context.build
+      end
+    end
+
+    # Allows negative tests using matchers. The matcher's description is used
+    # to generate a test name and negative failure message, and the test will
+    # pass unless the matcher matches the subject.
+    #
+    # === Example:
+    #
+    #   should_not set_the_flash
+    def should_not(matcher)
+      if Shoulda.current_context
+        Shoulda.current_context.should_not(matcher)
+      else
+        context_name = self.name.gsub(/Test/, "")
+        context = Shoulda::Context.new(context_name, self) do
+          should_not(matcher)
+        end
+        context.build
+      end
+    end
+
+    # == Before statements
+    #
+    # Before statements are should statements that run before the current
+    # context's setup. These are especially useful when setting expectations.
+    #
+    # === Example:
+    #
+    #  class UserControllerTest < Test::Unit::TestCase
+    #    context "the index action" do
+    #      setup do
+    #        @users = [Factory(:user)]
+    #        User.stubs(:find).returns(@users)
+    #      end
+    #
+    #      context "on GET" do
+    #        setup { get :index }
+    #
+    #        should respond_with(:success)
+    #
+    #        # runs before "get :index"
+    #        before_should "find all users" do
+    #          User.expects(:find).with(:all).returns(@users)
+    #        end
+    #      end
+    #    end
+    #  end
+    def before_should(name, &blk)
+      should(name, :before => blk) { assert true }
+    end
+
+    # Just like should, but never runs, and instead prints an 'X' in the Test::Unit output.
+    def should_eventually(name, options = {}, &blk)
+      context_name = self.name.gsub(/Test/, "")
+      context = Shoulda::Context.new(context_name, self) do
+        should_eventually(name, &blk)
+      end
+      context.build
+    end
+
+    # == Contexts
+    #
+    # A context block groups should statements under a common set of setup/teardown methods.
+    # Context blocks can be arbitrarily nested, and can do wonders for improving the maintainability
+    # and readability of your test code.
+    #
+    # A context block can contain setup, should, should_eventually, and teardown blocks.
+    #
+    #  class UserTest < Test::Unit::TestCase
+    #    context "A User instance" do
+    #      setup do
+    #        @user = User.find(:first)
+    #      end
+    #
+    #      should "return its full name"
+    #        assert_equal 'John Doe', @user.full_name
+    #      end
+    #    end
+    #  end
+    #
+    # This code will produce the method <tt>"test: A User instance should return its full name. "</tt>.
+    #
+    # Contexts may be nested.  Nested contexts run their setup blocks from out to in before each
+    # should statement.  They then run their teardown blocks from in to out after each should statement.
+    #
+    #  class UserTest < Test::Unit::TestCase
+    #    context "A User instance" do
+    #      setup do
+    #        @user = User.find(:first)
+    #      end
+    #
+    #      should "return its full name"
+    #        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?"
+    #          assert @user.has_profile?
+    #        end
+    #      end
+    #    end
+    #  end
+    #
+    # This code will produce the following methods
+    # * <tt>"test: A User instance should return its full name. "</tt>
+    # * <tt>"test: A User instance with a profile should return true when sent :has_profile?. "</tt>
+    #
+    # <b>Just like should statements, a context block can exist next to normal <tt>def test_the_old_way; end</tt>
+    # tests</b>.  This means you do not have to fully commit to the context/should syntax in a test file.
+
+    def context(name, &blk)
+      if Shoulda.current_context
+        Shoulda.current_context.context(name, &blk)
+      else
+        context = Shoulda::Context.new(name, self, &blk)
+        context.build
+      end
+    end
+
+    # Returns the class being tested, as determined by the test class name.
+    #
+    #   class UserTest; described_type; end
+    #   # => User
+    def described_type
+      self.name.gsub(/Test$/, '').constantize
+    end
+
+    # Sets the return value of the subject instance method:
+    #
+    #   class UserTest < Test::Unit::TestCase
+    #     subject { User.first }
+    #
+    #     # uses the existing user
+    #     should validate_uniqueness_of(:email)
+    #   end
+    def subject(&block)
+      @subject_block = block
+    end
+
+    def subject_block # :nodoc:
+      @subject_block
+    end
+  end
+
+  module InstanceMethods
+    # Returns an instance of the class under test.
+    #
+    #   class UserTest
+    #     should "be a user" do
+    #       assert_kind_of User, subject # passes
+    #     end
+    #   end
+    #
+    # The subject can be explicitly set using the subject class method:
+    #
+    #   class UserTest
+    #     subject { User.first }
+    #     should "be an existing user" do
+    #       assert !subject.new_record? # uses the first user
+    #     end
+    #   end
+    #
+    # The subject is used by all macros that require an instance of the class
+    # being tested.
+    def subject
+      @shoulda_subject ||= construct_subject
+    end
+
+    def subject_block # :nodoc:
+      (@shoulda_context && @shoulda_context.subject_block) || self.class.subject_block
+    end
+
+    def get_instance_of(object_or_klass) # :nodoc:
+      if object_or_klass.is_a?(Class)
+        object_or_klass.new
+      else
+        object_or_klass
+      end
+    end
+
+    def instance_variable_name_for(klass) # :nodoc:
+      klass.to_s.split('::').last.underscore
+    end
+
+    private
+
+    def construct_subject
+      if subject_block
+        instance_eval(&subject_block)
+      else
+        get_instance_of(self.class.described_type)
+      end
+    end
+  end
+
+  class Context # :nodoc:
+
+    attr_accessor :name               # my name
+    attr_accessor :parent             # may be another context, or the original test::unit class.
+    attr_accessor :subcontexts        # array of contexts nested under myself
+    attr_accessor :setup_blocks       # blocks given via setup methods
+    attr_accessor :teardown_blocks    # blocks given via teardown methods
+    attr_accessor :shoulds            # array of hashes representing the should statements
+    attr_accessor :should_eventuallys # array of hashes representing the should eventually statements
+    attr_accessor :subject_block
+
+    def initialize(name, parent, &blk)
+      Shoulda.add_context(self)
+      self.name               = name
+      self.parent             = parent
+      self.setup_blocks       = []
+      self.teardown_blocks    = []
+      self.shoulds            = []
+      self.should_eventuallys = []
+      self.subcontexts        = []
+
+      merge_block(&blk)
+      Shoulda.remove_context
+    end
+
+    def merge_block(&blk)
+      blk.bind(self).call
+    end
+
+    def context(name, &blk)
+      self.subcontexts << Context.new(name, self, &blk)
+    end
+
+    def setup(&blk)
+      self.setup_blocks << blk
+    end
+
+    def teardown(&blk)
+      self.teardown_blocks << blk
+    end
+
+    def should(name_or_matcher, options = {}, &blk)
+      if name_or_matcher.respond_to?(:description) && name_or_matcher.respond_to?(:matches?)
+        name = name_or_matcher.description
+        blk = lambda { assert_accepts name_or_matcher, subject }
+      else
+        name = name_or_matcher
+      end
+
+      if blk
+        self.shoulds << { :name => name, :before => options[:before], :block => blk }
+      else
+       self.should_eventuallys << { :name => name }
+     end
+    end
+
+    def should_not(matcher)
+      name = matcher.description
+      blk = lambda { assert_rejects matcher, subject }
+      self.shoulds << { :name => "not #{name}", :block => blk }
+    end
+
+    def should_eventually(name, &blk)
+      self.should_eventuallys << { :name => name, :block => blk }
+    end
+
+    def subject(&block)
+      self.subject_block = block
+    end
+
+    def subject_block
+      return @subject_block if @subject_block
+      parent.subject_block
+    end
+
+    def full_name
+      parent_name = parent.full_name if am_subcontext?
+      return [parent_name, name].join(" ").strip
+    end
+
+    def am_subcontext?
+      parent.is_a?(self.class) # my parent is the same class as myself.
+    end
+
+    def test_unit_class
+      am_subcontext? ? parent.test_unit_class : parent
+    end
+
+    def test_methods
+      @test_methods ||= Hash.new { |h,k|
+        h[k] = Hash[k.instance_methods.map { |n| [n, true] }]
+      }
+    end
+
+    def create_test_from_should_hash(should)
+      test_name = ["test:", full_name, "should", "#{should[:name]}. "].flatten.join(' ').to_sym
+
+      if test_methods[test_unit_class][test_name.to_s] then
+        warn "  * WARNING: '#{test_name}' is already defined"
+      end
+
+      test_methods[test_unit_class][test_name.to_s] = true
+
+      context = self
+      test_unit_class.send(:define_method, test_name) do
+        @shoulda_context = context
+        begin
+          context.run_parent_setup_blocks(self)
+          should[:before].bind(self).call if should[:before]
+          context.run_current_setup_blocks(self)
+          should[:block].bind(self).call
+        ensure
+          context.run_all_teardown_blocks(self)
+        end
+      end
+    end
+
+    def run_all_setup_blocks(binding)
+      run_parent_setup_blocks(binding)
+      run_current_setup_blocks(binding)
+    end
+
+    def run_parent_setup_blocks(binding)
+      self.parent.run_all_setup_blocks(binding) if am_subcontext?
+    end
+
+    def run_current_setup_blocks(binding)
+      setup_blocks.each do |setup_block|
+        setup_block.bind(binding).call
+      end
+    end
+
+    def run_all_teardown_blocks(binding)
+      teardown_blocks.reverse.each do |teardown_block|
+        teardown_block.bind(binding).call
+      end
+      self.parent.run_all_teardown_blocks(binding) if am_subcontext?
+    end
+
+    def print_should_eventuallys
+      should_eventuallys.each do |should|
+        test_name = [full_name, "should", "#{should[:name]}. "].flatten.join(' ')
+        puts "  * DEFERRED: " + test_name
+      end
+    end
+
+    def build
+      shoulds.each do |should|
+        create_test_from_should_hash(should)
+      end
+
+      subcontexts.each { |context| context.build }
+
+      print_should_eventuallys
+    end
+
+    def method_missing(method, *args, &blk)
+      test_unit_class.send(method, *args, &blk)
+    end
+
+  end
+end

data/lib/shoulda/helpers.rb

@@ -0,0 +1,8 @@
+module Shoulda # :nodoc:
+  module Helpers
+    # Prints a message to stdout, tagged with the name of the calling method.
+    def report!(msg = "")
+      puts("#{caller.first}: #{msg}")
+    end
+  end
+end

data/lib/shoulda/integrations/rspec.rb

@@ -0,0 +1,13 @@
+require 'shoulda/active_record/matchers'
+require 'shoulda/action_controller/matchers'
+require 'shoulda/action_mailer/matchers'
+require 'active_support/test_case'
+
+# :enddoc:
+module ActiveSupport
+  class TestCase
+    include Shoulda::ActiveRecord::Matchers
+    include Shoulda::ActionController::Matchers
+    include Shoulda::ActionMailer::Matchers
+  end
+end

data/lib/shoulda/integrations/rspec2.rb

@@ -0,0 +1,22 @@
+require 'shoulda/active_record/matchers'
+require 'shoulda/action_controller/matchers'
+require 'shoulda/action_mailer/matchers'
+
+# :enddoc:
+
+module RSpec
+  module Matchers
+    include Shoulda::ActiveRecord::Matchers
+  end
+
+  module Rails
+    module ControllerExampleGroup
+      include Shoulda::ActionController::Matchers
+    end
+
+    module MailerExampleGroup
+      include Shoulda::ActionMailer::Matchers
+    end
+  end
+end
+

data/lib/shoulda/integrations/test_unit.rb

@@ -0,0 +1,22 @@
+require 'test/unit'
+
+require 'shoulda/context'
+require 'shoulda/proc_extensions'
+require 'shoulda/assertions'
+require 'shoulda/macros'
+require 'shoulda/helpers'
+require 'shoulda/autoload_macros'
+require 'shoulda/rails' if defined? RAILS_ROOT
+
+module Test # :nodoc: all
+  module Unit
+    class TestCase
+      include Shoulda::InstanceMethods
+      extend Shoulda::ClassMethods
+      include Shoulda::Assertions
+      extend Shoulda::Macros
+      include Shoulda::Helpers
+    end
+  end
+end
+