hookapp 2.0.3 → 2.0.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (59) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +1 -0
  3. data/AUTHORS.md +4 -0
  4. data/CHANGELOG.md +5 -0
  5. data/Gemfile.lock +49 -66
  6. data/LICENSE +21 -0
  7. data/README.md +52 -19
  8. data/Rakefile +7 -3
  9. data/bin/hook +114 -78
  10. data/buildnotes.md +30 -0
  11. data/hook.rdoc +35 -11
  12. data/hookapp.gemspec +2 -2
  13. data/html/App.html +6 -18
  14. data/html/GLI/Commands/Doc.html +2 -10
  15. data/html/GLI/Commands/MarkdownDocumentListener.html +34 -230
  16. data/html/GLI/Commands.html +2 -10
  17. data/html/GLI.html +2 -10
  18. data/html/Hook.html +2 -15
  19. data/html/HookApp.html +99 -319
  20. data/html/Hooker.html +46 -24
  21. data/html/README_rdoc.html +49 -23
  22. data/html/String.html +28 -120
  23. data/html/created.rid +8 -8
  24. data/html/css/rdoc.css +21 -1
  25. data/html/index.html +38 -29
  26. data/html/js/navigation.js.gz +0 -0
  27. data/html/js/search_index.js +1 -1
  28. data/html/js/search_index.js.gz +0 -0
  29. data/html/js/searcher.js.gz +0 -0
  30. data/html/table_of_contents.html +33 -77
  31. data/lib/helpers/fuzzyfilefinder +0 -0
  32. data/lib/hook/hookapp.rb +39 -21
  33. data/lib/hook/hooker.rb +5 -2
  34. data/lib/hook/markdown_document_listener.rb +12 -2
  35. data/lib/hook/string.rb +4 -0
  36. data/lib/hook/version.rb +1 -1
  37. data/lib/hook.rb +5 -4
  38. data/test/helpers/hook-helpers.rb +76 -0
  39. data/test/hook_clip_test.rb +24 -0
  40. data/test/hook_clone_test.rb +30 -0
  41. data/test/hook_encode_test.rb +30 -0
  42. data/test/hook_link_test.rb +39 -0
  43. data/test/hook_list_test.rb +25 -0
  44. data/test/hook_remove_test.rb +34 -0
  45. data/test/hook_scripts_test.rb +21 -0
  46. metadata +19 -22
  47. data/test/default_test.rb +0 -14
  48. data/test/hookfiles/01.test +0 -0
  49. data/test/hookfiles/02.test +0 -0
  50. data/test/hookfiles/03.test +0 -0
  51. data/test/hookfiles/04.test +0 -0
  52. data/test/hookfiles/05.test +0 -0
  53. data/test/hookfiles/06.test +0 -0
  54. data/test/hookfiles/07.test +0 -0
  55. data/test/hookfiles/08.test +0 -0
  56. data/test/hookfiles/09.test +0 -0
  57. data/test/hookfiles/10.test +0 -0
  58. data/test/hookfiles/11.test +0 -0
  59. data/test/hookfiles/12.test +0 -0
data/html/GLI/Commands/MarkdownDocumentListener.html CHANGED
@@ -21,8 +21,6 @@
21
21
  <link href="../../css/rdoc.css" rel="stylesheet">
22
22
 
23
23
 
24
-
25
-
26
24
  <body id="top" role="document" class="class">
27
25
  <nav role="navigation">
28
26
  <div id="project-navigation">
@@ -59,52 +57,36 @@
59
57
 
60
58
  <div id="class-metadata">
61
59
 
62
- <div id="parent-class-section" class="nav-section">
60
+
61
+ <div id="parent-class-section" class="nav-section">
63
62
  <h3>Parent</h3>
64
63
 
65
-
66
64
  <p class="link">Object
67
-
68
65
  </div>
69
66
 
70
67
 
71
68
 
72
- <!-- Method Quickref -->
69
+
70
+ <!-- Method Quickref -->
73
71
  <div id="method-list-section" class="nav-section">
74
72
  <h3>Methods</h3>
75
73
 
76
74
  <ul class="link-list" role="directory">
77
-
78
75
  <li ><a href="#method-c-new">::new</a>
79
-
80
76
  <li ><a href="#method-i-beginning">#beginning</a>
81
-
82
77
  <li ><a href="#method-i-command">#command</a>
83
-
84
78
  <li ><a href="#method-i-commands">#commands</a>
85
-
86
79
  <li ><a href="#method-i-default_command">#default_command</a>
87
-
88
80
  <li ><a href="#method-i-end_command">#end_command</a>
89
-
90
81
  <li ><a href="#method-i-end_commands">#end_commands</a>
91
-
92
82
  <li ><a href="#method-i-end_options">#end_options</a>
93
-
94
83
  <li ><a href="#method-i-ending">#ending</a>
95
-
96
84
  <li ><a href="#method-i-flag">#flag</a>
97
-
98
85
  <li ><a href="#method-i-options">#options</a>
99
-
100
86
  <li ><a href="#method-i-program_desc">#program_desc</a>
101
-
102
87
  <li ><a href="#method-i-program_long_desc">#program_long_desc</a>
103
-
104
88
  <li ><a href="#method-i-switch">#switch</a>
105
-
106
89
  <li ><a href="#method-i-version">#version</a>
107
-
108
90
  </ul>
109
91
  </div>
110
92
 
@@ -122,41 +104,27 @@
122
104
 
123
105
  </section>
124
106
 
125
-
126
107
  <section id="5Buntitled-5D" class="documentation-section">
127
-
128
108
 
129
-
130
109
 
131
-
132
110
 
133
-
134
111
 
135
-
112
+
136
113
  <section id="public-class-5Buntitled-5D-method-details" class="method-section">
137
114
  <header>
138
115
  <h3>Public Class Methods</h3>
139
116
  </header>
140
117
 
141
-
142
118
  <div id="method-c-new" class="method-detail ">
143
-
144
119
  <div class="method-heading">
145
120
  <span class="method-name">new</span><span
146
121
  class="method-args">(_global_options, _options, _arguments, app)</span>
147
-
148
122
  <span class="method-click-advice">click to toggle source</span>
149
-
150
123
  </div>
151
-
152
124
 
153
125
  <div class="method-description">
154
126
 
155
-
156
-
157
-
158
127
 
159
-
160
128
  <div class="method-source-code" id="new-source">
161
129
  <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 9</span>
162
130
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">_global_options</span>, <span class="ruby-identifier">_options</span>, <span class="ruby-identifier">_arguments</span>, <span class="ruby-identifier">app</span>)
@@ -168,80 +136,58 @@
168
136
  <span class="ruby-ivar">@io</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">&#39;README.md&#39;</span>, <span class="ruby-string">&#39;w&#39;</span>)
169
137
  <span class="ruby-ivar">@nest</span> = <span class="ruby-string">&#39;#&#39;</span>
170
138
  <span class="ruby-ivar">@arg_name_formatter</span> = <span class="ruby-constant">GLI</span><span class="ruby-operator">::</span><span class="ruby-constant">Commands</span><span class="ruby-operator">::</span><span class="ruby-constant">HelpModules</span><span class="ruby-operator">::</span><span class="ruby-constant">ArgNameFormatter</span>.<span class="ruby-identifier">new</span>
139
+ <span class="ruby-ivar">@parent_command</span> = []
171
140
  <span class="ruby-keyword">end</span></pre>
172
141
  </div>
173
-
174
142
  </div>
175
143
 
176
-
177
144
 
178
-
179
145
  </div>
180
146
 
181
-
182
147
  </section>
183
-
148
+
184
149
  <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
185
150
  <header>
186
151
  <h3>Public Instance Methods</h3>
187
152
  </header>
188
153
 
189
-
190
154
  <div id="method-i-beginning" class="method-detail ">
191
-
192
155
  <div class="method-heading">
193
156
  <span class="method-name">beginning</span><span
194
157
  class="method-args">()</span>
195
-
196
158
  <span class="method-click-advice">click to toggle source</span>
197
-
198
159
  </div>
199
-
200
160
 
201
161
  <div class="method-description">
202
162
 
203
-
204
-
205
-
206
163
 
207
-
208
164
  <div class="method-source-code" id="beginning-source">
209
- <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 20</span>
165
+ <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 21</span>
210
166
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">beginning</span>
211
167
  <span class="ruby-keyword">end</span></pre>
212
168
  </div>
213
-
214
169
  </div>
215
170
 
216
-
217
171
 
218
-
219
172
  </div>
220
173
 
221
-
222
174
  <div id="method-i-command" class="method-detail ">
223
-
224
175
  <div class="method-heading">
225
176
  <span class="method-name">command</span><span
226
177
  class="method-args">(name, aliases, desc, long_desc, arg_name, arg_options)</span>
227
-
228
178
  <span class="method-click-advice">click to toggle source</span>
229
-
230
179
  </div>
231
-
232
180
 
233
181
  <div class="method-description">
234
-
235
182
  <p>Gives you a command in the current context and creates a new context of this command</p>
236
-
237
-
238
183
 
239
-
240
184
  <div class="method-source-code" id="command-source">
241
- <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 111</span>
185
+ <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 118</span>
242
186
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">command</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">aliases</span>, <span class="ruby-identifier">desc</span>, <span class="ruby-identifier">long_desc</span>, <span class="ruby-identifier">arg_name</span>, <span class="ruby-identifier">arg_options</span>)
187
+ <span class="ruby-ivar">@parent_command</span>.<span class="ruby-identifier">push</span> ([<span class="ruby-identifier">name</span>] <span class="ruby-operator">+</span> <span class="ruby-identifier">aliases</span>).<span class="ruby-identifier">join</span>(<span class="ruby-string">&#39;|&#39;</span>)
243
188
  <span class="ruby-identifier">arg_name_fmt</span> = <span class="ruby-ivar">@arg_name_formatter</span>.<span class="ruby-identifier">format</span>(<span class="ruby-identifier">arg_name</span>, <span class="ruby-identifier">arg_options</span>, [])
244
- <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">header</span>(<span class="ruby-node">&quot;`$ #{@exe}` &lt;mark&gt;`#{([name] + aliases).join(&#39;|&#39;)}`&lt;/mark&gt; `#{arg_name_fmt}`&quot;</span>, <span class="ruby-value">1</span>)
189
+ <span class="ruby-identifier">arg_name_fmt</span> = <span class="ruby-node">&quot; `#{arg_name_fmt.strip}`&quot;</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">arg_name_fmt</span>
190
+ <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">header</span>(<span class="ruby-node">&quot;`$ #{@exe}` &lt;mark&gt;`#{@parent_command.join(&#39; &#39;)}`&lt;/mark&gt;#{arg_name_fmt}&quot;</span>, <span class="ruby-value">1</span>)
245
191
  <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
246
192
  <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;*#{String(desc).strip}*&quot;</span>
247
193
  <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
@@ -250,207 +196,142 @@
250
196
  <span class="ruby-identifier">increment_nest</span>
251
197
  <span class="ruby-keyword">end</span></pre>
252
198
  </div>
253
-
254
199
  </div>
255
200
 
256
-
257
201
 
258
-
259
202
  </div>
260
203
 
261
-
262
204
  <div id="method-i-commands" class="method-detail ">
263
-
264
205
  <div class="method-heading">
265
206
  <span class="method-name">commands</span><span
266
207
  class="method-args">()</span>
267
-
268
208
  <span class="method-click-advice">click to toggle source</span>
269
-
270
209
  </div>
271
-
272
210
 
273
211
  <div class="method-description">
274
212
 
275
-
276
-
277
-
278
213
 
279
-
280
214
  <div class="method-source-code" id="commands-source">
281
- <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 104</span>
215
+ <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 111</span>
282
216
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">commands</span>
283
217
  <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">header</span>(<span class="ruby-string">&quot;Commands&quot;</span>, <span class="ruby-value">1</span>)
284
218
  <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
285
219
  <span class="ruby-identifier">increment_nest</span>
286
220
  <span class="ruby-keyword">end</span></pre>
287
221
  </div>
288
-
289
222
  </div>
290
223
 
291
-
292
224
 
293
-
294
225
  </div>
295
226
 
296
-
297
227
  <div id="method-i-default_command" class="method-detail ">
298
-
299
228
  <div class="method-heading">
300
229
  <span class="method-name">default_command</span><span
301
230
  class="method-args">(name)</span>
302
-
303
231
  <span class="method-click-advice">click to toggle source</span>
304
-
305
232
  </div>
306
-
307
233
 
308
234
  <div class="method-description">
309
-
310
235
  <p>Gives you the name of the current command in the current context</p>
311
-
312
-
313
236
 
314
-
315
237
  <div class="method-source-code" id="default_command-source">
316
- <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 129</span>
238
+ <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 139</span>
317
239
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">default_command</span>(<span class="ruby-identifier">name</span>)
318
240
  <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;#### [Default Command] #{name}&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">name</span>.<span class="ruby-identifier">nil?</span>
319
241
  <span class="ruby-keyword">end</span></pre>
320
242
  </div>
321
-
322
243
  </div>
323
244
 
324
-
325
245
 
326
-
327
246
  </div>
328
247
 
329
-
330
248
  <div id="method-i-end_command" class="method-detail ">
331
-
332
249
  <div class="method-heading">
333
250
  <span class="method-name">end_command</span><span
334
251
  class="method-args">(_name)</span>
335
-
336
252
  <span class="method-click-advice">click to toggle source</span>
337
-
338
253
  </div>
339
-
340
254
 
341
255
  <div class="method-description">
342
-
343
256
  <p>Ends a command, and “pops” you back up one context</p>
344
-
345
-
346
257
 
347
-
348
258
  <div class="method-source-code" id="end_command-source">
349
- <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 123</span>
259
+ <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 132</span>
350
260
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">end_command</span>(<span class="ruby-identifier">_name</span>)
261
+ <span class="ruby-ivar">@parent_command</span>.<span class="ruby-identifier">pop</span>
351
262
  <span class="ruby-identifier">decrement_nest</span>
352
263
  <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span> <span class="ruby-string">&quot;* * * * * *\n\n&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@nest</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">2</span>
353
264
  <span class="ruby-keyword">end</span></pre>
354
265
  </div>
355
-
356
266
  </div>
357
267
 
358
-
359
268
 
360
-
361
269
  </div>
362
270
 
363
-
364
271
  <div id="method-i-end_commands" class="method-detail ">
365
-
366
272
  <div class="method-heading">
367
273
  <span class="method-name">end_commands</span><span
368
274
  class="method-args">()</span>
369
-
370
275
  <span class="method-click-advice">click to toggle source</span>
371
-
372
276
  </div>
373
-
374
277
 
375
278
  <div class="method-description">
376
279
 
377
-
378
-
379
-
380
280
 
381
-
382
281
  <div class="method-source-code" id="end_commands-source">
383
- <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 133</span>
282
+ <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 143</span>
384
283
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">end_commands</span>
385
284
  <span class="ruby-identifier">decrement_nest</span>
386
285
  <span class="ruby-keyword">end</span></pre>
387
286
  </div>
388
-
389
287
  </div>
390
288
 
391
-
392
289
 
393
-
394
290
  </div>
395
291
 
396
-
397
292
  <div id="method-i-end_options" class="method-detail ">
398
-
399
293
  <div class="method-heading">
400
294
  <span class="method-name">end_options</span><span
401
295
  class="method-args">()</span>
402
-
403
296
  <span class="method-click-advice">click to toggle source</span>
404
-
405
297
  </div>
406
-
407
298
 
408
299
  <div class="method-description">
409
300
 
410
-
411
-
412
-
413
301
 
414
-
415
302
  <div class="method-source-code" id="end_options-source">
416
- <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 101</span>
303
+ <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 108</span>
417
304
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">end_options</span>
418
305
  <span class="ruby-keyword">end</span></pre>
419
306
  </div>
420
-
421
307
  </div>
422
308
 
423
-
424
309
 
425
-
426
310
  </div>
427
311
 
428
-
429
312
  <div id="method-i-ending" class="method-detail ">
430
-
431
313
  <div class="method-heading">
432
314
  <span class="method-name">ending</span><span
433
315
  class="method-args">()</span>
434
-
435
316
  <span class="method-click-advice">click to toggle source</span>
436
-
437
317
  </div>
438
-
439
318
 
440
319
  <div class="method-description">
441
-
442
320
  <p>Called when processing has completed</p>
443
-
444
-
445
321
 
446
-
447
322
  <div class="method-source-code" id="ending-source">
448
- <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 24</span>
323
+ <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 25</span>
449
324
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">ending</span>
450
325
  <span class="ruby-keyword">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-string">&#39;CREDITS.md&#39;</span>)
451
326
  <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span> <span class="ruby-constant">IO</span>.<span class="ruby-identifier">read</span>(<span class="ruby-string">&#39;CREDITS.md&#39;</span>)
452
327
  <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
453
328
  <span class="ruby-keyword">end</span>
329
+
330
+ <span class="ruby-keyword">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-string">&#39;AUTHORS.md&#39;</span>)
331
+ <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span> <span class="ruby-constant">IO</span>.<span class="ruby-identifier">read</span>(<span class="ruby-string">&#39;AUTHORS.md&#39;</span>)
332
+ <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
333
+ <span class="ruby-keyword">end</span>
334
+
454
335
  <span class="ruby-keyword">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-string">&#39;LICENSE.md&#39;</span>)
455
336
  <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span> <span class="ruby-constant">IO</span>.<span class="ruby-identifier">read</span>(<span class="ruby-string">&#39;LICENSE.md&#39;</span>)
456
337
  <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
@@ -461,35 +342,23 @@
461
342
  <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">close</span>
462
343
  <span class="ruby-keyword">end</span></pre>
463
344
  </div>
464
-
465
345
  </div>
466
346
 
467
-
468
347
 
469
-
470
348
  </div>
471
349
 
472
-
473
350
  <div id="method-i-flag" class="method-detail ">
474
-
475
351
  <div class="method-heading">
476
352
  <span class="method-name">flag</span><span
477
353
  class="method-args">(name, aliases, desc, long_desc, default_value, arg_name, must_match, _type)</span>
478
-
479
354
  <span class="method-click-advice">click to toggle source</span>
480
-
481
355
  </div>
482
-
483
356
 
484
357
  <div class="method-description">
485
-
486
358
  <p>Gives you a flag in the current context</p>
487
-
488
-
489
359
 
490
-
491
360
  <div class="method-source-code" id="flag-source">
492
- <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 73</span>
361
+ <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 80</span>
493
362
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">flag</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">aliases</span>, <span class="ruby-identifier">desc</span>, <span class="ruby-identifier">long_desc</span>, <span class="ruby-identifier">default_value</span>, <span class="ruby-identifier">arg_name</span>, <span class="ruby-identifier">must_match</span>, <span class="ruby-identifier">_type</span>)
494
363
  <span class="ruby-identifier">invocations</span> = ([<span class="ruby-identifier">name</span>] <span class="ruby-operator">+</span> <span class="ruby-constant">Array</span>(<span class="ruby-identifier">aliases</span>)).<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">_</span><span class="ruby-operator">|</span> <span class="ruby-string">&quot;`&quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">add_dashes</span>(<span class="ruby-identifier">_</span>) <span class="ruby-operator">+</span> <span class="ruby-string">&quot;`&quot;</span> }.<span class="ruby-identifier">join</span>(<span class="ruby-string">&#39; | &#39;</span>)
495
364
  <span class="ruby-identifier">usage</span> = <span class="ruby-node">&quot;#{invocations} #{arg_name || &#39;arg&#39;}&quot;</span>
@@ -503,35 +372,23 @@
503
372
  <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
504
373
  <span class="ruby-keyword">end</span></pre>
505
374
  </div>
506
-
507
375
  </div>
508
376
 
509
-
510
377
 
511
-
512
378
  </div>
513
379
 
514
-
515
380
  <div id="method-i-options" class="method-detail ">
516
-
517
381
  <div class="method-heading">
518
382
  <span class="method-name">options</span><span
519
383
  class="method-args">()</span>
520
-
521
384
  <span class="method-click-advice">click to toggle source</span>
522
-
523
385
  </div>
524
-
525
386
 
526
387
  <div class="method-description">
527
388
 
528
-
529
-
530
-
531
389
 
532
-
533
390
  <div class="method-source-code" id="options-source">
534
- <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 63</span>
391
+ <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 70</span>
535
392
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">options</span>
536
393
  <span class="ruby-keyword">if</span> <span class="ruby-ivar">@nest</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span>
537
394
  <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span> <span class="ruby-string">&quot;## Global Options&quot;</span>
@@ -541,35 +398,23 @@
541
398
  <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
542
399
  <span class="ruby-keyword">end</span></pre>
543
400
  </div>
544
-
545
401
  </div>
546
402
 
547
-
548
403
 
549
-
550
404
  </div>
551
405
 
552
-
553
406
  <div id="method-i-program_desc" class="method-detail ">
554
-
555
407
  <div class="method-heading">
556
408
  <span class="method-name">program_desc</span><span
557
409
  class="method-args">(desc)</span>
558
-
559
410
  <span class="method-click-advice">click to toggle source</span>
560
-
561
411
  </div>
562
-
563
412
 
564
413
  <div class="method-description">
565
-
566
414
  <p>Gives you the program description</p>
567
-
568
-
569
415
 
570
-
571
416
  <div class="method-source-code" id="program_desc-source">
572
- <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 40</span>
417
+ <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 47</span>
573
418
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">program_desc</span>(<span class="ruby-identifier">desc</span>)
574
419
  <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;# #{@exe} CLI&quot;</span>
575
420
  <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
@@ -577,75 +422,51 @@
577
422
  <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
578
423
  <span class="ruby-keyword">end</span></pre>
579
424
  </div>
580
-
581
425
  </div>
582
426
 
583
-
584
427
 
585
-
586
428
  </div>
587
429
 
588
-
589
430
  <div id="method-i-program_long_desc" class="method-detail ">
590
-
591
431
  <div class="method-heading">
592
432
  <span class="method-name">program_long_desc</span><span
593
433
  class="method-args">(desc)</span>
594
-
595
434
  <span class="method-click-advice">click to toggle source</span>
596
-
597
435
  </div>
598
-
599
436
 
600
437
  <div class="method-description">
601
438
 
602
-
603
-
604
-
605
439
 
606
-
607
440
  <div class="method-source-code" id="program_long_desc-source">
608
- <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 47</span>
441
+ <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 54</span>
609
442
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">program_long_desc</span>(<span class="ruby-identifier">desc</span>)
610
443
  <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;&gt; #{desc}&quot;</span>
611
444
  <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
612
445
  <span class="ruby-keyword">end</span></pre>
613
446
  </div>
614
-
615
447
  </div>
616
448
 
617
-
618
449
 
619
-
620
450
  </div>
621
451
 
622
-
623
452
  <div id="method-i-switch" class="method-detail ">
624
-
625
453
  <div class="method-heading">
626
454
  <span class="method-name">switch</span><span
627
455
  class="method-args">(name, aliases, desc, long_desc, negatable)</span>
628
-
629
456
  <span class="method-click-advice">click to toggle source</span>
630
-
631
457
  </div>
632
-
633
458
 
634
459
  <div class="method-description">
635
-
636
460
  <p>Gives you a switch in the current context</p>
637
-
638
-
639
461
 
640
-
641
462
  <div class="method-source-code" id="switch-source">
642
- <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 87</span>
463
+ <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 94</span>
643
464
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">switch</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">aliases</span>, <span class="ruby-identifier">desc</span>, <span class="ruby-identifier">long_desc</span>, <span class="ruby-identifier">negatable</span>)
644
465
  <span class="ruby-keyword">if</span> <span class="ruby-identifier">negatable</span>
645
466
  <span class="ruby-identifier">name</span> = <span class="ruby-node">&quot;[no-]#{name}&quot;</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">1</span>
646
467
  <span class="ruby-identifier">aliases</span> = <span class="ruby-identifier">aliases</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">_</span><span class="ruby-operator">|</span> <span class="ruby-identifier">_</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">1</span> <span class="ruby-operator">?</span> <span class="ruby-node">&quot;[no-]#{_}&quot;</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">_</span> }
647
468
  <span class="ruby-keyword">end</span>
648
- <span class="ruby-identifier">invocations</span> = ([<span class="ruby-identifier">name</span>] <span class="ruby-operator">+</span> <span class="ruby-identifier">aliases</span>).<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">_</span><span class="ruby-operator">|</span> <span class="ruby-string">&quot;`&quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">add_dashes</span>(<span class="ruby-identifier">_</span>) <span class="ruby-operator">+</span> <span class="ruby-string">&quot;`&quot;</span> }.<span class="ruby-identifier">join</span>(<span class="ruby-string">&#39;|&#39;</span>)
469
+ <span class="ruby-identifier">invocations</span> = ([<span class="ruby-identifier">name</span>] <span class="ruby-operator">+</span> <span class="ruby-identifier">aliases</span>).<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">_</span><span class="ruby-operator">|</span> <span class="ruby-string">&quot;`&quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">add_dashes</span>(<span class="ruby-identifier">_</span>).<span class="ruby-identifier">strip</span> <span class="ruby-operator">+</span> <span class="ruby-string">&quot;`&quot;</span> }.<span class="ruby-identifier">join</span>(<span class="ruby-string">&#39;|&#39;</span>)
649
470
  <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">header</span>(<span class="ruby-node">&quot;#{invocations}&quot;</span>, <span class="ruby-value">2</span>)
650
471
  <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
651
472
  <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span> <span class="ruby-constant">String</span>(<span class="ruby-identifier">desc</span>).<span class="ruby-identifier">strip</span>
@@ -654,35 +475,23 @@
654
475
  <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
655
476
  <span class="ruby-keyword">end</span></pre>
656
477
  </div>
657
-
658
478
  </div>
659
479
 
660
-
661
480
 
662
-
663
481
  </div>
664
482
 
665
-
666
483
  <div id="method-i-version" class="method-detail ">
667
-
668
484
  <div class="method-heading">
669
485
  <span class="method-name">version</span><span
670
486
  class="method-args">(version)</span>
671
-
672
487
  <span class="method-click-advice">click to toggle source</span>
673
-
674
488
  </div>
675
-
676
489
 
677
490
  <div class="method-description">
678
-
679
491
  <p>Gives you the program version</p>
680
-
681
-
682
492
 
683
-
684
493
  <div class="method-source-code" id="version-source">
685
- <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 53</span>
494
+ <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 60</span>
686
495
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">version</span>(<span class="ruby-identifier">version</span>)
687
496
  <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;*v#{version}*&quot;</span>
688
497
  <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
@@ -693,25 +502,20 @@
693
502
  <span class="ruby-keyword">end</span>
694
503
  <span class="ruby-keyword">end</span></pre>
695
504
  </div>
696
-
697
505
  </div>
698
506
 
699
-
700
507
 
701
-
702
508
  </div>
703
509
 
704
-
705
510
  </section>
706
-
707
- </section>
708
511
 
512
+ </section>
709
513
  </main>
710
514
 
711
515
 
712
516
  <footer id="validator-badges" role="contentinfo">
713
517
  <p><a href="https://validator.w3.org/check/referer">Validate</a>
714
- <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
518
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.2.
715
519
  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
716
520
  </footer>
717
521