ovto 0.6.0.rc1 → 0.6.0

data/docs/api/Ovto/Actions.html

@@ -6,15 +6,15 @@
 <title>
   Class: Ovto::Actions
   
-    &mdash; Documentation by YARD 0.9.20
+    &mdash; Documentation by YARD 0.9.24
   
 </title>
 
-  <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../css/style.css" type="text/css" />
 
-  <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../css/common.css" type="text/css" />
 
-<script type="text/javascript" charset="utf-8">
+<script type="text/javascript">
   pathId = "Ovto::Actions";
   relpath = '../';
 </script>
@@ -110,10 +110,14 @@
 <div class="tags">
   
 
+</div><div id="subclasses">
+  <h2>Direct Known Subclasses</h2>
+  <p class="children"><span class='object_link'><a href="Middleware/Actions.html" title="Ovto::Middleware::Actions (class)">Middleware::Actions</a></span></p>
 </div>
 
 
 
+
   <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
   <ul class="summary">
     
@@ -140,7 +144,9 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Sets the attribute wired_actions.</p>
+<p>WiredActions must be set after initialization (this cannot be an argument
+of #initialize because Actions and WiredActions have references to each
+other).</p>
 </div></span>
   
 </li>
@@ -176,6 +182,50 @@
   
 
   
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#middleware_name-instance_method" title="#middleware_name (instance method)">#<strong>middleware_name</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#middleware_path-instance_method" title="#middleware_path (instance method)">#<strong>middleware_path</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
     <span class="summary_desc"><div class='inline'></div></span>
   
 </li>
@@ -224,33 +274,15 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Sets the attribute wired_actions</p>
+<p>WiredActions must be set after initialization (this cannot be an argument
+of #initialize because Actions and WiredActions have references to each
+other)</p>
 
 
   </div>
 </div>
 <div class="tags">
-  <p class="tag_title">Parameters:</p>
-<ul class="param">
   
-    <li>
-      
-        <span class='name'>value</span>
-      
-      
-        <span class='type'></span>
-      
-      
-      
-        &mdash;
-        <div class='inline'>
-<p>the value to set the attribute wired_actions to.</p>
-</div>
-      
-    </li>
-  
-</ul>
-
 
 </div><table class="source_code">
   <tr>
@@ -258,12 +290,12 @@
       <pre class="lines">
 
 
-4
-5
-6</pre>
+7
+8
+9</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ovto/actions.rb', line 4</span>
+      <pre class="code"><span class="info file"># File 'lib/ovto/actions.rb', line 7</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_wired_actions='>wired_actions=</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
   <span class='ivar'>@wired_actions</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span>
@@ -295,12 +327,12 @@
       <pre class="lines">
 
 
-6
-7
-8</pre>
+9
+10
+11</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ovto/actions.rb', line 6</span>
+      <pre class="code"><span class="info file"># File 'lib/ovto/actions.rb', line 9</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_actions'>actions</span>
   <span class='ivar'>@wired_actions</span>
@@ -308,6 +340,66 @@
     </td>
   </tr>
 </table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="middleware_name-instance_method">
+  
+    #<strong>middleware_name</strong>  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+17
+18
+19</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ovto/actions.rb', line 17</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_middleware_name'>middleware_name</span>
+  <span class='const'><span class='object_link'><a href="WiredActionSet.html" title="Ovto::WiredActionSet (class)">WiredActionSet</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="WiredActionSet.html#I_AM_APP_NOT_A_MIDDLEWARE-constant" title="Ovto::WiredActionSet::I_AM_APP_NOT_A_MIDDLEWARE (constant)">I_AM_APP_NOT_A_MIDDLEWARE</a></span></span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="middleware_path-instance_method">
+  
+    #<strong>middleware_path</strong>  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+21
+22
+23</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ovto/actions.rb', line 21</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_middleware_path'>middleware_path</span>
+  <span class='lbracket'>[</span><span class='rbracket'>]</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
 </div>
     
       <div class="method_details ">
@@ -325,12 +417,12 @@
       <pre class="lines">
 
 
-10
-11
-12</pre>
+13
+14
+15</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ovto/actions.rb', line 10</span>
+      <pre class="code"><span class="info file"># File 'lib/ovto/actions.rb', line 13</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_state'>state</span>
   <span class='ivar'>@wired_actions</span><span class='period'>.</span><span class='id identifier rubyid__app'>_app</span><span class='period'>.</span><span class='id identifier rubyid_state'>state</span>
@@ -345,9 +437,9 @@
 </div>
 
       <div id="footer">
-  Generated on Sun Dec 22 22:06:04 2019 by
+  Generated on Fri Feb 28 23:42:46 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.20 (ruby-2.5.5).
+  0.9.24 (ruby-2.5.5).
 </div>
 
     </div>

data/docs/api/Ovto/App.html

@@ -6,15 +6,15 @@
 <title>
   Class: Ovto::App
   
-    &mdash; Documentation by YARD 0.9.20
+    &mdash; Documentation by YARD 0.9.24
   
 </title>
 
-  <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../css/style.css" type="text/css" />
 
-  <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../css/common.css" type="text/css" />
 
-<script type="text/javascript" charset="utf-8">
+<script type="text/javascript">
   pathId = "Ovto::App";
   relpath = '../';
 </script>
@@ -106,6 +106,35 @@
   <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="#main_component-instance_method" title="#main_component (instance method)">#<strong>main_component</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+    
+      <span class="note title readonly">readonly</span>
+    
+    
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>An instance of YourApp::MainComponent (mainly for testing).</p>
+</div></span>
+  
+</li>
+
+    
       <li class="public ">
   <span class="summary_signature">
     
@@ -151,6 +180,30 @@
         <li class="public ">
   <span class="summary_signature">
     
+      <a href="#middlewares-class_method" title="middlewares (class method)">.<strong>middlewares</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>List of installed middleware classes.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
       <a href="#run-class_method" title="run (class method)">.<strong>run</strong>(*args)  &#x21d2; Object </a>
     
 
@@ -169,6 +222,30 @@
 <p>Create an App and start it.</p>
 </div></span>
   
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#use-class_method" title="use (class method)">.<strong>use</strong>(middleware_class)  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Install a middleware.</p>
+</div></span>
+  
 </li>
 
       
@@ -319,7 +396,7 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Returns a new instance of App</p>
+<p>Returns a new instance of App.</p>
 
 
   </div>
@@ -333,17 +410,29 @@
       <pre class="lines">
 
 
-8
-9
-10
-11</pre>
+18
+19
+20
+21
+22
+23
+24
+25
+26
+27</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ovto/app.rb', line 8</span>
+      <pre class="code"><span class="info file"># File 'lib/ovto/app.rb', line 18</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
-  <span class='ivar'>@state</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_const_get'>const_get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>State</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
-  <span class='ivar'>@wired_actions</span> <span class='op'>=</span> <span class='kw'>nil</span>
+  <span class='id identifier rubyid_app_state_class'>app_state_class</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_const_get'>const_get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>State</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+  <span class='comment'># Inject middleware states
+</span>  <span class='id identifier rubyid_app_state_class'>app_state_class</span><span class='period'>.</span><span class='id identifier rubyid_item'>item</span> <span class='symbol'>:_middlewares</span><span class='comma'>,</span> <span class='label'>default_proc:</span> <span class='tlambda'>-&gt;</span><span class='tlambeg'>{</span>
+    <span class='const'><span class='object_link'><a href="../Ovto.html" title="Ovto (module)">Ovto</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Middleware.html" title="Ovto::Middleware (module)">Middleware</a></span></span><span class='period'>.</span><span class='id identifier rubyid_create_middleware_states_class'><span class='object_link'><a href="Middleware.html#create_middleware_states_class-class_method" title="Ovto::Middleware.create_middleware_states_class (method)">create_middleware_states_class</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_middlewares'>middlewares</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
+  <span class='rbrace'>}</span>
+  <span class='ivar'>@state</span> <span class='op'>=</span> <span class='id identifier rubyid_app_state_class'>app_state_class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
+  <span class='ivar'>@wired_action_set</span> <span class='op'>=</span> <span class='kw'>nil</span>
+  <span class='ivar'>@main_component</span> <span class='op'>=</span> <span class='kw'>nil</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -358,7 +447,50 @@
       
       <span id=""></span>
       <div class="method_details first">
-  <h3 class="signature first" id="state-instance_method">
+  <h3 class="signature first" id="main_component-instance_method">
+  
+    #<strong>main_component</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>An instance of YourApp::MainComponent (mainly for testing)</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+31
+32
+33</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ovto/app.rb', line 31</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_main_component'>main_component</span>
+  <span class='ivar'>@main_component</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="state-instance_method">
   
     #<strong>state</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
   
@@ -369,7 +501,7 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Returns the value of attribute state</p>
+<p>Returns the value of attribute state.</p>
 
 
   </div>
@@ -383,12 +515,12 @@
       <pre class="lines">
 
 
-12
-13
-14</pre>
+28
+29
+30</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ovto/app.rb', line 12</span>
+      <pre class="code"><span class="info file"># File 'lib/ovto/app.rb', line 28</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_state'>state</span>
   <span class='ivar'>@state</span>
@@ -406,9 +538,9 @@
 
     
       <div class="method_details first">
-  <h3 class="signature first" id="run-class_method">
+  <h3 class="signature first" id="middlewares-class_method">
   
-    .<strong>run</strong>(*args)  &#x21d2; <tt>Object</tt> 
+    .<strong>middlewares</strong>  &#x21d2; <tt>Object</tt> 
   
 
   
@@ -417,7 +549,7 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Create an App and start it</p>
+<p>List of installed middleware classes</p>
 
 
   </div>
@@ -438,12 +570,94 @@
     <td>
       <pre class="code"><span class="info file"># File 'lib/ovto/app.rb', line 4</span>
 
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_middlewares'>middlewares</span>
+  <span class='ivar'>@middlewares</span> <span class='op'>||=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="run-class_method">
+  
+    .<strong>run</strong>(*args)  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Create an App and start it</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+9
+10
+11</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ovto/app.rb', line 9</span>
+
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_new'>new</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="use-class_method">
+  
+    .<strong>use</strong>(middleware_class)  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Install a middleware</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+14
+15
+16</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ovto/app.rb', line 14</span>
+
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_use'>use</span><span class='lparen'>(</span><span class='id identifier rubyid_middleware_class'>middleware_class</span><span class='rparen'>)</span>
+  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_middlewares'>middlewares</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span><span class='lparen'>(</span><span class='id identifier rubyid_middleware_class'>middleware_class</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
 </div>
     
   </div>
@@ -478,12 +692,12 @@
       <pre class="lines">
 
 
-19
-20
-21</pre>
+38
+39
+40</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ovto/app.rb', line 19</span>
+      <pre class="code"><span class="info file"># File 'lib/ovto/app.rb', line 38</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid__set_state'>_set_state</span><span class='lparen'>(</span><span class='id identifier rubyid_new_state'>new_state</span><span class='rparen'>)</span>
   <span class='ivar'>@state</span> <span class='op'>=</span> <span class='id identifier rubyid_new_state'>new_state</span>
@@ -508,15 +722,15 @@
       <pre class="lines">
 
 
-14
-15
-16</pre>
+33
+34
+35</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ovto/app.rb', line 14</span>
+      <pre class="code"><span class="info file"># File 'lib/ovto/app.rb', line 33</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_actions'>actions</span>
-  <span class='ivar'>@wired_actions</span>
+  <span class='ivar'>@wired_action_set</span><span class='period'>.</span><span class='id identifier rubyid_app_wired_actions'>app_wired_actions</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -549,12 +763,12 @@
       <pre class="lines">
 
 
-24
-25
-26</pre>
+43
+44
+45</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ovto/app.rb', line 24</span>
+      <pre class="code"><span class="info file"># File 'lib/ovto/app.rb', line 43</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_run'>run</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
   <span class='const'><span class='object_link'><a href="../Ovto.html" title="Ovto (module)">Ovto</a></span></span><span class='period'>.</span><span class='id identifier rubyid_log_error'><span class='object_link'><a href="../Ovto.html#log_error-class_method" title="Ovto.log_error (method)">log_error</a></span></span><span class='lbrace'>{</span> <span class='id identifier rubyid__run'>_run</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
@@ -590,12 +804,12 @@
       <pre class="lines">
 
 
-29
-30
-31</pre>
+48
+49
+50</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ovto/app.rb', line 29</span>
+      <pre class="code"><span class="info file"># File 'lib/ovto/app.rb', line 48</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_setup'>setup</span>
   <span class='comment'># override this if needed
@@ -610,9 +824,9 @@
 </div>
 
       <div id="footer">
-  Generated on Sun Dec 22 22:06:04 2019 by
+  Generated on Fri Feb 28 23:42:46 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.20 (ruby-2.5.5).
+  0.9.24 (ruby-2.5.5).
 </div>
 
     </div>