ruff 1.0.1 → 1.1.0

data/docs/Ruff/Standard/Defer/Instance.html

@@ -6,7 +6,7 @@
 <title>
   Class: Ruff::Standard::Defer::Instance
   
-    &mdash; Ruff 1.0.0 Documentation
+    &mdash; Ruff 1.0.1 Documentation
   
 </title>
 
@@ -103,6 +103,39 @@
 
 
 
+  <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
+  <ul class="summary">
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#eff-instance_method" title="#eff (instance method)">#<strong>eff</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+    
+      <span class="note title readonly">readonly</span>
+    
+    
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'><p>You can reimplement the handler using this effect instance.</p>
+</div></span>
+  
+</li>
+
+    
+  </ul>
+
 
 
 
@@ -133,7 +166,7 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>A new instance of Instance.</p>
+    <span class="summary_desc"><div class='inline'><p>makes a new instance.</p>
 </div></span>
   
 </li>
@@ -142,7 +175,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#register-instance_method" title="#register (instance method)">#<strong>register</strong>(&amp;prc)  &#x21d2; Object </a>
+      <a href="#register-instance_method" title="#register (instance method)">#<strong>register</strong>(&amp;prc)  &#x21d2; () </a>
     
 
     
@@ -156,7 +189,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'><p>is a smart method to invoke the effect operation.</p>
+</div></span>
   
 </li>
 
@@ -164,7 +198,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#with-instance_method" title="#with (instance method)">#<strong>with</strong>(&amp;th)  &#x21d2; Object </a>
+      <a href="#with-instance_method" title="#with (instance method)">#<strong>with</strong>(&amp;th)  &#x21d2; A!{e} </a>
     
 
     
@@ -178,7 +212,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'><p>is a handler to interpret the effect invocation as registering a procedure.</p>
+</div></span>
   
 </li>
 
@@ -200,7 +235,7 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Returns a new instance of Instance</p>
+    <p>makes a new instance.</p>
 
 
   </div>
@@ -214,12 +249,12 @@
       <pre class="lines">
 
 
-5
-6
-7</pre>
+11
+12
+13</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ruff/standard/defer.rb', line 5</span>
+      <pre class="code"><span class="info file"># File 'lib/ruff/standard/defer.rb', line 11</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
   <span class='ivar'>@eff</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../../Ruff.html" title="Ruff (module)">Ruff</a></span></span><span class='period'>.</span><span class='id identifier rubyid_instance'><span class='object_link'><a href="../../../Ruff.html#instance-class_method" title="Ruff.instance (method)">instance</a></span></span>
@@ -231,6 +266,53 @@
   
 </div>
 
+  <div id="instance_attr_details" class="attr_details">
+    <h2>Instance Attribute Details</h2>
+    
+      
+      <span id=""></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="eff-instance_method">
+  
+    #<strong>eff</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>You can reimplement the handler using this effect instance.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+49
+50
+51</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ruff/standard/defer.rb', line 49</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_eff'>eff</span>
+  <span class='ivar'>@eff</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
 
   <div id="instance_method_details" class="method_details_list">
     <h2>Instance Method Details</h2>
@@ -239,24 +321,66 @@
       <div class="method_details first">
   <h3 class="signature first" id="register-instance_method">
   
-    #<strong>register</strong>(&amp;prc)  &#x21d2; <tt>Object</tt> 
+    #<strong>register</strong>(&amp;prc)  &#x21d2; <tt>()</tt> 
+  
+
   
 
   
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>is a smart method to invoke the effect operation.</p>
+
 
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
   
-</h3><table class="source_code">
+    <li>
+      
+        <span class='name'>prc</span>
+      
+      
+        <span class='type'>(<tt>Proc&lt;(), ()&gt;</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>is deferred, or &quot;registerred&quot;, and called on the end of computation.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>()</tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-9
-10
-11</pre>
+19
+20
+21</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ruff/standard/defer.rb', line 9</span>
+      <pre class="code"><span class="info file"># File 'lib/ruff/standard/defer.rb', line 19</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_register'>register</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_prc'>prc</span><span class='rparen'>)</span>
   <span class='ivar'>@eff</span><span class='period'>.</span><span class='id identifier rubyid_perform'>perform</span> <span class='id identifier rubyid_prc'>prc</span>
@@ -269,37 +393,88 @@
       <div class="method_details ">
   <h3 class="signature " id="with-instance_method">
   
-    #<strong>with</strong>(&amp;th)  &#x21d2; <tt>Object</tt> 
+    #<strong>with</strong>(&amp;th)  &#x21d2; <tt>A!{e}</tt> 
   
 
   
 
   
-</h3><table class="source_code">
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>is a handler to interpret the effect invocation as registering a procedure.
+Registerred procedures are run on the end of computation, by value handler.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>th</span>
+      
+      
+        <span class='type'>(<tt>Proc&lt;(), A&gt;!{<span class='object_link'><a href="../Defer.html" title="Ruff::Standard::Defer (module)">Defer</a></span>.<span class='object_link'><a href="#eff-instance_method" title="Ruff::Standard::Defer::Instance#eff (method)">eff</a></span>, e}</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>is a thunk returning <code>A</code> with the possibility to invoke effects, including <code>Defer.eff</code> .</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>A!{e}</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>returns <code>A</code> , without modification by value handler.
+But it still has the possibility to invoke effects(<code>e</code>).</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-13
-14
-15
-16
-17
-18
-19
-20
-21
-22
-23
-24
-25</pre>
+32
+33
+34
+35
+36
+37
+38
+39
+40
+41
+42
+43
+44
+45
+46</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ruff/standard/defer.rb', line 13</span>
+      <pre class="code"><span class="info file"># File 'lib/ruff/standard/defer.rb', line 32</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_with'>with</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_th'>th</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_procs'>procs</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
+  <span class='comment'># This is a stack to store deferred procedures.
+</span>  <span class='id identifier rubyid_procs'>procs</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
 
   <span class='const'><span class='object_link'><a href="../../../Ruff.html" title="Ruff (module)">Ruff</a></span></span><span class='period'>.</span><span class='id identifier rubyid_handler'><span class='object_link'><a href="../../../Ruff.html#handler-class_method" title="Ruff.handler (method)">handler</a></span></span>
       <span class='period'>.</span><span class='id identifier rubyid_on'>on</span><span class='lparen'>(</span><span class='ivar'>@eff</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_k'>k</span><span class='comma'>,</span> <span class='id identifier rubyid_prc'>prc</span><span class='op'>|</span>
@@ -307,9 +482,10 @@
     <span class='id identifier rubyid_k'>k</span><span class='lbracket'>[</span><span class='rbracket'>]</span>
   <span class='kw'>end</span>
       <span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid__'>_</span><span class='op'>|</span>
-    <span class='id identifier rubyid_procs'>procs</span><span class='period'>.</span><span class='id identifier rubyid_reverse_each'>reverse_each</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:[]</span><span class='rparen'>)</span>
+    <span class='comment'># Like Go&#39;s defer functions, it crashes the thunk by reversed order.
+</span>    <span class='id identifier rubyid_procs'>procs</span><span class='period'>.</span><span class='id identifier rubyid_reverse_each'>reverse_each</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:[]</span><span class='rparen'>)</span>
   <span class='kw'>end</span>
-      <span class='period'>.</span><span class='id identifier rubyid_run'>run</span> <span class='op'>&amp;</span><span class='id identifier rubyid_th'>th</span>
+      <span class='period'>.</span><span class='id identifier rubyid_run'>run</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_th'>th</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -321,7 +497,7 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Oct  3 05:05:04 2019 by
+  Generated on Fri Oct  4 13:57:07 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.20 (ruby-2.6.4).
 </div>

data/docs/Ruff/Standard/State.html

@@ -6,7 +6,7 @@
 <title>
   Module: Ruff::Standard::State
   
-    &mdash; Ruff 1.0.0 Documentation
+    &mdash; Ruff 1.0.1 Documentation
   
 </title>
 
@@ -83,7 +83,27 @@
   
 </div>
 
-<h2>Defined Under Namespace</h2>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p><code>State</code> provides effects <code>State.get</code> and <code>State.modify</code> ,
+and the implementation of the mutable cell or so-called <em>state</em> .</p>
+
+<p>The module has an instance of <code>Instance</code> and provides its methods as module method.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+    
+      <li><span class='object_link'><a href="State/Instance.html" title="Ruff::Standard::State::Instance (class)">Instance</a></span></li>
+    
+  </ul>
+
+</div><h2>Defined Under Namespace</h2>
 <p class="children">
   
     
@@ -97,6 +117,38 @@
 
 
 
+  <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
+  <ul class="summary">
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#eff-instance_method" title="#eff (instance method)">#<strong>eff</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+    
+      <span class="note title readonly">readonly</span>
+    
+    
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+    
+  </ul>
+
 
 
 
@@ -222,6 +274,59 @@
   
 
 
+  <div id="instance_attr_details" class="attr_details">
+    <h2>Instance Attribute Details</h2>
+    
+      
+      <span id=""></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="eff-instance_method">
+  
+    #<strong>eff</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+
+  </div>
+</div>
+<div class="tags">
+  
+
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+    
+      <li>Instance#eff</li>
+    
+  </ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+119
+120
+121</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ruff/standard/state.rb', line 119</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_eff'>eff</span>
+  <span class='ivar'>@eff</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
 
   <div id="class_method_details" class="method_details_list">
     <h2>Class Method Details</h2>
@@ -236,18 +341,34 @@
   
 
   
-</h3><table class="source_code">
+</h3><div class="docstring">
+  <div class="discussion">
+    
+
+  </div>
+</div>
+<div class="tags">
+  
+
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+    
+      <li><span class='object_link'><a href="State/Instance.html#get-instance_method" title="Ruff::Standard::State::Instance#get (method)">Ruff::Standard::State::Instance#get</a></span></li>
+    
+  </ul>
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-44
-45
-46</pre>
+92
+93
+94</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ruff/standard/state.rb', line 44</span>
+      <pre class="code"><span class="info file"># File 'lib/ruff/standard/state.rb', line 92</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span>
   <span class='ivar'>@inst</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span>
@@ -266,21 +387,37 @@
   
 
   
-</h3><table class="source_code">
+</h3><div class="docstring">
+  <div class="discussion">
+    
+
+  </div>
+</div>
+<div class="tags">
+  
+
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+    
+      <li><span class='object_link'><a href="State/Instance.html#modify-instance_method" title="Ruff::Standard::State::Instance#modify (method)">Ruff::Standard::State::Instance#modify</a></span></li>
+    
+  </ul>
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-48
-49
-50</pre>
+97
+98
+99</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ruff/standard/state.rb', line 48</span>
+      <pre class="code"><span class="info file"># File 'lib/ruff/standard/state.rb', line 97</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_modify'>modify</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_fn'>fn</span><span class='rparen'>)</span>
-  <span class='ivar'>@inst</span><span class='period'>.</span><span class='id identifier rubyid_modify'>modify</span> <span class='op'>&amp;</span><span class='id identifier rubyid_fn'>fn</span>
+  <span class='ivar'>@inst</span><span class='period'>.</span><span class='id identifier rubyid_modify'>modify</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_fn'>fn</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -296,18 +433,34 @@
   
 
   
-</h3><table class="source_code">
+</h3><div class="docstring">
+  <div class="discussion">
+    
+
+  </div>
+</div>
+<div class="tags">
+  
+
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+    
+      <li><span class='object_link'><a href="State/Instance.html#put-instance_method" title="Ruff::Standard::State::Instance#put (method)">Ruff::Standard::State::Instance#put</a></span></li>
+    
+  </ul>
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-52
-53
-54</pre>
+102
+103
+104</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ruff/standard/state.rb', line 52</span>
+      <pre class="code"><span class="info file"># File 'lib/ruff/standard/state.rb', line 102</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_put'>put</span><span class='lparen'>(</span><span class='id identifier rubyid_s'>s</span><span class='rparen'>)</span>
   <span class='ivar'>@inst</span><span class='period'>.</span><span class='id identifier rubyid_put'>put</span> <span class='id identifier rubyid_s'>s</span>
@@ -326,21 +479,37 @@
   
 
   
-</h3><table class="source_code">
+</h3><div class="docstring">
+  <div class="discussion">
+    
+
+  </div>
+</div>
+<div class="tags">
+  
+
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+    
+      <li><span class='object_link'><a href="State/Instance.html#with-instance_method" title="Ruff::Standard::State::Instance#with (method)">Ruff::Standard::State::Instance#with</a></span></li>
+    
+  </ul>
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-60
-61
-62</pre>
+112
+113
+114</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ruff/standard/state.rb', line 60</span>
+      <pre class="code"><span class="info file"># File 'lib/ruff/standard/state.rb', line 112</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_with'>with</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_task'>task</span><span class='rparen'>)</span>
-  <span class='ivar'>@inst</span><span class='period'>.</span><span class='id identifier rubyid_with'>with</span> <span class='op'>&amp;</span><span class='id identifier rubyid_task'>task</span>
+  <span class='ivar'>@inst</span><span class='period'>.</span><span class='id identifier rubyid_with'>with</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_task'>task</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -356,18 +525,34 @@
   
 
   
-</h3><table class="source_code">
+</h3><div class="docstring">
+  <div class="discussion">
+    
+
+  </div>
+</div>
+<div class="tags">
+  
+
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+    
+      <li><span class='object_link'><a href="State/Instance.html#with_init-instance_method" title="Ruff::Standard::State::Instance#with_init (method)">Ruff::Standard::State::Instance#with_init</a></span></li>
+    
+  </ul>
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-56
-57
-58</pre>
+107
+108
+109</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ruff/standard/state.rb', line 56</span>
+      <pre class="code"><span class="info file"># File 'lib/ruff/standard/state.rb', line 107</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_with_init'>with_init</span><span class='lparen'>(</span><span class='id identifier rubyid_init'>init</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_task'>task</span><span class='rparen'>)</span>
   <span class='ivar'>@inst</span><span class='period'>.</span><span class='id identifier rubyid_with_init'>with_init</span> <span class='id identifier rubyid_init'>init</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_task'>task</span>
@@ -382,7 +567,7 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Oct  3 05:05:04 2019 by
+  Generated on Fri Oct  4 13:57:07 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.20 (ruby-2.6.4).
 </div>