rubyunit 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7b282fd7aea1c73823b348dba0c1490f0c524033
+  data.tar.gz: 688fc628ab4914478f43ea9725fae391f95bf84f
+SHA512:
+  metadata.gz: 0297326918d2fe02b3698824c848fa08abc21fb868f78abc5204f405723aa9885e190ee1429242faa18676e9a9b04d194334f43d56323fa8809bb9a3d83b889e
+  data.tar.gz: 9d5c621bd08a22bd1016ecce2a52323d29152a369f9353d16f23a330fc2be754e7072fdda1f780455c820d3fd202ab3ecc3dc661693e77524e84d30a808eabf5

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

@@ -0,0 +1,29 @@
+RubyUnit
+========
+
+* https://github.com/RubyUnit/RubyUnit
+
+## Description
+
+A simple Unit Test framework for Ruby
+
+## TODO:
+
+* Flesh out assertion list
+* Improve error/failure handling and reporting
+* Build mock object and fixture templates
+* Build tests for framework
+* Add comments to existing code
+* Build documentation
+* Build better robust data driven test functionality
+* Build configuration mechanism (also need to decide what is configurable)
+* Build code coverage reporting
+* Implement multi-threaded testing
+* Add test dependencies for test
+
+### Ruby Gem
+* Get gem version from library
+* Update summary and description to pull a doc
+
+### In Progress
+* Create Ruby Gem from unit test framework

data/example/RealNumber.rb

@@ -0,0 +1,27 @@
+# Real Numbers (not complex)
+module RealNumber
+  # determines if a number is greater than zero
+  def positive?
+    self > 0
+  end
+
+  # determines if a number is less than zero
+  def negative?
+    self < 0
+  end
+end
+
+class Integer
+  # mixin RealNumber into Integer
+  include RealNumber
+end
+
+class Float
+  # mixin RealNumber into Float
+  include RealNumber
+end
+
+class Rational
+  # mixin RealNumber into Rational
+  include RealNumber
+end

data/example/RealNumberTest.rb

@@ -0,0 +1,69 @@
+require_relative 'RealNumber'
+
+# Test for RealNumber mixin
+class RealNumberTest < RubyUnit::TestCase
+  def positiveTest value
+    assert value.positive?, "#{value.class}:(#{value}) should be positive!"
+  end
+
+  def notPositiveTest value
+    assertNot value.positive?, "#{value.class}:(#{value}) should not be positive!"
+  end
+
+  def negativeTest value
+    assert value.negative?, "#{value.class}:(#{value}) should be negative!"
+  end
+
+  def notNegativeTest value
+    assertNot value.negative?, "#{value.class}:(#{value}) should not be negative!"
+  end
+end
+
+# Extend the class to add data providing functions
+class RealNumberTest
+  def positiveData
+    [
+      [           Integer(1),],
+      [        Integer(4242),],
+      [Integer(100000000000),],
+      [Integer(424200000000),],
+      [           Float(0.1),],
+      [           Float(1.0),],
+      [         Float(42.42),],
+      [       Rational(1,42),],
+      [        Rational(1,1),],
+      [    Rational(4242,42),],
+    ]
+  end
+
+  def zeroData
+    [
+      [   Integer(0)],
+      [   Float(0.0)],
+      [Rational(0,1)],
+    ]
+  end
+
+  def negativeData
+    [
+      [           Integer(-1),],
+      [        Integer(-4242),],
+      [Integer(-100000000000),],
+      [Integer(-424200000000),],
+      [           Float(-0.1),],
+      [           Float(-1.0),],
+      [         Float(-42.42),],
+      [       Rational(-1,42),],
+      [        Rational(-1,1),],
+      [    Rational(-4242,42),],
+    ]
+  end
+
+  def notPositiveData
+    zeroData + negativeData
+  end
+
+  def notNegativeData
+    zeroData + positiveData
+  end
+end

data/lib/RubyUnit/AssertionFailure.rb

@@ -0,0 +1,4 @@
+module RubyUnit
+  class AssertionFailure < StandardError
+  end
+end

data/lib/RubyUnit/Runner.rb

@@ -0,0 +1,93 @@
+require 'RubyUnit/TestCase'
+require 'RubyUnit/AssertionFailure'
+
+module RubyUnit
+  class Runner
+    protected
+    @@test_cases = []
+    @@failures   = []
+    @@errors     = []
+    @@tests      = 0
+    @@start      = nil
+    @@finish     = nil
+
+    class << self
+      public
+      def run
+        @@start = Time.new
+        runner = new
+        TestCase.descendents.each do |object|
+          @@test_cases << object
+
+          data_methods = object.instance_methods.grep /Data\Z/
+          test_methods = object.instance_methods.grep /Test\Z/
+
+          test_methods.each do |test|
+            data_method = "#{test.slice(0..-5)}Data".to_sym
+            if data_methods.include? data_method
+              test_case = object.new
+              data      = test_case.send data_method
+
+              raise "Data method #{data_method} must return an array" unless data.is_a? Array
+              data.each do |params|
+                raise "Data method #{data_method} must return an array of arrays" unless data.is_a? Array
+                runner.run object, test, params
+              end
+            else
+              runner.run object, test
+            end
+          end
+        end
+        @@finish = Time.new
+        report
+      end
+
+      protected
+      def report
+        # haven't figured out what I want to do for reporting yet but I need some results
+        puts "Started Tests #{@@start.strftime("%Y-%m-%d %H:%M:%S")}"
+
+        puts "#{@@errors.count} Errors:\n" if @@errors.count > 0
+        @@errors.each_with_index do |error, i|
+          puts "#{i + 1}) #{error[0]}::#{error[1]}(#{error[2]})"
+          puts error[3].message
+          puts error[3].backtrace.join("\n")
+        end
+
+        puts "#{@@failures.count} Failures:\n" if @@failures.count > 0
+        @@failures.each_with_index do |failure, i|
+          puts "#{i + 1}) #{failure[0]}::#{failure[1]}(#{failure[2]})"
+          puts failure[3].message
+          puts failure[3].backtrace.join("\n")
+        end
+        
+        elapsed  = @@finish - @@start
+        inverse  = Rational(elapsed.to_r.denominator,elapsed.to_r.numerator)
+        puts
+        puts "Tests Complete in #{elapsed} seconds!"
+        puts "%.3f tests/s, %.3f assertions/s" % [(@@tests * inverse).to_f, (TestCase.assertions * inverse).to_f]
+        puts "%d Tests, %d Assertions, %d Errors, %d Failures" % [@@tests, TestCase.assertions, @@errors.count, @@failures.count]
+        puts
+      end
+    end
+
+    public
+    def run object, test, params = []
+      raise ArgumentError, "Parameter list for #{object.class}::#{test} must be an array" unless params.is_a? Array
+
+      test_case = object.new
+
+      begin
+        @@tests += 1
+        test_case.setup
+        test_case.send test, *params
+      rescue AssertionFailure => failure
+        @@failures << [test_case.class.name, test, params, failure]
+      rescue Exception => error
+        @@errors << [test_case.class.name, test, params, error]
+      ensure
+        test_case.teardown
+      end
+    end
+  end
+end

data/lib/RubyUnit/TestCase.rb

@@ -0,0 +1,134 @@
+require 'RubyUnit/AssertionFailure'
+
+module RubyUnit
+  class TestCase
+    public
+    def setup
+    end
+
+    def teardown
+    end
+
+    private
+    def __assertion &block
+      @@assertions += 1
+      yield
+    end
+
+    protected
+    def fail message = nil
+      __assertion do
+        raise AssertionFailure, message
+      end
+    end
+
+    def assert expected, message = nil
+      __assertion do
+        raise AssertionFailure, message unless expected
+      end
+    end
+
+    def assertNot expected, message = nil
+      __assertion do
+        raise AssertionFailure, message if expected
+      end
+    end
+
+    def assertEqual expected, actual, message = nil
+      __assertion do
+        raise AssertionFailure, message unless expected == actual
+      end
+    end
+
+    def assertNotEqual expected, actual, message = nil
+      __assertion do
+        raise AssertionFailure, message if expected == actual
+      end
+    end
+
+    def assertMatch pattern, actual, message = nil
+      __assertion do
+        raise AssertionFailure, message unless actual =~ pattern
+      end
+    end
+
+    def assertRaiseExpected *args, &block
+      __assertion do
+        raise ArgumentError, "wrong number of arguments (#{args.count} for 2..3)" unless args.count >= 1 
+        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?
+
+        begin
+          yield
+          raise AssertionFailure, message
+        rescue expected => e
+          if pattern.is_a? String
+            assertEqual pattern, e.message
+          elsif pattern.is_a? Regexp
+            assertMatch pattern, e.message
+          end
+        end
+      end
+    end
+
+    def assertNothingRaised message = nil, &block
+      __assertion do
+        begin
+          yield
+        rescue
+          raise AssertionFailure, message
+        end
+      end
+    end
+
+    def assertIsA klass, object, message = nil
+      __assertion do
+        raise AssertionFailure, message unless klass.is_a? Class
+      end
+    end
+
+    def assertInstanceOf klass, object, message = nil
+      __assertion do
+        assertIsA Class, klass, message
+        raise AssertionFailure, message unless object.instance_of? klass
+      end
+    end
+
+    def assertSame expected, actual, message = nil
+      __assertion do
+        raise AssertionFailure, message unless expected.equal? actual
+      end
+    end
+
+    def assertNotSame expected, actual, message = nil
+      __assertion do
+        raise AssertionFailure, message if expected.equal? actual
+      end
+    end
+
+    def assertConst expected, klass, konstant, message = nil
+      __assertion do
+        assertIsA Class, klass, message
+        value = klass.const_get konstant
+        assertIsA expected.class, value, message
+        assertEqual expected, value, message
+      end
+    end
+
+    class << self
+      @@assertions = 0
+
+      def descendents
+        ObjectSpace.each_object(Class).select do |object|
+          object < self
+        end
+      end
+      
+      def assertions
+        @@assertions
+      end
+    end
+  end
+end

data/lib/RubyUnit/version.rb

@@ -0,0 +1,3 @@
+module RubyUnit
+  VERSION = '0.0.1'
+end

data/lib/RubyUnit.rb

@@ -0,0 +1,13 @@
+module RubyUnit
+end
+
+require 'RubyUnit/TestCase'
+require 'RubyUnit/Runner'
+# Automatically run test cases
+Module.new do
+  if $ERROR_INFO.nil?
+    at_exit do
+      RubyUnit::Runner.run
+    end
+  end
+end

data/test.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+# Sample Test
+require_relative 'RubyUnit'
+require_relative 'example/RealNumberTest'

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: rubyunit
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matthew Clower
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-12 00:00:00.000000000 Z
+dependencies: []
+description: Framework for Unit Testing in Ruby
+email:
+- matthewclower@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- LICENSE
+- README.md
+- example/RealNumber.rb
+- example/RealNumberTest.rb
+- lib/RubyUnit.rb
+- lib/RubyUnit/AssertionFailure.rb
+- lib/RubyUnit/Runner.rb
+- lib/RubyUnit/TestCase.rb
+- lib/RubyUnit/version.rb
+- test.rb
+homepage: http://github.com/RubyUnit/RubyUnit
+licenses:
+- LGPL
+metadata: {}
+post_install_message: Happy Testing!
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Unit Test Framework
+test_files: []