hookapp 2.0.5 → 2.0.7

Sign up to get free protection for your applications and to get access to all the features.
Files changed (87) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +26 -3
  4. data/Rakefile +7 -3
  5. data/bin/hook +49 -2
  6. data/buildnotes.md +30 -0
  7. data/hook.rdoc +21 -2
  8. data/lib/helpers/fuzzyfilefinder +0 -0
  9. data/lib/hook/hookapp.rb +29 -10
  10. data/lib/hook/string.rb +4 -0
  11. data/lib/hook/version.rb +1 -1
  12. data/test/helpers/hook-helpers.rb +76 -0
  13. data/test/hook_clip_test.rb +24 -0
  14. data/test/hook_clone_test.rb +30 -0
  15. data/test/hook_encode_test.rb +30 -0
  16. data/test/hook_link_test.rb +39 -0
  17. data/test/hook_list_test.rb +25 -0
  18. data/test/hook_remove_test.rb +34 -0
  19. data/test/hook_scripts_test.rb +21 -0
  20. metadata +10 -69
  21. data/html/App.html +0 -107
  22. data/html/GLI/Commands/Doc.html +0 -91
  23. data/html/GLI/Commands/MarkdownDocumentListener.html +0 -511
  24. data/html/GLI/Commands.html +0 -91
  25. data/html/GLI.html +0 -91
  26. data/html/Hook.html +0 -100
  27. data/html/HookApp.html +0 -946
  28. data/html/Hooker.html +0 -141
  29. data/html/README_rdoc.html +0 -325
  30. data/html/String.html +0 -313
  31. data/html/created.rid +0 -9
  32. data/html/css/fonts.css +0 -167
  33. data/html/css/rdoc.css +0 -639
  34. data/html/fonts/Lato-Light.ttf +0 -0
  35. data/html/fonts/Lato-LightItalic.ttf +0 -0
  36. data/html/fonts/Lato-Regular.ttf +0 -0
  37. data/html/fonts/Lato-RegularItalic.ttf +0 -0
  38. data/html/fonts/SourceCodePro-Bold.ttf +0 -0
  39. data/html/fonts/SourceCodePro-Regular.ttf +0 -0
  40. data/html/images/add.png +0 -0
  41. data/html/images/arrow_up.png +0 -0
  42. data/html/images/brick.png +0 -0
  43. data/html/images/brick_link.png +0 -0
  44. data/html/images/bug.png +0 -0
  45. data/html/images/bullet_black.png +0 -0
  46. data/html/images/bullet_toggle_minus.png +0 -0
  47. data/html/images/bullet_toggle_plus.png +0 -0
  48. data/html/images/date.png +0 -0
  49. data/html/images/delete.png +0 -0
  50. data/html/images/find.png +0 -0
  51. data/html/images/loadingAnimation.gif +0 -0
  52. data/html/images/macFFBgHack.png +0 -0
  53. data/html/images/package.png +0 -0
  54. data/html/images/page_green.png +0 -0
  55. data/html/images/page_white_text.png +0 -0
  56. data/html/images/page_white_width.png +0 -0
  57. data/html/images/plugin.png +0 -0
  58. data/html/images/ruby.png +0 -0
  59. data/html/images/tag_blue.png +0 -0
  60. data/html/images/tag_green.png +0 -0
  61. data/html/images/transparent.png +0 -0
  62. data/html/images/wrench.png +0 -0
  63. data/html/images/wrench_orange.png +0 -0
  64. data/html/images/zoom.png +0 -0
  65. data/html/index.html +0 -293
  66. data/html/js/darkfish.js +0 -84
  67. data/html/js/navigation.js +0 -105
  68. data/html/js/navigation.js.gz +0 -0
  69. data/html/js/search.js +0 -110
  70. data/html/js/search_index.js +0 -1
  71. data/html/js/search_index.js.gz +0 -0
  72. data/html/js/searcher.js +0 -229
  73. data/html/js/searcher.js.gz +0 -0
  74. data/html/table_of_contents.html +0 -345
  75. data/test/default_test.rb +0 -14
  76. data/test/hookfiles/01.test +0 -0
  77. data/test/hookfiles/02.test +0 -0
  78. data/test/hookfiles/03.test +0 -0
  79. data/test/hookfiles/04.test +0 -0
  80. data/test/hookfiles/05.test +0 -0
  81. data/test/hookfiles/06.test +0 -0
  82. data/test/hookfiles/07.test +0 -0
  83. data/test/hookfiles/08.test +0 -0
  84. data/test/hookfiles/09.test +0 -0
  85. data/test/hookfiles/10.test +0 -0
  86. data/test/hookfiles/11.test +0 -0
  87. data/test/hookfiles/12.test +0 -0
data/html/GLI/Commands/MarkdownDocumentListener.html DELETED
@@ -1,511 +0,0 @@
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-keyword">end</span></pre>
140
- </div>
141
- </div>
142
-
143
-
144
- </div>
145
-
146
- </section>
147
-
148
- <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
149
- <header>
150
- <h3>Public Instance Methods</h3>
151
- </header>
152
-
153
- <div id="method-i-beginning" class="method-detail ">
154
- <div class="method-heading">
155
- <span class="method-name">beginning</span><span
156
- class="method-args">()</span>
157
- <span class="method-click-advice">click to toggle source</span>
158
- </div>
159
-
160
- <div class="method-description">
161
-
162
-
163
- <div class="method-source-code" id="beginning-source">
164
- <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 20</span>
165
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">beginning</span>
166
- <span class="ruby-keyword">end</span></pre>
167
- </div>
168
- </div>
169
-
170
-
171
- </div>
172
-
173
- <div id="method-i-command" class="method-detail ">
174
- <div class="method-heading">
175
- <span class="method-name">command</span><span
176
- class="method-args">(name, aliases, desc, long_desc, arg_name, arg_options)</span>
177
- <span class="method-click-advice">click to toggle source</span>
178
- </div>
179
-
180
- <div class="method-description">
181
- <p>Gives you a command in the current context and creates a new context of this command</p>
182
-
183
- <div class="method-source-code" id="command-source">
184
- <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 111</span>
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>)
186
- <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>, [])
187
- <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>)
188
- <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
189
- <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;*#{String(desc).strip}*&quot;</span>
190
- <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
191
- <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>)
192
- <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>
193
- <span class="ruby-identifier">increment_nest</span>
194
- <span class="ruby-keyword">end</span></pre>
195
- </div>
196
- </div>
197
-
198
-
199
- </div>
200
-
201
- <div id="method-i-commands" class="method-detail ">
202
- <div class="method-heading">
203
- <span class="method-name">commands</span><span
204
- class="method-args">()</span>
205
- <span class="method-click-advice">click to toggle source</span>
206
- </div>
207
-
208
- <div class="method-description">
209
-
210
-
211
- <div class="method-source-code" id="commands-source">
212
- <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 104</span>
213
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">commands</span>
214
- <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>)
215
- <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
216
- <span class="ruby-identifier">increment_nest</span>
217
- <span class="ruby-keyword">end</span></pre>
218
- </div>
219
- </div>
220
-
221
-
222
- </div>
223
-
224
- <div id="method-i-default_command" class="method-detail ">
225
- <div class="method-heading">
226
- <span class="method-name">default_command</span><span
227
- class="method-args">(name)</span>
228
- <span class="method-click-advice">click to toggle source</span>
229
- </div>
230
-
231
- <div class="method-description">
232
- <p>Gives you the name of the current command in the current context</p>
233
-
234
- <div class="method-source-code" id="default_command-source">
235
- <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 129</span>
236
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">default_command</span>(<span class="ruby-identifier">name</span>)
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>
238
- <span class="ruby-keyword">end</span></pre>
239
- </div>
240
- </div>
241
-
242
-
243
- </div>
244
-
245
- <div id="method-i-end_command" class="method-detail ">
246
- <div class="method-heading">
247
- <span class="method-name">end_command</span><span
248
- class="method-args">(_name)</span>
249
- <span class="method-click-advice">click to toggle source</span>
250
- </div>
251
-
252
- <div class="method-description">
253
- <p>Ends a command, and “pops” you back up one context</p>
254
-
255
- <div class="method-source-code" id="end_command-source">
256
- <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 123</span>
257
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">end_command</span>(<span class="ruby-identifier">_name</span>)
258
- <span class="ruby-identifier">decrement_nest</span>
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>
260
- <span class="ruby-keyword">end</span></pre>
261
- </div>
262
- </div>
263
-
264
-
265
- </div>
266
-
267
- <div id="method-i-end_commands" class="method-detail ">
268
- <div class="method-heading">
269
- <span class="method-name">end_commands</span><span
270
- class="method-args">()</span>
271
- <span class="method-click-advice">click to toggle source</span>
272
- </div>
273
-
274
- <div class="method-description">
275
-
276
-
277
- <div class="method-source-code" id="end_commands-source">
278
- <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 133</span>
279
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">end_commands</span>
280
- <span class="ruby-identifier">decrement_nest</span>
281
- <span class="ruby-keyword">end</span></pre>
282
- </div>
283
- </div>
284
-
285
-
286
- </div>
287
-
288
- <div id="method-i-end_options" class="method-detail ">
289
- <div class="method-heading">
290
- <span class="method-name">end_options</span><span
291
- class="method-args">()</span>
292
- <span class="method-click-advice">click to toggle source</span>
293
- </div>
294
-
295
- <div class="method-description">
296
-
297
-
298
- <div class="method-source-code" id="end_options-source">
299
- <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 101</span>
300
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">end_options</span>
301
- <span class="ruby-keyword">end</span></pre>
302
- </div>
303
- </div>
304
-
305
-
306
- </div>
307
-
308
- <div id="method-i-ending" class="method-detail ">
309
- <div class="method-heading">
310
- <span class="method-name">ending</span><span
311
- class="method-args">()</span>
312
- <span class="method-click-advice">click to toggle source</span>
313
- </div>
314
-
315
- <div class="method-description">
316
- <p>Called when processing has completed</p>
317
-
318
- <div class="method-source-code" id="ending-source">
319
- <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 24</span>
320
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">ending</span>
321
- <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>)
322
- <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>)
323
- <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
324
- <span class="ruby-keyword">end</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;LICENSE.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;LICENSE.md&#39;</span>)
327
- <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
328
- <span class="ruby-keyword">end</span>
329
- <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
330
- <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>
331
- <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
332
- <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">close</span>
333
- <span class="ruby-keyword">end</span></pre>
334
- </div>
335
- </div>
336
-
337
-
338
- </div>
339
-
340
- <div id="method-i-flag" class="method-detail ">
341
- <div class="method-heading">
342
- <span class="method-name">flag</span><span
343
- class="method-args">(name, aliases, desc, long_desc, default_value, arg_name, must_match, _type)</span>
344
- <span class="method-click-advice">click to toggle source</span>
345
- </div>
346
-
347
- <div class="method-description">
348
- <p>Gives you a flag in the current context</p>
349
-
350
- <div class="method-source-code" id="flag-source">
351
- <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 73</span>
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>)
353
- <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>)
354
- <span class="ruby-identifier">usage</span> = <span class="ruby-node">&quot;#{invocations} #{arg_name || &#39;arg&#39;}&quot;</span>
355
- <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>)
356
- <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
357
- <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>
358
- <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>
359
- <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>
360
- <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>
361
- <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>
362
- <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
363
- <span class="ruby-keyword">end</span></pre>
364
- </div>
365
- </div>
366
-
367
-
368
- </div>
369
-
370
- <div id="method-i-options" class="method-detail ">
371
- <div class="method-heading">
372
- <span class="method-name">options</span><span
373
- class="method-args">()</span>
374
- <span class="method-click-advice">click to toggle source</span>
375
- </div>
376
-
377
- <div class="method-description">
378
-
379
-
380
- <div class="method-source-code" id="options-source">
381
- <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 63</span>
382
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">options</span>
383
- <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>
384
- <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span> <span class="ruby-string">&quot;## Global Options&quot;</span>
385
- <span class="ruby-keyword">else</span>
386
- <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>)
387
- <span class="ruby-keyword">end</span>
388
- <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
389
- <span class="ruby-keyword">end</span></pre>
390
- </div>
391
- </div>
392
-
393
-
394
- </div>
395
-
396
- <div id="method-i-program_desc" class="method-detail ">
397
- <div class="method-heading">
398
- <span class="method-name">program_desc</span><span
399
- class="method-args">(desc)</span>
400
- <span class="method-click-advice">click to toggle source</span>
401
- </div>
402
-
403
- <div class="method-description">
404
- <p>Gives you the program description</p>
405
-
406
- <div class="method-source-code" id="program_desc-source">
407
- <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 40</span>
408
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">program_desc</span>(<span class="ruby-identifier">desc</span>)
409
- <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;# #{@exe} CLI&quot;</span>
410
- <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
411
- <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">desc</span>
412
- <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
413
- <span class="ruby-keyword">end</span></pre>
414
- </div>
415
- </div>
416
-
417
-
418
- </div>
419
-
420
- <div id="method-i-program_long_desc" class="method-detail ">
421
- <div class="method-heading">
422
- <span class="method-name">program_long_desc</span><span
423
- class="method-args">(desc)</span>
424
- <span class="method-click-advice">click to toggle source</span>
425
- </div>
426
-
427
- <div class="method-description">
428
-
429
-
430
- <div class="method-source-code" id="program_long_desc-source">
431
- <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 47</span>
432
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">program_long_desc</span>(<span class="ruby-identifier">desc</span>)
433
- <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;&gt; #{desc}&quot;</span>
434
- <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
435
- <span class="ruby-keyword">end</span></pre>
436
- </div>
437
- </div>
438
-
439
-
440
- </div>
441
-
442
- <div id="method-i-switch" class="method-detail ">
443
- <div class="method-heading">
444
- <span class="method-name">switch</span><span
445
- class="method-args">(name, aliases, desc, long_desc, negatable)</span>
446
- <span class="method-click-advice">click to toggle source</span>
447
- </div>
448
-
449
- <div class="method-description">
450
- <p>Gives you a switch in the current context</p>
451
-
452
- <div class="method-source-code" id="switch-source">
453
- <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 87</span>
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>)
455
- <span class="ruby-keyword">if</span> <span class="ruby-identifier">negatable</span>
456
- <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>
457
- <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> }
458
- <span class="ruby-keyword">end</span>
459
- <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>)
460
- <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>)
461
- <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
462
- <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>
463
- <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>
464
- <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>
465
- <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
466
- <span class="ruby-keyword">end</span></pre>
467
- </div>
468
- </div>
469
-
470
-
471
- </div>
472
-
473
- <div id="method-i-version" class="method-detail ">
474
- <div class="method-heading">
475
- <span class="method-name">version</span><span
476
- class="method-args">(version)</span>
477
- <span class="method-click-advice">click to toggle source</span>
478
- </div>
479
-
480
- <div class="method-description">
481
- <p>Gives you the program version</p>
482
-
483
- <div class="method-source-code" id="version-source">
484
- <pre><span class="ruby-comment"># File lib/hook/markdown_document_listener.rb, line 53</span>
485
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">version</span>(<span class="ruby-identifier">version</span>)
486
- <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;*v#{version}*&quot;</span>
487
- <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
488
- <span class="ruby-comment"># Hacking in the overview file</span>
489
- <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>)
490
- <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>)
491
- <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">puts</span>
492
- <span class="ruby-keyword">end</span>
493
- <span class="ruby-keyword">end</span></pre>
494
- </div>
495
- </div>
496
-
497
-
498
- </div>
499
-
500
- </section>
501
-
502
- </section>
503
- </main>
504
-
505
-
506
- <footer id="validator-badges" role="contentinfo">
507
- <p><a href="https://validator.w3.org/check/referer">Validate</a>
508
- <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.2.
509
- <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
510
- </footer>
511
-
data/html/GLI/Commands.html DELETED
@@ -1,91 +0,0 @@
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.2.
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
-