rubyunit 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a32652a6b8baba30b124f684ae76d5bd38eb05d
-  data.tar.gz: af724b51a8a59f343a7042e5d9a60383e35b6132
+  metadata.gz: 16efc526e3776368644128d5ebbe643d3361e75e
+  data.tar.gz: 762ffcba3e891ef4583203a63cded3dc1a8ee15c
 SHA512:
-  metadata.gz: 66a385147c0641100c03abc6834b60fd1459464e6889e0d91947d38d652f9708dfb7a55d47e6b44f4f4d38b0d0d039999dd042f36254e92cce03fa42e696d635
-  data.tar.gz: 400c80553b0e47abc05b6660255c94c8ad65e322fc92a981664a650f1203ac19d78c11556f516a0b2136f84bedb8f670810cd461a4cea51d9fd031494235b1e3
+  metadata.gz: b0fc1890230763a45108c339026baa02ca3ff3fd1fde390f5c83ae77590470d58829d97f423e95e55ee7aa111e375c08a18ac912ce6a33bb64801e5513429bc9
+  data.tar.gz: a2ebc354cf1549388ac0be77499bb47fd97098bb68ac14036b96711938d104bc879c3a581a2659a61b3f4f2bd66f94f2f2049ca1cc19d928a97527ba0636bb41

data/LICENSE

@@ -0,0 +1,165 @@
+GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -8,11 +8,10 @@ RubyUnit
 ### Practical Examples
 * https://github.com/matthewclower/PlayingCards
 
-
 ### Links
 * http://rubyunit.github.io/
 * https://github.com/RubyUnit/RubyUnit
-
+* https://github.com/matthewclower/RubyUnit/wiki
 
 ### Description
 

data/lib/RubyUnit/Runner.rb

@@ -3,6 +3,8 @@ require_relative 'AssertionFailure'
 
 module RubyUnit
   #
+  # = RubyUnit::Runner
+  #  
   # This is the test runner.
   # Done, and done.
   #

data/lib/RubyUnit/TestCase.rb

@@ -217,13 +217,13 @@ module RubyUnit
     #  end
     #
     def assertRaiseExpected *args, &block
-      __assertion do
-        raise ArgumentError, "wrong number of arguments (#{args.count} for 2..3)" unless args.count > 0 
-        expected, pattern, message = args
-        raise ArgumentError, "expected exception must be a subclass of Exception" unless expected < Exception
-        raise ArgumentError, "exception message must be a Regexp or String" unless pattern.is_a? Regexp or pattern.is_a? String or pattern.nil?
-        raise ArguemntError, "message must be a String or nil" unless message.is_a? String or message.nil?
+      raise ArgumentError, "wrong number of arguments (#{args.count} for 2..3)" unless args.count > 0 
+      expected, pattern, message = args
+      raise ArgumentError, "expected exception must be a subclass of Exception" unless expected < Exception
+      raise ArgumentError, "exception message must be a Regexp or String" unless pattern.is_a? Regexp or pattern.is_a? String or pattern.nil?
+      raise ArguemntError, "message must be a String or nil" unless message.is_a? String or message.nil?
 
+      __assertion do
         begin
           yield
           raise AssertionFailure, message
@@ -358,6 +358,7 @@ module RubyUnit
     # 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
+    # * raises ArgumentError if _konstant_ is not a string
     #
     # expected::
     #   The value that is expected for the constant
@@ -366,8 +367,7 @@ module RubyUnit
     #   The class where the constant should be defined
     #
     # konstant::
-    #   The name of the constant expressed as a String so that it can be
-    #   validated in the class
+    #   The name of the constant
     #
     # message::
     #   The message provided to be reported for a failure
@@ -375,13 +375,63 @@ module RubyUnit
     #  assertConst 42, Numbers, 'TWENTYFOUR', 'So dyslexic.'  # => fail
     #
     def assertConst expected, klass, konstant, message = nil
+      raise ArgumentError, 'Constant name must be given as a String' unless konstant.is_a? String
       __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
+    # * raises ArgumentError if _konstant_ is not a string
+    #
+    # 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
+      raise ArgumentError, 'Constant name must be given as a String' unless konstant.is_a? String
+      __assertion do
+        raise AssertionFailure, message unless klass.const_defined? konstant
+      end
+    end
+
+    #
+    # Assert that a constant is not defined in the specified class
+    # * raises RubyUnit::AssertionFailure if the constant is defined in
+    #   the specified class
+    # * raises ArgumentError if _konstant_ is not a string
+    #
+    # 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
+      raise ArgumentError, 'Constant name must be given as a String' unless konstant.is_a? String
+      __assertion do
+        raise AssertionFailure, message if klass.const_defined? konstant
+      end
+    end
+
     class << self
       private
       # Tracks the total number of assertions made during the tests

data/lib/RubyUnit.rb

@@ -6,40 +6,21 @@
 #
 module RubyUnit
   # Current RubyUnit version
-  VERSION = '0.1.7'
+  VERSION = '0.1.8'
 
   #
   # RubyUnit::GemInfo contains data and functionality needed by the gem builder
   # when building and distributing the RubyUnit gem.
   #
   module GemInfo
+    FILES       = ['README.md', 'LICENSE'] +   # base files at root level
+                  Dir['lib/**/*.rb'] +         # library files
+                  Dir['example/*.rb'] +        # example files
+                  Dir['tests/**/*.rb']         # TESTS
 
-    #
-    # Provides a list of all the files required by this gem
-    #
-    #  spec.files = RubyUnit::GemInfo.files
-    #
-    def self.files
-      # local one-off directory
-      static   = ['README.md']
-      # libraries
-      libs     = Dir['lib/**/*.rb']
-      # examples
-      examples = Dir['example/*.rb']
-
-      static + libs + examples
-    end
-
-    #
-    # Provides a longer description of the RubyUnit gem
-    #
-    #  spec.description = RubyUnit::GemInfo.description
-    #
-    def self.description
-      '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.'
-    end
+    DESCRIPTION = 'Unit testing and test-driven development are crucial parts of' +
+                  'the software development life cycle. This tool is intended to' +
+                  'make development and testing in Ruby easier on everyone.'
   end
 end
 

data/tests/TEST_GemInfo.rb

@@ -0,0 +1,27 @@
+require 'RubyUnit'
+require_relative 'data/GemInfo'
+
+module RubyUnit
+  #
+  # Test for the GemInfo module
+  #
+  module GemInfo
+    class TEST_GemInfo < TestCase
+      include GemInfoData
+      
+      #
+      # Verify that the list of required constants is defined
+      #
+      def constantsDefinedTest konstant
+        assertConstDefined RubyUnit::GemInfo, konstant, "missing constant in GemInfo: #{konstant}!"
+      end
+      
+      #
+      # Verify that the list of files contains the LICENSE file
+      #
+      def validateFilesIncludesLicenseTest
+        assert (RubyUnit::GemInfo::FILES.include? 'LICENSE'), 'Gem MUST be distributed with the license!'
+      end
+    end
+  end
+end

data/tests/TEST_RubyUnit.rb

@@ -0,0 +1,15 @@
+require 'RubyUnit'
+
+module RubyUnit
+  #
+  # Test for the RubyUnit module
+  #
+  class TEST_RubyUnit < TestCase
+    #
+    # Verify that the VERSION constant is defined in the RubyUnit module
+    #
+    def versionDefinedTest
+      assertConstDefined RubyUnit, 'VERSION', 'Version must be defined in RubyUnit::VERSION!'
+    end
+  end
+end

data/tests/TEST_TestCase.rb

@@ -0,0 +1,7 @@
+require 'RubyUnit/TestCase'
+
+module RubyUnit
+  class TEST_TestCase < TestCase
+    
+  end
+end

data/tests/TestSuite.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+# IMPORTANT
+# require relative RubyUnit framework for local so that the tests are run on the build
+# in this repository
+$LOAD_PATH.unshift("#{File.dirname(__FILE__)}/../lib") if not ARGV.include? '--gem'
+
+require 'RubyUnit'
+
+# Test Cases
+
+# Ruby module => lib/RubyUnit.rb
+require_relative 'TEST_RubyUnit'
+
+# GemInfo module => lib/RubyUnit.rb
+require_relative 'TEST_GemInfo'
+
+# TestCase class => lib/RubyUnit/TestCase.rb
+require_relative 'TEST_TestCase'

data/tests/data/GemInfo.rb

@@ -0,0 +1,8 @@
+module GemInfoData
+  def constantsDefinedData
+    [
+      [      'FILES'],
+      ['DESCRIPTION'],
+    ]
+  end
+end

data/tests/data/TestCase.rb

@@ -0,0 +1,3 @@
+module TestCaseData
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubyunit
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Matthew Clower
@@ -10,8 +10,8 @@ bindir: bin
 cert_chain: []
 date: 2014-10-13 00:00:00.000000000 Z
 dependencies: []
-description: 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
+description: Unit testing and test-driven development are crucial parts ofthe software
+  development life cycle. This tool is intended tomake development and testing in
   Ruby easier on everyone.
 email:
 - matthewclower@gmail.com
@@ -20,6 +20,7 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- LICENSE
 - README.md
 - example/RealNumber.rb
 - example/RealNumberData.rb
@@ -29,6 +30,12 @@ files:
 - lib/RubyUnit/AssertionFailure.rb
 - lib/RubyUnit/Runner.rb
 - lib/RubyUnit/TestCase.rb
+- tests/TEST_GemInfo.rb
+- tests/TEST_RubyUnit.rb
+- tests/TEST_TestCase.rb
+- tests/TestSuite.rb
+- tests/data/GemInfo.rb
+- tests/data/TestCase.rb
 homepage: http://github.com/RubyUnit/RubyUnit
 licenses:
 - Ruby