rubyunit 0.3.16 → 0.3.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca80c88f05e1945496377a6b44d73c622412c985
-  data.tar.gz: 6a86a2572e1a7cc2e25f9af74224732e5664b3ca
+  metadata.gz: f5d35957bc44ace4839322331916d2a7bd7e40e9
+  data.tar.gz: 3aa1001b5357db11dc3101168039128f354c697b
 SHA512:
-  metadata.gz: 4dc2a9820139f22073934d121751fb7bbc0edc4099caf27a3b646976935c467173c600784ba8007ac829794014b8d980727a7a450c1b1682cae6fc8e4f0d0892
-  data.tar.gz: a01214430b5f3f640e264a81e9012de8e88f7d92b736d6d180e95a22d2b0aef93c3237ec17f89c05f80aca95450e1cd732e2ee1a907520edfd3025dc995816a1
+  metadata.gz: 06388c102cf2b807cd11c64ca2d4f05c5158090f71bad93f948f4cfb855a191f028e2c7f9b978bc640679da8cb33373d06e75abe8de1ab0c62e462e323d3f679
+  data.tar.gz: 2771b688763f6c1d7869802b69932fc2ae399c6daf576cae79efde2f617ab97709ede6af632042204b71e4b2d4ea8edfdb9b866253f7f98bd9d3c05006719181

data/README.md

@@ -16,7 +16,7 @@ RubyUnit
 Unit testing and test-driven development is a crucial part of the software
 development life cycle. This tool is intended to make development and
 testing in Ruby easier on everyone. RubyUnit is also designed to with a focus
-on data-driven testing.
+on data-driven testing and meta-programming.
 
 ### Install
 

data/lib/RubyUnit/Assertions/Basic.rb

@@ -1,121 +1,124 @@
+require_relative 'Root'
+
 module RubyUnit
   module Assertions
-    include AssertionMessage
+    module Basic
+      include RubyUnit::AssertionMessage
+      include Assertions::Root
 
-    #
-    # Fail the test. This is used when some conditioned outside the test warrants
-    # a test failure.
-    # * This is likely an indication of something unexpected or missing functionality
-    # * raises RubyUnit::AssertionFailure
-    #
-    # message::
-    #   The message provided to be reported for a failure
-    #
-    # data::
-    #   The data associated with assertion
-    #
-    #  fail "I wasn't expecting the moon to fall into Lake Michigan"  # => fail
-    #
-    def fail message = nil, data = {}
-      __wrap_assertion do
-        build_message FAILING, message, data
+      ##
+      # Fail the test. This is used when some conditioned outside the test warrants
+      # a test failure.
+      # * This is likely an indication of something unexpected or missing functionality
+      # * raises RubyUnit::AssertionFailure
+      #
+      # message::
+      #   The message provided to be reported for a failure
+      #
+      # data::
+      #   The data associated with assertion
+      #
+      #  fail "I wasn't expecting the moon to fall into Lake Michigan"  # => fail
+      #
+      def fail message = nil, data = {}
+        __assert_block FAILING, message, data
       end
-    end
 
-    #
-    # Assert that a test condition is true.
-    # * raises RubyUnit::AssertionFailure if _value_ is false or nil
-    #
-    # value::
-    #   The value that is being checked by the assertion
-    #
-    # message::
-    #   The message provided to be reported for a failure
-    #
-    #  assert false, "This will fail"  # => fail
-    #
-    def assert value, message = nil
-      __assert value, ASSERT_ERROR, message, {:value=>value}
-    end
+      ##
+      # Assert that a test condition is true.
+      # * raises RubyUnit::AssertionFailure if _value_ is false or nil
+      #
+      # value::
+      #   The value that is being checked by the assertion
+      #
+      # message::
+      #   The message provided to be reported for a failure
+      #
+      #  assert false, "This will fail"  # => fail
+      #
+      def assert value, message = nil
+        __assert value, ASSERT_ERROR, message, {:value=>value}
+      end
 
-    #
-    # Assert that a test condition is false.
-    # * raises RubyUnit::AssertionFailure unless _value_ is false or nil
-    #
-    # value::
-    #   The value that is being checked by the assertion
-    #
-    # message::
-    #   The message provided to be reported for a failure
-    #
-    #  assertNot true, "This will fail"  # => fail
-    #
-    def assertNot value, message = nil
-      __reject value, ASSERT_NOT_ERROR, message, {:value=>value}
-    end
+      ##
+      # Assert that a test condition is false.
+      # * raises RubyUnit::AssertionFailure unless _value_ is false or nil
+      #
+      # value::
+      #   The value that is being checked by the assertion
+      #
+      # message::
+      #   The message provided to be reported for a failure
+      #
+      #  assertNot true, "This will fail"  # => fail
+      #
+      def assertNot value, message = nil
+        __reject value, ASSERT_NOT_ERROR, message, {:value=>value}
+      end
 
-    #
-    # Assert that a test condition is exactly true.
-    # * raises RubyUnit::AssertionFailure unless _value_ is true
-    #
-    # value::
-    #   The value that is being checked by the assertion
-    #
-    # message::
-    #   The message provided to be reported for a failure
-    #
-    #  assertTrue false, "This will fail"  # => fail
-    #
-    def assertTrue value, message = nil
-      __assert (true == value), ASSERT_TRUE_ERROR, message, {:value=>value}
-    end
+      ##
+      # Assert that a test condition is exactly true.
+      # * raises RubyUnit::AssertionFailure unless _value_ is true
+      #
+      # value::
+      #   The value that is being checked by the assertion
+      #
+      # message::
+      #   The message provided to be reported for a failure
+      #
+      #  assertTrue false, "This will fail"  # => fail
+      #
+      def assertTrue value, message = nil
+        __assert (true == value), ASSERT_TRUE_ERROR, message, {:value=>value}
+      end
 
-    #
-    # Assert that a test condition is exactly false.
-    # * raises RubyUnit::AssertionFailure unless _value_ is false
-    #
-    # value::
-    #   The value that is being checked by the assertion
-    #
-    # message::
-    #   The message provided to be reported for a failure
-    #
-    #  assertNil true, "This will fail"  # => fail
-    #
-    def assertFalse value, message = nil
-      __assert (false == value), ASSERT_FALSE_ERROR, message, {:value=>value}
-    end
+      ##
+      # Assert that a test condition is exactly false.
+      # * raises RubyUnit::AssertionFailure unless _value_ is false
+      #
+      # value::
+      #   The value that is being checked by the assertion
+      #
+      # message::
+      #   The message provided to be reported for a failure
+      #
+      #  assertNil true, "This will fail"  # => fail
+      #
+      def assertFalse value, message = nil
+        __assert (false == value), ASSERT_FALSE_ERROR, message, {:value=>value}
+      end
 
-    #
-    # Assert that a test condition is exactly nil.
-    # * raises RubyUnit::AssertionFailure unless _value_ is nil
-    #
-    # value::
-    #   The value that is being checked by the assertion
-    #
-    # message::
-    #   The message provided to be reported for a failure
-    #
-    #  assertNil true, "This will fail"  # => fail
-    #
-    def assertNil value, message = nil
-      __assert value.nil?, ASSERT_NIL_ERROR, message, {:value=>value}
-    end
+      ##
+      # Assert that a test condition is exactly nil.
+      # * raises RubyUnit::AssertionFailure unless _value_ is nil
+      #
+      # value::
+      #   The value that is being checked by the assertion
+      #
+      # message::
+      #   The message provided to be reported for a failure
+      #
+      #  assertNil true, "This will fail"  # => fail
+      #
+      def assertNil value, message = nil
+        __assert value.nil?, ASSERT_NIL_ERROR, message, {:value=>value}
+      end
 
-    #
-    # Assert that a test condition is not nil.
-    # * raises RubyUnit::AssertionFailure if _value_ is nil
-    #
-    # value::
-    #   The value that is being checked by the assertion
-    #
-    # message::
-    #   The message provided to be reported for a failure
-    #
-    #  assertNotNil nil, "This will fail"  # => fail
-    #
-    def assertNotNil value, message = nil
-      __reject value.nil?, ASSERT_NOT_NIL_ERROR, message, {:value=>value}
+      ##
+      # Assert that a test condition is not nil.
+      # * raises RubyUnit::AssertionFailure if _value_ is nil
+      #
+      # value::
+      #   The value that is being checked by the assertion
+      #
+      # message::
+      #   The message provided to be reported for a failure
+      #
+      #  assertNotNil nil, "This will fail"  # => fail
+      #
+      def assertNotNil value, message = nil
+        __reject value.nil?, ASSERT_NOT_NIL_ERROR, message, {:value=>value}
+      end
     end
   end
 end

data/lib/RubyUnit/Assertions/Classes.rb

@@ -0,0 +1,216 @@
+require_relative 'Root'
+
+module RubyUnit
+  module Assertions
+    module Classes
+      include RubyUnit::AssertionMessage
+      include Root
+
+      ##
+      # Assert that an object is an instance of the specified class or one of
+      # its descendents.
+      # * raises RubyUnit::AssertionFailure unless _object_ is an instance of
+      #   _klass_ or one of its descendents. 
+      #
+      # klass::
+      #   The class that is expected
+      #
+      # object::
+      #   The object that will be checked against _klass_
+      #
+      # message::
+      #   The message provided to be reported for a failure
+      #
+      #  assertKindOf String, 25, 'Nope, try again.'  # => fail
+      #
+      def assertKindOf klass, object, message = nil
+        __assert (object.is_a? klass), ASSERT_KIND_OF_ERROR, message, {:klass=>klass, :object=>object}
+      end
+    
+      alias_method :assertIsA, :assertKindOf
+
+      #
+      # Assert that an object is not an instance of the specified class or one of
+      # its descendents.
+      # * raises RubyUnit::AssertionFailure if _object_ is an instance of _exclusion_ or
+      # one of its descendents. 
+      #
+      # exclusion::
+      #   The class that is excluded
+      #
+      # object::
+      #   The object that will be checked against _klass_
+      #
+      # message::
+      #   The message provided to be reported for a failure
+      #
+      #  assertNotKindOf Numeric, 25, 'Nope, try again.'  # => fail
+      #
+      def assertNotKindOf exclusion, object, message = nil
+        __reject (object.is_a? exclusion), ASSERT_NOT_KIND_OF_ERROR, message, {:exclusion=>exclusion, :object=>object}
+      end
+
+      [:assertNotIsA, :assertIsNotA].each do |method|
+        alias_method method, :assertNotKindOf
+      end
+
+      #
+      # Assert that an object is an instance of a specified class
+      # * raises RubyUnit::AssertionFailure unless _object_ is an instance of _klass_.
+      #
+      # klass::
+      #   The class that is expected
+      #
+      # object::
+      #   The object that will be checked against _klass_
+      #
+      # message::
+      #   The message provided to be reported for a failure
+      #
+      #  assertInstanceOf Integer, '25', 'So close, but... No.'  # => fail
+      #
+      def assertInstanceOf klass, object, message = nil
+        __assert (object.instance_of? klass), ASSERT_INSTANCE_OF_ERROR, message, {:klass=>klass, :object=>object}
+      end
+
+      #
+      # Assert that an object is an instance of a specified class
+      # * raises RubyUnit::AssertionFailure unless _object_ is an instance of _klass_.
+      #
+      # exclusion::
+      #   The class that is expected
+      #
+      # object::
+      #   The object that will be checked against _klass_
+      #
+      # message::
+      #   The message provided to be reported for a failure
+      #
+      #  assertNotInstanceOf Integer, 25, 'So close, but... No.'  # => fail
+      #
+      def assertNotInstanceOf exclusion, object, message = nil
+        __reject (object.instance_of? exclusion), ASSERT_NOT_INSTANCE_OF_ERROR, message, {:exclusion=>exclusion, :object=>object}
+      end
+
+      #
+      # Assert that a class is a descendent of another class
+      # * raises RubyUnit::AssertionFailure unless _descendent_ is a descendent of +_super+
+      #
+      # _super::
+      #   The parent class
+      #
+      # descendent::
+      #   The descendent class
+      #
+      # message::
+      #   The message provided to be reported for a failure
+      #
+      #  assertDescendent Numeric, Exception, 'Nope'  # => fail
+      #
+      def assertDescendent _super, descendent, message = nil
+        __assert_descendent ASSERT_DESCENDENT_ERROR, _super, descendent, message do
+          descendent < _super
+        end
+      end
+
+      #
+      # Assert that a class is not a descendent of another class
+      # * raises RubyUnit::AssertionFailure if _klass_ is a descendent of _klass_
+      #
+      # klass::
+      #   The parent class
+      #
+      # descendent::
+      #   The illegal descendent class
+      #
+      # message::
+      #   The message provided to be reported for a failure
+      #
+      #  assertDescendent StandardError, Exception, 'It is'  # => fail
+      #
+      def assertNotDescendent klass, descendent, message = nil
+        __assert_descendent ASSERT_NOT_DESCENDENT_ERROR, klass, descendent, message do
+          not descendent < klass
+        end
+      end
+
+      #
+      # Assert that a constant is defined correctly in the correct class
+      # * raises RubyUnit::AssertionFailure unless the constant is defined in
+      #   the specified class and it is the correct type and value
+      #
+      # expected::
+      #   The value that is expected for the constant
+      #
+      # klass::
+      #   The class where the constant should be defined
+      #
+      # konstant::
+      #   The name of the constant
+      #
+      # message::
+      #   The message provided to be reported for a failure
+      #
+      #  assertConst 42, Numbers, 'TWENTYFOUR', 'So dyslexic.'  # => fail
+      #
+      def assertConst expected, klass, konstant, message = nil
+        __assert_block ASSERT_CONST_ERROR, message do
+          assertConstDefined klass, konstant, message
+          value = klass.const_get konstant
+          assertKindOf expected.class, value, message
+          assertEqual expected, value, message
+        end
+      end
+
+      #
+      # Assert that a constant is defined in the specified class
+      # * raises RubyUnit::AssertionFailure unless the constant is defined in
+      #   the specified class
+      #
+      # klass::
+      #   The class where the constant should be defined
+      #
+      # konstant::
+      #   The name of the constant
+      #
+      # message::
+      #   The message provided to be reported for a failure
+      #
+      #  assertConstDefined Numbers, 'FORTYTWO', 'Mystery.'  # => ??
+      #
+      def assertConstDefined klass, konstant, message = nil
+        __assert (klass.const_defined? konstant), ASSERT_CONST_DEFINED_ERROR, message, {:klass=>klass, :konstant=>konstant}
+      end
+
+      #
+      # Assert that a constant is not defined in the specified class
+      # * raises RubyUnit::AssertionFailure if the constant is defined in
+      #   the specified class
+      #
+      # klass::
+      #   The class where the constant should not be defined
+      #
+      # konstant::
+      #   The name of the constant
+      #
+      # message::
+      #   The message provided to be reported for a failure
+      #
+      #  assertConstNotDefined Numbers, 'TWENTYFOUR', 'Mystery.'  # => ??
+      #
+      def assertConstNotDefined klass, konstant, message = nil
+        __reject (klass.const_defined? konstant), ASSERT_CONST_NOT_DEFINED_ERROR, message, {:klass=>klass, :konstant=>konstant}
+      end
+
+      private
+      ##
+      # Helper for asserting descendents
+      def __assert_descendent error, klass, descendent, message
+        raise ArgumentError, "Expecting Class, got #{klass.class}" unless klass.is_a? Class
+        __assert_block error, message, {:class=>klass, :descendent=>descendent} do
+          yield
+        end
+      end
+    end
+  end
+end

data/lib/RubyUnit/Assertions/Collections.rb

@@ -0,0 +1,105 @@
+require_relative 'Root'
+
+module RubyUnit
+  module Assertions
+    module Collections
+      include RubyUnit::AssertionMessage
+      include Root
+
+      ##
+      # Assert that a collection includes a specified value
+      # * raises RubyUnit::AssertionFailure unless _collection_ responds to _value_
+      #
+      # collection::
+      #   The collection to check
+      #
+      # value::
+      #   The value the object should contain
+      #
+      # message::
+      #   The message provided to be reported for a failure
+      #
+      #  assertInclude [1, 2], 'not in', 'It does not, so... no'  # => fail
+      #
+      def assertInclude collection, value, message = nil
+        __assert_include ASSERT_INCLUDE_ERROR, collection, value, message do
+          collection.include? value
+        end
+      end
+
+      ##
+      # Assert that a collection does not include a specified value
+      # * raises RubyUnit::AssertionFailure if _collection_ responds to _value_
+      #
+      # collection::
+      #   The collection to check
+      #
+      # reject::
+      #   The value the object should not contain
+      #
+      # message::
+      #   The message provided to be reported for a failure
+      #
+      #  assertNotInclude [1, 2, 3], 2, 'It does, so close'  # => fail
+      #
+      def assertNotInclude collection, reject, message = nil
+        __assert_include ASSERT_NOT_INCLUDE_ERROR, collection, reject, message do
+          not collection.include? reject
+        end
+      end
+
+      ##
+      # Assert that a value is empty
+      # * raises RubyUnit::AssertionFailure unless _object_ responds to :empty?
+      # * raises RubyUnit::AssertionFailure unless _object_ is empty
+      #
+      # object::
+      #   The object to check
+      #
+      # message::
+      #   The message provided to be reported for a failure
+      #
+      #  assertEmpty [1, 2], 'Not empty'  # => fail
+      #
+      def assertEmpty object, message = nil
+        __assert_empty ASSERT_EMPTY_ERROR, object, message do
+          object.empty?
+        end
+      end
+
+      ##
+      # Assert that a value is not empty
+      # * raises RubyUnit::AssertionFailure unless _object_ responds to :empty?
+      # * raises RubyUnit::AssertionFailure if _object_ is empty
+      #
+      # object::
+      #   The object to check
+      #
+      # message::
+      #   The message provided to be reported for a failure
+      #
+      #  assertNotInclude [1, 2, 3], 2, 'It does, so close'  # => fail
+      #
+      def assertNotEmpty object, message = nil
+        __assert_empty ASSERT_EMPTY_ERROR, object, message do
+          not object.empty?
+        end
+      end
+
+      private
+      ##
+      # Perform include assertion via block 
+      def __assert_include error, collection, value, message #:nodoc:
+        raise ArgumentError, "#{collection.class} does not respond to :include?" unless collection.respond_to? :include?
+        __assert_block error, message, {:collection=>collection, :value=>value} { yield }
+      end
+
+      ##
+      # Perform empty assertion via block
+      def __assert_empty error, object, message #:nodoc:
+        raise ArgumentError, "#{object.class} does not respond to :empty?" unless collection.respond_to? :empty?
+        __assert_block error, message, {:object=>object} { yield }
+      end
+    end
+  end
+end