action_command 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,982 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Module: ActionCommand
8
+
9
+ &mdash; Documentation by YARD 0.8.7.6
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '';
20
+ framesUrl = "frames.html#!ActionCommand.html";
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="_index.html">Index (A)</a> &raquo;
35
+
36
+
37
+ <span class="title">ActionCommand</span>
38
+
39
+
40
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
+ </div>
42
+
43
+ <div id="search">
44
+
45
+ <a class="full_list_link" id="class_list_link"
46
+ href="class_list.html">
47
+ Class List
48
+ </a>
49
+
50
+ <a class="full_list_link" id="method_list_link"
51
+ href="method_list.html">
52
+ Method List
53
+ </a>
54
+
55
+ <a class="full_list_link" id="file_list_link"
56
+ href="file_list.html">
57
+ File List
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <iframe id="search_frame"></iframe>
65
+
66
+ <div id="content"><h1>Module: ActionCommand
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+
75
+
76
+
77
+
78
+
79
+
80
+
81
+ <dt class="r1 last">Defined in:</dt>
82
+ <dd class="r1 last">lib/action_command.rb<span class="defines">,<br />
83
+ lib/action_command/version.rb</span>
84
+ </dd>
85
+
86
+ </dl>
87
+ <div class="clear"></div>
88
+
89
+ <h2>Overview</h2><div class="docstring">
90
+ <div class="discussion">
91
+
92
+ <p>To use action command, create subclasses of ActionCommand::Executable and
93
+ run them using the ActionCommand.execute_… variants.</p>
94
+
95
+
96
+ </div>
97
+ </div>
98
+ <div class="tags">
99
+
100
+
101
+ </div><h2>Defined Under Namespace</h2>
102
+ <p class="children">
103
+
104
+
105
+
106
+
107
+ <strong class="classes">Classes:</strong> <span class='object_link'><a href="ActionCommand/Executable.html" title="ActionCommand::Executable (class)">Executable</a></span>, <span class='object_link'><a href="ActionCommand/InputOutput.html" title="ActionCommand::InputOutput (class)">InputOutput</a></span>, <span class='object_link'><a href="ActionCommand/Result.html" title="ActionCommand::Result (class)">Result</a></span>
108
+
109
+
110
+ </p>
111
+
112
+ <h2>Constant Summary</h2>
113
+
114
+ <dl class="constants">
115
+
116
+ <dt id="CONTEXT_TEST-constant" class="">CONTEXT_TEST =
117
+ <div class="docstring">
118
+ <div class="discussion">
119
+
120
+ <p>Used as root parent of command if we are in a testing context.</p>
121
+
122
+
123
+ </div>
124
+ </div>
125
+ <div class="tags">
126
+
127
+
128
+ </div>
129
+ </dt>
130
+ <dd><pre class="code"><span class='symbol'>:test</span></pre></dd>
131
+
132
+ <dt id="CONTEXT_RAKE-constant" class="">CONTEXT_RAKE =
133
+ <div class="docstring">
134
+ <div class="discussion">
135
+
136
+ <p>Used as root parent of command if we are in a rake task</p>
137
+
138
+
139
+ </div>
140
+ </div>
141
+ <div class="tags">
142
+
143
+
144
+ </div>
145
+ </dt>
146
+ <dd><pre class="code"><span class='symbol'>:rake</span></pre></dd>
147
+
148
+ <dt id="CONTEXT_RAILS-constant" class="">CONTEXT_RAILS =
149
+ <div class="docstring">
150
+ <div class="discussion">
151
+
152
+ <p>Used as root parent of command if we are executing it from rails (a
153
+ controller, etc)</p>
154
+
155
+
156
+ </div>
157
+ </div>
158
+ <div class="tags">
159
+
160
+
161
+ </div>
162
+ </dt>
163
+ <dd><pre class="code"><span class='symbol'>:rails</span></pre></dd>
164
+
165
+ <dt id="VERSION-constant" class="">VERSION =
166
+ <div class="docstring">
167
+ <div class="discussion">
168
+
169
+ <p>Version of this Gem</p>
170
+
171
+
172
+ </div>
173
+ </div>
174
+ <div class="tags">
175
+
176
+
177
+ </div>
178
+ </dt>
179
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>0.1.0</span><span class='tstring_end'>&#39;</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
180
+
181
+ <dt id="logger-classvariable" class="">@@logger =
182
+ <div class="docstring">
183
+ <div class="discussion">
184
+
185
+ <p>rubocop:disable Style/ClassVars</p>
186
+
187
+
188
+ </div>
189
+ </div>
190
+ <div class="tags">
191
+
192
+
193
+ </div>
194
+ </dt>
195
+ <dd><pre class="code"><span class='kw'>nil</span></pre></dd>
196
+
197
+ <dt id="params-classvariable" class="">@@params =
198
+ <div class="docstring">
199
+ <div class="discussion">
200
+
201
+ <p>rubocop:disable Style/ClassVars</p>
202
+
203
+
204
+ </div>
205
+ </div>
206
+ <div class="tags">
207
+
208
+
209
+ </div>
210
+ </dt>
211
+ <dd><pre class="code"><span class='lbrace'>{</span><span class='rbrace'>}</span></pre></dd>
212
+
213
+ </dl>
214
+
215
+
216
+
217
+
218
+
219
+
220
+
221
+
222
+
223
+ <h2>
224
+ Class Method Summary
225
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
226
+ </h2>
227
+
228
+ <ul class="summary">
229
+
230
+ <li class="public ">
231
+ <span class="summary_signature">
232
+
233
+ <a href="#create_and_execute-class_method" title="create_and_execute (class method)">+ (Object) <strong>create_and_execute</strong>(cls, params, parent, result) </a>
234
+
235
+
236
+
237
+ </span>
238
+
239
+
240
+
241
+
242
+
243
+
244
+
245
+
246
+
247
+ <span class="summary_desc"><div class='inline'>
248
+ <p>Used internally, not for general purpose use.</p>
249
+ </div></span>
250
+
251
+ </li>
252
+
253
+
254
+ <li class="public ">
255
+ <span class="summary_signature">
256
+
257
+ <a href="#create_result-class_method" title="create_result (class method)">+ (Object) <strong>create_result</strong> </a>
258
+
259
+
260
+
261
+ </span>
262
+
263
+
264
+
265
+
266
+
267
+
268
+
269
+
270
+
271
+ <span class="summary_desc"><div class='inline'>
272
+ <p>A new, valid, empty result.</p>
273
+ </div></span>
274
+
275
+ </li>
276
+
277
+
278
+ <li class="public ">
279
+ <span class="summary_signature">
280
+
281
+ <a href="#describe_io-class_method" title="describe_io (class method)">+ (Object) <strong>describe_io</strong>(cmd_cls, desc) </a>
282
+
283
+
284
+
285
+ </span>
286
+
287
+
288
+
289
+
290
+
291
+
292
+
293
+
294
+
295
+ <span class="summary_desc"><div class='inline'>
296
+ <p>Create a global description of the inputs and outputs of a command.</p>
297
+ </div></span>
298
+
299
+ </li>
300
+
301
+
302
+ <li class="public ">
303
+ <span class="summary_signature">
304
+
305
+ <a href="#execute_rails-class_method" title="execute_rails (class method)">+ (ActionCommand::Result) <strong>execute_rails</strong>(cls, params = {}) </a>
306
+
307
+
308
+
309
+ </span>
310
+
311
+
312
+
313
+
314
+
315
+
316
+
317
+
318
+
319
+ <span class="summary_desc"><div class='inline'>
320
+ <p>Execute a command at the root level of a rails context.</p>
321
+ </div></span>
322
+
323
+ </li>
324
+
325
+
326
+ <li class="public ">
327
+ <span class="summary_signature">
328
+
329
+ <a href="#execute_rake-class_method" title="execute_rake (class method)">+ (ActionCommand::Result) <strong>execute_rake</strong>(cls, args = {}) </a>
330
+
331
+
332
+
333
+ </span>
334
+
335
+
336
+
337
+
338
+
339
+
340
+
341
+
342
+
343
+ <span class="summary_desc"><div class='inline'>
344
+ <p>Execute a command at the root level of a rake task context.</p>
345
+ </div></span>
346
+
347
+ </li>
348
+
349
+
350
+ <li class="public ">
351
+ <span class="summary_signature">
352
+
353
+ <a href="#execute_test-class_method" title="execute_test (class method)">+ (ActionCommand::Result) <strong>execute_test</strong>(rspec, cls, params = {}) </a>
354
+
355
+
356
+
357
+ </span>
358
+
359
+
360
+
361
+
362
+
363
+
364
+
365
+
366
+
367
+ <span class="summary_desc"><div class='inline'>
368
+ <p>Execute a command at the root level of a testing context.</p>
369
+ </div></span>
370
+
371
+ </li>
372
+
373
+
374
+ <li class="public ">
375
+ <span class="summary_signature">
376
+
377
+ <a href="#logger%3D-class_method" title="logger= (class method)">+ (Object) <strong>logger=</strong>(logger) </a>
378
+
379
+
380
+
381
+ </span>
382
+
383
+
384
+
385
+
386
+
387
+
388
+
389
+
390
+
391
+ <span class="summary_desc"><div class='inline'>
392
+ <p>Set a logger to be used when creating commands.</p>
393
+ </div></span>
394
+
395
+ </li>
396
+
397
+
398
+ </ul>
399
+
400
+
401
+
402
+
403
+ <div id="class_method_details" class="method_details_list">
404
+ <h2>Class Method Details</h2>
405
+
406
+
407
+ <div class="method_details first">
408
+ <h3 class="signature first" id="create_and_execute-class_method">
409
+
410
+ + (<tt>Object</tt>) <strong>create_and_execute</strong>(cls, params, parent, result)
411
+
412
+
413
+
414
+
415
+
416
+ </h3><div class="docstring">
417
+ <div class="discussion">
418
+
419
+ <p>Used internally, not for general purpose use.</p>
420
+
421
+
422
+ </div>
423
+ </div>
424
+ <div class="tags">
425
+
426
+ <p class="tag_title">Raises:</p>
427
+ <ul class="raise">
428
+
429
+ <li>
430
+
431
+
432
+ <span class='type'>(<tt>ArgumentError</tt>)</span>
433
+
434
+
435
+
436
+ </li>
437
+
438
+ </ul>
439
+
440
+ </div><table class="source_code">
441
+ <tr>
442
+ <td>
443
+ <pre class="lines">
444
+
445
+
446
+ 85
447
+ 86
448
+ 87
449
+ 88
450
+ 89
451
+ 90
452
+ 91
453
+ 92
454
+ 93
455
+ 94
456
+ 95</pre>
457
+ </td>
458
+ <td>
459
+ <pre class="code"><span class="info file"># File 'lib/action_command.rb', line 85</span>
460
+
461
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_create_and_execute'>create_and_execute</span><span class='lparen'>(</span><span class='id identifier rubyid_cls'>cls</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_parent'>parent</span><span class='comma'>,</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
462
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Expected params to be a Hash</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>Hash</span>
463
+
464
+ <span class='kw'>unless</span> <span class='id identifier rubyid_cls'>cls</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Class</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_cls'>cls</span><span class='period'>.</span><span class='id identifier rubyid_ancestors'>ancestors</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='const'>ActionCommand</span><span class='op'>::</span><span class='const'>Executable</span><span class='rparen'>)</span>
465
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Expected an ActionCommand::Executable as class</span><span class='tstring_end'>&#39;</span></span>
466
+ <span class='kw'>end</span>
467
+
468
+ <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:parent</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_parent'>parent</span>
469
+ <span class='id identifier rubyid_action'>action</span> <span class='op'>=</span> <span class='id identifier rubyid_cls'>cls</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
470
+ <span class='kw'>return</span> <span class='id identifier rubyid_action'>action</span><span class='period'>.</span><span class='id identifier rubyid_execute'>execute</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
471
+ <span class='kw'>end</span></pre>
472
+ </td>
473
+ </tr>
474
+ </table>
475
+ </div>
476
+
477
+ <div class="method_details ">
478
+ <h3 class="signature " id="create_result-class_method">
479
+
480
+ + (<tt>Object</tt>) <strong>create_result</strong>
481
+
482
+
483
+
484
+
485
+
486
+ </h3><div class="docstring">
487
+ <div class="discussion">
488
+
489
+ <p>Returns a new, valid, empty result.</p>
490
+
491
+
492
+ </div>
493
+ </div>
494
+ <div class="tags">
495
+
496
+ <p class="tag_title">Returns:</p>
497
+ <ul class="return">
498
+
499
+ <li>
500
+
501
+
502
+ <span class='type'></span>
503
+
504
+
505
+
506
+
507
+ <div class='inline'>
508
+ <p>a new, valid, empty result.</p>
509
+ </div>
510
+
511
+ </li>
512
+
513
+ </ul>
514
+
515
+ </div><table class="source_code">
516
+ <tr>
517
+ <td>
518
+ <pre class="lines">
519
+
520
+
521
+ 25
522
+ 26
523
+ 27</pre>
524
+ </td>
525
+ <td>
526
+ <pre class="code"><span class="info file"># File 'lib/action_command.rb', line 25</span>
527
+
528
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_create_result'>create_result</span>
529
+ <span class='kw'>return</span> <span class='const'>ActionCommand</span><span class='op'>::</span><span class='const'>Result</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='cvar'>@@logger</span><span class='rparen'>)</span>
530
+ <span class='kw'>end</span></pre>
531
+ </td>
532
+ </tr>
533
+ </table>
534
+ </div>
535
+
536
+ <div class="method_details ">
537
+ <h3 class="signature " id="describe_io-class_method">
538
+
539
+ + (<tt>Object</tt>) <strong>describe_io</strong>(cmd_cls, desc)
540
+
541
+
542
+
543
+
544
+
545
+ </h3><div class="docstring">
546
+ <div class="discussion">
547
+
548
+ <p>Create a global description of the inputs and outputs of a command. Should
549
+ usually be called within an ActionCommand::Executable subclass in its
550
+ self.describe_io method</p>
551
+
552
+
553
+ </div>
554
+ </div>
555
+ <div class="tags">
556
+
557
+
558
+ </div><table class="source_code">
559
+ <tr>
560
+ <td>
561
+ <pre class="lines">
562
+
563
+
564
+ 73
565
+ 74
566
+ 75
567
+ 76
568
+ 77
569
+ 78
570
+ 79
571
+ 80
572
+ 81
573
+ 82</pre>
574
+ </td>
575
+ <td>
576
+ <pre class="code"><span class="info file"># File 'lib/action_command.rb', line 73</span>
577
+
578
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_describe_io'>describe_io</span><span class='lparen'>(</span><span class='id identifier rubyid_cmd_cls'>cmd_cls</span><span class='comma'>,</span> <span class='id identifier rubyid_desc'>desc</span><span class='rparen'>)</span>
579
+ <span class='id identifier rubyid_name'>name</span> <span class='op'>=</span> <span class='id identifier rubyid_cmd_cls'>cmd_cls</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span>
580
+ <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='cvar'>@@params</span><span class='lbracket'>[</span><span class='id identifier rubyid_name'>name</span><span class='rbracket'>]</span>
581
+ <span class='kw'>unless</span> <span class='id identifier rubyid_params'>params</span>
582
+ <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='const'>InputOutput</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_cmd_cls'>cmd_cls</span><span class='comma'>,</span> <span class='id identifier rubyid_desc'>desc</span><span class='rparen'>)</span>
583
+ <span class='cvar'>@@params</span><span class='lbracket'>[</span><span class='id identifier rubyid_name'>name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>params</span>
584
+ <span class='kw'>yield</span> <span class='id identifier rubyid_params'>params</span>
585
+ <span class='kw'>end</span>
586
+ <span class='kw'>return</span> <span class='id identifier rubyid_params'>params</span>
587
+ <span class='kw'>end</span></pre>
588
+ </td>
589
+ </tr>
590
+ </table>
591
+ </div>
592
+
593
+ <div class="method_details ">
594
+ <h3 class="signature " id="execute_rails-class_method">
595
+
596
+ + (<tt><span class='object_link'><a href="ActionCommand/Result.html" title="ActionCommand::Result (class)">ActionCommand::Result</a></span></tt>) <strong>execute_rails</strong>(cls, params = {})
597
+
598
+
599
+
600
+
601
+
602
+ </h3><div class="docstring">
603
+ <div class="discussion">
604
+
605
+ <p>Execute a command at the root level of a rails context</p>
606
+
607
+
608
+ </div>
609
+ </div>
610
+ <div class="tags">
611
+ <p class="tag_title">Parameters:</p>
612
+ <ul class="param">
613
+
614
+ <li>
615
+
616
+ <span class='name'>cls</span>
617
+
618
+
619
+ <span class='type'>(<tt><span class='object_link'><a href="ActionCommand/Executable.html" title="ActionCommand::Executable (class)">ActionCommand::Executable</a></span></tt>)</span>
620
+
621
+
622
+
623
+ &mdash;
624
+ <div class='inline'>
625
+ <p>The class of an Executable subclass</p>
626
+ </div>
627
+
628
+ </li>
629
+
630
+ <li>
631
+
632
+ <span class='name'>params</span>
633
+
634
+
635
+ <span class='type'>(<tt>Hash</tt>)</span>
636
+
637
+
638
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
639
+
640
+
641
+ &mdash;
642
+ <div class='inline'>
643
+ <p>parameters used by the command.</p>
644
+ </div>
645
+
646
+ </li>
647
+
648
+ </ul>
649
+
650
+ <p class="tag_title">Returns:</p>
651
+ <ul class="return">
652
+
653
+ <li>
654
+
655
+
656
+ <span class='type'>(<tt><span class='object_link'><a href="ActionCommand/Result.html" title="ActionCommand::Result (class)">ActionCommand::Result</a></span></tt>)</span>
657
+
658
+
659
+
660
+ </li>
661
+
662
+ </ul>
663
+
664
+ </div><table class="source_code">
665
+ <tr>
666
+ <td>
667
+ <pre class="lines">
668
+
669
+
670
+ 64
671
+ 65
672
+ 66
673
+ 67</pre>
674
+ </td>
675
+ <td>
676
+ <pre class="code"><span class="info file"># File 'lib/action_command.rb', line 64</span>
677
+
678
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_execute_rails'>execute_rails</span><span class='lparen'>(</span><span class='id identifier rubyid_cls'>cls</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
679
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='id identifier rubyid_create_result'>create_result</span>
680
+ <span class='kw'>return</span> <span class='const'>ActionCommand</span><span class='period'>.</span><span class='id identifier rubyid_create_and_execute'>create_and_execute</span><span class='lparen'>(</span><span class='id identifier rubyid_cls'>cls</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='const'>CONTEXT_RAILS</span><span class='comma'>,</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
681
+ <span class='kw'>end</span></pre>
682
+ </td>
683
+ </tr>
684
+ </table>
685
+ </div>
686
+
687
+ <div class="method_details ">
688
+ <h3 class="signature " id="execute_rake-class_method">
689
+
690
+ + (<tt><span class='object_link'><a href="ActionCommand/Result.html" title="ActionCommand::Result (class)">ActionCommand::Result</a></span></tt>) <strong>execute_rake</strong>(cls, args = {})
691
+
692
+
693
+
694
+
695
+
696
+ </h3><div class="docstring">
697
+ <div class="discussion">
698
+
699
+ <p>Execute a command at the root level of a rake task context.</p>
700
+
701
+
702
+ </div>
703
+ </div>
704
+ <div class="tags">
705
+ <p class="tag_title">Parameters:</p>
706
+ <ul class="param">
707
+
708
+ <li>
709
+
710
+ <span class='name'>cls</span>
711
+
712
+
713
+ <span class='type'>(<tt><span class='object_link'><a href="ActionCommand/Executable.html" title="ActionCommand::Executable (class)">ActionCommand::Executable</a></span></tt>)</span>
714
+
715
+
716
+
717
+ &mdash;
718
+ <div class='inline'>
719
+ <p>The class of an Executable subclass</p>
720
+ </div>
721
+
722
+ </li>
723
+
724
+ <li>
725
+
726
+ <span class='name'>args</span>
727
+
728
+
729
+ <span class='type'>(<tt>Hash</tt>)</span>
730
+
731
+
732
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
733
+
734
+
735
+ &mdash;
736
+ <div class='inline'>
737
+ <p>parameters used by the command.</p>
738
+ </div>
739
+
740
+ </li>
741
+
742
+ </ul>
743
+
744
+ <p class="tag_title">Returns:</p>
745
+ <ul class="return">
746
+
747
+ <li>
748
+
749
+
750
+ <span class='type'>(<tt><span class='object_link'><a href="ActionCommand/Result.html" title="ActionCommand::Result (class)">ActionCommand::Result</a></span></tt>)</span>
751
+
752
+
753
+
754
+ </li>
755
+
756
+ </ul>
757
+
758
+ </div><table class="source_code">
759
+ <tr>
760
+ <td>
761
+ <pre class="lines">
762
+
763
+
764
+ 47
765
+ 48
766
+ 49
767
+ 50
768
+ 51
769
+ 52
770
+ 53
771
+ 54
772
+ 55
773
+ 56
774
+ 57
775
+ 58</pre>
776
+ </td>
777
+ <td>
778
+ <pre class="code"><span class="info file"># File 'lib/action_command.rb', line 47</span>
779
+
780
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_execute_rake'>execute_rake</span><span class='lparen'>(</span><span class='id identifier rubyid_cls'>cls</span><span class='comma'>,</span> <span class='id identifier rubyid_args'>args</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
781
+ <span class='id identifier rubyid_io'>io</span> <span class='op'>=</span> <span class='id identifier rubyid_cls'>cls</span><span class='period'>.</span><span class='id identifier rubyid_describe_io'>describe_io</span>
782
+ <span class='kw'>if</span> <span class='id identifier rubyid_io'>io</span><span class='period'>.</span><span class='id identifier rubyid_help?'>help?</span> <span class='id identifier rubyid_args'>args</span>
783
+ <span class='id identifier rubyid_io'>io</span><span class='period'>.</span><span class='id identifier rubyid_show_help'>show_help</span>
784
+ <span class='kw'>return</span>
785
+ <span class='kw'>end</span>
786
+
787
+ <span class='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_io'>io</span><span class='period'>.</span><span class='id identifier rubyid_validate'>validate</span><span class='lparen'>(</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
788
+
789
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='id identifier rubyid_create_result'>create_result</span>
790
+ <span class='kw'>return</span> <span class='const'>ActionCommand</span><span class='period'>.</span><span class='id identifier rubyid_create_and_execute'>create_and_execute</span><span class='lparen'>(</span><span class='id identifier rubyid_cls'>cls</span><span class='comma'>,</span> <span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='const'>CONTEXT_RAKE</span><span class='comma'>,</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
791
+ <span class='kw'>end</span></pre>
792
+ </td>
793
+ </tr>
794
+ </table>
795
+ </div>
796
+
797
+ <div class="method_details ">
798
+ <h3 class="signature " id="execute_test-class_method">
799
+
800
+ + (<tt><span class='object_link'><a href="ActionCommand/Result.html" title="ActionCommand::Result (class)">ActionCommand::Result</a></span></tt>) <strong>execute_test</strong>(rspec, cls, params = {})
801
+
802
+
803
+
804
+
805
+
806
+ </h3><div class="docstring">
807
+ <div class="discussion">
808
+
809
+ <p>Execute a command at the root level of a testing context</p>
810
+
811
+
812
+ </div>
813
+ </div>
814
+ <div class="tags">
815
+ <p class="tag_title">Parameters:</p>
816
+ <ul class="param">
817
+
818
+ <li>
819
+
820
+ <span class='name'>rspec</span>
821
+
822
+
823
+ <span class='type'></span>
824
+
825
+
826
+
827
+ &mdash;
828
+ <div class='inline'>
829
+ <p>pass in &#39;self&#39; in an rspec example if you want to perform internal
830
+ validations. See <span class='object_link'><a href="ActionCommand/Executable.html#testing-instance_method" title="ActionCommand::Executable#testing (method)">ActionCommand::Executable#testing</a></span> to embed test code within commands.</p>
831
+ </div>
832
+
833
+ </li>
834
+
835
+ <li>
836
+
837
+ <span class='name'>cls</span>
838
+
839
+
840
+ <span class='type'>(<tt><span class='object_link'><a href="ActionCommand/Executable.html" title="ActionCommand::Executable (class)">ActionCommand::Executable</a></span></tt>)</span>
841
+
842
+
843
+
844
+ &mdash;
845
+ <div class='inline'>
846
+ <p>the class of an Executable subclass</p>
847
+ </div>
848
+
849
+ </li>
850
+
851
+ <li>
852
+
853
+ <span class='name'>params</span>
854
+
855
+
856
+ <span class='type'>(<tt>Hash</tt>)</span>
857
+
858
+
859
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
860
+
861
+
862
+ &mdash;
863
+ <div class='inline'>
864
+ <p>parameters used by the command.</p>
865
+ </div>
866
+
867
+ </li>
868
+
869
+ </ul>
870
+
871
+ <p class="tag_title">Returns:</p>
872
+ <ul class="return">
873
+
874
+ <li>
875
+
876
+
877
+ <span class='type'>(<tt><span class='object_link'><a href="ActionCommand/Result.html" title="ActionCommand::Result (class)">ActionCommand::Result</a></span></tt>)</span>
878
+
879
+
880
+
881
+ </li>
882
+
883
+ </ul>
884
+
885
+ </div><table class="source_code">
886
+ <tr>
887
+ <td>
888
+ <pre class="lines">
889
+
890
+
891
+ 37
892
+ 38
893
+ 39
894
+ 40
895
+ 41</pre>
896
+ </td>
897
+ <td>
898
+ <pre class="code"><span class="info file"># File 'lib/action_command.rb', line 37</span>
899
+
900
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_execute_test'>execute_test</span><span class='lparen'>(</span><span class='id identifier rubyid_rspec'>rspec</span><span class='comma'>,</span> <span class='id identifier rubyid_cls'>cls</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
901
+ <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:test</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_rspec'>rspec</span>
902
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='id identifier rubyid_create_result'>create_result</span>
903
+ <span class='kw'>return</span> <span class='const'>ActionCommand</span><span class='period'>.</span><span class='id identifier rubyid_create_and_execute'>create_and_execute</span><span class='lparen'>(</span><span class='id identifier rubyid_cls'>cls</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='const'>CONTEXT_TEST</span><span class='comma'>,</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
904
+ <span class='kw'>end</span></pre>
905
+ </td>
906
+ </tr>
907
+ </table>
908
+ </div>
909
+
910
+ <div class="method_details ">
911
+ <h3 class="signature " id="logger=-class_method">
912
+
913
+ + (<tt>Object</tt>) <strong>logger=</strong>(logger)
914
+
915
+
916
+
917
+
918
+
919
+ </h3><div class="docstring">
920
+ <div class="discussion">
921
+
922
+ <p>Set a logger to be used when creating commands.</p>
923
+
924
+
925
+ </div>
926
+ </div>
927
+ <div class="tags">
928
+ <p class="tag_title">Parameters:</p>
929
+ <ul class="param">
930
+
931
+ <li>
932
+
933
+ <span class='name'>logger</span>
934
+
935
+
936
+ <span class='type'></span>
937
+
938
+
939
+
940
+ &mdash;
941
+ <div class='inline'>
942
+ <p>Any object that implements .error and .info</p>
943
+ </div>
944
+
945
+ </li>
946
+
947
+ </ul>
948
+
949
+
950
+ </div><table class="source_code">
951
+ <tr>
952
+ <td>
953
+ <pre class="lines">
954
+
955
+
956
+ 20
957
+ 21
958
+ 22</pre>
959
+ </td>
960
+ <td>
961
+ <pre class="code"><span class="info file"># File 'lib/action_command.rb', line 20</span>
962
+
963
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_logger='>logger=</span><span class='lparen'>(</span><span class='id identifier rubyid_logger'>logger</span><span class='rparen'>)</span>
964
+ <span class='cvar'>@@logger</span> <span class='op'>=</span> <span class='id identifier rubyid_logger'>logger</span> <span class='comment'># rubocop:disable Style/ClassVars
965
+ </span><span class='kw'>end</span></pre>
966
+ </td>
967
+ </tr>
968
+ </table>
969
+ </div>
970
+
971
+ </div>
972
+
973
+ </div>
974
+
975
+ <div id="footer">
976
+ Generated on Sat Feb 13 10:16:47 2016 by
977
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
978
+ 0.8.7.6 (ruby-2.2.3).
979
+ </div>
980
+
981
+ </body>
982
+ </html>