rushcheck 0.2

data/data/rushcheck/examples/roguetile.rb

@@ -0,0 +1,153 @@
+# roguetile.rb
+# an example of bug patterns
+# appeared in "Bug patterns: an introduction - diagnosing and
+# correcting recurring bug type in your Java programs", written by
+# Eric Allen, 2001. 
+# http://www-128.ibm.com/developerworks/library/j-diag1.html
+
+# Tree is an abstract class
+class Tree
+  def add
+    raise(NotImplementedError, "override!")
+  end
+
+  def multiply
+    raise(NotImplementedError, "override!")
+  end
+end
+
+class Leaf < Tree
+
+  attr_reader :value
+  def initialize(v)
+    @value = v
+  end
+
+  def add
+    @value.to_i
+  end
+
+  def multiply
+    @value.to_i
+  end
+
+end
+
+class Branch < Tree
+
+  attr_reader :value, :left, :right
+  def initialize(v, l, r)
+    @value, @left, @right = v, l, r
+  end
+
+  def add
+    @value.to_i + @left.add + @right.add
+  end
+
+  def multiply
+    # Here, there is a bug in multiply because the auther forgot to
+    # change after copying the add method. This bug is called Rogue-Tile
+    # pattern in the article.
+
+    @value.to_i * @left.multiply + @right.multiply # bug!
+  end    
+
+  # To not write a bug such as above, the author of the article
+  # recommends to use Command-Pattern. See also the article.
+  # Because the aim of this example is to find a bug, I leave
+  # a wrong style implementation.
+end
+
+# ok, then let's test them and find a bug.
+
+require 'rushcheck/rushcheck'
+
+class Tree
+  extend Arbitrary
+  include Coarbitrary
+
+  def self.arbitrary
+    Gen.frequency([[3, Leaf.arbitrary], [1, Branch.arbitrary]])
+  end
+
+  # In this example, coarbitrary isn't needed, however,
+  # I write them to see how to write coarbitrary.
+  def coarbitrary
+    raise(NotImplementedError, "override!")
+  end
+end
+
+class Leaf
+  extend Arbitrary
+  include Coarbitrary
+  
+  def self.arbitrary
+    Integer.arbitrary.bind {|x| Gen.unit(new(x)) }
+  end
+
+  def coarbitrary(g)
+    @value.coarbitrary(g)
+  end
+end
+
+class Branch
+  extend Arbitrary
+  include Coarbitrary
+
+  def self.arbitrary
+    Gen.new do |n, g|
+      g2 = g
+      v, l, r = [Integer.arbitrary, Tree.arbitrary, Tree.arbitrary].map do |x|
+        g1, g2 = g2.split
+        x.value(n, g1)
+      end
+      new(v, l, r)
+    end
+  end
+
+  def coarbitrary(g)
+    @value.coarbitrary(@left.coarbitrary(@right.coarbitrary(g)))
+  end
+end
+
+def prop_leaf_add
+  Assertion.new(Leaf) {|x| x.add == x.value }.check
+end
+
+def prop_leaf_multiply
+  Assertion.new(Leaf) {|x| x.multiply == x.value }.check
+end
+
+def prop_branch_add
+  Assertion.new(Branch) do |t|
+    t.add == t.value + t.left.add + t.right.add
+  end.check
+end
+
+# a bad example
+def prop_branch_multiply
+  # If the tester write a wrong test case by copying the code snippet?
+  # Then we will meet the same problem! Even this test is passed, but
+  # it is wrong.
+  Assertion.new(Branch) do |t|
+    t.add == t.value * t.left.add + t.right.add # Oops, a bug in testcase.
+  end.check
+end
+
+# But, we can test another /primitive/ properties about
+# branch_multiply.
+def prop_branch_multiply_zero
+  Assertion.new(Leaf) do |x|
+    Branch.new(0, x, x).multiply == 0
+  end.check
+end
+
+def prop_branch_multiply_power
+  Assertion.new(Leaf) do |x|
+    Branch.new(1, x, x).multiply == x.value * x.value
+  end.check
+end
+# Yay, then we can find a bug in Branch#multiply.
+# In this example, we gain a practical experience that
+# don't test by copying the definition, but consider /primitive/
+# properties!

data/data/rushcheck/examples/sample.rb

@@ -0,0 +1,52 @@
+# a simple example
+
+require 'rushcheck/rushcheck'
+
+# first boring example
+def assert_sort
+  Assertion.new { [].sort == [] }.check
+end
+
+# assert_sort_one should be true
+def assert_sort_one
+  Assertion.new(Integer) { |x|
+    [x].sort == [x]
+  }.check
+end
+
+# however, assert_sort_two is not true generally,
+# and RushCheck finds a counter example.
+def assert_sort_two
+  Assertion.new(Integer, Integer) { |x, y|
+    ary = [x, y]
+    ary.sort == ary
+  }.check
+end
+
+# if given array is already sorted, then the
+# assertion turns true.
+def assert_sort_two_sorted
+  Assertion.new(Integer, Integer) { |x, y, g|
+    g.guard {x <= y}
+    ary = [x, y]
+    ary.sort == ary
+  }.check
+end
+
+# watch statistics 
+def assert_sort_two_sorted_trivial
+  Assertion.new(Integer, Integer) { |x, y, g|
+    g.guard {x <= y}
+    ary = [x, y]
+    (ary.sort == ary).trivial{x == y}
+  }.check
+end
+
+def assert_sort_two_sorted_classify
+  Assertion.new(Integer, Integer) { |x, y, g|
+    g.guard {x <= y}
+    ary = [x, y]
+    (ary.sort == ary).classify('same'){x == y}.
+      classify('bit diff') { (x - y).abs == 1 }
+  }.check
+end

data/data/rushcheck/rdoc/classes/Arbitrary.html

@@ -0,0 +1,148 @@
+<?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: Arbitrary</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">Arbitrary</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../files/rushcheck/arbitrary_rb.html">
+                rushcheck/arbitrary.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <h1>arbitrary.rb</h1>
+<p>
+This file includes two modules <a href="Arbitrary.html">Arbitrary</a> and
+<a href="Coarbitrary.html">Coarbitrary</a>. <a
+href="Arbitrary.html">Arbitrary</a> provides an instance method arbitrary.
+<a href="Coarbitrary.html">Coarbitrary</a> provides a class method
+coarbitrary. However they are abstract methods and should be overrided in
+each class after include/extend them.
+</p>
+
+    </div>
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000075">arbitrary</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-M000075" class="method-detail">
+        <a name="M000075"></a>
+
+        <div class="method-heading">
+          <a href="Arbitrary.src/M000075.html" target="Code" class="method-signature"
+            onclick="popupCode('Arbitrary.src/M000075.html');return false;">
+          <span class="method-name">arbitrary</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+It is assumed that the arbitrary method must be overrided and return a <a
+href="Gen.html">Gen</a> object with the same class of self. See also
+rushcheck/gen.rb.
+</p>
+        </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/data/rushcheck/rdoc/classes/Arbitrary.src/M000075.html

@@ -0,0 +1,18 @@
+<?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>
+<head>
+  <title>arbitrary (Arbitrary)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File rushcheck/arbitrary.rb, line 14</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">arbitrary</span>
+    <span class="ruby-identifier">raise</span>(<span class="ruby-constant">NotImplementedError</span>, <span class="ruby-value str">&quot;This method should be overrided.&quot;</span>)
+  <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/data/rushcheck/rdoc/classes/Assertion.html

@@ -0,0 +1,183 @@
+<?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: Assertion</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">Assertion</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../files/rushcheck/assertion_rb.html">
+                rushcheck/assertion.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                Object
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <p>
+<a href="Assertion.html">Assertion</a> class is one of main features of
+RushCheck. You can write a testcase for random testing as follows:
+</p>
+<p>
+<a href="Assertion.html#M000015">Assertion.new</a>(<a
+href="Integer.html">Integer</a>, <a href="String.html">String</a>) do |x,
+y, g|
+</p>
+<pre>
+  g.guard { precondition }
+  body
+</pre>
+<p>
+end
+</p>
+<p>
+See also documents and several examples.
+</p>
+
+    </div>
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000015">new</a>&nbsp;&nbsp;
+      <a href="#M000016">property</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+    <div id="includes">
+      <h3 class="section-bar">Included Modules</h3>
+
+      <div id="includes-list">
+        <span class="include-name"><a href="Testable.html">Testable</a></span>
+      </div>
+    </div>
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+
+      <div id="method-M000015" class="method-detail">
+        <a name="M000015"></a>
+
+        <div class="method-heading">
+          <a href="Assertion.src/M000015.html" target="Code" class="method-signature"
+            onclick="popupCode('Assertion.src/M000015.html');return false;">
+          <span class="method-name">new</span><span class="method-args">(*xs, &amp;f)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+        </div>
+      </div>
+
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000016" class="method-detail">
+        <a name="M000016"></a>
+
+        <div class="method-heading">
+          <a href="Assertion.src/M000016.html" target="Code" class="method-signature"
+            onclick="popupCode('Assertion.src/M000016.html');return false;">
+          <span class="method-name">property</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+        </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/data/rushcheck/rdoc/classes/Assertion.src/M000015.html

@@ -0,0 +1,20 @@
+<?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>
+<head>
+  <title>new (Assertion)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File rushcheck/assertion.rb, line 24</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">xs</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">f</span>)
+    <span class="ruby-ivar">@inputs</span> = <span class="ruby-identifier">xs</span>[<span class="ruby-value">0</span><span class="ruby-operator">..</span>(<span class="ruby-identifier">f</span>.<span class="ruby-identifier">arity</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>)]
+    <span class="ruby-ivar">@nguard</span> = <span class="ruby-identifier">f</span>.<span class="ruby-identifier">arity</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">xs</span>.<span class="ruby-identifier">length</span> 
+    <span class="ruby-ivar">@proc</span> = <span class="ruby-identifier">f</span>
+  <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/data/rushcheck/rdoc/classes/Assertion.src/M000016.html

@@ -0,0 +1,45 @@
+<?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>
+<head>
+  <title>property (Assertion)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File rushcheck/assertion.rb, line 30</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">property</span>
+    <span class="ruby-constant">Property</span>.<span class="ruby-identifier">new</span>(<span class="ruby-constant">Gen</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">n</span>, <span class="ruby-identifier">r</span><span class="ruby-operator">|</span>
+      <span class="ruby-identifier">r2</span> = <span class="ruby-identifier">r</span>
+      <span class="ruby-ivar">@inputs</span>.<span class="ruby-identifier">map</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span>
+        <span class="ruby-identifier">r1</span>, <span class="ruby-identifier">r2</span> = <span class="ruby-identifier">r2</span>.<span class="ruby-identifier">split</span>
+        <span class="ruby-identifier">c</span>.<span class="ruby-identifier">arbitrary</span>.<span class="ruby-identifier">value</span>(<span class="ruby-identifier">n</span>, <span class="ruby-identifier">r1</span>)
+      <span class="ruby-keyword kw">end</span>
+    <span class="ruby-keyword kw">end</span>.<span class="ruby-identifier">bind</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">args</span><span class="ruby-operator">|</span>
+      <span class="ruby-identifier">guards</span> = <span class="ruby-constant">Array</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@nguard</span>, <span class="ruby-constant">Guard</span>.<span class="ruby-identifier">new</span>)
+      <span class="ruby-identifier">test</span> = <span class="ruby-keyword kw">begin</span>
+               <span class="ruby-identifier">xs</span> = <span class="ruby-identifier">args</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">guards</span>
+               <span class="ruby-ivar">@proc</span>.<span class="ruby-identifier">call</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">xs</span>)
+             <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">ex</span>
+               <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">ex</span>
+               <span class="ruby-keyword kw">when</span> <span class="ruby-constant">RushCheckGuard</span>
+                 <span class="ruby-constant">Result</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">nil</span>)
+               <span class="ruby-keyword kw">else</span>
+                 <span class="ruby-identifier">err</span> = <span class="ruby-node">&quot;Unexpected exception: #{ex.inspect}\n&quot;</span> <span class="ruby-operator">+</span> 
+                       <span class="ruby-identifier">ex</span>.<span class="ruby-identifier">backtrace</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">&quot;\n&quot;</span>)
+                 <span class="ruby-constant">Result</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">false</span>, [], [<span class="ruby-identifier">err</span>])
+               <span class="ruby-keyword kw">end</span>
+             <span class="ruby-keyword kw">end</span>
+      <span class="ruby-comment cmt"># not use ensure here because ensure clause</span>
+      <span class="ruby-comment cmt"># does not return values</span>
+      <span class="ruby-identifier">test</span>.<span class="ruby-identifier">property</span>.<span class="ruby-identifier">gen</span>.<span class="ruby-identifier">bind</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">res</span><span class="ruby-operator">|</span>
+        <span class="ruby-identifier">res</span>.<span class="ruby-identifier">arguments</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">inspect</span>
+        <span class="ruby-constant">Gen</span>.<span class="ruby-identifier">unit</span>(<span class="ruby-identifier">res</span>)
+      <span class="ruby-keyword kw">end</span>
+    <span class="ruby-keyword kw">end</span>)
+  <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>