RubyGems - ruby-contract - Versions diffs - 0.1.1 - Mend

ruby-contract 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (74) hide show

data/COPYING +56 -0
data/Manifest +85 -0
data/README +32 -0
data/TODO +83 -0
data/doc/classes/Contract.html +599 -0
data/doc/classes/Contract/Check.html +229 -0
data/doc/classes/Contract/Check/All.html +172 -0
data/doc/classes/Contract/Check/Any.html +172 -0
data/doc/classes/Contract/Check/Block.html +172 -0
data/doc/classes/Contract/Check/None.html +173 -0
data/doc/classes/Contract/Check/Quack.html +172 -0
data/doc/classes/Contract/ContractError.html +151 -0
data/doc/classes/Contract/ContractException.html +162 -0
data/doc/classes/Contract/ContractMismatch.html +134 -0
data/doc/classes/Kernel.html +256 -0
data/doc/classes/Method.html +135 -0
data/doc/classes/MethodSignatureMixin.html +208 -0
data/doc/classes/Module.html +526 -0
data/doc/created.rid +1 -0
data/doc/dot/f_0.dot +14 -0
data/doc/dot/f_0.png +0 -0
data/doc/dot/f_1.dot +14 -0
data/doc/dot/f_1.png +0 -0
data/doc/dot/f_2.dot +14 -0
data/doc/dot/f_2.png +0 -0
data/doc/dot/f_3.dot +112 -0
data/doc/dot/f_3.png +0 -0
data/doc/dot/f_4.dot +62 -0
data/doc/dot/f_4.png +0 -0
data/doc/dot/f_5.dot +62 -0
data/doc/dot/f_5.png +0 -0
data/doc/dot/f_6.dot +224 -0
data/doc/dot/f_6.png +0 -0
data/doc/dot/f_6_0.dot +24 -0
data/doc/dot/f_6_0.png +0 -0
data/doc/dot/f_6_1.dot +24 -0
data/doc/dot/f_6_1.png +0 -0
data/doc/dot/f_7.dot +62 -0
data/doc/dot/f_7.png +0 -0
data/doc/files/COPYING.html +168 -0
data/doc/files/README.html +146 -0
data/doc/files/TODO.html +240 -0
data/doc/files/lib/contract/assertions_rb.html +118 -0
data/doc/files/lib/contract/exception_rb.html +125 -0
data/doc/files/lib/contract/integration_rb.html +130 -0
data/doc/files/lib/contract/overrides_rb.html +118 -0
data/doc/files/lib/contract_rb.html +127 -0
data/doc/fr_class_index.html +40 -0
data/doc/fr_file_index.html +34 -0
data/doc/fr_method_index.html +45 -0
data/doc/index.html +24 -0
data/doc/rdoc-style.css +208 -0
data/lib/contract.rb +146 -0
data/lib/contract/assertions.rb +42 -0
data/lib/contract/exception.rb +95 -0
data/lib/contract/integration.rb +664 -0
data/lib/contract/overrides.rb +41 -0
data/setup.rb +1360 -0
data/test/coverage/_-lib-contract-assertions_rb.html +526 -0
data/test/coverage/_-lib-contract-exception_rb.html +632 -0
data/test/coverage/_-lib-contract-integration_rb.html +1450 -0
data/test/coverage/_-lib-contract-overrides_rb.html +524 -0
data/test/coverage/_-lib-contract_rb.html +724 -0
data/test/coverage/__-lib-contract-assertions_rb.html +484 -0
data/test/coverage/__-lib-contract-exception_rb.html +537 -0
data/test/coverage/__-lib-contract-integration_rb.html +946 -0
data/test/coverage/__-lib-contract-overrides_rb.html +483 -0
data/test/coverage/__-lib-contract_rb.html +583 -0
data/test/coverage/index.html +93 -0
data/test/tc_all.rb +8 -0
data/test/tc_contract.rb +109 -0
data/test/tc_exception.rb +43 -0
data/test/tc_integration.rb +357 -0
metadata +136 -0

data/test/coverage/index.html ADDED

@@ -0,0 +1,93 @@
+<?xml version="1.0" encoding="ISO-8859-15"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
+            "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head><title>coverage</title>
+<style type="text/css">body {
+  background-color: rgb(180, 180, 180));
+}
+span.marked {
+  background-color: rgb(185, 200, 200);
+  display: block;
+}
+span.inferred {
+  background-color: rgb(180, 195, 195);
+  display: block;
+}
+span.overview {
+  border-bottom: 8px solid black;
+}
+</style></head>
+<body><h3><tt>Sat Feb 05 23:35:41 Westeurop�ische Normalzeit 2005</tt></h3><h1>Average (code only): 45.9%</h1><h2>Average (with comments): 47.8%</h2><table><tr>
+<td><a href="_-lib-contract_rb.html">./lib/contract.rb</a></td>
+<td><tt>282</tt></td>
+<td>&nbsp;</td><td>&nbsp;</td><td>&nbsp;</td>
+<td><tt>122</tt></td>
+<td>&nbsp;</td><td>&nbsp;</td><td>&nbsp;</td>
+<td><tt>48.9%</tt></td>
+<td>&nbsp;</td><td>&nbsp;</td><td>&nbsp;</td>
+<td><tt>47.5%</tt></td>
+</tr>
+<tr>
+<td><a href="_-lib-contract-assertions_rb.html">./lib/contract/assertions.rb</a></td>
+<td><tt>84</tt></td>
+<td>&nbsp;</td><td>&nbsp;</td><td>&nbsp;</td>
+<td><tt>20</tt></td>
+<td>&nbsp;</td><td>&nbsp;</td><td>&nbsp;</td>
+<td><tt>50.0%</tt></td>
+<td>&nbsp;</td><td>&nbsp;</td><td>&nbsp;</td>
+<td><tt>50.0%</tt></td>
+</tr>
+<tr>
+<td><a href="_-lib-contract-exception_rb.html">./lib/contract/exception.rb</a></td>
+<td><tt>190</tt></td>
+<td>&nbsp;</td><td>&nbsp;</td><td>&nbsp;</td>
+<td><tt>110</tt></td>
+<td>&nbsp;</td><td>&nbsp;</td><td>&nbsp;</td>
+<td><tt>50.0%</tt></td>
+<td>&nbsp;</td><td>&nbsp;</td><td>&nbsp;</td>
+<td><tt>50.0%</tt></td>
+</tr>
+<tr>
+<td><a href="_-lib-contract-integration_rb.html">./lib/contract/integration.rb</a></td>
+<td><tt>1008</tt></td>
+<td>&nbsp;</td><td>&nbsp;</td><td>&nbsp;</td>
+<td><tt>494</tt></td>
+<td>&nbsp;</td><td>&nbsp;</td><td>&nbsp;</td>
+<td><tt>46.6%</tt></td>
+<td>&nbsp;</td><td>&nbsp;</td><td>&nbsp;</td>
+<td><tt>43.9%</tt></td>
+</tr>
+<tr>
+<td><a href="_-lib-contract-overrides_rb.html">./lib/contract/overrides.rb</a></td>
+<td><tt>82</tt></td>
+<td>&nbsp;</td><td>&nbsp;</td><td>&nbsp;</td>
+<td><tt>50</tt></td>
+<td>&nbsp;</td><td>&nbsp;</td><td>&nbsp;</td>
+<td><tt>50.0%</tt></td>
+<td>&nbsp;</td><td>&nbsp;</td><td>&nbsp;</td>
+<td><tt>50.0%</tt></td>
+</tr>
+<tr><td>TOTAL</td>
+<td><tt>1646</tt></td>
+<td>&nbsp;</td><td>&nbsp;</td><td>&nbsp;</td>
+<td><tt>796</tt></td>
+<td>&nbsp;</td><td>&nbsp;</td><td>&nbsp;</td>
+<td><tt>47.8%</tt></td>
+<td>&nbsp;</td><td>&nbsp;</td><td>&nbsp;</td>
+<td><tt>45.9%</tt></td>
+</tr></table>
+<hr />
+<p>
+  <a href="http://validator.w3.org/check/referer">
+    <img src="http://www.w3.org/Icons/valid-xhtml11"
+     alt="Valid XHTML 1.1!" height="31" width="88" />
+  </a>
+ <a href="http://jigsaw.w3.org/css-validator/">
+  <img style="border:0;width:88px;height:31px"
+       src="http://jigsaw.w3.org/css-validator/images/vcss"
+       alt="Valid CSS!" />
+ </a>
+</p>
+</body>
+</html>

data/test/tc_all.rb ADDED

@@ -0,0 +1,8 @@
+# Runs all tests.
+$LOAD_PATH.unshift "lib"
+test_dir = File.split(Dir.pwd).last == "test" ? "." : "test"
+tests = Dir["#{test_dir}/**/*.rb"].reject { |file| file == "tc_all.rb" }
+tests.each { |test| require test  }

data/test/tc_contract.rb ADDED

@@ -0,0 +1,109 @@
+require 'test/unit'
+$LOAD_PATH << "../lib"
+require 'contract'
+class TC_Integration_Signature < Test::Unit::TestCase
+  class EnumerableContract < Contract
+    provides :each
+  end
+  module List
+    module NonEmpty; end
+  end
+  class ListContract < Contract
+    implies List
+    def self.check_count() 3 end
+    provides :each
+    provides :[]
+    provides :size do
+      assert(@object.size >= 0)
+    end
+  end
+  class NonEmptyListContract < ListContract
+    implies List::NonEmpty
+    provides :size do
+      assert(@object.size > 0)
+    end
+  end
+  class EmptyList
+    def each() end
+    def [](idx) end
+    def size() 0 end
+    fulfills ListContract
+  end
+  class NonEmptyList < EmptyList
+    def size() 1 end
+    fulfills NonEmptyListContract
+  end
+  class BrokenContract < Contract
+    provides :size do
+      [][]
+    end
+  end
+  def test_contract_test()
+    result = EnumerableContract.test([])
+    assert_equal(nil, result)
+    result = EnumerableContract.test(5)
+    assert_instance_of(Contract::ContractMismatch, result)
+  end
+  def test_contract_test_all()
+    result = ListContract.test_all([])
+    assert_equal(nil, result)
+    result = ListContract.test_all(Object.new)
+    assert_instance_of(Array, result)
+    assert_equal(ListContract.check_count, result.size)
+  end
+  def test_contract_fulfilled_by?()
+    result = EnumerableContract.fulfilled_by?([])
+    assert_equal(true, result)
+    result = EnumerableContract.fulfilled_by?(5)
+    assert_equal(false, result)
+  end
+  def test_contract_enforce()
+    assert_nothing_raised { ListContract.enforce([]) }
+    assert_raise(Contract::ContractMismatch) do
+      ListContract.enforce(5)
+    end
+  end
+  def test_broken_contract()
+    result = BrokenContract.test(5)
+    assert_instance_of(Contract::ContractError, result)
+  end
+  def test_implies_non_module()
+    assert_raise(TypeError) do
+      Class.new(Contract) { implies 5 }
+    end
+  end
+  def test_implications()
+    assert_equal([List], ListContract.implications)
+  end
+  def test_inherited_implications()
+    assert_equal([List, List::NonEmpty], NonEmptyListContract.implications)
+  end
+  def test_implies()
+    assert_equal(true, EmptyList.ancestors.include?(List))
+  end
+  def test_inherited_implies()
+    assert_equal(true, NonEmptyList.ancestors.include?(List::NonEmpty))
+  end
+end

data/test/tc_exception.rb ADDED

@@ -0,0 +1,43 @@
+require 'test/unit'
+$LOAD_PATH << "../lib"
+require 'contract'
+class TC_Exception < Test::Unit::TestCase
+  def test_extract_method_name()
+    { "test_provides_each(ListContract)" => "test_provides_each",
+      "test_foo(Foo::Bar)" => "test_foo",
+      "test_bar(#<Class:0x2ba5e08>)" => "test_bar"
+    }.each do |from, to|
+      assert_equal(to, Contract.extract_method_name(from))
+    end
+  end
+  def test_fault_to_exception()
+    name, backtrace, message, object, contract =
+      "test_name(Contract)", caller, "message", Object.new,
+      Class.new(Contract)
+    exception = Exception.new(message)
+    exception.set_backtrace(backtrace)
+    [ Test::Unit::Failure.new(name, backtrace, message),
+      Test::Unit::Error.new(name, exception)
+    ].each do |fault|
+      result = Contract.fault_to_exception(fault, object, contract)
+      assert_kind_of(Contract::ContractException, result)
+      assert_equal("test_name", result.test_method)
+      assert_equal(backtrace, result.backtrace)
+      assert_equal(message, result.original_message)
+      assert_equal(object, result.test_object)
+      assert_equal(contract, result.test_contract)
+      case fault
+        when Test::Unit::Failure then
+          assert_instance_of(Contract::ContractMismatch, result)
+        when Test::Unit::Error then
+          assert_instance_of(Contract::ContractError, result)
+          assert_equal(exception.class, result.type)
+      end
+    end
+  end
+end

data/test/tc_integration.rb ADDED

@@ -0,0 +1,357 @@
+require 'test/unit'
+$LOAD_PATH << "../lib"
+require 'contract'
+module SignatureHelpers
+  def object(type = Object, *args, &block)
+    Class.new(type, &block).new(*args)
+  end
+end
+class TC_Integration_Signature < Test::Unit::TestCase
+  include SignatureHelpers
+  def setup()
+    Contract.check_signatures = true
+  end
+  def test_incompatible_signature()
+    exception = assert_raise(ArgumentError) do
+      object do
+        signature :to_s, :any
+      end
+    end
+    assert_equal("signature isn't compatible with arity",
+      exception.message)
+  end
+  def test_empty_repeated()
+    exception = assert_raise(ArgumentError) do
+      object do
+        signature :to_s, :repeated => []
+      end
+    end
+    assert_equal("repeated arguments may not be an empty Array",
+      exception.message)
+  end
+  def test_invalid_specifier()
+    assert_raise(ArgumentError) do
+      object do
+        signature :is_a?, Class.new { undef :=== }.new
+      end
+    end
+  end
+  def test_no_arguments()
+    obj = object do
+      alias :old_to_s :to_s
+      signature :to_s
+    end
+    assert_nothing_raised { obj.to_s }
+    assert_equal(obj.old_to_s, obj.to_s)
+    assert_raise(ArgumentError) { obj.to_s(1) }
+  end
+  def test_return()
+    obj = object do
+      signature :inspect, :return => String
+      def foo() end
+      signature :foo, :return => String
+    end
+    assert_nothing_raised { obj.inspect }
+    assert_raise(StandardError) { obj.foo }
+  end
+  def test_no_block()
+    obj = object do
+      signature :to_s, :block => false
+    end
+    assert_nothing_raised { obj.to_s }
+    assert_raise(ArgumentError) { obj.to_s { 1+1 } }
+  end
+  def test_block()
+    obj = object(Array) do
+      signature :each, :block => true
+    end
+    assert_nothing_raised { obj.each {} }
+    assert_raise(ArgumentError) { obj.each }
+  end
+  def test_any_arguments()
+    obj = object do
+      signature :respond_to?, :any, :any
+    end
+    assert_nothing_raised { obj.respond_to?(:inspect, true) }
+    assert_raise(ArgumentError) { obj.respond_to?() }
+  end
+  def test_allow_trailing()
+    obj = object(Array) do
+      signature :zip, :allow_trailing => true
+      signature :values_at, :any, :allow_trailing => true
+    end
+    assert_nothing_raised { obj.zip }
+    assert_nothing_raised { obj.zip(obj) }
+    assert_nothing_raised { obj.values_at(0) }
+    assert_nothing_raised { obj.values_at(0, 0) }
+    assert_raise(ArgumentError) { obj.values_at }
+  end
+  def test_classes()
+    obj = object(Array) do
+      signature :is_a?, Module
+      signature :join, String
+      signature :at, Integer
+    end
+    assert_nothing_raised { obj.is_a?(Array) }
+    assert_nothing_raised { obj.join(", ") }
+    assert_nothing_raised { obj.at(0) }
+    assert_raise(ArgumentError) { obj.is_a?(5) }
+    assert_raise(ArgumentError) { obj.join(5) }
+    assert_raise(ArgumentError) { obj.at("x") }
+  end
+  def test_callable()
+    obj = object(Array) do
+      alias :x :*
+      signature :*, lambda { |arg| arg >= 0 }
+      signature :x, 0.method(:<=)
+    end
+    assert_nothing_raised { obj * 0 }
+    assert_nothing_raised { obj.x(0) }
+    assert_raise(ArgumentError) { obj * -1 }
+    assert_raise(ArgumentError) { obj.x(-1) }
+  end
+  def test_optional()
+    obj = object do
+      def foo(x, y=5, z=3, *args) [x, y, z, *args] end
+      signature :foo, Numeric, :optional => [Numeric, Numeric],
+        :allow_trailing => true
+    end
+    assert_nothing_raised { obj.foo(5) }
+    assert_equal([5, 5, 3], obj.foo(5))
+    assert_nothing_raised { obj.foo(5, 4, 3) }
+    assert_nothing_raised { obj.foo(5, 4, 3, 2) }
+    assert_equal([5, 4, 3, 2], obj.foo(5, 4, 3, 2))
+    assert_raise(ArgumentError) { obj.foo }
+    assert_raise(ArgumentError) { obj.foo(5, "foo") }
+  end
+  def test_repeated()
+    obj = object(Array) do
+      signature :zip, :repeated => [Enumerable]
+      signature :values_at, Numeric, :repeated => Numeric
+    end
+    assert_nothing_raised { obj.zip }
+    assert_nothing_raised { obj.zip(obj) }
+    assert_nothing_raised { obj.values_at(0) }
+    assert_nothing_raised { obj.values_at(0, 0) }
+    assert_raise(ArgumentError) { obj.values_at }
+  end
+  def test_no_adaption()
+    obj = object do
+      signature :respond_to?, Symbol, :no_adaption => true
+    end
+    assert_nothing_raised { obj.respond_to?(:to_s) }
+    assert_raises(ArgumentError) { obj.respond_to?("to_s") }
+  end
+end
+class TC_Integration_Checks < Test::Unit::TestCase
+  def test_block()
+    check = Contract::Check.block { |obj| obj > 0 }
+    assert_equal(true, check === 5)
+    assert_equal(false, check === -5)
+  end
+  def test_quack()
+    check = Contract::Check::Quack[:to_str]
+    assert_equal(true, check === "foo")
+    assert_equal(false, check === Object.new)
+  end
+  def test_all()
+    check = Contract::Check::All[Numeric, 3 .. 10]
+    assert_equal(false, check === "x")
+    assert_equal(false, check === 2)
+    assert_equal(true, check === 5)
+  end
+  def test_any()
+    check = Contract::Check::Any[Numeric, Symbol]
+    assert_equal(false, check === "x")
+    assert_equal(true, check === 5)
+    assert_equal(true, check === :x)
+  end
+  def test_none()
+    check = Contract::Check::None[Numeric, Symbol]
+    assert_equal(true, check === "x")
+    assert_equal(false, check === 5)
+    assert_equal(false, check === :x)
+  end
+  def test_aliases()
+    assert_equal(Contract::Check::All, Contract::Check::And)
+    assert_equal(Contract::Check::Any, Contract::Check::Or)
+    assert_equal(Contract::Check::None, Contract::Check::Not)
+  end
+end
+class TC_Integration_Fulfills < Test::Unit::TestCase
+  class ListContract < Contract
+    provides :each, :[]
+    provides :size do
+      assert_nothing_raised { @object.size }
+      assert(@object.size >= 0)
+    end
+  end
+  class ListWrapper
+    def initialize(list)
+      @list = list
+    end
+    def each(&block) @list.each(&block) end
+    def size() @list.size end
+    def [](*args) @list[*args] end
+    fulfills ListContract
+  end
+  def setup()
+    Contract.check_fulfills = true
+  end
+  def test_fulfills()
+    assert_nothing_raised { ListWrapper.new([]) }
+    assert_raise(Contract::ContractMismatch) { ListWrapper.new(Object.new) }
+  end
+end
+class TC_Integration_Adaption < Test::Unit::TestCase
+  include SignatureHelpers
+  def test_no_from_and_to()
+    assert_raises(ArgumentError) do
+      object { adaption :via => :to_s }
+    end
+    assert_raises(ArgumentError) do
+      cls = Class.new
+      adaption :from => cls, :to => cls, :via => :to_s
+    end
+  end
+  def test_no_via()
+    assert_raises(ArgumentError) do
+      adaption :from => Class.new, :to => Class.new
+    end
+  end
+  def test_via_and_block()
+    assert_raises(ArgumentError) do
+      adaption :from => Class.new, :to => Class.new, :via => :to_s do |obj|
+        obj.to_s
+      end
+    end
+  end
+  def test_block()
+    obj = object do
+      adaption(:to => String) { "string" }
+    end
+    assert_equal("string", Contract.adapt(obj, String))
+  end
+  def test_callable_if()
+    cls = Class.new(Object) do
+      attr_accessor :value
+      def initialize(value)
+        @value = value
+      end
+    end
+    obj = object do
+      adaption :from => cls, :to => String, :via => :value,
+        :if => lambda { |obj| obj.value.is_a?(String) }
+    end
+    assert_equal("foo", Contract.adapt(cls.new("foo"), String))
+    obj = cls.new(5)
+    assert_equal(obj, Contract.adapt(obj, String))
+  end
+  def test_default_adaptions()
+    obj = object do
+      [Symbol, String, Array, Integer].each do |cls|
+        method = cls.name.downcase.intern
+        define_method(method) { |arg| arg }
+        signature(method, cls)
+      end
+    end
+    string_like = object { def to_str() "foo" end }
+    array_like = object { def to_ary() [1, 2] end }
+    assert_equal(:foo, obj.symbol("foo"))
+    assert_equal("foo", obj.string(string_like))
+    assert_equal([1, 2], obj.array(array_like))
+    assert_equal(5, obj.integer(5.0))
+  end
+end
+class TC_Integration_MethodSignatureMixin < Test::Unit::TestCase
+  include SignatureHelpers
+  def test_origin()
+    assert_equal(String, "foo".method(:+).origin)
+    assert_equal(Array, Array.instance_method(:[]).origin)
+  end
+  def test_name()
+    assert_equal(:+, "foo".method(:+).name)
+    assert_equal(:[], Array.instance_method(:[]).name)
+  end
+  def test_has_signature?()
+    assert(!"foo".method(:+).has_signature?)
+    obj = object do
+      def x() end
+      signature :x
+    end
+    assert(obj.method(:x).has_signature?)
+  end
+  def test_signature()
+    obj = object do
+      def m0() end
+      def m1(a) end
+      def t(a,*) end
+    end
+    assert_equal([[], {}], obj.method(:m0).signature)
+    assert_equal([[:any], {}], obj.method(:m1).signature)
+    assert_equal([[:any], { :allow_trailing => true }],
+      obj.method(:t).signature)
+    sign = [[Fixnum, String], { :repeated => [1 .. 10, 2 .. 3] }]
+    obj = object do
+      def x(*) end
+      signature(:x, *sign.flatten)
+    end
+    assert_equal(sign, obj.method(:x).signature)
+  end
+end