shoulda-context 1.2.2 → 2.0.0.rc1

data/lib/shoulda/context.rb

@@ -1,20 +1,16 @@
-require 'shoulda/context/test_framework_detection'
-require 'shoulda/context/version'
-require 'shoulda/context/proc_extensions'
-require 'shoulda/context/assertions'
-require 'shoulda/context/context'
-require 'shoulda/context/autoload_macros'
+require "shoulda/context/autoload_macros"
+require "shoulda/context/configuration"
+require "shoulda/context/context"
+require "shoulda/context/dsl"
+require "shoulda/context/proc_extensions"
+require "shoulda/context/test_framework_detection"
+require "shoulda/context/version"
+require "shoulda/context/world"
 
-module ShouldaContextLoadable
-  def self.included(base)
-    base.class_eval do
-      include Shoulda::Context::Assertions
-      include Shoulda::Context::InstanceMethods
-    end
-    base.extend(Shoulda::Context::ClassMethods)
-  end
+if defined?(Rails)
+  require "shoulda/context/railtie"
 end
 
-Shoulda::Context.test_framework_test_cases.each do |test_case|
-  test_case.class_eval { include ShouldaContextLoadable }
+Shoulda::Context.configure do |config|
+  config.include(Shoulda::Context::DSL)
 end

data/lib/shoulda/context/assertions.rb

@@ -3,7 +3,7 @@ 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
+      #   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}.") }
@@ -45,7 +45,8 @@ module Shoulda # :nodoc:
         end
       end
 
-      # Asserts that the given matcher returns true when +target+ is passed to #matches?
+      # 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)
@@ -54,33 +55,35 @@ module Shoulda # :nodoc:
         if matcher.matches?(target)
           safe_assert_block { true }
           if options[:message]
-            message = matcher.respond_to?(:failure_message_for_should_not) ? matcher.failure_message_for_should_not : matcher.negative_failure_message
-            assert_match options[:message], message
+            assert_match options[:message], matcher.failure_message_when_negated
           end
         else
-          message = matcher.respond_to?(:failure_message_for_should) ? matcher.failure_message_for_should : matcher.failure_message
-          safe_assert_block(message) { false }
+          safe_assert_block(matcher.failure_message) { false }
         end
       end
 
-      # Asserts that the given matcher returns true when +target+ is passed to #does_not_match?
-      # or false when +target+ is passed to #matches? if #does_not_match? is not implemented
+      # Asserts that the given matcher returns true when +target+ is passed to
+      # #does_not_match? or false when +target+ is passed to #matches? if
+      # #does_not_match? is not implemented
       def assert_rejects(matcher, target, options = {})
         if matcher.respond_to?(:in_context)
           matcher.in_context(self)
         end
 
-        not_match = matcher.respond_to?(:does_not_match?) ? matcher.does_not_match?(target) : !matcher.matches?(target)
+        not_match =
+          if matcher.respond_to?(:does_not_match?)
+            matcher.does_not_match?(target)
+          else
+            !matcher.matches?(target)
+          end
 
         if not_match
           safe_assert_block { true }
           if options[:message]
-            message = matcher.respond_to?(:failure_message_for_should) ? matcher.failure_message_for_should : matcher.failure_message
-            assert_match options[:message], message
+            assert_match options[:message], matcher.failure_message
           end
         else
-          message = matcher.respond_to?(:failure_message_for_should_not) ? matcher.failure_message_for_should_not : matcher.negative_failure_message
-          safe_assert_block(message) { false }
+          safe_assert_block(matcher.failure_message_when_negated) { false }
         end
       end
 

data/lib/shoulda/context/configuration.rb

@@ -0,0 +1,19 @@
+module Shoulda
+  module Context
+    def self.configure
+      yield self
+    end
+
+    def self.include(mod)
+      test_framework_test_cases.each do |test_case|
+        test_case.class_eval { include mod }
+      end
+    end
+
+    def self.extend(mod)
+      test_framework_test_cases.each do |test_case|
+        test_case.extend(mod)
+      end
+    end
+  end
+end

data/lib/shoulda/context/context.rb

@@ -1,290 +1,6 @@
 module Shoulda
   module Context
-    class << self
-      def contexts # :nodoc:
-        @contexts ||= []
-      end
-      attr_writer :contexts
-
-      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::Context.current_context
-          Shoulda::Context.current_context.should(name_or_matcher, options, &blk)
-        else
-          context_name = self.name.gsub(/Test/, "") if self.name
-          context = Shoulda::Context::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::Context.current_context
-          Shoulda::Context.current_context.should_not(matcher)
-        else
-          context_name = self.name.gsub(/Test/, "") if self.name
-          context = Shoulda::Context::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::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::Context.current_context
-          Shoulda::Context.current_context.context(name, &blk)
-        else
-          context = Shoulda::Context::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
-        @described_type ||= self.name.
-          gsub(/Test$/, '').
-          split('::').
-          inject(Object) do |parent, local_name|
-            parent.const_get(local_name, false)
-          end
-      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 ||= nil
-      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
@@ -389,38 +105,38 @@ module Shoulda
       end
 
       def create_test_from_should_hash(should)
-        test_name = [test_name_prefix, full_name, "should", "#{should[:name]}. "].flatten.join(' ').to_sym
+        test_name = build_test_name_from(should)
 
-        if test_methods[test_unit_class][test_name.to_s] then
-          raise DuplicateTestError, "'#{test_name}' is defined more than once."
+        if test_methods[test_unit_class][test_name.to_s]
+          raise Shoulda::Context::DuplicateTestError.new(
+            "'#{test_name}' is defined more than once."
+          )
         end
-
         test_methods[test_unit_class][test_name.to_s] = true
-        file, line_no = should[:block].source_location
+
         context = self
-        test_unit_class.class_eval <<-end_eval, file, line_no
-          define_method test_name do
+        test_unit_class.__send__(:define_method, test_name) do
           @shoulda_context = context
           begin
             context.run_parent_setup_blocks(self)
             if should[:before]
-              if self.respond_to?(:instance_exec)
-                self.instance_exec(&should[:before])
-              else
-                should[:before].bind(self).call
-              end
+              instance_exec(&should[:before])
             end
             context.run_current_setup_blocks(self)
-            if self.respond_to?(:instance_exec)
-              self.instance_exec(&should[:block])
-            else
-              should[:block].bind(self).call
-            end
+            instance_exec(&should[:block])
           ensure
             context.run_all_teardown_blocks(self)
           end
-          end
-        end_eval
+        end
+      end
+
+      def build_test_name_from(should)
+        [
+          test_name_prefix,
+          full_name,
+          "should",
+          "#{should[:name]}. "
+        ].flatten.join(' ').to_sym
       end
 
       def run_all_setup_blocks(binding)
@@ -473,7 +189,7 @@ module Shoulda
       end
 
       def test_name_prefix
-        if defined?(Minitest) || defined?(MiniTest)
+        if defined?(Minitest)
           'test_:'
         else
           'test:'
@@ -484,7 +200,8 @@ module Shoulda
         test_unit_class.send(method, *args, &blk)
       end
     end
+
+    class DuplicateTestError < RuntimeError; end
   end
 end
 
-class DuplicateTestError < RuntimeError; end