test-unit-must 0.0.1

data/README.md

@@ -0,0 +1,187 @@
+#         test-unit-must - Selfish "must" assertions for Test::Unit
+
+test-unit-must is a set of assertions for [Test::Unit] that treat the receiver
+of an assertion method call as the subject of the assertion.  In other words,
+these are [MiniTest::Spec]-style assertions, but their names only begin with
+`must_` or `must_not_`; there is no `wont_` or `refute_` prefix.
+
+------------------------------------------------------------------------------
+Compatibility
+------------------------------------------------------------------------------
+
+test-unit-must was designed for [Test::Unit] 2.2.0.  However, I found that it
+works just as well with the MiniTest library bundled in Ruby 1.9.2! :-)  In
+addition, it politely accomodates [Rails 3's ActiveSupport extensions to
+Test::Unit](
+http://rails.rubyonrails.org/classes/ActiveSupport/Testing/SetupAndTeardown/ForClassicTestUnit.html).
+
+------------------------------------------------------------------------------
+Installation
+------------------------------------------------------------------------------
+
+As a Ruby gem:
+
+    gem install test-unit-must
+
+As a Git clone:
+
+    git clone git://github.com/sunaku/test-unit-must
+
+------------------------------------------------------------------------------
+Usage
+------------------------------------------------------------------------------
+
+Load the library somewhere in your test suite, such as in your test helper:
+
+    require 'test/unit/must'
+
+In your test methods, call `must_*` methods on any Ruby object you like:
+
+    class ExampleTest < Test::Unit::TestCase
+      def test_example
+        ary = (1..10).to_a
+
+        ary.must_not_be_empty
+        assert_not_empty ary
+
+        ary.length.must_equal 10
+        assert_equal 10, ary.length
+
+        ary.must_not_equal []
+        assert_not_equal [], ary
+
+        ary.first.must_equal 1
+        assert_equal 1, ary.first
+
+        (ary[1] * 5).must_equal ary.length
+        assert_equal ary.length, (ary[1] * 5)
+
+        # and so on ...
+      end
+    end
+
+Note that you can still use traditional [Test::Unit] assertions freely.
+
+------------------------------------------------------------------------------
+Reference
+------------------------------------------------------------------------------
+
+Here is the mapping from test-unit-must assertions to [Test::Unit] assertions.
+
+    def must_alias_method alias_name, original_name, message=nil
+        assert_alias_method self, alias_name, original_name, message
+
+    def must_be_boolean message=nil
+        assert_boolean self, message
+
+    def must_compare operator, expected, message=nil
+        assert_compare expected, operator, self, message
+
+    def must_define_constant constant_name, message=nil
+        assert_const_defined self, constant_name, message
+
+    def must_not_define_constant constant_name, message=nil
+        assert_not_const_defined self, constant_name, message
+
+    def must_be_empty message=nil
+        assert_empty self, message
+
+    def must_not_be_empty message=nil
+        assert_not_empty self, message
+
+    def must_equal expected, message=nil
+        assert_equal expected, self, message
+
+    def must_not_equal expected, message=nil
+        assert_not_equal expected, self, message
+
+    def must_be_false message=nil
+        assert_false self, message
+
+    def must_be_in_delta expected_float, delta=0.001, message=nil
+        assert_in_delta expected_float, self, delta, message
+
+    def must_not_be_in_delta expected_float, delta=0.001, message=nil
+        assert_not_in_delta expected_float, self, delta, message
+
+    def must_be_in_epsilon expected_float, epsilon=0.001, message=nil
+        assert_in_epsilon expected_float, self, epsilon, message
+
+    def must_not_be_in_epsilon expected_float, epsilon=0.001, message=nil
+        assert_not_in_epsilon expected_float, self, epsilon, message
+
+    def must_include member, message=nil
+        assert_include self, member, message
+
+    def must_not_include member, message=nil
+        assert_not_include self, member, message
+
+    def must_be_instance_of klass, message=nil
+        assert_instance_of klass, self, message
+
+    def must_be_kind_of klass, message=nil
+        assert_kind_of klass, self, message
+
+    def must_match pattern, message=nil
+        assert_match pattern, self, message
+
+    def must_not_match pattern, message=nil
+        assert_not_match pattern, self, message
+
+    def must_be_nil message=nil
+        assert_nil self, message
+
+    def must_not_be_nil message=nil
+        assert_not_nil self, message
+
+    def must_operate operator, argument, message=nil
+        assert_operator self, operator, argument, message
+
+    def must_raise *arguments
+        assert_raise *arguments, &self
+
+    def must_raise_kind_of *arguments
+        assert_raise_kind_of *arguments, &self
+
+    def must_raise_message expected, message=nil
+        assert_raise_message expected, message, &self
+
+    def must_raise_nothing *arguments
+        assert_nothing_raised *arguments, &self
+
+    def must_be expected, message=nil
+        assert_same expected, self, message
+
+    def must_not_be expected, message=nil
+        assert_not_same expected, self, message
+
+    def must_receive send_array, message=nil
+        assert_send [self] + send_array, message
+
+    def must_not_receive send_array, message=nil
+        assert_not_send [self] + send_array, message
+
+    def must_respond_to method, message=nil
+        assert_respond_to self, method, message
+
+    def must_not_respond_to method, message=nil
+        assert_not_respond_to self, method, message
+
+    def must_throw expected_object, message=nil
+        assert_throw expected_object, message, &self
+
+    def must_throw_nothing *arguments
+        assert_nothing_thrown *arguments, &self
+
+    def must_be_true message=nil
+        assert_true self, message
+
+------------------------------------------------------------------------------
+License
+------------------------------------------------------------------------------
+
+Released under the ISC license.  See the `lib/test/unit/must.rb` file.
+
+[Test::Unit]: http://test-unit.rubyforge.org/
+[MiniTest]: http://rubydoc.info/stdlib/minitest/
+[MiniTest::Spec]: http://rubydoc.info/stdlib/minitest/

data/lib/test/unit/must.rb

@@ -0,0 +1,250 @@
+##############################################################################
+#
+# test-unit-must - Selfish "must" assertions for Test::Unit
+#                  https://github.com/sunaku/test-unit-must
+#
+##############################################################################
+#
+# (the ISC license)
+#
+# Copyright 2011 Suraj N. Kurapati <sunaku@gmail.com>
+#
+# Permission to use, copy, modify, and/or distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+#
+##############################################################################
+
+require 'test/unit'
+
+module Test::Unit::Must
+  module CaptureCurrentTestCase
+    def self.included target
+      target.module_eval do
+        alias ebb6cc8f_e966_4d1f_969f_530ea365eb36 run
+        def run *arguments, &block
+          $ebb6cc8f_e966_4d1f_969f_530ea365eb36 = self
+          ebb6cc8f_e966_4d1f_969f_530ea365eb36 *arguments, &block
+        end
+      end
+    end
+  end
+
+  module Assertions
+    def must_alias_method alias_name, original_name, message=nil
+      $ebb6cc8f_e966_4d1f_969f_530ea365eb36.send \
+        :assert_alias_method, self, alias_name, original_name, message
+    end
+
+    def must_be_boolean message=nil
+      $ebb6cc8f_e966_4d1f_969f_530ea365eb36.send \
+        :assert_boolean, self, message
+    end
+
+    def must_compare operator, expected, message=nil
+      $ebb6cc8f_e966_4d1f_969f_530ea365eb36.send \
+        :assert_compare, expected, operator, self, message
+    end
+
+    def must_define_constant constant_name, message=nil
+      $ebb6cc8f_e966_4d1f_969f_530ea365eb36.send \
+        :assert_const_defined, self, constant_name, message
+    end
+
+    def must_not_define_constant constant_name, message=nil
+      $ebb6cc8f_e966_4d1f_969f_530ea365eb36.send \
+        :assert_not_const_defined, self, constant_name, message
+    end
+
+    def must_be_empty message=nil
+      $ebb6cc8f_e966_4d1f_969f_530ea365eb36.send \
+        :assert_empty, self, message
+    end
+
+    def must_not_be_empty message=nil
+      $ebb6cc8f_e966_4d1f_969f_530ea365eb36.send \
+        :assert_not_empty, self, message
+    end
+
+    def must_equal expected, message=nil
+      $ebb6cc8f_e966_4d1f_969f_530ea365eb36.send \
+        :assert_equal, expected, self, message
+    end
+
+    def must_not_equal expected, message=nil
+      $ebb6cc8f_e966_4d1f_969f_530ea365eb36.send \
+        :assert_not_equal, expected, self, message
+    end
+
+    def must_be_false message=nil
+      $ebb6cc8f_e966_4d1f_969f_530ea365eb36.send \
+        :assert_false, self, message
+    end
+
+    def must_be_in_delta expected_float, delta=0.001, message=nil
+      $ebb6cc8f_e966_4d1f_969f_530ea365eb36.send \
+        :assert_in_delta, expected_float, self, delta, message
+    end
+
+    def must_not_be_in_delta expected_float, delta=0.001, message=nil
+      $ebb6cc8f_e966_4d1f_969f_530ea365eb36.send \
+        :assert_not_in_delta, expected_float, self, delta, message
+    end
+
+    def must_be_in_epsilon expected_float, epsilon=0.001, message=nil
+      $ebb6cc8f_e966_4d1f_969f_530ea365eb36.send \
+        :assert_in_epsilon, expected_float, self, epsilon, message
+    end
+
+    def must_not_be_in_epsilon expected_float, epsilon=0.001, message=nil
+      $ebb6cc8f_e966_4d1f_969f_530ea365eb36.send \
+        :assert_not_in_epsilon, expected_float, self, epsilon, message
+    end
+
+    def must_include member, message=nil
+      $ebb6cc8f_e966_4d1f_969f_530ea365eb36.send \
+        :assert_include, self, member, message
+    end
+
+    def must_not_include member, message=nil
+      $ebb6cc8f_e966_4d1f_969f_530ea365eb36.send \
+        :assert_not_include, self, member, message
+    end
+
+    def must_be_instance_of klass, message=nil
+      $ebb6cc8f_e966_4d1f_969f_530ea365eb36.send \
+        :assert_instance_of, klass, self, message
+    end
+
+    def must_be_kind_of klass, message=nil
+      $ebb6cc8f_e966_4d1f_969f_530ea365eb36.send \
+        :assert_kind_of, klass, self, message
+    end
+
+    def must_match pattern, message=nil
+      $ebb6cc8f_e966_4d1f_969f_530ea365eb36.send \
+        :assert_match, pattern, self, message
+    end
+
+    def must_not_match pattern, message=nil
+      $ebb6cc8f_e966_4d1f_969f_530ea365eb36.send \
+        :assert_not_match, pattern, self, message
+    end
+
+    def must_be_nil message=nil
+      $ebb6cc8f_e966_4d1f_969f_530ea365eb36.send \
+        :assert_nil, self, message
+    end
+
+    def must_not_be_nil message=nil
+      $ebb6cc8f_e966_4d1f_969f_530ea365eb36.send \
+        :assert_not_nil, self, message
+    end
+
+    def must_operate operator, argument, message=nil
+      $ebb6cc8f_e966_4d1f_969f_530ea365eb36.send \
+        :assert_operator, self, operator, argument, message
+    end
+
+    def must_raise *arguments
+      $ebb6cc8f_e966_4d1f_969f_530ea365eb36.send \
+        :assert_raise, *arguments, &self
+    end
+
+    def must_raise_kind_of *arguments
+      $ebb6cc8f_e966_4d1f_969f_530ea365eb36.send \
+        :assert_raise_kind_of, *arguments, &self
+    end
+
+    def must_raise_message expected, message=nil
+      $ebb6cc8f_e966_4d1f_969f_530ea365eb36.send \
+        :assert_raise_message, expected, message, &self
+    end
+
+    def must_raise_nothing *arguments
+      $ebb6cc8f_e966_4d1f_969f_530ea365eb36.send \
+        :assert_nothing_raised, *arguments, &self
+    end
+
+    def must_be expected, message=nil
+      $ebb6cc8f_e966_4d1f_969f_530ea365eb36.send \
+        :assert_same, expected, self, message
+    end
+
+    def must_not_be expected, message=nil
+      $ebb6cc8f_e966_4d1f_969f_530ea365eb36.send \
+        :assert_not_same, expected, self, message
+    end
+
+    def must_receive send_array, message=nil
+      $ebb6cc8f_e966_4d1f_969f_530ea365eb36.send \
+        :assert_send, [self] + send_array, message
+    end
+
+    def must_not_receive send_array, message=nil
+      $ebb6cc8f_e966_4d1f_969f_530ea365eb36.send \
+        :assert_not_send, [self] + send_array, message
+    end
+
+    def must_respond_to method, message=nil
+      $ebb6cc8f_e966_4d1f_969f_530ea365eb36.send \
+        :assert_respond_to, self, method, message
+    end
+
+    def must_not_respond_to method, message=nil
+      $ebb6cc8f_e966_4d1f_969f_530ea365eb36.send \
+        :assert_not_respond_to, self, method, message
+    end
+
+    def must_throw expected_object, message=nil
+      $ebb6cc8f_e966_4d1f_969f_530ea365eb36.send \
+        :assert_throw, expected_object, message, &self
+    end
+
+    def must_throw_nothing *arguments
+      $ebb6cc8f_e966_4d1f_969f_530ea365eb36.send \
+        :assert_nothing_thrown, *arguments, &self
+    end
+
+    def must_be_true message=nil
+      $ebb6cc8f_e966_4d1f_969f_530ea365eb36.send \
+        :assert_true, self, message
+    end
+
+    # Implicitly handle negations for positive assertion methods
+    # that lack an explicitly defined negative assertion method.
+    def method_missing method, *arguments, &block
+      if method =~ /^(must_)(not_)/ and respond_to? positive = $1 + $'
+        $ebb6cc8f_e966_4d1f_969f_530ea365eb36.send :assert_fail_assertion do
+          __send__ positive, *arguments, &block
+        end
+      else
+        super
+      end
+    end
+  end
+end
+
+# Rails 3 replaces Test::Unit::TestSuite with its own class, so
+# the standard Test::Unit::TestCase#run() method is never called.
+if defined? ActiveSupport::Testing::SetupAndTeardown::ForClassicTestUnit
+  module ActiveSupport::Testing::SetupAndTeardown::ForClassicTestUnit
+    include Test::Unit::Must::CaptureCurrentTestCase
+  end
+end
+
+class Test::Unit::TestCase
+  include Test::Unit::Must::CaptureCurrentTestCase
+end
+
+class Object
+  include Test::Unit::Must::Assertions
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification 
+name: test-unit-must
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Suraj N. Kurapati
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-29 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- lib/test/unit/must.rb
+has_rdoc: true
+homepage: http://github.com/sunaku/test-unit-must
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Selfish "must" assertions for Test::Unit
+test_files: []
+