assertions 0.9.0

data/History.txt

@@ -0,0 +1,2 @@
+=== 0.9.0 / 2008-06-04
+Initial release of assertions.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Designing Patterns
+
+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/Manifest.txt

@@ -0,0 +1,7 @@
+Manifest.txt
+LICENSE
+README.txt
+History.txt
+Rakefile
+lib/assertions.rb
+test/test_assertions.rb

data/README.txt

@@ -0,0 +1,72 @@
+= assertions
+
+Project Page: http://rubyforge.org/projects/assertions/
+
+== DESCRIPTION:
+
+This package adds some additional assertions to Test::Unit::Assertions,
+including:
+* Assertions for all of the comparison operators (assert_greater_than,
+  assert_less_than_or_equal_to, etc.).  Shorter aliases also are provided
+  for these (assert_gt, assert_le, etc.).
+* An assertion that tests whether a given block raises a specified exception
+  with a specified message (assert_raise_message).  This allows full testing
+  of error messages.
+* An assertion that tests whether a given block contains an assertion that
+  fails, which can be used to test new assertions.
+
+== PROBLEMS:
+
+None (known).
+
+== SYNOPSIS:
+  require 'rubygems'
+  require 'assertions'
+
+  require 'test/unit'
+
+  class Tests < Test::Unit::TestCase
+    def test_assertions
+      #
+      # Verify that 4 < 5
+      #
+      assert_less_than(4, 5)
+
+      #
+      # Verify that 4 < 5 again, but this time with the
+      # shorter alias.
+      #
+      assert_lt(4, 5)
+
+      #
+      # Verify that 5 >= 5
+      #
+      assert_ge(5, 5)
+
+      #
+      # Verify that the specified exception is raised.
+      #
+      assert_raise_message("Hello, exception!", RuntimeError) do
+        raise "Hello, exception!"
+      end
+
+      #
+      # Verify that an assertion failed.
+      #
+      assert_fail do
+        assert_equal(5, 4)
+      end
+    end
+  end
+
+== REQUIREMENTS:
+
+Hoe is required but only for running the tests.
+
+== INSTALL:
+
+sudo gem install assertions
+
+== LICENSE:
+
+See LICENSE, at the root of the distribution.

data/Rakefile

@@ -0,0 +1,15 @@
+# -*- ruby -*-
+
+$LOAD_PATH.unshift("lib")
+
+require 'rubygems'
+require 'hoe'
+
+$stderr = STDERR
+
+Hoe.new('assertions', "0.9.0") do |p|
+  p.remote_rdoc_dir = ''
+  p.developer('DesigningPatterns', 'technical.inquiries@designingpatterns.com')
+end
+
+# vim: syntax=Ruby

data/lib/assertions.rb

@@ -0,0 +1,202 @@
+#!/usr/bin/env ruby
+
+module Test
+module Unit
+
+#
+# Some useful extra assertions.
+# Require 'assertions', and Test::Unit::Assertions will have
+# the additional assertions.
+#
+module Assertions
+  public
+
+  # 
+  # ====Description:
+  # This assertion passes if and only if block contains an assertion
+  # that fails (but which is suppressed from propagating outside of
+  # block).  If the assertion passes, the failed assertion is written to
+  # stdout.  This method is (only?) useful when testing other assertions.
+  # 
+  # ====Example:
+  #   assert_fail do
+  #     assert_equal(5, 4)
+  #   end
+  #
+  # ====Parameters:
+  # [message = ""]
+  #      An optional additional message that will be displayed if the
+  #      assertion fails.
+  # [&block]
+  #      This block should contain an assertion that fails.
+  # 
+  def assert_fail(message = "", &block)
+    _wrap_assertion do
+      full_message = build_message(message,
+                                   "Failed assertion was expected, but it did not occur.")
+
+      assert_block(full_message) do
+        begin
+          yield
+          false
+        rescue AssertionFailedError => e
+          print("Assertion correctly failed:\n#{e.message}\n")
+          true
+        end
+      end
+    end
+  end
+
+  # 
+  # ====Description:
+  # This is a convenience wrapper around assert_operator.  It asserts that
+  # lhs > rhs.
+  # 
+  # ====Example:
+  #   assert_greater_than(5, 4)
+  #
+  # ====Parameters:
+  # [lhs]
+  #      The left-hand side of the comparison.
+  # [rhs]
+  #      The right-hand side of the comparison.
+  # [message = ""]
+  #      An optional additional message that will be displayed if the
+  #      assertion fails.
+  # 
+  def assert_greater_than(lhs, rhs, message = "")
+    assert_operator(lhs, :>, rhs, message)
+  end
+  alias assert_gt assert_greater_than
+
+  # 
+  # ====Description:
+  # This is a convenience wrapper around assert_operator.  It asserts that
+  # lhs >= rhs.
+  # 
+  # ====Example:
+  #   assert_greater_than_or_equal_to(5, 5)
+  #
+  # ====Parameters:
+  # [lhs]
+  #      The left-hand side of the comparison.
+  # [rhs]
+  #      The right-hand side of the comparison.
+  # [message = ""]
+  #      An optional additional message that will be displayed if the
+  #      assertion fails.
+  # 
+  def assert_greater_than_or_equal_to(lhs, rhs, message = "")
+    assert_operator(lhs, :>=, rhs, message)
+  end
+  alias assert_ge assert_greater_than_or_equal_to
+
+  # 
+  # ====Description:
+  # This is a convenience wrapper around assert_operator.  It asserts that
+  # lhs < rhs.
+  # 
+  # ====Example:
+  #   assert_less_than(4, 5)
+  #
+  # ====Parameters:
+  # [lhs]
+  #      The left-hand side of the comparison.
+  # [rhs]
+  #      The right-hand side of the comparison.
+  # [message = ""]
+  #      An optional additional message that will be displayed if the
+  #      assertion fails.
+  # 
+  def assert_less_than(lhs, rhs, message = "")\
+    assert_operator(lhs, :<, rhs, message)
+  end
+  alias assert_lt assert_less_than
+
+  # 
+  # ====Description:
+  # This is a convenience wrapper around assert_operator.  It asserts that
+  # lhs <= rhs.
+  # 
+  # ====Example:
+  #   assert_less_than_or_equal_to(4, 4)
+  #
+  # ====Parameters:
+  # [lhs]
+  #      The left-hand side of the comparison.
+  # [rhs]
+  #      The right-hand side of the comparison.
+  # [message = ""]
+  #      An optional additional message that will be displayed if the
+  #      assertion fails.
+  # 
+  def assert_less_than_or_equal_to(lhs, rhs, message = "")
+    assert_operator(lhs, :<=, rhs, message)
+  end
+  alias assert_le assert_less_than_or_equal_to
+
+  # 
+  # ====Description:
+  # This assertion passes if and only if block throws an exception of
+  # class (or descended from class) expected_exception_class with
+  # message expected_exception_message.
+  # 
+  # ====Example:
+  #   assert_raise_message("Hello, exception!", RuntimeError) do
+  #     raise "Hello, exception!"
+  #   end
+  #
+  # ====Parameters:
+  # [expected_exception_message]
+  #      The message expected to be contained in the exception thrown
+  #      by block.
+  # [expected_exception_class]
+  #      The expected class (or parent class) of the exception thrown by
+  #      block.
+  # [message = ""]
+  #      An optional additional message that will be displayed if the
+  #      assertion fails.
+  # [&block]
+  #      The block that is supposed to throw the specified exception.
+  #
+  def assert_raise_message(expected_exception_message,
+                           expected_exception_class,
+                           message = "",
+                           &block)
+    _wrap_assertion do
+      full_message = build_message(message,
+                                   "<?> exception expected but none was thrown.",
+                                   expected_exception_class)
+      actual_exception = nil
+      assert_block(full_message) do
+        begin
+          yield
+          false
+        rescue Exception => e
+          actual_exception = e
+          true
+        end
+      end
+
+      full_message = build_message(message,
+                                   "<?> exception expected but was\n?",
+                                   expected_exception_class,
+                                   actual_exception)
+
+      assert_block(full_message) do
+        actual_exception.is_a?(expected_exception_class)
+      end
+
+      full_message = build_message(message,
+                                   "<?> exception message expected but was\n?",
+                                   expected_exception_message,
+                                   actual_exception)
+      assert_block(full_message) do
+        expected_exception_message == actual_exception.message
+      end
+    end
+  end
+
+end
+end
+end

data/test/test_assertions.rb

@@ -0,0 +1,114 @@
+#!/usr/bin/env ruby
+
+require 'assertions'
+
+require 'test/unit'
+
+class AssertionsTest < Test::Unit::TestCase
+  def test_assert_fail
+    #
+    # Verify that assert_fail fails if the block has
+    # no failed assertions.
+    #
+    failed_assertion = false
+    begin
+      assert_fail do
+      end
+    rescue Test::Unit::AssertionFailedError => e
+      failed_assertion = true
+    end
+
+    if(!failed_assertion)
+      flunk("assert_fail incorrectly passed")
+    end
+
+    #
+    # Verify that assert_fail succeeds when the block
+    # has a failed assertion.
+    #
+    assert_fail do
+      assert_equal(4, 5)
+    end
+  end
+
+  def test_assert_greater_than
+    assert_greater_than(5, 4)
+
+    assert_fail do
+      assert_greater_than(4, 4)
+    end
+
+    assert_fail do
+      assert_gt(4, 5, "test greater than")
+    end
+  end
+
+  def test_assert_greater_than_or_equal_to_or_equal_to
+    assert_greater_than_or_equal_to(5, 4)
+    assert_greater_than_or_equal_to(4, 4)
+
+    assert_fail do
+      assert_ge(4, 5, "test greater than or equal to")
+    end
+  end
+
+  def test_assert_less_than
+    assert_less_than(4, 5)
+
+    assert_fail do
+      assert_less_than(4, 4)
+    end
+
+    assert_fail do
+      assert_lt(5, 4, "test less than")
+    end
+  end
+
+  def test_assert_less_than_or_equal_to_or_equal_to
+    assert_less_than_or_equal_to(4, 5)
+    assert_less_than_or_equal_to(4, 4)
+
+    assert_fail do
+      assert_le(5, 4, "test less than or equal to")
+    end
+  end
+
+  def test_assert_raise_message
+    #
+    # Verify that the assertion passes correctly.
+    #
+    assert_nothing_raised do
+      assert_raise_message("hello, error!", RuntimeError) do
+        raise RuntimeError, "hello, error!"
+      end
+    end
+
+    #
+    # Verify that the assertion fails if no exception is thrown.
+    #
+    assert_fail do
+      assert_raise_message("hello, error!", RuntimeError) do
+      end
+    end
+
+    #
+    # Verify that the assertion fails if the wrong kind of
+    # exception is thrown.
+    #
+    assert_fail do
+      assert_raise_message("hello, error!", ArgumentError) do
+        raise RuntimeError, "hello, error!"
+      end
+    end
+
+    #
+    # Verify that the assertion fails if a different
+    # error message is specified.
+    #
+    assert_fail do
+      assert_raise_message("hello, error!", RuntimeError, "test message comparison") do
+        raise RuntimeError, "hello, errrr!"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: assertions
+version: !ruby/object:Gem::Version 
+  version: 0.9.0
+platform: ruby
+authors: 
+- DesigningPatterns
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-06-07 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.3
+    version: 
+description: "This package adds some additional assertions to Test::Unit::Assertions, including: * Assertions for all of the comparison operators (assert_greater_than, assert_less_than_or_equal_to, etc.).  Shorter aliases also are provided for these (assert_gt, assert_le, etc.). * An assertion that tests whether a given block raises a specified exception with a specified message (assert_raise_message).  This allows full testing of error messages. * An assertion that tests whether a given block contains an assertion that fails, which can be used to test new assertions."
+email: 
+- technical.inquiries@designingpatterns.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- Manifest.txt
+- README.txt
+- History.txt
+files: 
+- Manifest.txt
+- LICENSE
+- README.txt
+- History.txt
+- Rakefile
+- lib/assertions.rb
+- test/test_assertions.rb
+has_rdoc: true
+homepage: "Project Page: http://rubyforge.org/projects/assertions/"
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: assertions
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: "This package adds some additional assertions to Test::Unit::Assertions, including: * Assertions for all of the comparison operators (assert_greater_than, assert_less_than_or_equal_to, etc.)"
+test_files: 
+- test/test_assertions.rb