hookapp 2.0.7 → 2.0.10

Sign up to get free protection for your applications and to get access to all the features.
Files changed (77) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHORS.md +4 -0
  3. data/CHANGELOG.md +13 -0
  4. data/Gemfile.lock +35 -40
  5. data/LICENSE +21 -0
  6. data/README.md +32 -22
  7. data/bin/hook +57 -67
  8. data/hook.rdoc +16 -11
  9. data/hookapp.gemspec +1 -0
  10. data/html/App.html +107 -0
  11. data/html/GLI/Commands/Doc.html +91 -0
  12. data/html/GLI/Commands/MarkdownDocumentListener.html +521 -0
  13. data/html/GLI/Commands.html +91 -0
  14. data/html/GLI.html +91 -0
  15. data/html/Hook/Prompt.html +100 -0
  16. data/html/Hook/PromptFZF.html +243 -0
  17. data/html/Hook/PromptSTD.html +177 -0
  18. data/html/Hook.html +100 -0
  19. data/html/HookApp.html +1008 -0
  20. data/html/Hooker.html +141 -0
  21. data/html/README_rdoc.html +354 -0
  22. data/html/String.html +335 -0
  23. data/html/created.rid +10 -0
  24. data/html/css/fonts.css +167 -0
  25. data/html/css/rdoc.css +639 -0
  26. data/html/fonts/Lato-Light.ttf +0 -0
  27. data/html/fonts/Lato-LightItalic.ttf +0 -0
  28. data/html/fonts/Lato-Regular.ttf +0 -0
  29. data/html/fonts/Lato-RegularItalic.ttf +0 -0
  30. data/html/fonts/SourceCodePro-Bold.ttf +0 -0
  31. data/html/fonts/SourceCodePro-Regular.ttf +0 -0
  32. data/html/images/add.png +0 -0
  33. data/html/images/arrow_up.png +0 -0
  34. data/html/images/brick.png +0 -0
  35. data/html/images/brick_link.png +0 -0
  36. data/html/images/bug.png +0 -0
  37. data/html/images/bullet_black.png +0 -0
  38. data/html/images/bullet_toggle_minus.png +0 -0
  39. data/html/images/bullet_toggle_plus.png +0 -0
  40. data/html/images/date.png +0 -0
  41. data/html/images/delete.png +0 -0
  42. data/html/images/find.png +0 -0
  43. data/html/images/loadingAnimation.gif +0 -0
  44. data/html/images/macFFBgHack.png +0 -0
  45. data/html/images/package.png +0 -0
  46. data/html/images/page_green.png +0 -0
  47. data/html/images/page_white_text.png +0 -0
  48. data/html/images/page_white_width.png +0 -0
  49. data/html/images/plugin.png +0 -0
  50. data/html/images/ruby.png +0 -0
  51. data/html/images/tag_blue.png +0 -0
  52. data/html/images/tag_green.png +0 -0
  53. data/html/images/transparent.png +0 -0
  54. data/html/images/wrench.png +0 -0
  55. data/html/images/wrench_orange.png +0 -0
  56. data/html/images/zoom.png +0 -0
  57. data/html/index.html +320 -0
  58. data/html/js/darkfish.js +84 -0
  59. data/html/js/navigation.js +105 -0
  60. data/html/js/navigation.js.gz +0 -0
  61. data/html/js/search.js +110 -0
  62. data/html/js/search_index.js +1 -0
  63. data/html/js/search_index.js.gz +0 -0
  64. data/html/js/searcher.js +229 -0
  65. data/html/js/searcher.js.gz +0 -0
  66. data/html/table_of_contents.html +409 -0
  67. data/lib/hook/hookapp.rb +11 -12
  68. data/lib/hook/hooker.rb +1 -0
  69. data/lib/hook/markdown_document_listener.rb +12 -2
  70. data/lib/hook/prompt.rb +113 -0
  71. data/lib/hook/version.rb +1 -1
  72. data/lib/hook.rb +2 -0
  73. data/test/hook_clip_test.rb +1 -1
  74. data/test/hook_link_test.rb +2 -1
  75. data/test/hook_scripts_test.rb +1 -1
  76. metadata +82 -3
  77. data/lib/helpers/fuzzyfilefinder +0 -0
data/html/GLI/Commands/MarkdownDocumentListener.html ADDED
@@ -0,0 +1,521 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta charset="UTF-8">
6
+
7
+ <title>class GLI::Commands::MarkdownDocumentListener - hookapp</title>
8
+
9
+ <script type="text/javascript">
10
+ var rdoc_rel_prefix = "../../";
11
+ var index_rel_prefix = "../../";
12
+ </script>
13
+
14
+ <script src="../../js/navigation.js" defer></script>
15
+ <script src="../../js/search.js" defer></script>
16
+ <script src="../../js/search_index.js" defer></script>
17
+ <script src="../../js/searcher.js" defer></script>
18
+ <script src="../../js/darkfish.js" defer></script>
19
+
20
+ <link href="../../css/fonts.css" rel="stylesheet">
21
+ <link href="../../css/rdoc.css" rel="stylesheet">
22
+
23
+
24
+ <body id="top" role="document" class="class">
25
+ <nav role="navigation">
26
+ <div id="project-navigation">
27
+ <div id="home-section" role="region" title="Quick navigation" class="nav-section">
28
+ <h2>
29
+ <a href="../../index.html" rel="home">Home</a>
30
+ </h2>
31
+
32
+ <div id="table-of-contents-navigation">
33
+ <a href="../../table_of_contents.html#pages">Pages</a>
34
+ <a href="../../table_of_contents.html#classes">Classes</a>
35
+ <a href="../../table_of_contents.html#methods">Methods</a>
36
+ </div>
37
+ </div>
38
+
39
+ <div id="search-section" role="search" class="project-section initially-hidden">
40
+ <form action="#" method="get" accept-charset="utf-8">
41
+ <div id="search-field-wrapper">
42
+ <input id="search-field" role="combobox" aria-label="Search"
43
+ aria-autocomplete="list" aria-controls="search-results"
44
+ type="text" name="search" placeholder="Search" spellcheck="false"
45
+ title="Type to search, Up and Down to navigate, Enter to load">
46
+ </div>
47
+
48
+ <ul id="search-results" aria-label="Search Results"
49
+ aria-busy="false" aria-expanded="false"
50
+ aria-atomic="false" class="initially-hidden"></ul>
51
+ </form>
52
+ </div>
53
+
54
+ </div>
55
+
56
+
57
+
58
+ <div id="class-metadata">
59
+
60
+
61
+ <div id="parent-class-section" class="nav-section">
62
+ <h3>Parent</h3>
63
+
64
+ <p class="link">Object
65
+ </div>
66
+
67
+
68
+
69
+
70
+ <!-- Method Quickref -->
71
+ <div id="method-list-section" class="nav-section">
72
+ <h3>Methods</h3>
73
+
74
+ <ul class="link-list" role="directory">
75
+ <li ><a href="#method-c-new">::new</a>
76
+ <li ><a href="#method-i-beginning">#beginning</a>
77
+ <li ><a href="#method-i-command">#command</a>
78
+ <li ><a href="#method-i-commands">#commands</a>
79
+ <li ><a href="#method-i-default_command">#default_command</a>
80
+ <li ><a href="#method-i-end_command">#end_command</a>
81
+ <li ><a href="#method-i-end_commands">#end_commands</a>
82
+ <li ><a href="#method-i-end_options">#end_options</a>
83
+ <li ><a href="#method-i-ending">#ending</a>
84
+ <li ><a href="#method-i-flag">#flag</a>
85
+ <li ><a href="#method-i-options">#options</a>
86
+ <li ><a href="#method-i-program_desc">#program_desc</a>
87
+ <li ><a href="#method-i-program_long_desc">#program_long_desc</a>
88
+ <li ><a href="#method-i-switch">#switch</a>
89
+ <li ><a href="#method-i-version">#version</a>
90
+ </ul>
91
+ </div>
92
+
93
+ </div>
94
+ </nav>
95
+
96
+ <main role="main" aria-labelledby="class-GLI::Commands::MarkdownDocumentListener">
97
+ <h1 id="class-GLI::Commands::MarkdownDocumentListener" class="class">
98
+ class GLI::Commands::MarkdownDocumentListener
99
+ </h1>
100
+
101
+ <section class="description">
102
+
103
+ <p>DocumentListener class for <a href="../../GLI.html"><code>GLI</code></a> documentation generator</p>
104
+
105
+ </section>
106
+
107
+ <section id="5Buntitled-5D" class="documentation-section">
108
+
109
+
110
+
111
+
112
+
113
+ <section id="public-class-5Buntitled-5D-method-details" class="method-section">
114
+ <header>
115
+ <h3>Public Class Methods</h3>
116
+ </header>
117
+
118
+ <div id="method-c-new" class="method-detail ">
119
+ <div class="method-heading">
120
+ <span class="method-name">new</span><span
121
+ class="method-args">(_global_options, _options, _arguments, app)</span>
122
+ <span class="method-click-advice">click to toggle source</span>
123
+ </div>
124
+
125
+ <div class="method-description">
126
+
127
+
128
+ <div class="method-source-code" id="new-source">
129
+ <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 9</span>
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>)
131
+ <span class="ruby-ivar">@exe</span> = <span class="ruby-identifier">app</span>.<span class="ruby-identifier">exe_name</span>
132
+ <span class="ruby-keyword">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-string">&#39;README.md&#39;</span>) <span class="ruby-comment"># Back up existing README</span>
133
+ <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mv</span>(<span class="ruby-string">&#39;README.md&#39;</span>, <span class="ruby-string">&#39;README.bak&#39;</span>)
134
+ <span class="ruby-identifier">$stderr</span>.<span class="ruby-identifier">puts</span> <span class="ruby-string">&quot;Backing up existing README.md to README.bak&quot;</span>
135
+ <span class="ruby-keyword">end</span>
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>)
137
+ <span class="ruby-ivar">@nest</span> = <span class="ruby-string">&#39;#&#39;</span>
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> = []
140
+ <span class="ruby-keyword">end</span></pre>
141
+ </div>
142
+ </div>
143
+
144
+
145
+ </div>
146
+
147
+ </section>
148
+
149
+ <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
150
+ <header>
151
+ <h3>Public Instance Methods</h3>
152
+ </header>
153
+
154
+ <div id="method-i-beginning" class="method-detail ">
155
+ <div class="method-heading">
156
+ <span class="method-name">beginning</span><span
157
+ class="method-args">()</span>
158
+ <span class="method-click-advice">click to toggle source</span>
159
+ </div>
160
+
161
+ <div class="method-description">
162
+
163
+
164
+ <div class="method-source-code" id="beginning-source">
165
+ <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 21</span>
166
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">beginning</span>
167
+ <span class="ruby-keyword">end</span></pre>
168
+ </div>
169
+ </div>
170
+
171
+
172
+ </div>
173
+
174
+ <div id="method-i-command" class="method-detail ">
175
+ <div class="method-heading">
176
+ <span class="method-name">command</span><span
177
+ class="method-args">(name, aliases, desc, long_desc, arg_name, arg_options)</span>
178
+ <span class="method-click-advice">click to toggle source</span>
179
+ </div>
180
+
181
+ <div class="method-description">
182
+ <p>Gives you a command in the current context and creates a new context of this command</p>
183
+
184
+ <div class="method-source-code" id="command-source">
185
+ <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 118</span>
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>)
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>, [])
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>)
191
+ <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
192
+ <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;*#{String(desc).strip}*&quot;</span>
193
+ <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
194
+ <span class="ruby-identifier">cmd_desc</span> = <span class="ruby-constant">String</span>(<span class="ruby-identifier">long_desc</span>).<span class="ruby-identifier">strip</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">&quot;\n&quot;</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-node">&quot;&gt; #{_}&quot;</span> }.<span class="ruby-identifier">join</span>(<span class="ruby-string">&quot;\n&quot;</span>)
195
+ <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;#{cmd_desc}\n\n&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">cmd_desc</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
196
+ <span class="ruby-identifier">increment_nest</span>
197
+ <span class="ruby-keyword">end</span></pre>
198
+ </div>
199
+ </div>
200
+
201
+
202
+ </div>
203
+
204
+ <div id="method-i-commands" class="method-detail ">
205
+ <div class="method-heading">
206
+ <span class="method-name">commands</span><span
207
+ class="method-args">()</span>
208
+ <span class="method-click-advice">click to toggle source</span>
209
+ </div>
210
+
211
+ <div class="method-description">
212
+
213
+
214
+ <div class="method-source-code" id="commands-source">
215
+ <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 111</span>
216
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">commands</span>
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>)
218
+ <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
219
+ <span class="ruby-identifier">increment_nest</span>
220
+ <span class="ruby-keyword">end</span></pre>
221
+ </div>
222
+ </div>
223
+
224
+
225
+ </div>
226
+
227
+ <div id="method-i-default_command" class="method-detail ">
228
+ <div class="method-heading">
229
+ <span class="method-name">default_command</span><span
230
+ class="method-args">(name)</span>
231
+ <span class="method-click-advice">click to toggle source</span>
232
+ </div>
233
+
234
+ <div class="method-description">
235
+ <p>Gives you the name of the current command in the current context</p>
236
+
237
+ <div class="method-source-code" id="default_command-source">
238
+ <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 139</span>
239
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">default_command</span>(<span class="ruby-identifier">name</span>)
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>
241
+ <span class="ruby-keyword">end</span></pre>
242
+ </div>
243
+ </div>
244
+
245
+
246
+ </div>
247
+
248
+ <div id="method-i-end_command" class="method-detail ">
249
+ <div class="method-heading">
250
+ <span class="method-name">end_command</span><span
251
+ class="method-args">(_name)</span>
252
+ <span class="method-click-advice">click to toggle source</span>
253
+ </div>
254
+
255
+ <div class="method-description">
256
+ <p>Ends a command, and “pops” you back up one context</p>
257
+
258
+ <div class="method-source-code" id="end_command-source">
259
+ <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 132</span>
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>
262
+ <span class="ruby-identifier">decrement_nest</span>
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>
264
+ <span class="ruby-keyword">end</span></pre>
265
+ </div>
266
+ </div>
267
+
268
+
269
+ </div>
270
+
271
+ <div id="method-i-end_commands" class="method-detail ">
272
+ <div class="method-heading">
273
+ <span class="method-name">end_commands</span><span
274
+ class="method-args">()</span>
275
+ <span class="method-click-advice">click to toggle source</span>
276
+ </div>
277
+
278
+ <div class="method-description">
279
+
280
+
281
+ <div class="method-source-code" id="end_commands-source">
282
+ <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 143</span>
283
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">end_commands</span>
284
+ <span class="ruby-identifier">decrement_nest</span>
285
+ <span class="ruby-keyword">end</span></pre>
286
+ </div>
287
+ </div>
288
+
289
+
290
+ </div>
291
+
292
+ <div id="method-i-end_options" class="method-detail ">
293
+ <div class="method-heading">
294
+ <span class="method-name">end_options</span><span
295
+ class="method-args">()</span>
296
+ <span class="method-click-advice">click to toggle source</span>
297
+ </div>
298
+
299
+ <div class="method-description">
300
+
301
+
302
+ <div class="method-source-code" id="end_options-source">
303
+ <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 108</span>
304
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">end_options</span>
305
+ <span class="ruby-keyword">end</span></pre>
306
+ </div>
307
+ </div>
308
+
309
+
310
+ </div>
311
+
312
+ <div id="method-i-ending" class="method-detail ">
313
+ <div class="method-heading">
314
+ <span class="method-name">ending</span><span
315
+ class="method-args">()</span>
316
+ <span class="method-click-advice">click to toggle source</span>
317
+ </div>
318
+
319
+ <div class="method-description">
320
+ <p>Called when processing has completed</p>
321
+
322
+ <div class="method-source-code" id="ending-source">
323
+ <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 25</span>
324
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">ending</span>
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>)
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>)
327
+ <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
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
+
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>)
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>)
337
+ <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
338
+ <span class="ruby-keyword">end</span>
339
+ <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
340
+ <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;Documentation generated #{Time.now.strftime(&#39;%Y-%m-%d %H:%M&#39;)}&quot;</span>
341
+ <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
342
+ <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">close</span>
343
+ <span class="ruby-keyword">end</span></pre>
344
+ </div>
345
+ </div>
346
+
347
+
348
+ </div>
349
+
350
+ <div id="method-i-flag" class="method-detail ">
351
+ <div class="method-heading">
352
+ <span class="method-name">flag</span><span
353
+ class="method-args">(name, aliases, desc, long_desc, default_value, arg_name, must_match, _type)</span>
354
+ <span class="method-click-advice">click to toggle source</span>
355
+ </div>
356
+
357
+ <div class="method-description">
358
+ <p>Gives you a flag in the current context</p>
359
+
360
+ <div class="method-source-code" id="flag-source">
361
+ <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 80</span>
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>)
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>)
364
+ <span class="ruby-identifier">usage</span> = <span class="ruby-node">&quot;#{invocations} #{arg_name || &#39;arg&#39;}&quot;</span>
365
+ <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">header</span>(<span class="ruby-identifier">usage</span>, <span class="ruby-value">2</span>)
366
+ <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
367
+ <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>
368
+ <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;\n*Default Value:* `#{default_value || &#39;None&#39;}`\n&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">default_value</span>.<span class="ruby-identifier">nil?</span>
369
+ <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;\n*Must Match:* `#{must_match.to_s}`\n&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">must_match</span>.<span class="ruby-identifier">nil?</span>
370
+ <span class="ruby-identifier">cmd_desc</span> = <span class="ruby-constant">String</span>(<span class="ruby-identifier">long_desc</span>).<span class="ruby-identifier">strip</span>
371
+ <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;&gt; #{cmd_desc}\n&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">cmd_desc</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
372
+ <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
373
+ <span class="ruby-keyword">end</span></pre>
374
+ </div>
375
+ </div>
376
+
377
+
378
+ </div>
379
+
380
+ <div id="method-i-options" class="method-detail ">
381
+ <div class="method-heading">
382
+ <span class="method-name">options</span><span
383
+ class="method-args">()</span>
384
+ <span class="method-click-advice">click to toggle source</span>
385
+ </div>
386
+
387
+ <div class="method-description">
388
+
389
+
390
+ <div class="method-source-code" id="options-source">
391
+ <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 70</span>
392
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">options</span>
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>
394
+ <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span> <span class="ruby-string">&quot;## Global Options&quot;</span>
395
+ <span class="ruby-keyword">else</span>
396
+ <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">header</span>(<span class="ruby-string">&quot;Options&quot;</span>, <span class="ruby-value">1</span>)
397
+ <span class="ruby-keyword">end</span>
398
+ <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
399
+ <span class="ruby-keyword">end</span></pre>
400
+ </div>
401
+ </div>
402
+
403
+
404
+ </div>
405
+
406
+ <div id="method-i-program_desc" class="method-detail ">
407
+ <div class="method-heading">
408
+ <span class="method-name">program_desc</span><span
409
+ class="method-args">(desc)</span>
410
+ <span class="method-click-advice">click to toggle source</span>
411
+ </div>
412
+
413
+ <div class="method-description">
414
+ <p>Gives you the program description</p>
415
+
416
+ <div class="method-source-code" id="program_desc-source">
417
+ <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 47</span>
418
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">program_desc</span>(<span class="ruby-identifier">desc</span>)
419
+ <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;# #{@exe} CLI&quot;</span>
420
+ <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
421
+ <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">desc</span>
422
+ <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
423
+ <span class="ruby-keyword">end</span></pre>
424
+ </div>
425
+ </div>
426
+
427
+
428
+ </div>
429
+
430
+ <div id="method-i-program_long_desc" class="method-detail ">
431
+ <div class="method-heading">
432
+ <span class="method-name">program_long_desc</span><span
433
+ class="method-args">(desc)</span>
434
+ <span class="method-click-advice">click to toggle source</span>
435
+ </div>
436
+
437
+ <div class="method-description">
438
+
439
+
440
+ <div class="method-source-code" id="program_long_desc-source">
441
+ <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 54</span>
442
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">program_long_desc</span>(<span class="ruby-identifier">desc</span>)
443
+ <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;&gt; #{desc}&quot;</span>
444
+ <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
445
+ <span class="ruby-keyword">end</span></pre>
446
+ </div>
447
+ </div>
448
+
449
+
450
+ </div>
451
+
452
+ <div id="method-i-switch" class="method-detail ">
453
+ <div class="method-heading">
454
+ <span class="method-name">switch</span><span
455
+ class="method-args">(name, aliases, desc, long_desc, negatable)</span>
456
+ <span class="method-click-advice">click to toggle source</span>
457
+ </div>
458
+
459
+ <div class="method-description">
460
+ <p>Gives you a switch in the current context</p>
461
+
462
+ <div class="method-source-code" id="switch-source">
463
+ <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 94</span>
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>)
465
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">negatable</span>
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>
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> }
468
+ <span class="ruby-keyword">end</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>)
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>)
471
+ <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
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>
473
+ <span class="ruby-identifier">cmd_desc</span> = <span class="ruby-constant">String</span>(<span class="ruby-identifier">long_desc</span>).<span class="ruby-identifier">strip</span>
474
+ <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;\n&gt; #{cmd_desc}\n&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">cmd_desc</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
475
+ <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
476
+ <span class="ruby-keyword">end</span></pre>
477
+ </div>
478
+ </div>
479
+
480
+
481
+ </div>
482
+
483
+ <div id="method-i-version" class="method-detail ">
484
+ <div class="method-heading">
485
+ <span class="method-name">version</span><span
486
+ class="method-args">(version)</span>
487
+ <span class="method-click-advice">click to toggle source</span>
488
+ </div>
489
+
490
+ <div class="method-description">
491
+ <p>Gives you the program version</p>
492
+
493
+ <div class="method-source-code" id="version-source">
494
+ <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 60</span>
495
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">version</span>(<span class="ruby-identifier">version</span>)
496
+ <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;*v#{version}*&quot;</span>
497
+ <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
498
+ <span class="ruby-comment"># Hacking in the overview file</span>
499
+ <span class="ruby-keyword">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-string">&#39;OVERVIEW.md&#39;</span>)
500
+ <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;OVERVIEW.md&#39;</span>)
501
+ <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
502
+ <span class="ruby-keyword">end</span>
503
+ <span class="ruby-keyword">end</span></pre>
504
+ </div>
505
+ </div>
506
+
507
+
508
+ </div>
509
+
510
+ </section>
511
+
512
+ </section>
513
+ </main>
514
+
515
+
516
+ <footer id="validator-badges" role="contentinfo">
517
+ <p><a href="https://validator.w3.org/check/referer">Validate</a>
518
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.3.
519
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
520
+ </footer>
521
+
data/html/GLI/Commands.html ADDED
@@ -0,0 +1,91 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta charset="UTF-8">
6
+
7
+ <title>module GLI::Commands - hookapp</title>
8
+
9
+ <script type="text/javascript">
10
+ var rdoc_rel_prefix = "../";
11
+ var index_rel_prefix = "../";
12
+ </script>
13
+
14
+ <script src="../js/navigation.js" defer></script>
15
+ <script src="../js/search.js" defer></script>
16
+ <script src="../js/search_index.js" defer></script>
17
+ <script src="../js/searcher.js" defer></script>
18
+ <script src="../js/darkfish.js" defer></script>
19
+
20
+ <link href="../css/fonts.css" rel="stylesheet">
21
+ <link href="../css/rdoc.css" rel="stylesheet">
22
+
23
+
24
+ <body id="top" role="document" class="module">
25
+ <nav role="navigation">
26
+ <div id="project-navigation">
27
+ <div id="home-section" role="region" title="Quick navigation" class="nav-section">
28
+ <h2>
29
+ <a href="../index.html" rel="home">Home</a>
30
+ </h2>
31
+
32
+ <div id="table-of-contents-navigation">
33
+ <a href="../table_of_contents.html#pages">Pages</a>
34
+ <a href="../table_of_contents.html#classes">Classes</a>
35
+ <a href="../table_of_contents.html#methods">Methods</a>
36
+ </div>
37
+ </div>
38
+
39
+ <div id="search-section" role="search" class="project-section initially-hidden">
40
+ <form action="#" method="get" accept-charset="utf-8">
41
+ <div id="search-field-wrapper">
42
+ <input id="search-field" role="combobox" aria-label="Search"
43
+ aria-autocomplete="list" aria-controls="search-results"
44
+ type="text" name="search" placeholder="Search" spellcheck="false"
45
+ title="Type to search, Up and Down to navigate, Enter to load">
46
+ </div>
47
+
48
+ <ul id="search-results" aria-label="Search Results"
49
+ aria-busy="false" aria-expanded="false"
50
+ aria-atomic="false" class="initially-hidden"></ul>
51
+ </form>
52
+ </div>
53
+
54
+ </div>
55
+
56
+
57
+
58
+ <div id="class-metadata">
59
+
60
+
61
+
62
+
63
+
64
+ </div>
65
+ </nav>
66
+
67
+ <main role="main" aria-labelledby="module-GLI::Commands">
68
+ <h1 id="module-GLI::Commands" class="module">
69
+ module GLI::Commands
70
+ </h1>
71
+
72
+ <section class="description">
73
+
74
+ </section>
75
+
76
+ <section id="5Buntitled-5D" class="documentation-section">
77
+
78
+
79
+
80
+
81
+
82
+ </section>
83
+ </main>
84
+
85
+
86
+ <footer id="validator-badges" role="contentinfo">
87
+ <p><a href="https://validator.w3.org/check/referer">Validate</a>
88
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.3.
89
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
90
+ </footer>
91
+