hookapp 2.0.3 → 2.0.4

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.
@@ -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>)
@@ -170,73 +138,48 @@
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>
171
139
  <span class="ruby-keyword">end</span></pre>
172
140
  </div>
173
-
174
141
  </div>
175
142
 
176
-
177
143
 
178
-
179
144
  </div>
180
145
 
181
-
182
146
  </section>
183
-
147
+
184
148
  <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
185
149
  <header>
186
150
  <h3>Public Instance Methods</h3>
187
151
  </header>
188
152
 
189
-
190
153
  <div id="method-i-beginning" class="method-detail ">
191
-
192
154
  <div class="method-heading">
193
155
  <span class="method-name">beginning</span><span
194
156
  class="method-args">()</span>
195
-
196
157
  <span class="method-click-advice">click to toggle source</span>
197
-
198
158
  </div>
199
-
200
159
 
201
160
  <div class="method-description">
202
161
 
203
-
204
-
205
-
206
162
 
207
-
208
163
  <div class="method-source-code" id="beginning-source">
209
164
  <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 20</span>
210
165
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">beginning</span>
211
166
  <span class="ruby-keyword">end</span></pre>
212
167
  </div>
213
-
214
168
  </div>
215
169
 
216
-
217
170
 
218
-
219
171
  </div>
220
172
 
221
-
222
173
  <div id="method-i-command" class="method-detail ">
223
-
224
174
  <div class="method-heading">
225
175
  <span class="method-name">command</span><span
226
176
  class="method-args">(name, aliases, desc, long_desc, arg_name, arg_options)</span>
227
-
228
177
  <span class="method-click-advice">click to toggle source</span>
229
-
230
178
  </div>
231
-
232
179
 
233
180
  <div class="method-description">
234
-
235
181
  <p>Gives you a command in the current context and creates a new context of this command</p>
236
-
237
-
238
182
 
239
-
240
183
  <div class="method-source-code" id="command-source">
241
184
  <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 111</span>
242
185
  <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>)
@@ -250,33 +193,21 @@
250
193
  <span class="ruby-identifier">increment_nest</span>
251
194
  <span class="ruby-keyword">end</span></pre>
252
195
  </div>
253
-
254
196
  </div>
255
197
 
256
-
257
198
 
258
-
259
199
  </div>
260
200
 
261
-
262
201
  <div id="method-i-commands" class="method-detail ">
263
-
264
202
  <div class="method-heading">
265
203
  <span class="method-name">commands</span><span
266
204
  class="method-args">()</span>
267
-
268
205
  <span class="method-click-advice">click to toggle source</span>
269
-
270
206
  </div>
271
-
272
207
 
273
208
  <div class="method-description">
274
209
 
275
-
276
-
277
-
278
210
 
279
-
280
211
  <div class="method-source-code" id="commands-source">
281
212
  <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 104</span>
282
213
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">commands</span>
@@ -285,66 +216,42 @@
285
216
  <span class="ruby-identifier">increment_nest</span>
286
217
  <span class="ruby-keyword">end</span></pre>
287
218
  </div>
288
-
289
219
  </div>
290
220
 
291
-
292
221
 
293
-
294
222
  </div>
295
223
 
296
-
297
224
  <div id="method-i-default_command" class="method-detail ">
298
-
299
225
  <div class="method-heading">
300
226
  <span class="method-name">default_command</span><span
301
227
  class="method-args">(name)</span>
302
-
303
228
  <span class="method-click-advice">click to toggle source</span>
304
-
305
229
  </div>
306
-
307
230
 
308
231
  <div class="method-description">
309
-
310
232
  <p>Gives you the name of the current command in the current context</p>
311
-
312
-
313
233
 
314
-
315
234
  <div class="method-source-code" id="default_command-source">
316
235
  <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 129</span>
317
236
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">default_command</span>(<span class="ruby-identifier">name</span>)
318
237
  <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
238
  <span class="ruby-keyword">end</span></pre>
320
239
  </div>
321
-
322
240
  </div>
323
241
 
324
-
325
242
 
326
-
327
243
  </div>
328
244
 
329
-
330
245
  <div id="method-i-end_command" class="method-detail ">
331
-
332
246
  <div class="method-heading">
333
247
  <span class="method-name">end_command</span><span
334
248
  class="method-args">(_name)</span>
335
-
336
249
  <span class="method-click-advice">click to toggle source</span>
337
-
338
250
  </div>
339
-
340
251
 
341
252
  <div class="method-description">
342
-
343
253
  <p>Ends a command, and “pops” you back up one context</p>
344
-
345
-
346
254
 
347
-
348
255
  <div class="method-source-code" id="end_command-source">
349
256
  <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 123</span>
350
257
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">end_command</span>(<span class="ruby-identifier">_name</span>)
@@ -352,98 +259,62 @@
352
259
  <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
260
  <span class="ruby-keyword">end</span></pre>
354
261
  </div>
355
-
356
262
  </div>
357
263
 
358
-
359
264
 
360
-
361
265
  </div>
362
266
 
363
-
364
267
  <div id="method-i-end_commands" class="method-detail ">
365
-
366
268
  <div class="method-heading">
367
269
  <span class="method-name">end_commands</span><span
368
270
  class="method-args">()</span>
369
-
370
271
  <span class="method-click-advice">click to toggle source</span>
371
-
372
272
  </div>
373
-
374
273
 
375
274
  <div class="method-description">
376
275
 
377
-
378
-
379
-
380
276
 
381
-
382
277
  <div class="method-source-code" id="end_commands-source">
383
278
  <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 133</span>
384
279
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">end_commands</span>
385
280
  <span class="ruby-identifier">decrement_nest</span>
386
281
  <span class="ruby-keyword">end</span></pre>
387
282
  </div>
388
-
389
283
  </div>
390
284
 
391
-
392
285
 
393
-
394
286
  </div>
395
287
 
396
-
397
288
  <div id="method-i-end_options" class="method-detail ">
398
-
399
289
  <div class="method-heading">
400
290
  <span class="method-name">end_options</span><span
401
291
  class="method-args">()</span>
402
-
403
292
  <span class="method-click-advice">click to toggle source</span>
404
-
405
293
  </div>
406
-
407
294
 
408
295
  <div class="method-description">
409
296
 
410
-
411
-
412
-
413
297
 
414
-
415
298
  <div class="method-source-code" id="end_options-source">
416
299
  <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 101</span>
417
300
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">end_options</span>
418
301
  <span class="ruby-keyword">end</span></pre>
419
302
  </div>
420
-
421
303
  </div>
422
304
 
423
-
424
305
 
425
-
426
306
  </div>
427
307
 
428
-
429
308
  <div id="method-i-ending" class="method-detail ">
430
-
431
309
  <div class="method-heading">
432
310
  <span class="method-name">ending</span><span
433
311
  class="method-args">()</span>
434
-
435
312
  <span class="method-click-advice">click to toggle source</span>
436
-
437
313
  </div>
438
-
439
314
 
440
315
  <div class="method-description">
441
-
442
316
  <p>Called when processing has completed</p>
443
-
444
-
445
317
 
446
-
447
318
  <div class="method-source-code" id="ending-source">
448
319
  <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 24</span>
449
320
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">ending</span>
@@ -461,33 +332,21 @@
461
332
  <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">close</span>
462
333
  <span class="ruby-keyword">end</span></pre>
463
334
  </div>
464
-
465
335
  </div>
466
336
 
467
-
468
337
 
469
-
470
338
  </div>
471
339
 
472
-
473
340
  <div id="method-i-flag" class="method-detail ">
474
-
475
341
  <div class="method-heading">
476
342
  <span class="method-name">flag</span><span
477
343
  class="method-args">(name, aliases, desc, long_desc, default_value, arg_name, must_match, _type)</span>
478
-
479
344
  <span class="method-click-advice">click to toggle source</span>
480
-
481
345
  </div>
482
-
483
346
 
484
347
  <div class="method-description">
485
-
486
348
  <p>Gives you a flag in the current context</p>
487
-
488
-
489
349
 
490
-
491
350
  <div class="method-source-code" id="flag-source">
492
351
  <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 73</span>
493
352
  <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>)
@@ -503,33 +362,21 @@
503
362
  <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
504
363
  <span class="ruby-keyword">end</span></pre>
505
364
  </div>
506
-
507
365
  </div>
508
366
 
509
-
510
367
 
511
-
512
368
  </div>
513
369
 
514
-
515
370
  <div id="method-i-options" class="method-detail ">
516
-
517
371
  <div class="method-heading">
518
372
  <span class="method-name">options</span><span
519
373
  class="method-args">()</span>
520
-
521
374
  <span class="method-click-advice">click to toggle source</span>
522
-
523
375
  </div>
524
-
525
376
 
526
377
  <div class="method-description">
527
378
 
528
-
529
-
530
-
531
379
 
532
-
533
380
  <div class="method-source-code" id="options-source">
534
381
  <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 63</span>
535
382
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">options</span>
@@ -541,33 +388,21 @@
541
388
  <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
542
389
  <span class="ruby-keyword">end</span></pre>
543
390
  </div>
544
-
545
391
  </div>
546
392
 
547
-
548
393
 
549
-
550
394
  </div>
551
395
 
552
-
553
396
  <div id="method-i-program_desc" class="method-detail ">
554
-
555
397
  <div class="method-heading">
556
398
  <span class="method-name">program_desc</span><span
557
399
  class="method-args">(desc)</span>
558
-
559
400
  <span class="method-click-advice">click to toggle source</span>
560
-
561
401
  </div>
562
-
563
402
 
564
403
  <div class="method-description">
565
-
566
404
  <p>Gives you the program description</p>
567
-
568
-
569
405
 
570
-
571
406
  <div class="method-source-code" id="program_desc-source">
572
407
  <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 40</span>
573
408
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">program_desc</span>(<span class="ruby-identifier">desc</span>)
@@ -577,33 +412,21 @@
577
412
  <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
578
413
  <span class="ruby-keyword">end</span></pre>
579
414
  </div>
580
-
581
415
  </div>
582
416
 
583
-
584
417
 
585
-
586
418
  </div>
587
419
 
588
-
589
420
  <div id="method-i-program_long_desc" class="method-detail ">
590
-
591
421
  <div class="method-heading">
592
422
  <span class="method-name">program_long_desc</span><span
593
423
  class="method-args">(desc)</span>
594
-
595
424
  <span class="method-click-advice">click to toggle source</span>
596
-
597
425
  </div>
598
-
599
426
 
600
427
  <div class="method-description">
601
428
 
602
-
603
-
604
-
605
429
 
606
-
607
430
  <div class="method-source-code" id="program_long_desc-source">
608
431
  <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 47</span>
609
432
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">program_long_desc</span>(<span class="ruby-identifier">desc</span>)
@@ -611,33 +434,21 @@
611
434
  <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
612
435
  <span class="ruby-keyword">end</span></pre>
613
436
  </div>
614
-
615
437
  </div>
616
438
 
617
-
618
439
 
619
-
620
440
  </div>
621
441
 
622
-
623
442
  <div id="method-i-switch" class="method-detail ">
624
-
625
443
  <div class="method-heading">
626
444
  <span class="method-name">switch</span><span
627
445
  class="method-args">(name, aliases, desc, long_desc, negatable)</span>
628
-
629
446
  <span class="method-click-advice">click to toggle source</span>
630
-
631
447
  </div>
632
-
633
448
 
634
449
  <div class="method-description">
635
-
636
450
  <p>Gives you a switch in the current context</p>
637
-
638
-
639
451
 
640
-
641
452
  <div class="method-source-code" id="switch-source">
642
453
  <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 87</span>
643
454
  <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>)
@@ -654,33 +465,21 @@
654
465
  <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
655
466
  <span class="ruby-keyword">end</span></pre>
656
467
  </div>
657
-
658
468
  </div>
659
469
 
660
-
661
470
 
662
-
663
471
  </div>
664
472
 
665
-
666
473
  <div id="method-i-version" class="method-detail ">
667
-
668
474
  <div class="method-heading">
669
475
  <span class="method-name">version</span><span
670
476
  class="method-args">(version)</span>
671
-
672
477
  <span class="method-click-advice">click to toggle source</span>
673
-
674
478
  </div>
675
-
676
479
 
677
480
  <div class="method-description">
678
-
679
481
  <p>Gives you the program version</p>
680
-
681
-
682
482
 
683
-
684
483
  <div class="method-source-code" id="version-source">
685
484
  <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 53</span>
686
485
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">version</span>(<span class="ruby-identifier">version</span>)
@@ -693,25 +492,20 @@
693
492
  <span class="ruby-keyword">end</span>
694
493
  <span class="ruby-keyword">end</span></pre>
695
494
  </div>
696
-
697
495
  </div>
698
496
 
699
-
700
497
 
701
-
702
498
  </div>
703
499
 
704
-
705
500
  </section>
706
-
707
- </section>
708
501
 
502
+ </section>
709
503
  </main>
710
504
 
711
505
 
712
506
  <footer id="validator-badges" role="contentinfo">
713
507
  <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.
508
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.2.
715
509
  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
716
510
  </footer>
717
511
 
@@ -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="module">
27
25
  <nav role="navigation">
28
26
  <div id="project-navigation">
@@ -75,25 +73,19 @@
75
73
 
76
74
  </section>
77
75
 
78
-
79
76
  <section id="5Buntitled-5D" class="documentation-section">
80
-
81
77
 
82
-
83
78
 
84
-
85
79
 
86
-
87
80
 
88
-
89
- </section>
90
81
 
82
+ </section>
91
83
  </main>
92
84
 
93
85
 
94
86
  <footer id="validator-badges" role="contentinfo">
95
87
  <p><a href="https://validator.w3.org/check/referer">Validate</a>
96
- <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
88
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.2.
97
89
  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
98
90
  </footer>
99
91
 
data/html/GLI.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="module">
27
25
  <nav role="navigation">
28
26
  <div id="project-navigation">
@@ -75,25 +73,19 @@
75
73
 
76
74
  </section>
77
75
 
78
-
79
76
  <section id="5Buntitled-5D" class="documentation-section">
80
-
81
77
 
82
-
83
78
 
84
-
85
79
 
86
-
87
80
 
88
-
89
- </section>
90
81
 
82
+ </section>
91
83
  </main>
92
84
 
93
85
 
94
86
  <footer id="validator-badges" role="contentinfo">
95
87
  <p><a href="https://validator.w3.org/check/referer">Validate</a>
96
- <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
88
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.2.
97
89
  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
98
90
  </footer>
99
91