rubyunit 0.2.14 → 0.3.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b64f6dbfe4319e46907b2011f73fdadd28eefe7a
-  data.tar.gz: b71d665242db3cfc15f5db95b9c4410bd5f67d38
+  metadata.gz: fbbc44756c8014588e15f7b9db7f6d07e3d40ad4
+  data.tar.gz: c3a39f3f2a8a55fdeaeabfab1857655714a18c26
 SHA512:
-  metadata.gz: bad85169080b04079d2603d31ebd4bcd9eba77c9b62770d1418d4e6abcc16df2b942f5d72ae1e6a94d5c37e45ffcc656033e3e8dac39cf679e411cc198b31ab0
-  data.tar.gz: c7ff085f436ef93f1a13b07fd5b5b547906cd13690d32d9759c6c512bc5316d8b095d258c1f529b561d81fcfa1b2e87e68735e0968f6555e3247730021dbcd65
+  metadata.gz: 623a1fe7c5dfde8032454373019dc7e51eed67e3b4c2dca6360bfe3ebb4d64ccfd61765fa8b0ba6b97b22ba475e585570a1b847e6062341fc17386e3ac3478eb
+  data.tar.gz: e95597151407a17709aade4fc6a955c4500b53e750113c9827fc20f08d99d3a81c36a6826999262dfa879913627da868ca4546f42f37eb800e4d57e356f64533

data/README.md

@@ -3,10 +3,8 @@ RubyUnit
 
 [![Gem Version](https://badge.fury.io/rb/rubyunit.svg)](http://badge.fury.io/rb/rubyunit)
 [![Code Climate](https://codeclimate.com/github/RubyUnit/RubyUnit/badges/gpa.svg)](https://codeclimate.com/github/RubyUnit/RubyUnit)
-[![Test Coverage](https://codeclimate.com/github/RubyUnit/RubyUnit/badges/coverage.svg)](https://codeclimate.com/github/RubyUnit/RubyUnit)
-
-### Practical Examples
-* https://github.com/matthewclower/PlayingCards
+[![Build Status](https://travis-ci.org/RubyUnit/RubyUnit.svg?branch=master)](https://travis-ci.org/RubyUnit/RubyUnit)
+<!-- [![Test Coverage](https://codeclimate.com/github/RubyUnit/RubyUnit/badges/coverage.svg)](https://codeclimate.com/github/RubyUnit/RubyUnit) -->
 
 ### Links
 * http://rubyunit.github.io/
@@ -17,7 +15,8 @@ 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.
+testing in Ruby easier on everyone. RubyUnit is also designed to with a focus
+on data-driven testing.
 
 ### Install
 

data/TestSuite.rb

@@ -4,30 +4,14 @@
 # in this repository
 path = File.dirname(__FILE__)
 
-$LOAD_PATH.unshift("#{path}/lib") if not ARGV.include? '--gem'
-$LOAD_PATH.unshift("#{path}/tests")
+$LOAD_PATH.unshift("#{path}/lib") unless ARGV.include? '--gem'
 
 require 'RubyUnit'
 
-# Test Sets
+RubyUnit.debug = true if ARGV.include? '--debug'
 
-# RubyUnit module => RubyUnit.rb
-require 'TS_RubyUnit'
-
-# AssertionFailure exception => RubyUnit/AssertionFailure.rb
-require 'TS_AssertionFailure'
-
-# Assertions module => RubyUnit/Assertions.rb
-require 'TEST_Assertions'
-
-# IncompleteTest exception => RubyUnit/IncompleteTest.rb
-require 'TEST_IncompleteTest'
-
-# Runner class => RubyUnit/Runner.rb
-require 'TEST_Runner'
-
-# SkippedTest exception => RubyUnit/SkippedTest.rb
-require 'TEST_SkippedTest'
-
-# TestCase class => RubyUnit/TestCase.rb
-require 'TEST_TestCase'
+# Automatically load Test Sets
+Dir['tests/TS_*.rb'].each do |test_set|
+  puts "Adding Test Set #{test_set}" if RubyUnit.debug
+  require_relative test_set
+end

data/lib/RubyUnit/AssertionFailure.rb

@@ -1,14 +1,14 @@
+require 'RubyUnit/AssertionMessage'
+
 module RubyUnit
-  #
+  ##
   # Exception that is raised when a test assertion fails.
   #
   class AssertionFailure < StandardError
+    include AssertionMessage
     attr_reader :data
 
-    # Error messages
-    FAILING = 'Failing test'
-
-    #
+    ##
     # Create a RubyUnit::AssertionFailure exception
     #
     # data::
@@ -19,14 +19,14 @@ module RubyUnit
       @data = data
     end
 
-    #
+    ##
     # Create a string from the assertion data
     #
     def info
       s = "\n"
-      s = "#{message}\n" if message.length > 0
-      @data.each do |index, value|
-        s << "\n#{index}:\n\t#{value.inspect}"
+      s = "#{FAILURE}: #{message}\n" if message.length > 0
+      @data.each do |key, value|
+        s << "\n#{key}:\n\t#{value.inspect}"
       end
       s
     end

data/lib/RubyUnit/AssertionMessage.rb

@@ -0,0 +1,70 @@
+module RubyUnit
+  ##
+  # module containing text for assertion errors and messages
+  #
+  module AssertionMessage
+    ##
+    # Error messages
+    FAILING = 'Failing test'
+    FAILURE = 'Failed to ASSERT'
+
+    ##
+    # Basic assertions
+    ASSERT_ERROR         = 'Value IS NOT false OR nil'
+    ASSERT_NOT_ERROR     = 'Value IS false OR nil'
+    ASSERT_TRUE_ERROR    = 'Value IS EXACLTY true' 
+    ASSERT_FALSE_ERROR   = 'Value IS EXACLTY false'
+    ASSERT_NIL_ERROR     = 'Value IS EXACTLY nil'
+    ASSERT_NOT_NIL_ERROR = 'Value IS NOT nil'
+
+    ##
+    # Class assertions
+    ASSERT_KIND_OF_ERROR           = 'Object IS kind_of?'
+    ASSERT_NOT_KIND_OF_ERROR       = 'Object IS NOT kind_of?'
+    ASSERT_INSTANCE_OF_ERROR       = 'Object IS instance_of?'
+    ASSERT_NOT_INSTANCE_OF_ERROR   = 'Object IS NOT instance_of?'
+    ASSERT_DESCENDENT_ERROR        = 'Object IS a descendent'
+    ASSERT_NOT_DESCENDENT_ERROR    = 'Object IS NOT a descendent'
+    ASSERT_CONST_ERROR             = 'Object defines correct constant'
+    ASSERT_CONST_DEFINED_ERROR     = 'Object defines constant'
+    ASSERT_CONST_NOT_DEFINED_ERROR = 'Object does NOT define constant'
+
+    ##
+    # Collection assertions
+    ASSERT_INCLUDE_ERROR     = 'Collection includes object'
+    ASSERT_NOT_INCLUDE_ERROR = 'Collection does NOT include object'
+    ASSERT_EMPTY_ERROR       = 'Collection IS empty'
+    ASSERT_NOT_EMPTY_ERROR   = 'Collection IS NOT empty'
+
+    ##
+    # Comparison assertions
+    ASSERT_EQUAL_ERROR              = 'Objects ARE equal'
+    ASSERT_NOT_EQUAL_ERROR          = 'Objects ARE NOT equal'
+    ASSERT_GREATERTHAN_ERROR        = 'Object IS greater than expected'
+    ASSERT_GREATERTHANOREQUAL_ERROR = 'Object IS greater than OR equal to expected'
+    ASSERT_LESSTHAN_ERROR           = 'Object IS less than expected'
+    ASSERT_LESSTHANOREQUAL_ERROR    = 'Object IS less than OR equal to expected'
+    ASSERT_MATCH_ERROR              = 'Value matches Regexp'
+    ASSERT_NOT_MATCH_ERROR          = 'Value does NOT match Regexp'
+    ASSERT_SAME_ERROR               = 'Objects ARE the same'
+    ASSERT_NOT_SAME_ERROR           = 'Objects ARE NOT the same'
+
+    ##
+    # Exception assertions
+    ASSERT_NOTHING_RAISED_ERROR = 'Exception WAS NOT raised'
+    ASSERT_RAISE_MESSAGE_ERROR  = 'Exception message WAS raised'
+    ASSERT_RAISE_KIND_OF_ERROR  = 'Exception Class WAS raised'
+    ASSERT_RAISE_EXPECTED_ERROR = 'Expected Exception WAS raised'
+
+    ##
+    # Method assertions
+    ASSERT_RESPOND_TO_ERROR          = 'Object responds to method'
+    ASSERT_NOT_RESPOND_TO_ERROR      = 'Object does NOT respond to method'
+    ASSERT_METHOD_ERROR              = 'Object defines method'
+    ASSERT_NOT_METHOD_ERROR          = 'Object does NOT define method'
+    ASSERT_INSTANCE_METHOD_ERROR     = 'Object defines instance method'
+    ASSERT_NOT_INSTANCE_METHOD_ERROR = 'Object does NOT define instance method'
+    ASSERT_CLASS_METHOD_ERROR        = 'Object defines class method'
+    ASSERT_NOT_CLASS_METHOD_ERROR    = 'Object does NOT define instance method'
+  end
+end

data/lib/RubyUnit/Assertions/Basic.rb

@@ -0,0 +1,121 @@
+module RubyUnit
+  module Assertions
+    include AssertionMessage
+
+    #
+    # 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
+      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 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 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 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

data/lib/RubyUnit/Assertions/Class.rb

@@ -0,0 +1,196 @@
+module RubyUnit
+  module Assertions
+    include AssertionMessage
+    #
+    # 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 _klass_
+    #
+    # klass::
+    #   The parent class
+    #
+    # descendent::
+    #   The descendent class
+    #
+    # message::
+    #   The message provided to be reported for a failure
+    #
+    #  assertDescendent Numeric, Exception, 'Nope'  # => fail
+    #
+    def assertDescendent klass, descendent, message = nil
+      __assert (descendent < klass), ASSERT_DESCENDENT_ERROR, message, {:klass=>klass, :descendent=>descendent}
+    end
+
+    #
+    # Assert that a class is not a descendent of another class
+    # * raises RubyUnit::AssertionFailure if _illegal_ 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, illegal, message = nil
+      __reject (descendent < klass), ASSERT_NOT_DESCENDENT_ERROR, message, {:klass=>klass, :descendent=>descendent}
+    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
+      __wrap_assertion do
+        assertConstDefined klass, konstant, message
+        value = klass.const_get konstant
+        assertIsA 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
+  end
+end

data/lib/RubyUnit/Assertions/Collection.rb

@@ -0,0 +1,80 @@
+module RubyUnit
+  module Assertions
+    include AssertionMessage
+    #
+    # Assert that a collection includes a specified value
+    # * raises RubyUnit::AssertionFailure unless _collection_ responds to _value_
+    #
+    # object::
+    #   The collection to check
+    #
+    # method::
+    #   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
+      assertRespondTo collection, :include?, message
+      __assert (collection.include? value), ASSERT_INCLUDE_ERROR, message, {:collection=>collection, :value=>value}
+    end
+
+    #
+    # Assert that a collection does not include a specified value
+    # * raises RubyUnit::AssertionFailure if _collection_ responds to _value_
+    #
+    # object::
+    #   The collection to check
+    #
+    # method::
+    #   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, value, message = nil
+      assertRespondTo collection, :include?, message
+      __reject (collection.include? value), ASSERT_NOT_INCLUDE_ERROR, message, {:collection=>collection, :value=>value}
+    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
+      assertRespondTo object, :include?, message
+      __assert object.empty?, ASSERT_EMPTY_ERROR, message, {:object=>object}
+    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
+      assertRespondTo object, :include?, message
+      __reject object.empty?, ASSERT_NOT_EMPTY_ERROR, message, {:object=>object}
+    end
+  end
+end