docs/api/Ovto/App.html in ovto-0.2.1 vs docs/api/Ovto/App.html in ovto-0.2.2

- old
+ new

@@ -4,11 +4,11 @@ <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title> Class: Ovto::App - &mdash; Documentation by YARD 0.9.12 + &mdash; Documentation by YARD 0.9.16 </title> <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" /> @@ -164,11 +164,11 @@ <span class="summary_desc"><div class='inline'> -<p>Entry point of Ovto apps.</p> +<p>Create an App and start it.</p> </div></span> </li> @@ -206,10 +206,32 @@ <li class="public "> <span class="summary_signature"> + <a href="#actions-instance_method" title="#actions (instance method)">#<strong>actions</strong> &#x21d2; Object </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'></div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong> &#x21d2; App </a> </span> @@ -232,11 +254,11 @@ <li class="public "> <span class="summary_signature"> - <a href="#run-instance_method" title="#run (instance method)">#<strong>run</strong>(id: nil) &#x21d2; Object </a> + <a href="#run-instance_method" title="#run (instance method)">#<strong>run</strong>(*args) &#x21d2; Object </a> </span> @@ -253,10 +275,34 @@ </div></span> </li> + <li class="public "> + <span class="summary_signature"> + + <a href="#setup-instance_method" title="#setup (instance method)">#<strong>setup</strong> &#x21d2; Object </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>Called when this app is started.</p> +</div></span> + +</li> + + </ul> <div id="constructor_details" class="method_details_list"> <h2>Constructor Details</h2> @@ -287,17 +333,19 @@ <pre class="lines"> 8 9 -10</pre> +10 +11</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ovto/app.rb', line 8</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='kw'>end</span></pre> </td> </tr> </table> </div> @@ -333,16 +381,16 @@ <tr> <td> <pre class="lines"> -11 12 -13</pre> +13 +14</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ovto/app.rb', line 11</span> + <pre class="code"><span class="info file"># File 'lib/ovto/app.rb', line 12</span> <span class='kw'>def</span> <span class='id identifier rubyid_state'>state</span> <span class='ivar'>@state</span> <span class='kw'>end</span></pre> </td> @@ -367,11 +415,11 @@ </h3><div class="docstring"> <div class="discussion"> -<p>Entry point of Ovto apps</p> +<p>Create an App and start it</p> </div> </div> <div class="tags"> @@ -389,11 +437,11 @@ </td> <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_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_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='rbrace'>}</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> @@ -428,29 +476,59 @@ <tr> <td> <pre class="lines"> +19 +20 +21</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ovto/app.rb', line 19</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> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <h3 class="signature " id="actions-instance_method"> + + #<strong>actions</strong> &#x21d2; <tt>Object</tt> + + + + + +</h3><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='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> +<span class='kw'>def</span> <span class='id identifier rubyid_actions'>actions</span> + <span class='ivar'>@wired_actions</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="run-instance_method"> - #<strong>run</strong>(id: nil) &#x21d2; <tt>Object</tt> + #<strong>run</strong>(*args) &#x21d2; <tt>Object</tt> @@ -469,62 +547,73 @@ <tr> <td> <pre class="lines"> -19 -20 -21 -22 -23 24 25 -26 -27 -28 +26</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ovto/app.rb', line 24</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> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <h3 class="signature " id="setup-instance_method"> + + #<strong>setup</strong> &#x21d2; <tt>Object</tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>Called when this app is started</p> + + + </div> +</div> +<div class="tags"> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + 29 30 -31 -32 -33 -34 -35 -36</pre> +31</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 29</span> -<span class='kw'>def</span> <span class='id identifier rubyid_run'>run</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='kw'>nil</span><span class='rparen'>)</span> - <span class='id identifier rubyid_runtime'>runtime</span> <span class='op'>=</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="Runtime.html" title="Ovto::Runtime (class)">Runtime</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Runtime.html#initialize-instance_method" title="Ovto::Runtime#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span> - <span class='id identifier rubyid_wired_actions'>wired_actions</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="WiredActions.html" title="Ovto::WiredActions (class)">WiredActions</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="WiredActions.html#initialize-instance_method" title="Ovto::WiredActions#initialize (method)">new</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_const_get'>const_get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Actions</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='comma'>,</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_runtime'>runtime</span><span class='rparen'>)</span> - <span class='id identifier rubyid_view'>view</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'>View</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='lparen'>(</span><span class='id identifier rubyid_wired_actions'>wired_actions</span><span class='rparen'>)</span> - <span class='kw'>if</span> <span class='id identifier rubyid_id'>id</span> - <span class='backtick'>%x{</span><span class='tstring_content'> - document.addEventListener(&#39;DOMContentLoaded&#39;, function(){ - var container = document.getElementById(id); - if (!container) { - throw &quot;Ovto::App#run: tag with id=&#39;&quot; + id + &quot;&#39; was not found&quot;; - } - </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_runtime'>runtime</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</span><span class='lparen'>(</span><span class='id identifier rubyid_view'>view</span><span class='comma'>,</span> <span class='backtick'>`</span><span class='tstring_content'>container</span><span class='tstring_end'>`</span></span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_content'> - }); - </span><span class='tstring_end'>}</span></span> - <span class='kw'>else</span> - <span class='id identifier rubyid_runtime'>runtime</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</span><span class='lparen'>(</span><span class='id identifier rubyid_view'>view</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rparen'>)</span> - <span class='kw'>end</span> -<span class='kw'>end</span></pre> +<span class='kw'>def</span> <span class='id identifier rubyid_setup'>setup</span> + <span class='comment'># override this if needed +</span><span class='kw'>end</span></pre> </td> </tr> </table> </div> </div> </div> <div id="footer"> - Generated on Fri Jun 1 21:07:20 2018 by + Generated on Wed Nov 7 18:02:01 2018 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.9.12 (ruby-2.4.2). + 0.9.16 (ruby-2.5.3). </div> </div> </body> </html> \ No newline at end of file