Update generated documentation for version 3.1.0

Author: kurtschelfthout

Properties.html

@@ -100,10 +100,43 @@ <h1><a name="Model-based-Testing-Experimental" class="anchor" href="#Model-based
     <span class="k">member</span> <span onmouseout="hideTip(event, 'fs10', 25)" onmouseover="showTip(event, 'fs10', 25)" class="id">__</span><span class="pn">.</span><span class="fn">Reset</span><span class="pn">(</span><span class="pn">)</span> <span class="o">=</span> <span onmouseout="hideTip(event, 'fs8', 26)" onmouseover="showTip(event, 'fs8', 26)" class="mv">n</span> <span class="k">&lt;-</span> <span class="n">0</span>
     <span class="k">override</span> <span onmouseout="hideTip(event, 'fs10', 27)" onmouseover="showTip(event, 'fs10', 27)" class="id">__</span><span class="pn">.</span><span class="fn">ToString</span><span class="pn">(</span><span class="pn">)</span> <span class="o">=</span> <span onmouseout="hideTip(event, 'fs12', 28)" onmouseover="showTip(event, 'fs12', 28)" class="fn">sprintf</span> <span class="s">&quot;Counter = </span><span class="pf">%i</span><span class="s">&quot;</span> <span onmouseout="hideTip(event, 'fs8', 29)" onmouseover="showTip(event, 'fs8', 29)" class="mv">n</span>
 </code></pre>
-<p>As a model to test this class we can use an int value which is an abstraction of the object's internal state. The
-idea is that each operation on the class (in this case, Inc, Dec and Reset) affects both the model object and the actual object, and
+<p>In C#:</p>
+<table class="pre"><tr><td class="snippet"><pre class="fssnip highlighted"><code lang="csharp"><span class="k">public</span> <span class="k">class</span> Counter
+{
+    <span class="k">internal</span> <span class="k">int</span> N { get; <span class="k">private</span> set; }
+
+    <span class="k">internal</span> Counter(<span class="k">int</span> n)
+    {
+        N <span class="o">=</span> n;
+    }
+
+    <span class="k">internal</span> <span class="k">void</span> Inc()
+    {
+        <span class="k">if</span> (N <span class="o">&lt;</span><span class="o">=</span> <span class="n">3</span>)
+            N <span class="o">+</span><span class="o">=</span> <span class="n">1</span>;
+        <span class="k">else</span>
+            N <span class="o">=</span> -N <span class="o">+</span> <span class="n">2</span>;
+    }
+
+    <span class="k">internal</span> <span class="k">void</span> Dec()
+    {
+        <span class="k">if</span> (N <span class="o">&lt;</span><span class="o">=</span> <span class="n">0</span>)
+            <span class="k">throw</span> <span class="k">new</span> InvalidOperationException(<span class="s">"Precondition fail"</span>);
+
+        N <span class="o">-</span><span class="o">=</span> <span class="n">1</span>;
+    }
+
+    <span class="k">internal</span> <span class="k">void</span> Reset()
+    {
+        N <span class="o">=</span> <span class="n">0</span>;
+    }
+
+    <span class="k">public</span> <span class="k">override</span> <span class="k">string</span> ToString() <span class="o">=</span><span class="o">&gt;</span> $<span class="s">"Counter = {N}"</span>;
+}</code></pre></td></tr></table>
+<p>As a model to test this class we can use an <code>int</code> value which is an abstraction of the object's internal state. The
+idea is that each operation on the class (in this case, <code>Inc</code>, <code>Dec</code> and <code>Reset</code>) affects both the model object and the actual object, and
 after each such operation, the model and the actual instance should still be equivalent.</p>
-<p>With this idea in mind, you can write a specification of the Counter class using an int model as follows:</p>
+<p>With this idea in mind, you can write a specification of the <code>Counter</code> class using an int model as follows:</p>
 <pre class="fssnip highlighted"><code lang="fsharp"><span class="k">let</span> <span onmouseout="hideTip(event, 'fs13', 30)" onmouseover="showTip(event, 'fs13', 30)" class="id">spec</span> <span class="o">=</span>
     <span class="k">let</span> <span onmouseout="hideTip(event, 'fs14', 31)" onmouseover="showTip(event, 'fs14', 31)" class="fn">inc</span> <span class="o">=</span> 
         <span class="pn">{</span> <span class="k">new</span> <span onmouseout="hideTip(event, 'fs15', 32)" onmouseover="showTip(event, 'fs15', 32)" class="rt">Operation</span><span class="pn">&lt;</span><span onmouseout="hideTip(event, 'fs5', 33)" onmouseover="showTip(event, 'fs5', 33)" class="rt">Counter</span><span class="pn">,</span><span onmouseout="hideTip(event, 'fs7', 34)" onmouseover="showTip(event, 'fs7', 34)" class="vt">int</span><span class="pn">&gt;</span><span class="pn">(</span><span class="pn">)</span> <span class="k">with</span>
@@ -131,6 +164,86 @@ <h1><a name="Model-based-Testing-Experimental" class="anchor" href="#Model-based
         <span class="k">member</span> <span class="id">__</span><span class="pn">.</span><span class="fn">Setup</span> <span class="o">=</span> <span onmouseout="hideTip(event, 'fs34', 92)" onmouseover="showTip(event, 'fs34', 92)" class="m">Gen</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs35', 93)" onmouseover="showTip(event, 'fs35', 93)" class="id">choose</span> <span class="pn">(</span><span class="n">0</span><span class="pn">,</span><span class="n">3</span><span class="pn">)</span> <span class="o">|&gt;</span> <span onmouseout="hideTip(event, 'fs34', 94)" onmouseover="showTip(event, 'fs34', 94)" class="m">Gen</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs36', 95)" onmouseover="showTip(event, 'fs36', 95)" class="id">map</span> <span onmouseout="hideTip(event, 'fs28', 96)" onmouseover="showTip(event, 'fs28', 96)" class="fn">create</span> <span class="o">|&gt;</span> <span onmouseout="hideTip(event, 'fs37', 97)" onmouseover="showTip(event, 'fs37', 97)" class="m">Arb</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs38', 98)" onmouseover="showTip(event, 'fs38', 98)" class="id">fromGen</span>
         <span class="k">member</span> <span onmouseout="hideTip(event, 'fs39', 99)" onmouseover="showTip(event, 'fs39', 99)" class="id">__</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs40', 100)" onmouseover="showTip(event, 'fs40', 100)" class="fn">Next</span> <span class="id">_</span> <span class="o">=</span> <span onmouseout="hideTip(event, 'fs34', 101)" onmouseover="showTip(event, 'fs34', 101)" class="m">Gen</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs41', 102)" onmouseover="showTip(event, 'fs41', 102)" class="id">elements</span> <span class="pn">[</span> <span onmouseout="hideTip(event, 'fs14', 103)" onmouseover="showTip(event, 'fs14', 103)" class="fn">inc</span><span class="pn">;</span> <span onmouseout="hideTip(event, 'fs25', 104)" onmouseover="showTip(event, 'fs25', 104)" class="fn">dec</span> <span class="pn">]</span> <span class="pn">}</span>
 </code></pre>
+<p>In C#:</p>
+<table class="pre"><tr><td class="snippet"><pre class="fssnip highlighted"><code lang="csharp"><span class="k">private</span> <span class="k">class</span> CounterSpec
+{
+    <span class="k">internal</span> <span class="k">class</span> Inc <span class="o">:</span> Operation&lt;Counter, <span class="k">int</span>&gt;
+    {
+        <span class="k">public</span> <span class="k">override</span> <span class="k">bool</span> Pre(<span class="k">int</span> m)
+        {
+            <span class="k">return</span> m <span class="o">&gt;</span> <span class="n">0</span>;
+        }
+
+        <span class="k">public</span> <span class="k">override</span> <span class="k">int</span> Run(<span class="k">int</span> m)
+        {
+            <span class="k">return</span> m <span class="o">+</span> <span class="n">1</span>;
+        }
+
+        <span class="k">public</span> <span class="k">override</span> Property Check(Counter c, <span class="k">int</span> m)
+        {
+            <span class="k">return</span> (m <span class="o">=</span><span class="o">=</span> c.N).Label($<span class="s">"Inc: model = {m}, actual = {c.N}"</span>);
+        }
+
+        <span class="k">public</span> <span class="k">override</span> <span class="k">string</span> ToString() <span class="o">=</span><span class="o">&gt;</span> <span class="s">"inc"</span>;
+    }
+
+    <span class="k">internal</span> <span class="k">class</span> Dec <span class="o">:</span> Operation&lt;Counter, <span class="k">int</span>&gt;
+    {
+        <span class="k">public</span> <span class="k">override</span> <span class="k">bool</span> Pre(<span class="k">int</span> m)
+        {
+            <span class="k">return</span> m <span class="o">&gt;</span> <span class="n">0</span>;
+        }
+
+        <span class="k">public</span> <span class="k">override</span> <span class="k">int</span> Run(<span class="k">int</span> m)
+        {
+            <span class="k">return</span> m <span class="o">-</span> <span class="n">1</span>;
+        }
+
+
+        <span class="k">public</span> <span class="k">override</span> Property Check(Counter c, <span class="k">int</span> m)
+        {
+            c.Dec();
+            <span class="k">return</span> (m <span class="o">=</span><span class="o">=</span> c.N).Label($<span class="s">"Dec: model = {m}, actual = {c.N}"</span>);
+        }
+
+        <span class="k">public</span> <span class="k">override</span> <span class="k">string</span> ToString() <span class="o">=</span><span class="o">&gt;</span> <span class="s">"dec"</span>;
+    }
+
+    <span class="k">internal</span> <span class="k">class</span> CounterSetup <span class="o">:</span> Setup&lt;Counter, <span class="k">int</span>&gt;
+    {
+        <span class="k">private</span> <span class="k">readonly</span> <span class="k">int</span> _initialValue;
+
+        <span class="k">internal</span> CounterSetup(<span class="k">int</span> initialValue)
+        {
+            _initialValue <span class="o">=</span> initialValue;
+        }
+
+        <span class="k">public</span> <span class="k">override</span> Counter Actual() <span class="o">=</span><span class="o">&gt;</span> <span class="k">new</span>(_initialValue);
+
+        <span class="k">public</span> <span class="k">override</span> <span class="k">int</span> Model() <span class="o">=</span><span class="o">&gt;</span> _initialValue;
+    }
+}
+
+<span class="k">public</span> <span class="k">class</span> Specification <span class="o">:</span> Machine&lt;Counter, <span class="k">int</span>&gt;
+{
+    <span class="k">public</span> Specification(<span class="k">int</span> maxNumberOfCommands) <span class="o">:</span> <span class="k">base</span>(maxNumberOfCommands) { }
+
+    <span class="k">public</span> <span class="k">override</span> Arbitrary&lt;Setup&lt;Counter, <span class="k">int</span>&gt;<span class="o">&gt;</span> Setup <span class="o">=</span><span class="o">&gt;</span>
+        Arb.From(Gen.Choose(<span class="n">0</span>, <span class="n">3</span>)
+            .Select&lt;<span class="k">int</span>, Setup&lt;Counter, <span class="k">int</span>&gt;<span class="o">&gt;</span>(i <span class="o">=</span><span class="o">&gt;</span> <span class="k">new</span> CounterSpec.CounterSetup(i)));
+
+    <span class="k">public</span> <span class="k">override</span> TearDown&lt;Counter&gt; TearDown <span class="o">=</span><span class="o">&gt;</span> <span class="k">new</span> DisposeCall&lt;Counter&gt;();
+
+    <span class="k">public</span> <span class="k">override</span> Gen&lt;Operation&lt;Counter, <span class="k">int</span>&gt;<span class="o">&gt;</span> Next(<span class="k">int</span> _) <span class="o">=</span><span class="o">&gt;</span>
+        Gen.Elements(<span class="k">new</span> Operation&lt;Counter, <span class="k">int</span>&gt;[]
+        {
+            <span class="k">new</span> CounterSpec.Inc(), 
+            <span class="k">new</span> CounterSpec.Dec()
+        });
+
+    <span class="k">public</span> <span class="k">override</span> IEnumerable&lt;FSharpList&lt;Operation&lt;Counter, <span class="k">int</span>&gt;<span class="o">&gt;</span><span class="o">&gt;</span> ShrinkOperations(FSharpList&lt;Operation&lt;Counter, <span class="k">int</span>&gt;<span class="o">&gt;</span> operation) <span class="o">=</span><span class="o">&gt;</span> 
+        <span class="k">base</span>.ShrinkOperations(operation);
+}</code></pre></td></tr></table>
 <p>Let's break this down a bit. A specification is put together as an object that is a subtype of the abstract class <code>Machine&lt;'TypeUnderTest,'ModelType&gt;</code>.
 What you're actually defining is a state machine which can simultaneously apply operations, or state transitions, to the actual system
 under test (in this case, a simple object) and a model of the system under test.</p>
@@ -152,22 +265,20 @@ <h1><a name="Model-based-Testing-Experimental" class="anchor" href="#Model-based
 calls <code>Inc()</code> or <code>Dec()</code> on the <code>Counter</code> instance, and checks that after that the model counter is equal to the real <code>Counter</code>. <code>Dec</code> in addition has a (quite
 silly, for demonstration purposes) precondition that the value should be strictly greater than 0 - if we run this machine our <code>Counter</code> throws if we call <code>Dec</code>
 so when we run this specification we can check that FsCheck does the right thing here (testing the test library, very meta...)</p>
-<p>We also override ToString in each <code>Operation</code> so that counter-examples can be printed.</p>
+<p>We also override <code>ToString</code> in each <code>Operation</code> so that counter-examples can be printed.</p>
 <p>A specification can be checked as follows:</p>
 <pre class="fssnip highlighted"><code lang="fsharp"><span onmouseout="hideTip(event, 'fs42', 105)" onmouseover="showTip(event, 'fs42', 105)" class="rt">Check</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs43', 106)" onmouseover="showTip(event, 'fs43', 106)" class="id">Quick</span> <span class="pn">(</span><span onmouseout="hideTip(event, 'fs44', 107)" onmouseover="showTip(event, 'fs44', 107)" class="m">StateMachine</span><span class="pn">.</span><span onmouseout="hideTip(event, 'fs45', 108)" onmouseover="showTip(event, 'fs45', 108)" class="id">toProperty</span> <span onmouseout="hideTip(event, 'fs13', 109)" onmouseover="showTip(event, 'fs13', 109)" class="id">spec</span><span class="pn">)</span>
 </code></pre>
-<table class="pre"><tr><td><pre><code>Falsifiable, after 6 tests (4 shrinks) (12770152580777276754,10005441753482479477)
-Last step was invoked with size of 7 and seed of (17861426896115535097,11667813865249411481):
+<table class="pre"><tr><td><pre><code>Falsifiable, after 4 tests (2 shrinks) (14366654795077628011,16084604498746219839)
+Last step was invoked with size of 5 and seed of (16085007916889491838,9608441260416857165):
 Label of failing property: Inc: model = 5, actual = 6
 Original:
 (2, Setup Counter)
-dec -&gt; 1
-inc -&gt; 2
 inc -&gt; 3
 inc -&gt; 4
 inc -&gt; 5
 dec -&gt; 4
-dec -&gt; 3
+inc -&gt; 5
 
 Shrunk:
 (2, Setup Counter)