bovem 3.0.5 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (82) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +4 -3
  3. data/.rubocop.yml +82 -0
  4. data/.travis-gemfile +4 -5
  5. data/.travis.yml +8 -6
  6. data/CHANGELOG.md +12 -0
  7. data/Gemfile +9 -8
  8. data/README.md +1 -1
  9. data/Rakefile +22 -6
  10. data/bovem.gemspec +5 -5
  11. data/doc/Bovem.html +10 -10
  12. data/doc/Bovem/Application.html +670 -318
  13. data/doc/Bovem/Command.html +1447 -1125
  14. data/doc/Bovem/CommandMethods.html +4 -4
  15. data/doc/Bovem/CommandMethods/Children.html +173 -179
  16. data/doc/Bovem/CommandMethods/Help.html +9 -9
  17. data/doc/Bovem/Configuration.html +239 -24
  18. data/doc/Bovem/Console.html +267 -128
  19. data/doc/Bovem/ConsoleMethods.html +4 -4
  20. data/doc/Bovem/ConsoleMethods/Interactions.html +57 -70
  21. data/doc/Bovem/ConsoleMethods/Interactions/ClassMethods.html +9 -9
  22. data/doc/Bovem/ConsoleMethods/Logging.html +258 -298
  23. data/doc/Bovem/ConsoleMethods/Logging/ClassMethods.html +8 -8
  24. data/doc/Bovem/ConsoleMethods/Output.html +96 -118
  25. data/doc/Bovem/ConsoleMethods/StyleHandling.html +8 -8
  26. data/doc/Bovem/ConsoleMethods/StyleHandling/ClassMethods.html +26 -39
  27. data/doc/Bovem/Errors.html +4 -4
  28. data/doc/Bovem/Errors/Error.html +4 -4
  29. data/doc/Bovem/Errors/InvalidConfiguration.html +4 -4
  30. data/doc/Bovem/Errors/InvalidLogger.html +4 -4
  31. data/doc/Bovem/I18n.html +175 -0
  32. data/doc/Bovem/Logger.html +95 -83
  33. data/doc/Bovem/Option.html +669 -862
  34. data/doc/Bovem/Parser.html +10 -10
  35. data/doc/Bovem/ParserMethods.html +4 -4
  36. data/doc/Bovem/ParserMethods/General.html +4 -4
  37. data/doc/Bovem/ParserMethods/General/ClassMethods.html +26 -38
  38. data/doc/Bovem/Shell.html +169 -48
  39. data/doc/Bovem/ShellMethods.html +4 -4
  40. data/doc/Bovem/ShellMethods/Directories.html +46 -62
  41. data/doc/Bovem/ShellMethods/Execute.html +51 -99
  42. data/doc/Bovem/ShellMethods/General.html +4 -445
  43. data/doc/Bovem/ShellMethods/Read.html +56 -61
  44. data/doc/Bovem/ShellMethods/Write.html +22 -242
  45. data/doc/Bovem/Version.html +6 -6
  46. data/doc/_index.html +18 -18
  47. data/doc/class_list.html +6 -2
  48. data/doc/css/style.css +1 -0
  49. data/doc/file.README.html +5 -5
  50. data/doc/file_list.html +5 -1
  51. data/doc/frames.html +1 -1
  52. data/doc/index.html +5 -5
  53. data/doc/js/full_list.js +4 -1
  54. data/doc/method_list.html +161 -157
  55. data/doc/top-level-namespace.html +4 -4
  56. data/lib/bovem.rb +3 -4
  57. data/lib/bovem/application.rb +47 -39
  58. data/lib/bovem/command.rb +175 -193
  59. data/lib/bovem/configuration.rb +28 -29
  60. data/lib/bovem/console.rb +244 -171
  61. data/lib/bovem/errors.rb +1 -1
  62. data/lib/bovem/i18n.rb +18 -0
  63. data/lib/bovem/logger.rb +26 -26
  64. data/lib/bovem/option.rb +49 -58
  65. data/lib/bovem/parser.rb +174 -222
  66. data/lib/bovem/shell.rb +272 -320
  67. data/lib/bovem/version.rb +2 -2
  68. data/locales/en.yml +39 -38
  69. data/locales/it.yml +39 -38
  70. data/spec/bovem/application_spec.rb +6 -5
  71. data/spec/bovem/command_spec.rb +23 -23
  72. data/spec/bovem/console_spec.rb +101 -102
  73. data/spec/bovem/i18n_spec.rb +21 -0
  74. data/spec/bovem/logger_spec.rb +4 -4
  75. data/spec/bovem/option_spec.rb +43 -43
  76. data/spec/bovem/parser_spec.rb +13 -13
  77. data/spec/bovem/shell_spec.rb +106 -115
  78. data/spec/spec_helper.rb +19 -6
  79. metadata +14 -13
  80. data/doc/Bovem/Localizer.html +0 -376
  81. data/lib/bovem/localizer.rb +0 -27
  82. data/spec/coverage_helper.rb +0 -20
@@ -6,7 +6,7 @@
6
6
  <title>
7
7
  Module: Bovem::ShellMethods::General
8
8
 
9
- &mdash; Documentation by YARD 0.8.7.3
9
+ &mdash; Documentation by YARD 0.8.7.6
10
10
 
11
11
  </title>
12
12
 
@@ -17,7 +17,7 @@
17
17
  <script type="text/javascript" charset="utf-8">
18
18
  hasFrames = window.top.frames.main ? true : false;
19
19
  relpath = '../../';
20
- framesUrl = "../../frames.html#!" + escape(window.location.href);
20
+ framesUrl = "../../frames.html#!Bovem/ShellMethods/General.html";
21
21
  </script>
22
22
 
23
23
 
@@ -105,455 +105,14 @@
105
105
 
106
106
 
107
107
 
108
-
109
- <h2>
110
- Instance Method Summary
111
- <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
112
- </h2>
113
-
114
- <ul class="summary">
115
-
116
- <li class="public ">
117
- <span class="summary_signature">
118
-
119
- <a href="#handle_failure-instance_method" title="#handle_failure (instance method)">- (Object) <strong>handle_failure</strong>(e, access_error, not_found_error, general_error, entries, fatal, show_errors) </a>
120
-
121
-
122
-
123
- </span>
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
-
132
-
133
- <span class="summary_desc"><div class='inline'><p>Handles general failure of a file/directory method.</p>
134
- </div></span>
135
-
136
- </li>
137
-
138
-
139
- <li class="public ">
140
- <span class="summary_signature">
141
-
142
- <a href="#setup_error_handling-instance_method" title="#setup_error_handling (instance method)">- (Array) <strong>setup_error_handling</strong>(entries, fatal) </a>
143
-
144
-
145
-
146
- </span>
147
-
148
-
149
-
150
-
151
-
152
-
153
-
154
-
155
-
156
- <span class="summary_desc"><div class='inline'><p>Setups error handling.</p>
157
- </div></span>
158
-
159
- </li>
160
-
161
-
162
- <li class="public ">
163
- <span class="summary_signature">
164
-
165
- <a href="#show_general_failure-instance_method" title="#show_general_failure (instance method)">- (Object) <strong>show_general_failure</strong>(e, general_error, entries, fatal) </a>
166
-
167
-
168
-
169
- </span>
170
-
171
-
172
-
173
-
174
-
175
-
176
-
177
-
178
-
179
- <span class="summary_desc"><div class='inline'><p>Shows errors when a directory creation failed.</p>
180
- </div></span>
181
-
182
- </li>
183
-
184
-
185
- </ul>
186
-
187
-
188
-
189
-
190
- <div id="instance_method_details" class="method_details_list">
191
- <h2>Instance Method Details</h2>
192
-
193
-
194
- <div class="method_details first">
195
- <h3 class="signature first" id="handle_failure-instance_method">
196
-
197
- - (<tt>Object</tt>) <strong>handle_failure</strong>(e, access_error, not_found_error, general_error, entries, fatal, show_errors)
198
-
199
-
200
-
201
-
202
-
203
- </h3><div class="docstring">
204
- <div class="discussion">
205
- <p>Handles general failure of a file/directory method.</p>
206
-
207
-
208
- </div>
209
- </div>
210
- <div class="tags">
211
- <p class="tag_title">Parameters:</p>
212
- <ul class="param">
213
-
214
- <li>
215
-
216
- <span class='name'>e</span>
217
-
218
-
219
- <span class='type'>(<tt>Exception</tt>)</span>
220
-
221
-
222
-
223
- &mdash;
224
- <div class='inline'><p>The occurred exception.</p>
225
- </div>
226
-
227
- </li>
228
-
229
- <li>
230
-
231
- <span class='name'>access_error</span>
232
-
233
-
234
- <span class='type'>(<tt>String|Symbol</tt>)</span>
235
-
236
-
237
-
238
- &mdash;
239
- <div class='inline'><p>The message to show in case of access errors.</p>
240
- </div>
241
-
242
- </li>
243
-
244
- <li>
245
-
246
- <span class='name'>not_found_error</span>
247
-
248
-
249
- <span class='type'>(<tt>String|Symbol</tt>)</span>
250
-
251
-
252
-
253
- &mdash;
254
- <div class='inline'><p>The message to show in case of a not found entry.</p>
255
- </div>
256
-
257
- </li>
258
-
259
- <li>
260
-
261
- <span class='name'>general_error</span>
262
-
263
-
264
- <span class='type'>(<tt>String|Symbol</tt>)</span>
265
-
266
-
267
-
268
- &mdash;
269
- <div class='inline'><p>The message to show in case of other errors.</p>
270
- </div>
271
-
272
- </li>
273
-
274
- <li>
275
-
276
- <span class='name'>entries</span>
277
-
278
-
279
- <span class='type'>(<tt>Array</tt>)</span>
280
-
281
-
282
-
283
- &mdash;
284
- <div class='inline'><p>The list of entries which failed.</p>
285
- </div>
286
-
287
- </li>
288
-
289
- <li>
290
-
291
- <span class='name'>fatal</span>
292
-
293
-
294
- <span class='type'>(<tt>Boolean</tt>)</span>
295
-
296
-
297
-
298
- &mdash;
299
- <div class='inline'><p>If quit in case of fatal errors.</p>
300
- </div>
301
-
302
- </li>
303
-
304
- <li>
305
-
306
- <span class='name'>show_errors</span>
307
-
308
-
309
- <span class='type'>(<tt>Boolean</tt>)</span>
310
-
311
-
312
-
313
- &mdash;
314
- <div class='inline'><p>Whether to show errors.</p>
315
- </div>
316
-
317
- </li>
318
-
319
- </ul>
320
-
321
-
322
- </div><table class="source_code">
323
- <tr>
324
- <td>
325
- <pre class="lines">
326
-
327
-
328
- 21
329
- 22
330
- 23
331
- 24
332
- 25
333
- 26
334
- 27
335
- 28
336
- 29</pre>
337
- </td>
338
- <td>
339
- <pre class="code"><span class="info file"># File 'lib/bovem/shell.rb', line 21</span>
340
-
341
- <span class='kw'>def</span> <span class='id identifier rubyid_handle_failure'>handle_failure</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='id identifier rubyid_access_error'>access_error</span><span class='comma'>,</span> <span class='id identifier rubyid_not_found_error'>not_found_error</span><span class='comma'>,</span> <span class='id identifier rubyid_general_error'>general_error</span><span class='comma'>,</span> <span class='id identifier rubyid_entries'>entries</span><span class='comma'>,</span> <span class='id identifier rubyid_fatal'>fatal</span><span class='comma'>,</span> <span class='id identifier rubyid_show_errors'>show_errors</span><span class='rparen'>)</span>
342
- <span class='id identifier rubyid_error_type'>error_type</span><span class='comma'>,</span> <span class='id identifier rubyid_locale'>locale</span><span class='comma'>,</span> <span class='id identifier rubyid_final_entries'>final_entries</span> <span class='op'>=</span> <span class='id identifier rubyid_setup_error_handling'>setup_error_handling</span><span class='lparen'>(</span><span class='id identifier rubyid_entries'>entries</span><span class='comma'>,</span> <span class='id identifier rubyid_fatal'>fatal</span><span class='rparen'>)</span>
343
-
344
- <span class='kw'>case</span> <span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
345
- <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Errno::EACCES</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>then</span> <span class='ivar'>@console</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_error_type'>error_type</span><span class='comma'>,</span> <span class='id identifier rubyid_locale'>locale</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_access_error'>access_error</span><span class='comma'>,</span> <span class='id identifier rubyid_final_entries'>final_entries</span><span class='rparen'>)</span><span class='rparen'>)</span>
346
- <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Errno::ENOENT</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>then</span> <span class='ivar'>@console</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_error_type'>error_type</span><span class='comma'>,</span> <span class='id identifier rubyid_locale'>locale</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_not_found_error'>not_found_error</span><span class='comma'>,</span> <span class='id identifier rubyid_final_entries'>final_entries</span><span class='rparen'>)</span><span class='rparen'>)</span>
347
- <span class='kw'>else</span> <span class='id identifier rubyid_show_general_failure'>show_general_failure</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='id identifier rubyid_general_error'>general_error</span><span class='comma'>,</span> <span class='id identifier rubyid_entries'>entries</span><span class='comma'>,</span> <span class='id identifier rubyid_fatal'>fatal</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_show_errors'>show_errors</span>
348
- <span class='kw'>end</span>
349
- <span class='kw'>end</span></pre>
350
- </td>
351
- </tr>
352
- </table>
353
- </div>
354
-
355
- <div class="method_details ">
356
- <h3 class="signature " id="setup_error_handling-instance_method">
357
-
358
- - (<tt>Array</tt>) <strong>setup_error_handling</strong>(entries, fatal)
359
-
360
-
361
-
362
-
363
-
364
- </h3><div class="docstring">
365
- <div class="discussion">
366
- <p>Setups error handling.</p>
367
-
368
-
369
- </div>
370
- </div>
371
- <div class="tags">
372
- <p class="tag_title">Parameters:</p>
373
- <ul class="param">
374
-
375
- <li>
376
-
377
- <span class='name'>entries</span>
378
-
379
-
380
- <span class='type'>(<tt>Array</tt>)</span>
381
-
382
-
383
-
384
- &mdash;
385
- <div class='inline'><p>The list of entries which failed.</p>
386
- </div>
387
-
388
- </li>
389
-
390
- <li>
391
-
392
- <span class='name'>fatal</span>
393
-
394
-
395
- <span class='type'>(<tt>Boolean</tt>)</span>
396
-
397
-
398
-
399
- &mdash;
400
- <div class='inline'><p>If quit in case of fatal errors.</p>
401
- </div>
402
-
403
- </li>
404
-
405
- </ul>
406
108
 
407
- <p class="tag_title">Returns:</p>
408
- <ul class="return">
409
-
410
- <li>
411
-
412
-
413
- <span class='type'>(<tt>Array</tt>)</span>
414
-
415
-
416
-
417
- &mdash;
418
- <div class='inline'><p>Variables for error handling</p>
419
- </div>
420
-
421
- </li>
422
-
423
- </ul>
424
-
425
- </div><table class="source_code">
426
- <tr>
427
- <td>
428
- <pre class="lines">
429
-
430
-
431
- 36
432
- 37
433
- 38</pre>
434
- </td>
435
- <td>
436
- <pre class="code"><span class="info file"># File 'lib/bovem/shell.rb', line 36</span>
437
-
438
- <span class='kw'>def</span> <span class='id identifier rubyid_setup_error_handling'>setup_error_handling</span><span class='lparen'>(</span><span class='id identifier rubyid_entries'>entries</span><span class='comma'>,</span> <span class='id identifier rubyid_fatal'>fatal</span><span class='rparen'>)</span>
439
- <span class='lbracket'>[</span><span class='id identifier rubyid_fatal'>fatal</span> <span class='op'>?</span> <span class='symbol'>:fatal</span> <span class='op'>:</span> <span class='symbol'>:error</span><span class='comma'>,</span> <span class='id identifier rubyid_i18n'>i18n</span><span class='period'>.</span><span class='id identifier rubyid_shell'>shell</span><span class='comma'>,</span> <span class='id identifier rubyid_entries'>entries</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span> <span class='op'>==</span> <span class='int'>1</span> <span class='op'>?</span> <span class='id identifier rubyid_entries'>entries</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> <span class='op'>:</span> <span class='id identifier rubyid_entries'>entries</span><span class='rbracket'>]</span>
440
- <span class='kw'>end</span></pre>
441
- </td>
442
- </tr>
443
- </table>
444
- </div>
445
-
446
- <div class="method_details ">
447
- <h3 class="signature " id="show_general_failure-instance_method">
448
-
449
- - (<tt>Object</tt>) <strong>show_general_failure</strong>(e, general_error, entries, fatal)
450
-
451
-
452
-
453
-
454
-
455
- </h3><div class="docstring">
456
- <div class="discussion">
457
- <p>Shows errors when a directory creation failed.</p>
458
-
459
-
460
- </div>
461
- </div>
462
- <div class="tags">
463
- <p class="tag_title">Parameters:</p>
464
- <ul class="param">
465
-
466
- <li>
467
-
468
- <span class='name'>e</span>
469
-
470
-
471
- <span class='type'>(<tt>Exception</tt>)</span>
472
-
473
-
474
-
475
- &mdash;
476
- <div class='inline'><p>The occurred exception.</p>
477
- </div>
478
-
479
- </li>
480
-
481
- <li>
482
-
483
- <span class='name'>entries</span>
484
-
485
-
486
- <span class='type'>(<tt>Array</tt>)</span>
487
-
488
-
489
-
490
- &mdash;
491
- <div class='inline'><p>The list of entries which failed.</p>
492
- </div>
493
-
494
- </li>
495
-
496
- <li>
497
-
498
- <span class='name'>fatal</span>
499
-
500
-
501
- <span class='type'>(<tt>Boolean</tt>)</span>
502
-
503
-
504
-
505
- &mdash;
506
- <div class='inline'><p>If quit in case of fatal errors.</p>
507
- </div>
508
-
509
- </li>
510
-
511
- </ul>
512
-
513
-
514
- </div><table class="source_code">
515
- <tr>
516
- <td>
517
- <pre class="lines">
518
-
519
-
520
- 45
521
- 46
522
- 47
523
- 48
524
- 49
525
- 50
526
- 51
527
- 52
528
- 53
529
- 54</pre>
530
- </td>
531
- <td>
532
- <pre class="code"><span class="info file"># File 'lib/bovem/shell.rb', line 45</span>
533
-
534
- <span class='kw'>def</span> <span class='id identifier rubyid_show_general_failure'>show_general_failure</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='id identifier rubyid_general_error'>general_error</span><span class='comma'>,</span> <span class='id identifier rubyid_entries'>entries</span><span class='comma'>,</span> <span class='id identifier rubyid_fatal'>fatal</span><span class='rparen'>)</span>
535
- <span class='id identifier rubyid_locale'>locale</span> <span class='op'>=</span> <span class='id identifier rubyid_i18n'>i18n</span><span class='period'>.</span><span class='id identifier rubyid_shell'>shell</span>
536
-
537
- <span class='ivar'>@console</span><span class='period'>.</span><span class='id identifier rubyid_error'>error</span><span class='lparen'>(</span><span class='id identifier rubyid_locale'>locale</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_general_error'>general_error</span><span class='rparen'>)</span><span class='rparen'>)</span>
538
- <span class='ivar'>@console</span><span class='period'>.</span><span class='id identifier rubyid_with_indentation'>with_indentation</span><span class='lparen'>(</span><span class='int'>11</span><span class='rparen'>)</span> <span class='kw'>do</span>
539
- <span class='id identifier rubyid_entries'>entries</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_entry'>entry</span><span class='op'>|</span> <span class='ivar'>@console</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='id identifier rubyid_entry'>entry</span><span class='rparen'>)</span> <span class='kw'>end</span>
540
- <span class='kw'>end</span>
541
- <span class='ivar'>@console</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='id identifier rubyid_locale'>locale</span><span class='period'>.</span><span class='id identifier rubyid_error'>error</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='comma'>,</span> <span class='id identifier rubyid_e'>e</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='int'>5</span><span class='rparen'>)</span>
542
- <span class='const'>Kernel</span><span class='period'>.</span><span class='id identifier rubyid_exit'>exit</span><span class='lparen'>(</span><span class='op'>-</span><span class='int'>1</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_fatal'>fatal</span>
543
- <span class='kw'>end</span></pre>
544
- </td>
545
- </tr>
546
- </table>
547
- </div>
548
-
549
- </div>
550
109
 
551
110
  </div>
552
111
 
553
112
  <div id="footer">
554
- Generated on Sat Mar 8 10:27:42 2014 by
113
+ Generated on Tue Mar 29 20:43:16 2016 by
555
114
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
556
- 0.8.7.3 (ruby-2.1.0).
115
+ 0.8.7.6 (ruby-2.3.0).
557
116
  </div>
558
117
 
559
118
  </body>