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

Update documentation

Browse source
This commit is contained in:
Bill Niblock 2017-05-07 16:59:34 -04:00
parent d0b25e210c
commit 8d2da5c6c6
19 changed files with 1657 additions and 310 deletions
Download patch file Download diff file Expand all files Collapse all files

141
doc/Sapling/CLI.html
View file

@ -102,7 +102,8 @@
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>CLI is the class for option parsing, and the gateway to the program</p>
<p>CLI is the class for option parsing, and the gateway to the program, on the
command line</p>
</div>
@ -186,50 +187,71 @@ editing/creating a tree.</p>
<pre class="lines">
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219</pre>
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
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
70
71
72
73
74
75
76
77
78
79
80
81
82</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sapling.rb', line 179</span>
<pre class="code"><span class="info file"># File 'lib/sapling.rb', line 21</span>
<span class='kw'>def</span> <span class='id identifier rubyid_talk'>talk</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
<span class='id identifier rubyid_opt_parser'>opt_parser</span> <span class='op'>=</span> <span class='const'>OptionParser</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_opt'>opt</span><span class='op'>|</span>
@ -245,29 +267,50 @@ editing/creating a tree.</p>
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Begin traversing the provided dialogue tree</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='kw'>do</span>
<span class='kw'>if</span> <span class='const'>ARGV</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'>No tree file provided. Please provide a tree file.</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_opt_parser'>opt_parser</span>
<span class='id identifier rubyid_exit'>exit</span>
<span class='kw'>end</span>
<span class='kw'>unless</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_verify_tree'><span class='object_link'><a href="../Gardner.html#verify_tree-class_method" title="Gardner.verify_tree (method)">verify_tree</a></span></span><span class='lparen'>(</span><span class='const'>ARGV</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rparen'>)</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='const'>ARGV</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</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_opt'>opt</span><span class='embexpr_end'>}</span><span class='tstring_content'>\n</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_exit'>exit</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'>Welcome to Sapling, a Dialogue Tree Utility.\n</span><span class='tstring_end'>&quot;</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='id identifier rubyid_speaker'>speaker</span><span class='period'>.</span><span class='id identifier rubyid_file'>file</span> <span class='op'>=</span> <span class='const'>ARGV</span>
<span class='id identifier rubyid_speaker'>speaker</span><span class='period'>.</span><span class='id identifier rubyid_file'>file</span> <span class='op'>=</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='const'>ARGV</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</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>
<span class='id identifier rubyid_opt'>opt</span><span class='period'>.</span><span class='id identifier rubyid_on'>on</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>-e</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'>--edit</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'>Create or edit a dialogue tree</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</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'>We gonna make a tree!</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>if</span> <span class='const'>ARGV</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'>Creating a new tree.</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_tree'>tree</span> <span class='op'>=</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='kw'>else</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Using tree at </span><span class='embexpr_beg'>#{</span><span class='const'>ARGV</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'>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='const'>ARGV</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</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_opt'>opt</span><span class='embexpr_end'>}</span><span class='tstring_content'>\n</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_exit'>exit</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_tree'>tree</span> <span class='op'>=</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='const'>ARGV</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</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'>Welcome to Sapling, a Dialogue Tree Utility.\n</span><span class='tstring_end'>&quot;</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'>new</span>
<span class='id identifier rubyid_gardner'>gardner</span><span class='period'>.</span><span class='id identifier rubyid_file'>file</span> <span class='op'>=</span> <span class='id identifier rubyid_tree'>tree</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>
<span class='kw'>end</span>
<span class='id identifier rubyid_opt_parser'>opt_parser</span><span class='period'>.</span><span class='id identifier rubyid_parse!'>parse!</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='const'>ARGV</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
<span class='comment'># Hacky way of dealing with bad options
</span> <span class='kw'>begin</span>
<span class='id identifier rubyid_opt_parser'>opt_parser</span><span class='period'>.</span><span class='id identifier rubyid_parse!'>parse!</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
<span class='kw'>rescue</span> <span class='const'>OptionParser</span><span class='op'>::</span><span class='const'>InvalidOption</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Invalid option.</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_opt_parser'>opt_parser</span>
<span class='id identifier rubyid_exit'>exit</span>
<span class='kw'>end</span>
@ -282,7 +325,7 @@ editing/creating a tree.</p>
</div>
<div id="footer">
Generated on Sat May 6 18:16:02 2017 by
Generated on Sun May 7 16:58:49 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.9 (ruby-2.2.5).
</div>