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/doc/classes/Contract/Check.html ADDED

@@ -0,0 +1,229 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Module: Contract::Check</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+    elemStyle = elem.style;
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+    return true;
+  }
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  // ]]>
+  </script>
+</head>
+<body>
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Module</strong></td>
+          <td class="class-name-in-header">Contract::Check</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/contract/integration_rb.html">
+                lib/contract/integration.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="diagram">
+      <map id="map" name="map">
+  <area shape="RECT" coords="33,117,105,165"      href="../Method.html" alt="Method" title="Method">
+  <area shape="RECT" coords="259,117,331,165"      href="../Contract.html" alt="Contract" title="Contract">
+  <area shape="RECT" coords="393,21,465,69"      href="../Module.html" alt="Module" title="Module">
+  <area shape="RECT" coords="515,21,621,69"      href="../UnboundMethod.html" alt="UnboundMethod" title="UnboundMethod">
+  <area shape="RECT" coords="355,117,488,165"      href="Check/Any.html" alt="Contract::Check::Any" title="Contract::Check::Any">
+  <area shape="RECT" coords="512,117,635,165"      href="Check/All.html" alt="Contract::Check::All" title="Contract::Check::All">
+  <area shape="RECT" coords="659,117,795,165"      href="Check/None.html" alt="Contract::Check::None" title="Contract::Check::None">
+  <area shape="RECT" coords="819,117,957,165"      href="Check/Block.html" alt="Contract::Check::Block" title="Contract::Check::Block">
+  <area shape="RECT" coords="659,21,795,69"      href="Check/Base.html" alt="Contract::Check::Base" title="Contract::Check::Base">
+  <area shape="RECT" coords="981,117,1123,165"      href="Check/Quack.html" alt="Contract::Check::Quack" title="Contract::Check::Quack">
+  <area shape="RECT" coords="7,17,132,61"      href="../MethodSignatureMixin.html" alt="MethodSignatureMixin" title="MethodSignatureMixin">
+  <area shape="RECT" coords="127,17,220,61"      href="../Kernel.html" alt="Kernel" title="Kernel">
+</map>
+<img src="../../dot/f_6.png" usemap="#map" border=0 alt="lib/contract/integration.rb">
+    </div>
+    <div id="description">
+      <p>
+Implements checks that can for example be used in <a
+href="../Module.html#M000015">Module#signature</a> specifications. They are
+implemented simply by overriding the === case equality operator. They can
+also be nested like this:
+</p>
+<pre>
+  # Matches something that is an Enumerable and that responds to
+  # either :to_ary or :to_a.
+  signature :x, Contract::Check::All[
+    Enumerable,
+    Contract::Check::Any[
+      Contract::Check::Quack[:to_a],
+      Contract::Check::Quack[:to_ary]
+    ]
+  ]
+</pre>
+    </div>
+   </div>
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+      <div class="name-list">
+      <a href="#M000009">block</a>&nbsp;&nbsp;
+      </div>
+    </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <div id="class-list">
+      <h3 class="section-bar">Classes and Modules</h3>
+      Class <a href="Check/All.html" class="link">Contract::Check::All</a><br />
+Class <a href="Check/Any.html" class="link">Contract::Check::Any</a><br />
+Class <a href="Check/Block.html" class="link">Contract::Check::Block</a><br />
+Class <a href="Check/None.html" class="link">Contract::Check::None</a><br />
+Class <a href="Check/Quack.html" class="link">Contract::Check::Quack</a><br />
+    </div>
+    <div id="constants-list">
+      <h3 class="section-bar">Constants</h3>
+      <div class="name-list">
+        <table summary="Constants">
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">And</td>
+          <td>=</td>
+          <td class="context-item-value">All unless defined?(And)</td>
+          <td width="3em">&nbsp;</td>
+          <td class="context-item-desc">
+Alias for <a href="Check/All.html">Contract::Check::All</a>
+</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">Or</td>
+          <td>=</td>
+          <td class="context-item-value">Any unless defined?(Or)</td>
+          <td width="3em">&nbsp;</td>
+          <td class="context-item-desc">
+Alias for <a href="Check/Any.html">Contract::Check::Any</a>
+</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">Not</td>
+          <td>=</td>
+          <td class="context-item-value">None unless defined?(Not)</td>
+          <td width="3em">&nbsp;</td>
+          <td class="context-item-desc">
+Alias for <a href="Check/None.html">Contract::Check::None</a>
+</td>
+        </tr>
+        </table>
+      </div>
+    </div>
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+      <div id="method-M000009" class="method-detail">
+        <a name="M000009"></a>
+        <div class="method-heading">
+          <a href="#M000009" class="method-signature">
+          <span class="method-name">block</span><span class="method-args">() {|arg| ...}</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Short-cut for creating a <a
+href="Check/Block.html">Contract::Check::Block</a>.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000009-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000009-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/contract/integration.rb, line 42</span>
+42:     <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">block</span>(<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>) <span class="ruby-comment cmt"># :yields: arg</span>
+43:       <span class="ruby-constant">Block</span>.<span class="ruby-identifier">new</span>(<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
+44:     <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>

data/doc/classes/Contract/Check/All.html ADDED

@@ -0,0 +1,172 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: Contract::Check::All</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+    elemStyle = elem.style;
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+    return true;
+  }
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  // ]]>
+  </script>
+</head>
+<body>
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">Contract::Check::All</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../../files/lib/contract/integration_rb.html">
+                lib/contract/integration.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                Base
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="diagram">
+      <map id="map" name="map">
+  <area shape="RECT" coords="33,117,105,165"      href="../../Method.html" alt="Method" title="Method">
+  <area shape="RECT" coords="259,117,331,165"      href="../../Contract.html" alt="Contract" title="Contract">
+  <area shape="RECT" coords="393,21,465,69"      href="../../Module.html" alt="Module" title="Module">
+  <area shape="RECT" coords="515,21,621,69"      href="../../UnboundMethod.html" alt="UnboundMethod" title="UnboundMethod">
+  <area shape="RECT" coords="355,117,488,165"      href="Any.html" alt="Contract::Check::Any" title="Contract::Check::Any">
+  <area shape="RECT" coords="512,117,635,165"      href="All.html" alt="Contract::Check::All" title="Contract::Check::All">
+  <area shape="RECT" coords="659,117,795,165"      href="None.html" alt="Contract::Check::None" title="Contract::Check::None">
+  <area shape="RECT" coords="819,117,957,165"      href="Block.html" alt="Contract::Check::Block" title="Contract::Check::Block">
+  <area shape="RECT" coords="659,21,795,69"      href="Base.html" alt="Contract::Check::Base" title="Contract::Check::Base">
+  <area shape="RECT" coords="981,117,1123,165"      href="Quack.html" alt="Contract::Check::Quack" title="Contract::Check::Quack">
+  <area shape="RECT" coords="7,17,132,61"      href="../../MethodSignatureMixin.html" alt="MethodSignatureMixin" title="MethodSignatureMixin">
+  <area shape="RECT" coords="127,17,220,61"      href="../../Kernel.html" alt="Kernel" title="Kernel">
+</map>
+<img src="../../../dot/f_6.png" usemap="#map" border=0 alt="lib/contract/integration.rb">
+    </div>
+    <div id="description">
+      <p>
+Checks that all the specified conditions match. Example:
+</p>
+<pre>
+  signature :x, Contract::Check::All[Array, Enumerable]
+</pre>
+    </div>
+   </div>
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+      <div class="name-list">
+      <a href="#M000011">===</a>&nbsp;&nbsp;
+      </div>
+    </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Instance methods</h3>
+      <div id="method-M000011" class="method-detail">
+        <a name="M000011"></a>
+        <div class="method-heading">
+          <a href="#M000011" class="method-signature">
+          <span class="method-name">===</span><span class="method-args">(other)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000011-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000011-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/contract/integration.rb, line 59</span>
+59:       <span class="ruby-keyword kw">def</span> <span class="ruby-operator">===</span>(<span class="ruby-identifier">other</span>)
+60:         <span class="ruby-ivar">@args</span>.<span class="ruby-identifier">all?</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">arg</span><span class="ruby-operator">|</span> <span class="ruby-identifier">arg</span> <span class="ruby-operator">===</span> <span class="ruby-identifier">other</span> }
+61:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>

data/doc/classes/Contract/Check/Any.html ADDED

@@ -0,0 +1,172 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: Contract::Check::Any</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+    elemStyle = elem.style;
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+    return true;
+  }
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  // ]]>
+  </script>
+</head>
+<body>
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">Contract::Check::Any</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../../files/lib/contract/integration_rb.html">
+                lib/contract/integration.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                Base
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="diagram">
+      <map id="map" name="map">
+  <area shape="RECT" coords="33,117,105,165"      href="../../Method.html" alt="Method" title="Method">
+  <area shape="RECT" coords="259,117,331,165"      href="../../Contract.html" alt="Contract" title="Contract">
+  <area shape="RECT" coords="393,21,465,69"      href="../../Module.html" alt="Module" title="Module">
+  <area shape="RECT" coords="515,21,621,69"      href="../../UnboundMethod.html" alt="UnboundMethod" title="UnboundMethod">
+  <area shape="RECT" coords="355,117,488,165"      href="Any.html" alt="Contract::Check::Any" title="Contract::Check::Any">
+  <area shape="RECT" coords="512,117,635,165"      href="All.html" alt="Contract::Check::All" title="Contract::Check::All">
+  <area shape="RECT" coords="659,117,795,165"      href="None.html" alt="Contract::Check::None" title="Contract::Check::None">
+  <area shape="RECT" coords="819,117,957,165"      href="Block.html" alt="Contract::Check::Block" title="Contract::Check::Block">
+  <area shape="RECT" coords="659,21,795,69"      href="Base.html" alt="Contract::Check::Base" title="Contract::Check::Base">
+  <area shape="RECT" coords="981,117,1123,165"      href="Quack.html" alt="Contract::Check::Quack" title="Contract::Check::Quack">
+  <area shape="RECT" coords="7,17,132,61"      href="../../MethodSignatureMixin.html" alt="MethodSignatureMixin" title="MethodSignatureMixin">
+  <area shape="RECT" coords="127,17,220,61"      href="../../Kernel.html" alt="Kernel" title="Kernel">
+</map>
+<img src="../../../dot/f_6.png" usemap="#map" border=0 alt="lib/contract/integration.rb">
+    </div>
+    <div id="description">
+      <p>
+Checks that at least one of the specified conditions match. Example:
+</p>
+<pre>
+  signature :x, Contract::Check::Any[String, Symbol]
+</pre>
+    </div>
+   </div>
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+      <div class="name-list">
+      <a href="#M000010">===</a>&nbsp;&nbsp;
+      </div>
+    </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Instance methods</h3>
+      <div id="method-M000010" class="method-detail">
+        <a name="M000010"></a>
+        <div class="method-heading">
+          <a href="#M000010" class="method-signature">
+          <span class="method-name">===</span><span class="method-args">(other)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000010-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000010-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/contract/integration.rb, line 70</span>
+70:       <span class="ruby-keyword kw">def</span> <span class="ruby-operator">===</span>(<span class="ruby-identifier">other</span>)
+71:         <span class="ruby-ivar">@args</span>.<span class="ruby-identifier">any?</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">arg</span><span class="ruby-operator">|</span> <span class="ruby-identifier">arg</span> <span class="ruby-operator">===</span> <span class="ruby-identifier">other</span> }
+72:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>