vagabond/sapling
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update YARD docs

Browse source
This commit is contained in:
Bill Niblock 2017-10-14 23:40:38 -04:00
parent 119786aad6
commit 321ce557d8
18 changed files with 1554 additions and 517 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

263
doc/Dialogue.html
View file

@ -111,14 +111,273 @@
<h2>
Class Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#display_branch-class_method" title="display_branch (class method)">.<strong>display_branch</strong>(branch, branch_no, debug = false) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Format and display a branch and the options.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#display_trunk-class_method" title="display_trunk (class method)">.<strong>display_trunk</strong>(trunk, debug = false) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Format and display the trunk.</p>
</div></span>
</li>
</ul>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="display_branch-class_method">
.<strong>display_branch</strong>(branch, branch_no, debug = false) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Format and display a branch and the options</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>branch</span>
<span class='type'>(<tt>Hash</tt>)</span>
&mdash;
<div class='inline'>
<p>A branch data set</p>
</div>
</li>
<li>
<span class='name'>branch_no</span>
<span class='type'>(<tt>Integer</tt>)</span>
&mdash;
<div class='inline'>
<p>The branch number</p>
</div>
</li>
<li>
<span class='name'>debug</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'>
<p>Status of showing debug information</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
23
24
25
26
27
28
29
30
31</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sapling/dialogue.rb', line 23</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_display_branch'>display_branch</span><span class='lparen'>(</span><span class='id identifier rubyid_branch'>branch</span><span class='comma'>,</span> <span class='id identifier rubyid_branch_no'>branch_no</span><span class='comma'>,</span> <span class='id identifier rubyid_debug'>debug</span><span class='op'>=</span><span class='kw'>false</span><span class='rparen'>)</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n[ Branch: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_branch_no'>branch_no</span><span class='embexpr_end'>}</span><span class='tstring_content'> ]</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_debug'>debug</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_branch'>branch</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>desc</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'>\n\n</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_branch'>branch</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>options</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_each_pair'>each_pair</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_v'>v</span><span class='op'>|</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\t</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_k'>k</span><span class='embexpr_end'>}</span><span class='tstring_content'>: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_v'>v</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\t\t[ Goes to branch </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_v'>v</span><span class='period'>.</span><span class='id identifier rubyid_values'>values</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'> ]\n</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_debug'>debug</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="display_trunk-class_method">
.<strong>display_trunk</strong>(trunk, debug = false) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Format and display the trunk</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>trunk</span>
<span class='type'>(<tt>Hash</tt>)</span>
&mdash;
<div class='inline'>
<p>The trunk hash</p>
</div>
</li>
<li>
<span class='name'>debug</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'>
<p>The status of showing debug information</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
10
11
12
13
14
15
16</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sapling/dialogue.rb', line 10</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_display_trunk'>display_trunk</span><span class='lparen'>(</span><span class='id identifier rubyid_trunk'>trunk</span><span class='comma'>,</span> <span class='id identifier rubyid_debug'>debug</span><span class='op'>=</span><span class='kw'>false</span><span class='rparen'>)</span>
<span class='int'>40</span><span class='period'>.</span><span class='id identifier rubyid_times'>times</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>-</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n[ Trunk ]\n</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_debug'>debug</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_trunk'>trunk</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>trunk</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='int'>40</span><span class='period'>.</span><span class='id identifier rubyid_times'>times</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>-</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun May 7 16:58:49 2017 by
Generated on Sat Oct 14 23:40:01 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.9 (ruby-2.2.5).
0.9.9 (ruby-2.4.2).
</div>
</div>

316
doc/Dialogue/Speaker.html
View file

@ -102,8 +102,7 @@
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Spealer holds the functionality for viewing and going through a dialogue
tree.</p>
<p>Speaker holds the functionality for going through a dialogue tree.</p>
</div>
@ -213,7 +212,31 @@ reached.</p>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong> &#x21d2; Speaker </a>
<a href="#get_response-instance_method" title="#get_response (instance method)">#<strong>get_response</strong>(branch) &#x21d2; Integer </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Get a response for the displayed branch.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(file = &quot;&quot;, debug = false) &#x21d2; Speaker </a>
@ -239,7 +262,7 @@ reached.</p>
<li class="public ">
<span class="summary_signature">
<a href="#talk-instance_method" title="#talk (instance method)">#<strong>talk</strong>(branch) &#x21d2; Integer </a>
<a href="#talk-instance_method" title="#talk (instance method)">#<strong>talk</strong>(branch, branch_no) &#x21d2; Integer </a>
@ -269,7 +292,7 @@ reached.</p>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong> &#x21d2; <tt><span class='object_link'><a href="" title="Dialogue::Speaker (class)">Speaker</a></span></tt>
#<strong>initialize</strong>(file = &quot;&quot;, debug = false) &#x21d2; <tt><span class='object_link'><a href="" title="Dialogue::Speaker (class)">Speaker</a></span></tt>
@ -292,17 +315,17 @@ reached.</p>
<pre class="lines">
15
16
17
18</pre>
40
41
42
43</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sapling/dialogue.rb', line 15</span>
<pre class="code"><span class="info file"># File 'lib/sapling/dialogue.rb', line 40</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
<span class='ivar'>@file</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span>
<span class='ivar'>@debug</span> <span class='op'>=</span> <span class='kw'>false</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_file'>file</span><span class='op'>=</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_debug'>debug</span><span class='op'>=</span><span class='kw'>false</span><span class='rparen'>)</span>
<span class='ivar'>@file</span> <span class='op'>=</span> <span class='id identifier rubyid_file'>file</span>
<span class='ivar'>@debug</span> <span class='op'>=</span> <span class='id identifier rubyid_debug'>debug</span>
<span class='kw'>end</span></pre>
</td>
</tr>
@ -342,12 +365,12 @@ reached.</p>
<pre class="lines">
13
14
15</pre>
38
39
40</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sapling/dialogue.rb', line 13</span>
<pre class="code"><span class="info file"># File 'lib/sapling/dialogue.rb', line 38</span>
<span class='kw'>def</span> <span class='id identifier rubyid_debug'>debug</span>
<span class='ivar'>@debug</span>
@ -385,12 +408,12 @@ reached.</p>
<pre class="lines">
10
11
12</pre>
36
37
38</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sapling/dialogue.rb', line 10</span>
<pre class="code"><span class="info file"># File 'lib/sapling/dialogue.rb', line 36</span>
<span class='kw'>def</span> <span class='id identifier rubyid_file'>file</span>
<span class='ivar'>@file</span>
@ -434,36 +457,36 @@ reached.</p>
<pre class="lines">
22
23
24
25
26
27
28
29
30
31
32
33
34
35</pre>
47
48
49
50
51
52
53
54
55
56
57
58
59
60</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sapling/dialogue.rb', line 22</span>
<pre class="code"><span class="info file"># File 'lib/sapling/dialogue.rb', line 47</span>
<span class='kw'>def</span> <span class='id identifier rubyid_conversation'>conversation</span><span class='lparen'>(</span><span class='rparen'>)</span>
<span class='id identifier rubyid_tree'>tree</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Gardner.html" title="Gardner (module)">Gardner</a></span></span><span class='period'>.</span><span class='id identifier rubyid_grow'><span class='object_link'><a href="../Gardner.html#grow-class_method" title="Gardner.grow (method)">grow</a></span></span><span class='lparen'>(</span><span class='ivar'>@file</span><span class='rparen'>)</span>
<span class='id identifier rubyid_tree'>tree</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Gardner.html" title="Gardner (module)">Gardner</a></span></span><span class='period'>.</span><span class='id identifier rubyid_prune_trunk'><span class='object_link'><a href="../Gardner.html#prune_trunk-class_method" title="Gardner.prune_trunk (method)">prune_trunk</a></span></span><span class='lparen'>(</span><span class='ivar'>@file</span><span class='rparen'>)</span>
<span class='int'>10</span><span class='period'>.</span><span class='id identifier rubyid_times'>times</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>*</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n[ Branch: 1 ]</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='ivar'>@debug</span>
<span class='id identifier rubyid_next_branch'>next_branch</span> <span class='op'>=</span> <span class='id identifier rubyid_talk'>talk</span><span class='lparen'>(</span><span class='id identifier rubyid_tree'>tree</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='const'><span class='object_link'><a href="../Dialogue.html" title="Dialogue (module)">Dialogue</a></span></span><span class='period'>.</span><span class='id identifier rubyid_display_trunk'><span class='object_link'><a href="../Dialogue.html#display_trunk-class_method" title="Dialogue.display_trunk (method)">display_trunk</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_tree'>tree</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='kw'>false</span><span class='rparen'>)</span>
<span class='id identifier rubyid_branches'>branches</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Gardner.html" title="Gardner (module)">Gardner</a></span></span><span class='period'>.</span><span class='id identifier rubyid_prune_branches'><span class='object_link'><a href="../Gardner.html#prune_branches-class_method" title="Gardner.prune_branches (method)">prune_branches</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_tree'>tree</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='id identifier rubyid_next_branch'>next_branch</span> <span class='op'>=</span> <span class='int'>1</span>
<span class='kw'>until</span> <span class='id identifier rubyid_next_branch'>next_branch</span> <span class='op'>==</span> <span class='int'>0</span> <span class='kw'>do</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n[ Branch: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_next_branch'>next_branch</span><span class='embexpr_end'>}</span><span class='tstring_content'> ]</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='ivar'>@debug</span>
<span class='id identifier rubyid_next_branch'>next_branch</span> <span class='op'>=</span> <span class='id identifier rubyid_talk'>talk</span><span class='lparen'>(</span><span class='id identifier rubyid_tree'>tree</span><span class='lbracket'>[</span><span class='id identifier rubyid_next_branch'>next_branch</span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='id identifier rubyid_next_branch'>next_branch</span> <span class='op'>=</span> <span class='id identifier rubyid_talk'>talk</span><span class='lparen'>(</span><span class='id identifier rubyid_branches'>branches</span><span class='lbracket'>[</span><span class='id identifier rubyid_next_branch'>next_branch</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_next_branch'>next_branch</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_tree'>tree</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>desc</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_branches'>branches</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>desc</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_exit'>exit</span>
<span class='kw'>end</span></pre>
</td>
@ -472,9 +495,9 @@ reached.</p>
</div>
<div class="method_details ">
<h3 class="signature " id="talk-instance_method">
<h3 class="signature " id="get_response-instance_method">
#<strong>talk</strong>(branch) &#x21d2; <tt>Integer</tt>
#<strong>get_response</strong>(branch) &#x21d2; <tt>Integer</tt>
@ -483,7 +506,7 @@ reached.</p>
</h3><div class="docstring">
<div class="discussion">
<p>Talk displays a branch, the options, and prompts for a response</p>
<p>Get a response for the displayed branch</p>
</div>
@ -520,6 +543,127 @@ reached.</p>
&mdash;
<div class='inline'>
<p>the next branch</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sapling/dialogue.rb', line 93</span>
<span class='kw'>def</span> <span class='id identifier rubyid_get_response'>get_response</span><span class='lparen'>(</span><span class='id identifier rubyid_branch'>branch</span><span class='rparen'>)</span>
<span class='id identifier rubyid_valid_options'>valid_options</span> <span class='op'>=</span> <span class='id identifier rubyid_branch'>branch</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>options</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>, </span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n[</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_valid_options'>valid_options</span><span class='embexpr_end'>}</span><span class='tstring_content'>]&gt; </span><span class='tstring_end'>&quot;</span></span>
<span class='const'>STDOUT</span><span class='period'>.</span><span class='id identifier rubyid_flush'>flush</span>
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'>STDIN</span><span class='period'>.</span><span class='id identifier rubyid_gets'>gets</span><span class='period'>.</span><span class='id identifier rubyid_chomp'>chomp</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
<span class='kw'>until</span> <span class='id identifier rubyid_branch'>branch</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>options</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span> <span class='kw'>or</span> <span class='id identifier rubyid_response'>response</span> <span class='op'>==</span> <span class='int'>0</span>
<span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>[## Invalid options. </span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Valid options are </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_valid_options'>valid_options</span><span class='embexpr_end'>}</span><span class='tstring_content'>, or 0 to exit.</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n[</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_valid_options'>valid_options</span><span class='embexpr_end'>}</span><span class='tstring_content'>]&gt; </span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'>STDIN</span><span class='period'>.</span><span class='id identifier rubyid_gets'>gets</span><span class='period'>.</span><span class='id identifier rubyid_chomp'>chomp</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
<span class='kw'>end</span>
<span class='kw'>return</span> <span class='id identifier rubyid_response'>response</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="talk-instance_method">
#<strong>talk</strong>(branch, branch_no) &#x21d2; <tt>Integer</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Talk displays a branch, the options, and prompts for a response.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>branch</span>
<span class='type'>(<tt>Hash</tt>)</span>
&mdash;
<div class='inline'>
<p>A branch data set</p>
</div>
</li>
<li>
<span class='name'>branch_no</span>
<span class='type'>(<tt>Integer</tt>)</span>
&mdash;
<div class='inline'>
<p>The branch number</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Integer</tt>)</span>
&mdash;
<div class='inline'>
<p>The number of the next branch</p>
@ -535,32 +679,6 @@ reached.</p>
<pre class="lines">
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
@ -569,13 +687,24 @@ reached.</p>
72
73
74
75</pre>
75
76
77
78
79
80
81
82
83
84
85
86
87</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sapling/dialogue.rb', line 41</span>
<span class='kw'>def</span> <span class='id identifier rubyid_talk'>talk</span><span class='lparen'>(</span><span class='id identifier rubyid_branch'>branch</span><span class='rparen'>)</span>
<pre class="code"><span class="info file"># File 'lib/sapling/dialogue.rb', line 67</span>
<span class='kw'>def</span> <span class='id identifier rubyid_talk'>talk</span><span class='lparen'>(</span><span class='id identifier rubyid_branch'>branch</span><span class='comma'>,</span> <span class='id identifier rubyid_branch_no'>branch_no</span><span class='rparen'>)</span>
<span class='comment'># If there are no options on this branch, we assume it&#39;s a terminal
</span> <span class='comment'># branch. Return 0, and end the program.
</span> <span class='kw'>if</span> <span class='id identifier rubyid_branch'>branch</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>options</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
@ -583,31 +712,18 @@ reached.</p>
<span class='kw'>return</span> <span class='int'>0</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_valid_options'>valid_options</span> <span class='op'>=</span> <span class='id identifier rubyid_branch'>branch</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>options</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>, </span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='const'><span class='object_link'><a href="../Dialogue.html" title="Dialogue (module)">Dialogue</a></span></span><span class='period'>.</span><span class='id identifier rubyid_display_branch'><span class='object_link'><a href="../Dialogue.html#display_branch-class_method" title="Dialogue.display_branch (method)">display_branch</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_branch'>branch</span><span class='comma'>,</span> <span class='id identifier rubyid_branch_no'>branch_no</span><span class='comma'>,</span> <span class='ivar'>@debug</span><span class='rparen'>)</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_branch'>branch</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>desc</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'>\n\n</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_branch'>branch</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>options</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_each_pair'>each_pair</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_v'>v</span><span class='op'>|</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\t</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_k'>k</span><span class='embexpr_end'>}</span><span class='tstring_content'>: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_v'>v</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\t\t [ Goes to branch </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_v'>v</span><span class='period'>.</span><span class='id identifier rubyid_values'>values</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'> ]</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='ivar'>@debug</span>
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_get_response'>get_response</span><span class='lparen'>(</span><span class='id identifier rubyid_branch'>branch</span><span class='rparen'>)</span>
<span class='kw'>unless</span> <span class='id identifier rubyid_response'>response</span> <span class='op'>==</span> <span class='int'>0</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n</span><span class='tstring_end'>&quot;</span></span>
<span class='int'>10</span><span class='period'>.</span><span class='id identifier rubyid_times'>times</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>*</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n(Your choice: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_branch'>branch</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>options</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='id identifier rubyid_response'>response</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'>)</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_branch'>branch</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>options</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='id identifier rubyid_response'>response</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_values'>values</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n[</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_valid_options'>valid_options</span><span class='embexpr_end'>}</span><span class='tstring_content'>]&gt; </span><span class='tstring_end'>&quot;</span></span>
<span class='const'>STDOUT</span><span class='period'>.</span><span class='id identifier rubyid_flush'>flush</span>
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'>STDIN</span><span class='period'>.</span><span class='id identifier rubyid_gets'>gets</span><span class='period'>.</span><span class='id identifier rubyid_chomp'>chomp</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
<span class='kw'>until</span> <span class='id identifier rubyid_branch'>branch</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>options</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span> <span class='kw'>or</span> <span class='id identifier rubyid_response'>response</span> <span class='op'>==</span> <span class='int'>0</span>
<span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>[## Invalid options. </span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Valid options are </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_valid_options'>valid_options</span><span class='embexpr_end'>}</span><span class='tstring_content'>, or 0 to exit.</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n[</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_valid_options'>valid_options</span><span class='embexpr_end'>}</span><span class='tstring_content'>]&gt; </span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'>STDIN</span><span class='period'>.</span><span class='id identifier rubyid_gets'>gets</span><span class='period'>.</span><span class='id identifier rubyid_chomp'>chomp</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n</span><span class='tstring_end'>&quot;</span></span>
<span class='int'>10</span><span class='period'>.</span><span class='id identifier rubyid_times'>times</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>*</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span>
<span class='kw'>return</span> <span class='int'>0</span> <span class='kw'>if</span> <span class='id identifier rubyid_response'>response</span> <span class='op'>==</span> <span class='int'>0</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n(Your choice: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_branch'>branch</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>options</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='id identifier rubyid_response'>response</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'>)</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>return</span> <span class='id identifier rubyid_branch'>branch</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>options</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='id identifier rubyid_response'>response</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_values'>values</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
<span class='kw'>return</span> <span class='id identifier rubyid_response'>response</span>
<span class='kw'>end</span></pre>
</td>
</tr>
@ -619,9 +735,9 @@ reached.</p>
</div>
<div id="footer">
Generated on Sun May 7 16:58:49 2017 by
Generated on Sat Oct 14 23:40:01 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.9 (ruby-2.2.5).
0.9.9 (ruby-2.4.2).
</div>
</div>

175
doc/Gardner.html
View file

@ -112,30 +112,6 @@
<li class="public ">
<span class="summary_signature">
<a href="#grow-class_method" title="grow (class method)">.<strong>grow</strong>(tree) &#x21d2; Hash </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The main method for Sapling.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#prune_branches-class_method" title="prune_branches (class method)">.<strong>prune_branches</strong>(tree) &#x21d2; Array </a>
@ -151,7 +127,8 @@
<span class="summary_desc"><div class='inline'>
<p>Parse the branch.</p>
<p>Parse the tree array into an array of numbered branches, and ordered
leaves.</p>
</div></span>
</li>
@ -175,7 +152,7 @@
<span class="summary_desc"><div class='inline'>
<p>Parse the options.</p>
<p>Parse the leaves of a branch into a numbered hash of options.</p>
</div></span>
</li>
@ -184,7 +161,7 @@
<li class="public ">
<span class="summary_signature">
<a href="#prune_trunk-class_method" title="prune_trunk (class method)">.<strong>prune_trunk</strong>(tree) &#x21d2; Hash </a>
<a href="#prune_trunk-class_method" title="prune_trunk (class method)">.<strong>prune_trunk</strong>(tree) &#x21d2; Array </a>
@ -199,7 +176,7 @@
<span class="summary_desc"><div class='inline'>
<p>Parse the trunk The trunk is like the introduction to the tree.</p>
<p>Parse the trunk of the tree.</p>
</div></span>
</li>
@ -215,92 +192,7 @@
<div class="method_details first">
<h3 class="signature first" id="grow-class_method">
.<strong>grow</strong>(tree) &#x21d2; <tt>Hash</tt>
</h3><div class="docstring">
<div class="discussion">
<p>The main method for Sapling. From here, the tree is grown.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>tree</span>
<span class='type'>(<tt>File</tt>)</span>
&mdash;
<div class='inline'>
<p>The dialogue tree file</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Hash</tt>)</span>
&mdash;
<div class='inline'>
<p>The final, constructed data set</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
61
62
63
64
65
66</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sapling/gardner.rb', line 61</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_grow'>grow</span><span class='lparen'>(</span><span class='id identifier rubyid_tree'>tree</span><span class='rparen'>)</span>
<span class='id identifier rubyid_trunk'>trunk</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Gardner (module)">Gardner</a></span></span><span class='period'>.</span><span class='id identifier rubyid_prune_trunk'><span class='object_link'><a href="#prune_trunk-class_method" title="Gardner.prune_trunk (method)">prune_trunk</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_tree'>tree</span><span class='rparen'>)</span>
<span class='id identifier rubyid_branches'>branches</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Gardner (module)">Gardner</a></span></span><span class='period'>.</span><span class='id identifier rubyid_prune_branches'><span class='object_link'><a href="#prune_branches-class_method" title="Gardner.prune_branches (method)">prune_branches</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_trunk'>trunk</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='id identifier rubyid_branches'>branches</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="prune_branches-class_method">
<h3 class="signature first" id="prune_branches-class_method">
.<strong>prune_branches</strong>(tree) &#x21d2; <tt>Array</tt>
@ -311,7 +203,8 @@
</h3><div class="docstring">
<div class="discussion">
<p>Parse the branch</p>
<p>Parse the tree array into an array of numbered branches, and ordered
leaves.</p>
</div>
@ -350,7 +243,7 @@
&mdash;
<div class='inline'>
<p>The array of options on the branch.</p>
<p>An array of numbered branches, with numbered leaves</p>
</div>
</li>
@ -372,8 +265,7 @@
16
17
18
19
20</pre>
19</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sapling/gardner.rb', line 10</span>
@ -387,7 +279,6 @@
<span class='kw'>end</span>
<span class='kw'>return</span> <span class='id identifier rubyid_branches'>branches</span>
<span class='kw'>end</span></pre>
</td>
</tr>
@ -406,7 +297,7 @@
</h3><div class="docstring">
<div class="discussion">
<p>Parse the options</p>
<p>Parse the leaves of a branch into a numbered hash of options.</p>
</div>
@ -445,7 +336,7 @@
&mdash;
<div class='inline'>
<p>A has of options</p>
<p>A numbered hash of options</p>
</div>
</li>
@ -458,6 +349,7 @@
<pre class="lines">
25
26
27
28
@ -469,12 +361,10 @@
34
35
36
37
38
39</pre>
37</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sapling/gardner.rb', line 26</span>
<pre class="code"><span class="info file"># File 'lib/sapling/gardner.rb', line 25</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_prune_leaves'>prune_leaves</span><span class='lparen'>(</span><span class='id identifier rubyid_leaves'>leaves</span><span class='rparen'>)</span>
<span class='id identifier rubyid_x'>x</span> <span class='op'>=</span> <span class='int'>1</span>
@ -488,7 +378,6 @@
<span class='kw'>end</span>
<span class='kw'>return</span> <span class='id identifier rubyid_options'>options</span>
<span class='kw'>end</span></pre>
</td>
</tr>
@ -498,7 +387,7 @@
<div class="method_details ">
<h3 class="signature " id="prune_trunk-class_method">
.<strong>prune_trunk</strong>(tree) &#x21d2; <tt>Hash</tt>
.<strong>prune_trunk</strong>(tree) &#x21d2; <tt>Array</tt>
@ -507,7 +396,7 @@
</h3><div class="docstring">
<div class="discussion">
<p>Parse the trunk The trunk is like the introduction to the tree.</p>
<p>Parse the trunk of the tree.</p>
</div>
@ -540,13 +429,13 @@
<li>
<span class='type'>(<tt>Hash</tt>)</span>
<span class='type'>(<tt>Array</tt>)</span>
&mdash;
<div class='inline'>
<p>The tree without the trunk</p>
<p>The trunk, and the remainder of the tree</p>
</div>
</li>
@ -559,29 +448,19 @@
<pre class="lines">
43
44
45
46
47
48
49
50
51
52
53
54
55</pre>
47</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sapling/gardner.rb', line 46</span>
<pre class="code"><span class="info file"># File 'lib/sapling/gardner.rb', line 43</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_prune_trunk'>prune_trunk</span><span class='lparen'>(</span><span class='id identifier rubyid_tree'>tree</span><span class='rparen'>)</span>
<span class='id identifier rubyid_trunk'>trunk</span> <span class='op'>=</span> <span class='id identifier rubyid_tree'>tree</span><span class='period'>.</span><span class='id identifier rubyid_shift'>shift</span>
<span class='int'>40</span><span class='period'>.</span><span class='id identifier rubyid_times'>times</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>-</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_trunk'>trunk</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>trunk</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='int'>40</span><span class='period'>.</span><span class='id identifier rubyid_times'>times</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>-</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>return</span> <span class='id identifier rubyid_tree'>tree</span>
<span class='kw'>return</span> <span class='lbracket'>[</span><span class='id identifier rubyid_trunk'>trunk</span><span class='comma'>,</span><span class='id identifier rubyid_tree'>tree</span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
@ -593,9 +472,9 @@
</div>
<div id="footer">
Generated on Sun May 7 16:58:49 2017 by
Generated on Sat Oct 14 23:40:01 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.9 (ruby-2.2.5).
0.9.9 (ruby-2.4.2).
</div>
</div>

4
doc/Planter.html
View file

@ -116,9 +116,9 @@
</div>
<div id="footer">
Generated on Sun May 7 16:58:49 2017 by
Generated on Sat Oct 14 23:40:01 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.9 (ruby-2.2.5).
0.9.9 (ruby-2.4.2).
</div>
</div>

347
doc/Planter/Plot.html
View file

@ -99,8 +99,19 @@
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>In-memory tree</p>
</div>
</div>
<div class="tags">
</div>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
@ -192,6 +203,89 @@
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#edit_branch-instance_method" title="#edit_branch (instance method)">#<strong>edit_branch</strong>(branch_no) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Edit a branch on the tree.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#edit_leaf-instance_method" title="#edit_leaf (instance method)">#<strong>edit_leaf</strong>(branch, leaf) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Edit a leaf on a branch, grasshopper.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#edit_trunk-instance_method" title="#edit_trunk (instance method)">#<strong>edit_trunk</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Edit the trunk of the tree.</p>
</div></span>
</li>
</ul>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
@ -224,12 +318,12 @@
<pre class="lines">
10
11
12</pre>
12
13
14</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sapling/planter.rb', line 10</span>
<pre class="code"><span class="info file"># File 'lib/sapling/planter.rb', line 12</span>
<span class='kw'>def</span> <span class='id identifier rubyid_branches'>branches</span>
<span class='ivar'>@branches</span>
@ -267,12 +361,12 @@
<pre class="lines">
10
11
12</pre>
12
13
14</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sapling/planter.rb', line 10</span>
<pre class="code"><span class="info file"># File 'lib/sapling/planter.rb', line 12</span>
<span class='kw'>def</span> <span class='id identifier rubyid_tree'>tree</span>
<span class='ivar'>@tree</span>
@ -310,12 +404,12 @@
<pre class="lines">
10
11
12</pre>
12
13
14</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sapling/planter.rb', line 10</span>
<pre class="code"><span class="info file"># File 'lib/sapling/planter.rb', line 12</span>
<span class='kw'>def</span> <span class='id identifier rubyid_trunk'>trunk</span>
<span class='ivar'>@trunk</span>
@ -328,12 +422,237 @@
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="edit_branch-instance_method">
#<strong>edit_branch</strong>(branch_no) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Edit a branch on the tree</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>branch</span>
<span class='type'>(<tt>Integer</tt>)</span>
&mdash;
<div class='inline'>
<p>The number of the branch to be edited.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
32
33
34
35
36
37
38
39
40
41
42
43
44</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sapling/planter.rb', line 32</span>
<span class='kw'>def</span> <span class='id identifier rubyid_edit_branch'>edit_branch</span><span class='lparen'>(</span><span class='id identifier rubyid_branch_no'>branch_no</span><span class='rparen'>)</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Current Branch:\n</span><span class='tstring_end'>&quot;</span></span>
<span class='const'><span class='object_link'><a href="../Dialogue.html" title="Dialogue (module)">Dialogue</a></span></span><span class='period'>.</span><span class='id identifier rubyid_display_branch'><span class='object_link'><a href="../Dialogue.html#display_branch-class_method" title="Dialogue.display_branch (method)">display_branch</a></span></span><span class='lparen'>(</span><span class='ivar'>@branches</span><span class='lbracket'>[</span><span class='id identifier rubyid_branch_no'>branch_no</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_branch_no'>branch_no</span><span class='comma'>,</span> <span class='kw'>true</span><span class='rparen'>)</span>
<span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n[ =EDITING= ](CTRL-C to abort)&gt; </span><span class='tstring_end'>&quot;</span></span>
<span class='const'>STDOUT</span><span class='period'>.</span><span class='id identifier rubyid_flush'>flush</span>
<span class='kw'>begin</span>
<span class='id identifier rubyid_new_branch'>new_branch</span> <span class='op'>=</span> <span class='const'>STDIN</span><span class='period'>.</span><span class='id identifier rubyid_gets'>gets</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
<span class='kw'>rescue</span> <span class='const'>Interrupt</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n**Aborting edit**\n\n</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_new_branch'>new_branch</span> <span class='op'>=</span> <span class='ivar'>@branches</span><span class='lbracket'>[</span><span class='id identifier rubyid_branch_no'>branch_no</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>desc</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
<span class='kw'>end</span>
<span class='ivar'>@branches</span><span class='lbracket'>[</span><span class='id identifier rubyid_branch_no'>branch_no</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>desc</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_new_branch'>new_branch</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="edit_leaf-instance_method">
#<strong>edit_leaf</strong>(branch, leaf) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Edit a leaf on a branch, grasshopper</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>branch</span>
<span class='type'>(<tt>Integer</tt>)</span>
&mdash;
<div class='inline'>
<p>The number of the branch to be edited.</p>
</div>
</li>
<li>
<span class='name'>leaf</span>
<span class='type'>(<tt>Hash</tt>)</span>
&mdash;
<div class='inline'>
<p>The leaf hash to be edited.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
50
51
52</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sapling/planter.rb', line 50</span>
<span class='kw'>def</span> <span class='id identifier rubyid_edit_leaf'>edit_leaf</span><span class='lparen'>(</span><span class='id identifier rubyid_branch'>branch</span><span class='comma'>,</span> <span class='id identifier rubyid_leaf'>leaf</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="edit_trunk-instance_method">
#<strong>edit_trunk</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Edit the trunk of the tree</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
15
16
17
18
19
20
21
22
23
24
25
26
27</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sapling/planter.rb', line 15</span>
<span class='kw'>def</span> <span class='id identifier rubyid_edit_trunk'>edit_trunk</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Current Trunk:\n</span><span class='tstring_end'>&quot;</span></span>
<span class='const'><span class='object_link'><a href="../Dialogue.html" title="Dialogue (module)">Dialogue</a></span></span><span class='period'>.</span><span class='id identifier rubyid_display_trunk'><span class='object_link'><a href="../Dialogue.html#display_trunk-class_method" title="Dialogue.display_trunk (method)">display_trunk</a></span></span><span class='lparen'>(</span><span class='ivar'>@trunk</span><span class='comma'>,</span> <span class='kw'>true</span><span class='rparen'>)</span>
<span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n[ =EDITING= ](CTRL-C to abort)&gt; </span><span class='tstring_end'>&quot;</span></span>
<span class='const'>STDOUT</span><span class='period'>.</span><span class='id identifier rubyid_flush'>flush</span>
<span class='kw'>begin</span>
<span class='id identifier rubyid_new_trunk'>new_trunk</span> <span class='op'>=</span> <span class='const'>STDIN</span><span class='period'>.</span><span class='id identifier rubyid_gets'>gets</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
<span class='kw'>rescue</span> <span class='const'>Interrupt</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n**Aborting edit**\n\n</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_new_trunk'>new_trunk</span> <span class='op'>=</span> <span class='ivar'>@trunk</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>trunk</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
<span class='kw'>end</span>
<span class='ivar'>@trunk</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>trunk</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_new_trunk'>new_trunk</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun May 7 16:58:49 2017 by
Generated on Sat Oct 14 23:40:01 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.9 (ruby-2.2.5).
0.9.9 (ruby-2.4.2).
</div>
</div>

460
doc/Planter/Spade.html
View file

@ -186,7 +186,7 @@
<li class="public ">
<span class="summary_signature">
<a href="#edit_branch-instance_method" title="#edit_branch (instance method)">#<strong>edit_branch</strong>(branch) &#x21d2; Object </a>
<a href="#get_response-instance_method" title="#get_response (instance method)">#<strong>get_response</strong>(branch) &#x21d2; Integer </a>
@ -201,7 +201,7 @@
<span class="summary_desc"><div class='inline'>
<p>Edit a branch on the tree.</p>
<p>Get a response for the displayed branch.</p>
</div></span>
</li>
@ -210,13 +210,15 @@
<li class="public ">
<span class="summary_signature">
<a href="#edit_leaf-instance_method" title="#edit_leaf (instance method)">#<strong>edit_leaf</strong>(branch, leaf) &#x21d2; Object </a>
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(file) &#x21d2; Spade </a>
</span>
<span class="note title constructor">constructor</span>
@ -225,7 +227,7 @@
<span class="summary_desc"><div class='inline'>
<p>Edit a leaf on a branch, grasshopper.</p>
<p>A new instance of Spade.</p>
</div></span>
</li>
@ -234,7 +236,7 @@
<li class="public ">
<span class="summary_signature">
<a href="#edit_trunk-instance_method" title="#edit_trunk (instance method)">#<strong>edit_trunk</strong> &#x21d2; Object </a>
<a href="#parse_response-instance_method" title="#parse_response (instance method)">#<strong>parse_response</strong>(response, branch_no) &#x21d2; Integer </a>
@ -249,7 +251,7 @@
<span class="summary_desc"><div class='inline'>
<p>Edit the trunk of the tree.</p>
<p>Parse the response from get_response.</p>
</div></span>
</li>
@ -273,8 +275,8 @@
<span class="summary_desc"><div class='inline'>
<p>Establish a new Plot, which is basically an object for storing information
for us.</p>
<p>Establish and populate a new Plot (in-memory tree), then control the flow
of editing the Plot.</p>
</div></span>
</li>
@ -283,6 +285,51 @@ for us.</p>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(file) &#x21d2; <tt><span class='object_link'><a href="" title="Planter::Spade (class)">Spade</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of Spade</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
61
62
63</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sapling/planter.rb', line 61</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_file'>file</span><span class='rparen'>)</span>
<span class='ivar'>@file</span> <span class='op'>=</span> <span class='id identifier rubyid_file'>file</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
@ -315,12 +362,12 @@ for us.</p>
<pre class="lines">
18
19
20</pre>
59
60
61</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sapling/planter.rb', line 18</span>
<pre class="code"><span class="info file"># File 'lib/sapling/planter.rb', line 59</span>
<span class='kw'>def</span> <span class='id identifier rubyid_file='>file=</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='ivar'>@file</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span>
@ -385,49 +432,31 @@ gone forever (until next time).</p>
<pre class="lines">
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55</pre>
87
88
89
90
91
92
93
94
95
96
97</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sapling/planter.rb', line 36</span>
<pre class="code"><span class="info file"># File 'lib/sapling/planter.rb', line 87</span>
<span class='kw'>def</span> <span class='id identifier rubyid_dig'>dig</span><span class='lparen'>(</span><span class='id identifier rubyid_branch_no'>branch_no</span><span class='rparen'>)</span>
<span class='id identifier rubyid_branch'>branch</span> <span class='op'>=</span> <span class='ivar'>@plot</span><span class='period'>.</span><span class='id identifier rubyid_branches'>branches</span><span class='lbracket'>[</span><span class='id identifier rubyid_branch_no'>branch_no</span><span class='rbracket'>]</span>
<span class='comment'># Print the trunk
</span> <span class='int'>40</span><span class='period'>.</span><span class='id identifier rubyid_times'>times</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>-</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n[ Trunk ]\n</span><span class='embexpr_beg'>#{</span><span class='ivar'>@plot</span><span class='period'>.</span><span class='id identifier rubyid_trunk'>trunk</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='int'>40</span><span class='period'>.</span><span class='id identifier rubyid_times'>times</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>-</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n</span><span class='tstring_end'>&quot;</span></span>
<span class='int'>10</span><span class='period'>.</span><span class='id identifier rubyid_times'>times</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>*</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span>
<span class='const'><span class='object_link'><a href="../Dialogue.html" title="Dialogue (module)">Dialogue</a></span></span><span class='period'>.</span><span class='id identifier rubyid_display_trunk'><span class='object_link'><a href="../Dialogue.html#display_trunk-class_method" title="Dialogue.display_trunk (method)">display_trunk</a></span></span><span class='lparen'>(</span><span class='ivar'>@plot</span><span class='period'>.</span><span class='id identifier rubyid_trunk'>trunk</span><span class='comma'>,</span> <span class='kw'>true</span><span class='rparen'>)</span>
<span class='const'><span class='object_link'><a href="../Dialogue.html" title="Dialogue (module)">Dialogue</a></span></span><span class='period'>.</span><span class='id identifier rubyid_display_branch'><span class='object_link'><a href="../Dialogue.html#display_branch-class_method" title="Dialogue.display_branch (method)">display_branch</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_branch'>branch</span><span class='comma'>,</span> <span class='id identifier rubyid_branch_no'>branch_no</span><span class='comma'>,</span> <span class='kw'>true</span><span class='rparen'>)</span>
<span class='comment'># Print the branch and options
</span> <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n[ Branch: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_branch_no'>branch_no</span><span class='embexpr_end'>}</span><span class='tstring_content'> ]</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_branch'>branch</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>desc</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'>\n\n</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>unless</span> <span class='id identifier rubyid_branch'>branch</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>options</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
<span class='id identifier rubyid_branch'>branch</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>options</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_each_pair'>each_pair</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_v'>v</span><span class='op'>|</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\t</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_k'>k</span><span class='embexpr_end'>}</span><span class='tstring_content'>: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_v'>v</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\t\t [ Goes to branch </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_v'>v</span><span class='period'>.</span><span class='id identifier rubyid_values'>values</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'> ]</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_get_response'>get_response</span><span class='lparen'>(</span><span class='id identifier rubyid_branch'>branch</span><span class='rparen'>)</span>
<span class='id identifier rubyid_to_branch'>to_branch</span> <span class='op'>=</span> <span class='id identifier rubyid_parse_response'>parse_response</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='id identifier rubyid_branch_no'>branch_no</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='id identifier rubyid_to_branch'>to_branch</span>
<span class='kw'>end</span></pre>
</td>
</tr>
@ -435,9 +464,9 @@ gone forever (until next time).</p>
</div>
<div class="method_details ">
<h3 class="signature " id="edit_branch-instance_method">
<h3 class="signature " id="get_response-instance_method">
#<strong>edit_branch</strong>(branch) &#x21d2; <tt>Object</tt>
#<strong>get_response</strong>(branch) &#x21d2; <tt>Integer</tt>
@ -446,7 +475,7 @@ gone forever (until next time).</p>
</h3><div class="docstring">
<div class="discussion">
<p>Edit a branch on the tree</p>
<p>Get a response for the displayed branch</p>
</div>
@ -460,96 +489,37 @@ gone forever (until next time).</p>
<span class='name'>branch</span>
<span class='type'>(<tt>Integer</tt>)</span>
&mdash;
<div class='inline'>
<p>The number of the branch to be edited.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
65
66
67</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sapling/planter.rb', line 65</span>
<span class='kw'>def</span> <span class='id identifier rubyid_edit_branch'>edit_branch</span><span class='lparen'>(</span><span class='id identifier rubyid_branch'>branch</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="edit_leaf-instance_method">
#<strong>edit_leaf</strong>(branch, leaf) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Edit a leaf on a branch, grasshopper</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>branch</span>
<span class='type'>(<tt>Integer</tt>)</span>
&mdash;
<div class='inline'>
<p>The number of the branch to be edited.</p>
</div>
</li>
<li>
<span class='name'>leaf</span>
<span class='type'>(<tt>Hash</tt>)</span>
&mdash;
<div class='inline'>
<p>The leaf hash to be edited.</p>
<p>A branch data set</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Integer</tt>)</span>
&mdash;
<div class='inline'>
<p>the next branch</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
@ -557,15 +527,45 @@ gone forever (until next time).</p>
<pre class="lines">
73
74
75</pre>
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sapling/planter.rb', line 73</span>
<pre class="code"><span class="info file"># File 'lib/sapling/planter.rb', line 103</span>
<span class='kw'>def</span> <span class='id identifier rubyid_edit_leaf'>edit_leaf</span><span class='lparen'>(</span><span class='id identifier rubyid_branch'>branch</span><span class='comma'>,</span> <span class='id identifier rubyid_leaf'>leaf</span><span class='rparen'>)</span>
<span class='kw'>def</span> <span class='id identifier rubyid_get_response'>get_response</span><span class='lparen'>(</span><span class='id identifier rubyid_branch'>branch</span><span class='rparen'>)</span>
<span class='id identifier rubyid_total_branches'>total_branches</span> <span class='op'>=</span> <span class='ivar'>@plot</span><span class='period'>.</span><span class='id identifier rubyid_branches'>branches</span><span class='period'>.</span><span class='id identifier rubyid_count'>count</span> <span class='op'>-</span> <span class='int'>1</span>
<span class='id identifier rubyid_valid_options'>valid_options</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1-</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_total_branches'>total_branches</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>t</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>a</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>b</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>x</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>l</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>s</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>q</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
<span class='id identifier rubyid_print_options'>print_options</span> <span class='op'>=</span> <span class='id identifier rubyid_valid_options'>valid_options</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>,</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n[</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_print_options'>print_options</span><span class='embexpr_end'>}</span><span class='tstring_content'>]&gt; </span><span class='tstring_end'>&quot;</span></span>
<span class='const'>STDOUT</span><span class='period'>.</span><span class='id identifier rubyid_flush'>flush</span>
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'>STDIN</span><span class='period'>.</span><span class='id identifier rubyid_gets'>gets</span><span class='period'>.</span><span class='id identifier rubyid_chomp'>chomp</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_downcase'>downcase</span>
<span class='kw'>until</span> <span class='id identifier rubyid_valid_options'>valid_options</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span> <span class='kw'>or</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span><span class='period'>.</span><span class='id identifier rubyid_between?'>between?</span><span class='lparen'>(</span><span class='int'>1</span><span class='comma'>,</span><span class='id identifier rubyid_total_branches'>total_branches</span><span class='rparen'>)</span>
<span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>[## Invalid response. </span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Valid options are </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_print_options'>print_options</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n[</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_print_options'>print_options</span><span class='embexpr_end'>}</span><span class='tstring_content'>]&gt; </span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'>STDIN</span><span class='period'>.</span><span class='id identifier rubyid_gets'>gets</span><span class='period'>.</span><span class='id identifier rubyid_chomp'>chomp</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_downcase'>downcase</span>
<span class='kw'>end</span>
<span class='kw'>return</span> <span class='id identifier rubyid_response'>response</span>
<span class='kw'>end</span></pre>
</td>
</tr>
@ -573,9 +573,9 @@ gone forever (until next time).</p>
</div>
<div class="method_details ">
<h3 class="signature " id="edit_trunk-instance_method">
<h3 class="signature " id="parse_response-instance_method">
#<strong>edit_trunk</strong> &#x21d2; <tt>Object</tt>
#<strong>parse_response</strong>(response, branch_no) &#x21d2; <tt>Integer</tt>
@ -584,13 +584,67 @@ gone forever (until next time).</p>
</h3><div class="docstring">
<div class="discussion">
<p>Edit the trunk of the tree</p>
<p>Parse the response from get_response</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>response</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>The option selected</p>
</div>
</li>
<li>
<span class='name'>branch_no</span>
<span class='type'>(<tt>Integer</tt>)</span>
&mdash;
<div class='inline'>
<p>The currently-displayed branch</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Integer</tt>)</span>
&mdash;
<div class='inline'>
<p>the branch to display</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
@ -598,15 +652,95 @@ gone forever (until next time).</p>
<pre class="lines">
58
59
60</pre>
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sapling/planter.rb', line 58</span>
<pre class="code"><span class="info file"># File 'lib/sapling/planter.rb', line 127</span>
<span class='kw'>def</span> <span class='id identifier rubyid_edit_trunk'>edit_trunk</span>
<span class='kw'>def</span> <span class='id identifier rubyid_parse_response'>parse_response</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='id identifier rubyid_branch_no'>branch_no</span><span class='rparen'>)</span>
<span class='int'>10</span><span class='period'>.</span><span class='id identifier rubyid_times'>times</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>*</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n(Your choice: </span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>if</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span> <span class='op'>&gt;=</span> <span class='int'>1</span>
<span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Change to branch </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span><span class='embexpr_end'>}</span><span class='tstring_content'>)\n\n</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>return</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
<span class='kw'>end</span>
<span class='kw'>case</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_downcase'>downcase</span>
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>t</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Edit the trunk.)\n\n</span><span class='tstring_end'>&quot;</span></span>
<span class='ivar'>@plot</span><span class='period'>.</span><span class='id identifier rubyid_edit_trunk'>edit_trunk</span>
<span class='kw'>return</span> <span class='id identifier rubyid_branch_no'>branch_no</span>
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>a</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Add a new branch.)\n\n</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>return</span> <span class='id identifier rubyid_branch_no'>branch_no</span>
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>b</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Edit the current branch.)\n\n</span><span class='tstring_end'>&quot;</span></span>
<span class='ivar'>@plot</span><span class='period'>.</span><span class='id identifier rubyid_edit_branch'>edit_branch</span><span class='lparen'>(</span><span class='id identifier rubyid_branch_no'>branch_no</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='id identifier rubyid_branch_no'>branch_no</span>
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>x</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Delete the current branch.)\n\n</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>return</span> <span class='id identifier rubyid_branch_no'>branch_no</span>
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>l</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Edit leaves of current branch.)\n\n</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>return</span> <span class='id identifier rubyid_branch_no'>branch_no</span>
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>s</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Save changes.)\n\n</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>return</span> <span class='id identifier rubyid_branch_no'>branch_no</span>
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>q</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Quit without saving.)\n\n</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Unsaved changes will be lost. Still quit? [y/n]&gt; </span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_verify'>verify</span> <span class='op'>=</span> <span class='const'>STDIN</span><span class='period'>.</span><span class='id identifier rubyid_gets'>gets</span><span class='period'>.</span><span class='id identifier rubyid_chomp'>chomp</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_downcase'>downcase</span>
<span class='kw'>return</span> <span class='int'>0</span> <span class='kw'>if</span> <span class='id identifier rubyid_verify'>verify</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>y</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>return</span> <span class='id identifier rubyid_branch_no'>branch_no</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Unknown option. Returning to current branch.)\n\n</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>return</span> <span class='id identifier rubyid_branch_no'>branch_no</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
@ -625,8 +759,8 @@ gone forever (until next time).</p>
</h3><div class="docstring">
<div class="discussion">
<p>Establish a new Plot, which is basically an object for storing information
for us. From here, we start gardening.</p>
<p>Establish and populate a new Plot (in-memory tree), then control the flow
of editing the Plot</p>
</div>
@ -640,25 +774,37 @@ for us. From here, we start gardening.</p>
<pre class="lines">
22
23
24
25
26
27
28
29</pre>
67
68
69
70
71
72
73
74
75
76
77
78
79
80</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sapling/planter.rb', line 22</span>
<pre class="code"><span class="info file"># File 'lib/sapling/planter.rb', line 67</span>
<span class='kw'>def</span> <span class='id identifier rubyid_plant'>plant</span>
<span class='ivar'>@plot</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Plot.html" title="Planter::Plot (class)">Plot</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
<span class='ivar'>@plot</span><span class='period'>.</span><span class='id identifier rubyid_tree'>tree</span> <span class='op'>=</span> <span class='ivar'>@file</span>
<span class='ivar'>@plot</span><span class='period'>.</span><span class='id identifier rubyid_trunk'>trunk</span> <span class='op'>=</span> <span class='ivar'>@file</span><span class='period'>.</span><span class='id identifier rubyid_shift'>shift</span><span class='period'>.</span><span class='id identifier rubyid_values'>values</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span>
<span class='ivar'>@plot</span><span class='period'>.</span><span class='id identifier rubyid_trunk'>trunk</span> <span class='op'>=</span> <span class='ivar'>@file</span><span class='period'>.</span><span class='id identifier rubyid_shift'>shift</span>
<span class='ivar'>@plot</span><span class='period'>.</span><span class='id identifier rubyid_branches'>branches</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Gardner.html" title="Gardner (module)">Gardner</a></span></span><span class='period'>.</span><span class='id identifier rubyid_prune_branches'><span class='object_link'><a href="../Gardner.html#prune_branches-class_method" title="Gardner.prune_branches (method)">prune_branches</a></span></span><span class='lparen'>(</span><span class='ivar'>@file</span><span class='rparen'>)</span>
<span class='id identifier rubyid_dig'>dig</span><span class='lparen'>(</span><span class='int'>1</span><span class='rparen'>)</span>
<span class='id identifier rubyid_next_branch'>next_branch</span> <span class='op'>=</span> <span class='id identifier rubyid_dig'>dig</span><span class='lparen'>(</span><span class='int'>1</span><span class='rparen'>)</span>
<span class='kw'>until</span> <span class='id identifier rubyid_next_branch'>next_branch</span> <span class='op'>==</span> <span class='int'>0</span> <span class='kw'>do</span>
<span class='id identifier rubyid_next_branch'>next_branch</span> <span class='op'>=</span> <span class='id identifier rubyid_dig'>dig</span><span class='lparen'>(</span><span class='id identifier rubyid_next_branch'>next_branch</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='ivar'>@plot</span><span class='period'>.</span><span class='id identifier rubyid_branches'>branches</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>desc</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_exit'>exit</span>
<span class='kw'>end</span></pre>
</td>
</tr>
@ -670,9 +816,9 @@ for us. From here, we start gardening.</p>
</div>
<div id="footer">
Generated on Sun May 7 16:58:49 2017 by
Generated on Sat Oct 14 23:40:01 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.9 (ruby-2.2.5).
0.9.9 (ruby-2.4.2).
</div>
</div>

285
doc/Sapling.html
View file

@ -4,7 +4,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Sapling
Class: Sapling
&mdash; Sapling Documentation
@ -59,13 +59,31 @@
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Sapling
<div id="content"><h1>Class: Sapling
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Thor</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Thor</li>
<li class="next">Sapling</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
@ -86,8 +104,7 @@
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Sapling is the main module for the program. From here, the rest of the
world starts building.</p>
<p>The main Sapling interface.</p>
</div>
@ -95,31 +112,275 @@ world starts building.</p>
<div class="tags">
</div><h2>Defined Under Namespace</h2>
<p class="children">
</div>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#edit-instance_method" title="#edit (instance method)">#<strong>edit</strong>(tree = &#39;&#39;) &#x21d2; Object </a>
</span>
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Sapling/CLI.html" title="Sapling::CLI (class)">CLI</a></span>
</p>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#export-instance_method" title="#export (instance method)">#<strong>export</strong>(tree) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#read-instance_method" title="#read (instance method)">#<strong>read</strong>(tree) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#serve-instance_method" title="#serve (instance method)">#<strong>serve</strong>(tree) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="edit-instance_method">
#<strong>edit</strong>(tree = &#39;&#39;) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
19
20
21
22
23
24
25
26
27
28
29
30</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sapling.rb', line 19</span>
<span class='kw'>def</span> <span class='id identifier rubyid_edit'>edit</span><span class='lparen'>(</span><span class='id identifier rubyid_tree'>tree</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Welcome to Sapling, a Dialogue Tree Utility.</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_tree'>tree</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Loading tree: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_tree'>tree</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_exit'>exit</span> <span class='kw'>unless</span> <span class='id identifier rubyid_verify_tree'><span class='object_link'><a href="top-level-namespace.html#verify_tree-instance_method" title="#verify_tree (method)">verify_tree</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_tree'>tree</span><span class='rparen'>)</span>
<span class='id identifier rubyid_gardner'>gardner</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Planter.html" title="Planter (module)">Planter</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Planter/Spade.html" title="Planter::Spade (class)">Spade</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Planter/Spade.html#initialize-instance_method" title="Planter::Spade#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='const'>YAML</span><span class='period'>.</span><span class='id identifier rubyid_load_file'>load_file</span><span class='lparen'>(</span><span class='id identifier rubyid_tree'>tree</span><span class='comma'>,</span> <span class='kw'>false</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Creating a new tree!</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_gardner'>gardner</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Planter.html" title="Planter (module)">Planter</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Planter/Spade.html" title="Planter::Spade (class)">Spade</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Planter/Spade.html#initialize-instance_method" title="Planter::Spade#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="top-level-namespace.html#SKELETON_TREE-constant" title="SKELETON_TREE (constant)">SKELETON_TREE</a></span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_gardner'>gardner</span><span class='period'>.</span><span class='id identifier rubyid_plant'>plant</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="export-instance_method">
#<strong>export</strong>(tree) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
39
40
41
42</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sapling.rb', line 39</span>
<span class='kw'>def</span> <span class='id identifier rubyid_export'>export</span><span class='lparen'>(</span><span class='id identifier rubyid_tree'>tree</span><span class='rparen'>)</span>
<span class='id identifier rubyid_exit'>exit</span> <span class='kw'>unless</span> <span class='id identifier rubyid_verify_tree'><span class='object_link'><a href="top-level-namespace.html#verify_tree-instance_method" title="#verify_tree (method)">verify_tree</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_tree'>tree</span><span class='rparen'>)</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Cool feature, bro!</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="read-instance_method">
#<strong>read</strong>(tree) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
11
12
13
14
15
16</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sapling.rb', line 11</span>
<span class='kw'>def</span> <span class='id identifier rubyid_read'>read</span><span class='lparen'>(</span><span class='id identifier rubyid_tree'>tree</span><span class='rparen'>)</span>
<span class='id identifier rubyid_exit'>exit</span> <span class='kw'>unless</span> <span class='id identifier rubyid_verify_tree'><span class='object_link'><a href="top-level-namespace.html#verify_tree-instance_method" title="#verify_tree (method)">verify_tree</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_tree'>tree</span><span class='rparen'>)</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Welcome to Sapling, a Dialogue Tree Utility.</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_speaker'>speaker</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Dialogue.html" title="Dialogue (module)">Dialogue</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Dialogue/Speaker.html" title="Dialogue::Speaker (class)">Speaker</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Dialogue/Speaker.html#initialize-instance_method" title="Dialogue::Speaker#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='const'>YAML</span><span class='period'>.</span><span class='id identifier rubyid_load_file'>load_file</span><span class='lparen'>(</span><span class='id identifier rubyid_tree'>tree</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='kw'>false</span><span class='rparen'>)</span>
<span class='id identifier rubyid_speaker'>speaker</span><span class='period'>.</span><span class='id identifier rubyid_conversation'>conversation</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="serve-instance_method">
#<strong>serve</strong>(tree) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
33
34
35
36</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sapling.rb', line 33</span>
<span class='kw'>def</span> <span class='id identifier rubyid_serve'>serve</span><span class='lparen'>(</span><span class='id identifier rubyid_tree'>tree</span><span class='rparen'>)</span>
<span class='id identifier rubyid_exit'>exit</span> <span class='kw'>unless</span> <span class='id identifier rubyid_verify_tree'><span class='object_link'><a href="top-level-namespace.html#verify_tree-instance_method" title="#verify_tree (method)">verify_tree</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_tree'>tree</span><span class='rparen'>)</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Sinatra will be cool.</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun May 7 16:58:49 2017 by
Generated on Sat Oct 14 23:40:01 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.9 (ruby-2.2.5).
0.9.9 (ruby-2.4.2).
</div>
</div>

21
doc/_index.html
View file

@ -93,21 +93,6 @@
<td valign='top' width="33%">
<ul id="alpha_C" class="alpha">
<li class="letter">C</li>
<ul>
<li>
<span class='object_link'><a href="Sapling/CLI.html" title="Sapling::CLI (class)">CLI</a></span>
<small>(Sapling)</small>
</li>
</ul>
</ul>
<ul id="alpha_D" class="alpha">
<li class="letter">D</li>
<ul>
@ -159,7 +144,7 @@
<ul>
<li>
<span class='object_link'><a href="Sapling.html" title="Sapling (module)">Sapling</a></span>
<span class='object_link'><a href="Sapling.html" title="Sapling (class)">Sapling</a></span>
</li>
@ -189,9 +174,9 @@
</div>
<div id="footer">
Generated on Sun May 7 16:58:49 2017 by
Generated on Sat Oct 14 23:40:01 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.9 (ruby-2.2.5).
0.9.9 (ruby-2.4.2).
</div>
</div>

2
doc/class_list.html
View file

@ -43,7 +43,7 @@
<ul id="full_list" class="class">
<li id="object_" class="odd"><div class="item" style="padding-left:30px"><span class='object_link'><a href="top-level-namespace.html" title="Top Level Namespace (root)">Top Level Namespace</a></span></div></li>
<li id='object_Dialogue' class='even'><div class='item' style='padding-left:30px'><a class='toggle'></a> <span class='object_link'><a href="Dialogue.html" title="Dialogue (module)">Dialogue</a></span><small class='search_info'>Top Level Namespace</small></div><ul><li id='object_Dialogue::Speaker' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Dialogue/Speaker.html" title="Dialogue::Speaker (class)">Speaker</a></span> &lt; Object<small class='search_info'>Dialogue</small></div></li></ul></li><li id='object_Gardner' class='even'><div class='item' style='padding-left:30px'><span class='object_link'><a href="Gardner.html" title="Gardner (module)">Gardner</a></span><small class='search_info'>Top Level Namespace</small></div></li><li id='object_Planter' class='odd'><div class='item' style='padding-left:30px'><a class='toggle'></a> <span class='object_link'><a href="Planter.html" title="Planter (module)">Planter</a></span><small class='search_info'>Top Level Namespace</small></div><ul><li id='object_Planter::Plot' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Planter/Plot.html" title="Planter::Plot (class)">Plot</a></span> &lt; Object<small class='search_info'>Planter</small></div></li><li id='object_Planter::Spade' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Planter/Spade.html" title="Planter::Spade (class)">Spade</a></span> &lt; Object<small class='search_info'>Planter</small></div></li></ul></li><li id='object_Sapling' class='even'><div class='item' style='padding-left:30px'><a class='toggle'></a> <span class='object_link'><a href="Sapling.html" title="Sapling (module)">Sapling</a></span><small class='search_info'>Top Level Namespace</small></div><ul><li id='object_Sapling::CLI' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Sapling/CLI.html" title="Sapling::CLI (class)">CLI</a></span> &lt; Object<small class='search_info'>Sapling</small></div></li></ul></li>
<li id='object_Dialogue' class='even'><div class='item' style='padding-left:30px'><a class='toggle'></a> <span class='object_link'><a href="Dialogue.html" title="Dialogue (module)">Dialogue</a></span><small class='search_info'>Top Level Namespace</small></div><ul><li id='object_Dialogue::Speaker' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Dialogue/Speaker.html" title="Dialogue::Speaker (class)">Speaker</a></span> &lt; Object<small class='search_info'>Dialogue</small></div></li></ul></li><li id='object_Gardner' class='even'><div class='item' style='padding-left:30px'><span class='object_link'><a href="Gardner.html" title="Gardner (module)">Gardner</a></span><small class='search_info'>Top Level Namespace</small></div></li><li id='object_Planter' class='odd'><div class='item' style='padding-left:30px'><a class='toggle'></a> <span class='object_link'><a href="Planter.html" title="Planter (module)">Planter</a></span><small class='search_info'>Top Level Namespace</small></div><ul><li id='object_Planter::Plot' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Planter/Plot.html" title="Planter::Plot (class)">Plot</a></span> &lt; Object<small class='search_info'>Planter</small></div></li><li id='object_Planter::Spade' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Planter/Spade.html" title="Planter::Spade (class)">Spade</a></span> &lt; Object<small class='search_info'>Planter</small></div></li></ul></li><li id='object_Sapling' class='even'><div class='item' style='padding-left:30px'><span class='object_link'><a href="Sapling.html" title="Sapling (class)">Sapling</a></span> &lt; Thor<small class='search_info'>Top Level Namespace</small></div></li>
</ul>
</div>

4
doc/file.CONTRIBUTING.html
View file

@ -74,9 +74,9 @@ feel free to submit an issue or reach out to me directly.</p>
</div></div>
<div id="footer">
Generated on Sun May 7 16:58:49 2017 by
Generated on Sat Oct 14 23:40:01 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.9 (ruby-2.2.5).
0.9.9 (ruby-2.4.2).
</div>
</div>

4
doc/file.LICENSE.html
View file

@ -82,9 +82,9 @@ DEALINGS IN THE SOFTWARE.</p>
</div></div>
<div id="footer">
Generated on Sun May 7 16:58:49 2017 by
Generated on Sat Oct 14 23:40:01 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.9 (ruby-2.2.5).
0.9.9 (ruby-2.4.2).
</div>
</div>

36
doc/file.README.html
View file

@ -59,6 +59,10 @@
<div id="content"><div id='filecontents'><h1>Sapling: A Dialogue Tree CLI Utility</h1>
<p><a href="https://badge.fury.io/rb/sapling-dialogue"><img src="https://badge.fury.io/rb/sapling-dialogue.svg" alt="Gem
Version"></a> <a href="https://travis-ci.org/VagabondAzulien/sapling"><img src="https://travis-ci.org/VagabondAzulien/sapling.svg?branch=master" alt="Build
Status"></a></p>
<p>Sapling allows for easy creation and use of dialogue trees.</p>
<p>A dialogue tree is a series of dialogues which follow sequentially, though with
@ -75,25 +79,25 @@ branch represents a choice taken in the dialogue. Branches flow to each other
through leafs, which are the actual choices.</p>
<p>You can experience this yourself, by loading &quot;Example Quest! - A Meta Dialogue
Tree!&quot;. You can find the tree itself at <a href="var/trees/example_quest.yaml">trees/example_quest.yaml</a>. To run it, just type <code>sapling -t
trees/example_quest.yaml</code>.</p>
Tree!&quot;. You can find the tree itself at <a href="https://github.com/VagabondAzulien/sapling/blob/master/var/trees/example_quest.yaml">var/trees/example_quest.yaml</a>.
To run it, just type <code>sapling read path/to/example_quest.yaml</code>.</p>
<h2>Building a New Tree</h2>
<p>To build a new tree, you have two options. You can manually edit a configuration
file, or go through the construction wizard. Either way, the end result is a
plain-text configuration file, which can be easily shared, edited, and viewed.
For more details on the configuration file itself, check out the <a href="var/docs/config_file.md">Configuration
File documentation</a>, or the self-documented
<a href="var/docs/config_file_example.yaml">configuration file example</a>. Alternatively,
you can checkout <a href="var/trees/example_quest.yaml">Example Quest</a> for a complete
tree.</p>
For more details on the configuration file itself, check out the <a href="http://www.theinternetvagabond.com/sapling/file.config_file.html">Configuration
File documentation</a>, or the
self-documented <a href="http://www.theinternetvagabond.com/sapling/file.config_file_example.html">configuration file example</a>.
Alternatively, you can checkout <a href="https://github.com/VagabondAzulien/sapling/blob/master/var/trees/example_quest.yaml">Example Quest</a>
for a complete tree.</p>
<h3>Manual Edit</h3>
<ol>
<li>Open your preferred text editor.</li>
<li>Refer to the <a href="var/docs/config_file.md">Configuration File documentation</a></li>
<li>Refer to the <a href="http://www.theinternetvagabond.com/sapling/file.config_file.html">Configuration File documentation</a></li>
<li>Make your changes.</li>
<li>Save your changes.</li>
</ol>
@ -101,16 +105,16 @@ tree.</p>
<h3>Automatic Edit -- Coming Soon(tm)!</h3>
<ol>
<li>Run the configuration editor: <code>sapling --edit [--new][--file FILE]</code></li>
<li>If you choose to create a new dialogue, <code>sapling</code> will generate a new file in
your current directory.</li>
<li>Run the configuration editor: <code>sapling edit [TREE]</code></li>
<li>If you don&#39;t include a TREE, <code>sapling</code> will create a new tree in the current
directory.</li>
<li>If you choose to modify an existing file, <code>sapling</code> will open the tree at the
trunk, and show you the first branch.</li>
<li>Make your changes.</li>
<li>Save your changes.</li>
</ol>
<p>More details on the editor can be found in the <a href="var/docs/editor.md">Editor
<p>More details on the editor can be found in the <a href="http://www.theinternetvagabond.com/sapling/file.editor.html">Editor
documentation</a>.</p>
<h2>Contributing</h2>
@ -120,7 +124,7 @@ documentation</a>.</p>
<ol>
<li>Fork this repository.</li>
<li>In your fork, make your changes.</li>
<li>Make sure your changes respect the <a href="CONTRIBUTING.md">contribution
<li>Make sure your changes respect the <a href="http://www.theinternetvagabond.com/sapling/file.CONTRIBUTING.html">contribution
guidelines</a>.</li>
<li>Submit a pull request.</li>
</ol>
@ -128,13 +132,13 @@ guidelines</a>.</li>
<h2>License</h2>
<p>Sapling is licensed under the MIT license. The full text can be found in
<a href="LICENSE">LICENSE</a>.</p>
<a href="http://www.theinternetvagabond.com/sapling/file.LICENSE.html">LICENSE</a>.</p>
</div></div>
<div id="footer">
Generated on Sun May 7 16:58:49 2017 by
Generated on Sat Oct 14 23:40:01 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.9 (ruby-2.2.5).
0.9.9 (ruby-2.4.2).
</div>
</div>

4
doc/file.config_file.html
View file

@ -126,9 +126,9 @@ branch&quot;, and the program will end after reaching it.</li>
</div></div>
<div id="footer">
Generated on Sun May 7 16:58:49 2017 by
Generated on Sat Oct 14 23:40:01 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.9 (ruby-2.2.5).
0.9.9 (ruby-2.4.2).
</div>
</div>

4
doc/file.config_file_example.html
View file

@ -100,9 +100,9 @@
</div></div>
<div id="footer">
Generated on Sun May 7 16:58:49 2017 by
Generated on Sat Oct 14 23:40:01 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.9 (ruby-2.2.5).
0.9.9 (ruby-2.4.2).
</div>
</div>

4
doc/file.editor.html
View file

@ -72,9 +72,9 @@ allows for editing all parts of a tree, from the trunk to the leaves.</p>
</div></div>
<div id="footer">
Generated on Sun May 7 16:58:49 2017 by
Generated on Sat Oct 14 23:40:01 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.9 (ruby-2.2.5).
0.9.9 (ruby-2.4.2).
</div>
</div>

36
doc/index.html
View file

@ -59,6 +59,10 @@
<div id="content"><div id='filecontents'><h1>Sapling: A Dialogue Tree CLI Utility</h1>
<p><a href="https://badge.fury.io/rb/sapling-dialogue"><img src="https://badge.fury.io/rb/sapling-dialogue.svg" alt="Gem
Version"></a> <a href="https://travis-ci.org/VagabondAzulien/sapling"><img src="https://travis-ci.org/VagabondAzulien/sapling.svg?branch=master" alt="Build
Status"></a></p>
<p>Sapling allows for easy creation and use of dialogue trees.</p>
<p>A dialogue tree is a series of dialogues which follow sequentially, though with
@ -75,25 +79,25 @@ branch represents a choice taken in the dialogue. Branches flow to each other
through leafs, which are the actual choices.</p>
<p>You can experience this yourself, by loading &quot;Example Quest! - A Meta Dialogue
Tree!&quot;. You can find the tree itself at <a href="var/trees/example_quest.yaml">trees/example_quest.yaml</a>. To run it, just type <code>sapling -t
trees/example_quest.yaml</code>.</p>
Tree!&quot;. You can find the tree itself at <a href="https://github.com/VagabondAzulien/sapling/blob/master/var/trees/example_quest.yaml">var/trees/example_quest.yaml</a>.
To run it, just type <code>sapling read path/to/example_quest.yaml</code>.</p>
<h2>Building a New Tree</h2>
<p>To build a new tree, you have two options. You can manually edit a configuration
file, or go through the construction wizard. Either way, the end result is a
plain-text configuration file, which can be easily shared, edited, and viewed.
For more details on the configuration file itself, check out the <a href="var/docs/config_file.md">Configuration
File documentation</a>, or the self-documented
<a href="var/docs/config_file_example.yaml">configuration file example</a>. Alternatively,
you can checkout <a href="var/trees/example_quest.yaml">Example Quest</a> for a complete
tree.</p>
For more details on the configuration file itself, check out the <a href="http://www.theinternetvagabond.com/sapling/file.config_file.html">Configuration
File documentation</a>, or the
self-documented <a href="http://www.theinternetvagabond.com/sapling/file.config_file_example.html">configuration file example</a>.
Alternatively, you can checkout <a href="https://github.com/VagabondAzulien/sapling/blob/master/var/trees/example_quest.yaml">Example Quest</a>
for a complete tree.</p>
<h3>Manual Edit</h3>
<ol>
<li>Open your preferred text editor.</li>
<li>Refer to the <a href="var/docs/config_file.md">Configuration File documentation</a></li>
<li>Refer to the <a href="http://www.theinternetvagabond.com/sapling/file.config_file.html">Configuration File documentation</a></li>
<li>Make your changes.</li>
<li>Save your changes.</li>
</ol>
@ -101,16 +105,16 @@ tree.</p>
<h3>Automatic Edit -- Coming Soon(tm)!</h3>
<ol>
<li>Run the configuration editor: <code>sapling --edit [--new][--file FILE]</code></li>
<li>If you choose to create a new dialogue, <code>sapling</code> will generate a new file in
your current directory.</li>
<li>Run the configuration editor: <code>sapling edit [TREE]</code></li>
<li>If you don&#39;t include a TREE, <code>sapling</code> will create a new tree in the current
directory.</li>
<li>If you choose to modify an existing file, <code>sapling</code> will open the tree at the
trunk, and show you the first branch.</li>
<li>Make your changes.</li>
<li>Save your changes.</li>
</ol>
<p>More details on the editor can be found in the <a href="var/docs/editor.md">Editor
<p>More details on the editor can be found in the <a href="http://www.theinternetvagabond.com/sapling/file.editor.html">Editor
documentation</a>.</p>
<h2>Contributing</h2>
@ -120,7 +124,7 @@ documentation</a>.</p>
<ol>
<li>Fork this repository.</li>
<li>In your fork, make your changes.</li>
<li>Make sure your changes respect the <a href="CONTRIBUTING.md">contribution
<li>Make sure your changes respect the <a href="http://www.theinternetvagabond.com/sapling/file.CONTRIBUTING.html">contribution
guidelines</a>.</li>
<li>Submit a pull request.</li>
</ol>
@ -128,13 +132,13 @@ guidelines</a>.</li>
<h2>License</h2>
<p>Sapling is licensed under the MIT license. The full text can be found in
<a href="LICENSE">LICENSE</a>.</p>
<a href="http://www.theinternetvagabond.com/sapling/file.LICENSE.html">LICENSE</a>.</p>
</div></div>
<div id="footer">
Generated on Sun May 7 16:58:49 2017 by
Generated on Sat Oct 14 23:40:01 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.9 (ruby-2.2.5).
0.9.9 (ruby-2.4.2).
</div>
</div>

94
doc/method_list.html
View file

@ -78,24 +78,56 @@
<li class="odd ">
<div class="item">
<span class='object_link'><a href="Planter/Spade.html#edit_branch-instance_method" title="Planter::Spade#edit_branch (method)">#edit_branch</a></span>
<small>Planter::Spade</small>
<span class='object_link'><a href="Dialogue.html#display_branch-class_method" title="Dialogue.display_branch (method)">display_branch</a></span>
<small>Dialogue</small>
</div>
</li>
<li class="even ">
<div class="item">
<span class='object_link'><a href="Planter/Spade.html#edit_leaf-instance_method" title="Planter::Spade#edit_leaf (method)">#edit_leaf</a></span>
<small>Planter::Spade</small>
<span class='object_link'><a href="Dialogue.html#display_trunk-class_method" title="Dialogue.display_trunk (method)">display_trunk</a></span>
<small>Dialogue</small>
</div>
</li>
<li class="odd ">
<div class="item">
<span class='object_link'><a href="Planter/Spade.html#edit_trunk-instance_method" title="Planter::Spade#edit_trunk (method)">#edit_trunk</a></span>
<small>Planter::Spade</small>
<span class='object_link'><a href="Sapling.html#edit-instance_method" title="Sapling#edit (method)">#edit</a></span>
<small>Sapling</small>
</div>
</li>
<li class="even ">
<div class="item">
<span class='object_link'><a href="Planter/Plot.html#edit_branch-instance_method" title="Planter::Plot#edit_branch (method)">#edit_branch</a></span>
<small>Planter::Plot</small>
</div>
</li>
<li class="odd ">
<div class="item">
<span class='object_link'><a href="Planter/Plot.html#edit_leaf-instance_method" title="Planter::Plot#edit_leaf (method)">#edit_leaf</a></span>
<small>Planter::Plot</small>
</div>
</li>
<li class="even ">
<div class="item">
<span class='object_link'><a href="Planter/Plot.html#edit_trunk-instance_method" title="Planter::Plot#edit_trunk (method)">#edit_trunk</a></span>
<small>Planter::Plot</small>
</div>
</li>
<li class="odd ">
<div class="item">
<span class='object_link'><a href="Sapling.html#export-instance_method" title="Sapling#export (method)">#export</a></span>
<small>Sapling</small>
</div>
</li>
@ -110,8 +142,24 @@
<li class="odd ">
<div class="item">
<span class='object_link'><a href="Gardner.html#grow-class_method" title="Gardner.grow (method)">grow</a></span>
<small>Gardner</small>
<span class='object_link'><a href="Planter/Spade.html#get_response-instance_method" title="Planter::Spade#get_response (method)">#get_response</a></span>
<small>Planter::Spade</small>
</div>
</li>
<li class="even ">
<div class="item">
<span class='object_link'><a href="Dialogue/Speaker.html#get_response-instance_method" title="Dialogue::Speaker#get_response (method)">#get_response</a></span>
<small>Dialogue::Speaker</small>
</div>
</li>
<li class="odd ">
<div class="item">
<span class='object_link'><a href="Planter/Spade.html#initialize-instance_method" title="Planter::Spade#initialize (method)">#initialize</a></span>
<small>Planter::Spade</small>
</div>
</li>
@ -126,7 +174,7 @@
<li class="odd ">
<div class="item">
<span class='object_link'><a href="Planter/Spade.html#plant-instance_method" title="Planter::Spade#plant (method)">#plant</a></span>
<span class='object_link'><a href="Planter/Spade.html#parse_response-instance_method" title="Planter::Spade#parse_response (method)">#parse_response</a></span>
<small>Planter::Spade</small>
</div>
</li>
@ -134,15 +182,15 @@
<li class="even ">
<div class="item">
<span class='object_link'><a href="Gardner.html#prune_branches-class_method" title="Gardner.prune_branches (method)">prune_branches</a></span>
<small>Gardner</small>
<span class='object_link'><a href="Planter/Spade.html#plant-instance_method" title="Planter::Spade#plant (method)">#plant</a></span>
<small>Planter::Spade</small>
</div>
</li>
<li class="odd ">
<div class="item">
<span class='object_link'><a href="Gardner.html#prune_leaves-class_method" title="Gardner.prune_leaves (method)">prune_leaves</a></span>
<span class='object_link'><a href="Gardner.html#prune_branches-class_method" title="Gardner.prune_branches (method)">prune_branches</a></span>
<small>Gardner</small>
</div>
</li>
@ -150,7 +198,7 @@
<li class="even ">
<div class="item">
<span class='object_link'><a href="Gardner.html#prune_trunk-class_method" title="Gardner.prune_trunk (method)">prune_trunk</a></span>
<span class='object_link'><a href="Gardner.html#prune_leaves-class_method" title="Gardner.prune_leaves (method)">prune_leaves</a></span>
<small>Gardner</small>
</div>
</li>
@ -158,8 +206,24 @@
<li class="odd ">
<div class="item">
<span class='object_link'><a href="Sapling/CLI.html#talk-instance_method" title="Sapling::CLI#talk (method)">#talk</a></span>
<small>Sapling::CLI</small>
<span class='object_link'><a href="Gardner.html#prune_trunk-class_method" title="Gardner.prune_trunk (method)">prune_trunk</a></span>
<small>Gardner</small>
</div>
</li>
<li class="even ">
<div class="item">
<span class='object_link'><a href="Sapling.html#read-instance_method" title="Sapling#read (method)">#read</a></span>
<small>Sapling</small>
</div>
</li>
<li class="odd ">
<div class="item">
<span class='object_link'><a href="Sapling.html#serve-instance_method" title="Sapling#serve (method)">#serve</a></span>
<small>Sapling</small>
</div>
</li>

12
doc/top-level-namespace.html
View file

@ -82,10 +82,12 @@
<p class="children">
<strong class="modules">Modules:</strong> <span class='object_link'><a href="Dialogue.html" title="Dialogue (module)">Dialogue</a></span>, <span class='object_link'><a href="Gardner.html" title="Gardner (module)">Gardner</a></span>, <span class='object_link'><a href="Planter.html" title="Planter (module)">Planter</a></span>, <span class='object_link'><a href="Sapling.html" title="Sapling (module)">Sapling</a></span>
<strong class="modules">Modules:</strong> <span class='object_link'><a href="Dialogue.html" title="Dialogue (module)">Dialogue</a></span>, <span class='object_link'><a href="Gardner.html" title="Gardner (module)">Gardner</a></span>, <span class='object_link'><a href="Planter.html" title="Planter (module)">Planter</a></span>
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Sapling.html" title="Sapling (class)">Sapling</a></span>
</p>
@ -301,8 +303,7 @@ can point to branch 0 to immediately exit.</span><span class='tstring_end'>&quot
55
56
57
58
59</pre>
58</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sapling/utility.rb', line 43</span>
@ -322,7 +323,6 @@ can point to branch 0 to immediately exit.</span><span class='tstring_end'>&quot
<span class='kw'>end</span>
<span class='id identifier rubyid_results'>results</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='kw'>false</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='kw'>false</span> <span class='op'>:</span> <span class='kw'>true</span>
<span class='kw'>end</span></pre>
</td>
</tr>
@ -334,9 +334,9 @@ can point to branch 0 to immediately exit.</span><span class='tstring_end'>&quot
</div>
<div id="footer">
Generated on Sun May 7 16:58:49 2017 by
Generated on Sat Oct 14 23:40:01 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.9 (ruby-2.2.5).
0.9.9 (ruby-2.4.2).
</div>
</div>