action_command 0.1.3 → 0.1.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.byebug_history +5 -0
- data/.codeclimate.yml +1 -0
- data/.rubocop.yml +4 -0
- data/Gemfile.lock +33 -6
- data/README.md +62 -0
- data/action_command.gemspec +3 -0
- data/doc/ActionCommand/Executable.html +106 -19
- data/doc/ActionCommand/InputOutput.html +203 -70
- data/doc/ActionCommand/Result.html +938 -131
- data/doc/ActionCommand.html +405 -82
- data/doc/_index.html +45 -1
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +61 -2
- data/doc/index.html +61 -2
- data/doc/method_list.html +224 -14
- data/doc/top-level-namespace.html +1 -1
- data/lib/action_command/executable.rb +6 -0
- data/lib/action_command/executable_transaction.rb +27 -0
- data/lib/action_command/input_output.rb +5 -0
- data/lib/action_command/log_parser.rb +105 -0
- data/lib/action_command/pretty_print_log_action.rb +114 -0
- data/lib/action_command/result.rb +106 -16
- data/lib/action_command/utils.rb +0 -5
- data/lib/action_command/version.rb +1 -1
- data/lib/action_command.rb +53 -6
- metadata +48 -2
data/doc/ActionCommand.html
CHANGED
@@ -80,7 +80,7 @@
|
|
80
80
|
|
81
81
|
<dt class="r1 last">Defined in:</dt>
|
82
82
|
<dd class="r1 last">lib/action_command.rb<span class="defines">,<br />
|
83
|
-
lib/action_command/utils.rb,<br /> lib/action_command/result.rb,<br /> lib/action_command/version.rb,<br /> lib/action_command/executable.rb,<br /> lib/action_command/input_output.rb</span>
|
83
|
+
lib/action_command/utils.rb,<br /> lib/action_command/result.rb,<br /> lib/action_command/version.rb,<br /> lib/action_command/log_parser.rb,<br /> lib/action_command/executable.rb,<br /> lib/action_command/input_output.rb,<br /> lib/action_command/executable_transaction.rb,<br /> lib/action_command/pretty_print_log_action.rb</span>
|
84
84
|
</dd>
|
85
85
|
|
86
86
|
</dl>
|
@@ -89,8 +89,7 @@
|
|
89
89
|
<h2>Overview</h2><div class="docstring">
|
90
90
|
<div class="discussion">
|
91
91
|
|
92
|
-
<p>
|
93
|
-
run them using the ActionCommand.execute_… variants.</p>
|
92
|
+
<p>Unnecessary comment for rubocop</p>
|
94
93
|
|
95
94
|
|
96
95
|
</div>
|
@@ -104,7 +103,7 @@ run them using the ActionCommand.execute_… variants.</p>
|
|
104
103
|
|
105
104
|
|
106
105
|
|
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>, <span class='object_link'><a href="ActionCommand/Utils.html" title="ActionCommand::Utils (class)">Utils</a></span>
|
106
|
+
<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/ExecutableTransaction.html" title="ActionCommand::ExecutableTransaction (class)">ExecutableTransaction</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/LogMessage.html" title="ActionCommand::LogMessage (class)">LogMessage</a></span>, <span class='object_link'><a href="ActionCommand/LogParser.html" title="ActionCommand::LogParser (class)">LogParser</a></span>, <span class='object_link'><a href="ActionCommand/PrettyPrintLogAction.html" title="ActionCommand::PrettyPrintLogAction (class)">PrettyPrintLogAction</a></span>, <span class='object_link'><a href="ActionCommand/Result.html" title="ActionCommand::Result (class)">Result</a></span>, <span class='object_link'><a href="ActionCommand/Utils.html" title="ActionCommand::Utils (class)">Utils</a></span>
|
108
107
|
|
109
108
|
|
110
109
|
</p>
|
@@ -162,6 +161,135 @@ controller, etc)</p>
|
|
162
161
|
</dt>
|
163
162
|
<dd><pre class="code"><span class='symbol'>:rails</span></pre></dd>
|
164
163
|
|
164
|
+
<dt id="CONTEXT_API-constant" class="">CONTEXT_API =
|
165
|
+
<div class="docstring">
|
166
|
+
<div class="discussion">
|
167
|
+
|
168
|
+
<p>Used as a root element when the command is executed from an API context</p>
|
169
|
+
|
170
|
+
|
171
|
+
</div>
|
172
|
+
</div>
|
173
|
+
<div class="tags">
|
174
|
+
|
175
|
+
|
176
|
+
</div>
|
177
|
+
</dt>
|
178
|
+
<dd><pre class="code"><span class='symbol'>:api</span></pre></dd>
|
179
|
+
|
180
|
+
<dt id="RESULT_CODE_OK-constant" class="">RESULT_CODE_OK =
|
181
|
+
<div class="docstring">
|
182
|
+
<div class="discussion">
|
183
|
+
|
184
|
+
<p>Used if a result has had no failures</p>
|
185
|
+
|
186
|
+
|
187
|
+
</div>
|
188
|
+
</div>
|
189
|
+
<div class="tags">
|
190
|
+
|
191
|
+
|
192
|
+
</div>
|
193
|
+
</dt>
|
194
|
+
<dd><pre class="code"><span class='int'>0</span></pre></dd>
|
195
|
+
|
196
|
+
<dt id="RESULT_CODE_FAILED-constant" class="">RESULT_CODE_FAILED =
|
197
|
+
<div class="docstring">
|
198
|
+
<div class="discussion">
|
199
|
+
|
200
|
+
<p>Used as a generic result code for failure, if you do not provide a more
|
201
|
+
specific one through <span class='object_link'><a href="ActionCommand/Result.html#failed_with_code-instance_method" title="ActionCommand::Result#failed_with_code (method)">ActionCommand::Result#failed_with_code</a></span></p>
|
202
|
+
|
203
|
+
|
204
|
+
</div>
|
205
|
+
</div>
|
206
|
+
<div class="tags">
|
207
|
+
|
208
|
+
|
209
|
+
</div>
|
210
|
+
</dt>
|
211
|
+
<dd><pre class="code"><span class='int'>1</span></pre></dd>
|
212
|
+
|
213
|
+
<dt id="LOG_KIND_COMMAND_INPUT-constant" class="">LOG_KIND_COMMAND_INPUT =
|
214
|
+
<div class="docstring">
|
215
|
+
<div class="discussion">
|
216
|
+
|
217
|
+
<p>log entry for the input to a commmand</p>
|
218
|
+
|
219
|
+
|
220
|
+
</div>
|
221
|
+
</div>
|
222
|
+
<div class="tags">
|
223
|
+
|
224
|
+
|
225
|
+
</div>
|
226
|
+
</dt>
|
227
|
+
<dd><pre class="code"><span class='symbol'>:command_input</span></pre></dd>
|
228
|
+
|
229
|
+
<dt id="LOG_KIND_COMMAND_OUTPUT-constant" class="">LOG_KIND_COMMAND_OUTPUT =
|
230
|
+
<div class="docstring">
|
231
|
+
<div class="discussion">
|
232
|
+
|
233
|
+
<p>log entry for the output from a command</p>
|
234
|
+
|
235
|
+
|
236
|
+
</div>
|
237
|
+
</div>
|
238
|
+
<div class="tags">
|
239
|
+
|
240
|
+
|
241
|
+
</div>
|
242
|
+
</dt>
|
243
|
+
<dd><pre class="code"><span class='symbol'>:command_output</span></pre></dd>
|
244
|
+
|
245
|
+
<dt id="LOG_KIND_INFO-constant" class="">LOG_KIND_INFO =
|
246
|
+
<div class="docstring">
|
247
|
+
<div class="discussion">
|
248
|
+
|
249
|
+
<p>info message from within a command</p>
|
250
|
+
|
251
|
+
|
252
|
+
</div>
|
253
|
+
</div>
|
254
|
+
<div class="tags">
|
255
|
+
|
256
|
+
|
257
|
+
</div>
|
258
|
+
</dt>
|
259
|
+
<dd><pre class="code"><span class='symbol'>:info</span></pre></dd>
|
260
|
+
|
261
|
+
<dt id="LOG_KIND_DEBUG-constant" class="">LOG_KIND_DEBUG =
|
262
|
+
<div class="docstring">
|
263
|
+
<div class="discussion">
|
264
|
+
|
265
|
+
<p>debug message from within a command</p>
|
266
|
+
|
267
|
+
|
268
|
+
</div>
|
269
|
+
</div>
|
270
|
+
<div class="tags">
|
271
|
+
|
272
|
+
|
273
|
+
</div>
|
274
|
+
</dt>
|
275
|
+
<dd><pre class="code"><span class='symbol'>:debug</span></pre></dd>
|
276
|
+
|
277
|
+
<dt id="LOG_KIND_ERROR-constant" class="">LOG_KIND_ERROR =
|
278
|
+
<div class="docstring">
|
279
|
+
<div class="discussion">
|
280
|
+
|
281
|
+
<p>error message from within a command</p>
|
282
|
+
|
283
|
+
|
284
|
+
</div>
|
285
|
+
</div>
|
286
|
+
<div class="tags">
|
287
|
+
|
288
|
+
|
289
|
+
</div>
|
290
|
+
</dt>
|
291
|
+
<dd><pre class="code"><span class='symbol'>:error</span></pre></dd>
|
292
|
+
|
165
293
|
<dt id="OPTIONAL-constant" class="">OPTIONAL =
|
166
294
|
<div class="docstring">
|
167
295
|
<div class="discussion">
|
@@ -192,7 +320,7 @@ controller, etc)</p>
|
|
192
320
|
|
193
321
|
</div>
|
194
322
|
</dt>
|
195
|
-
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>0.1.
|
323
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>0.1.4</span><span class='tstring_end'>'</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
|
196
324
|
|
197
325
|
<dt id="logger-classvariable" class="">@@logger =
|
198
326
|
<div class="docstring">
|
@@ -246,6 +374,28 @@ controller, etc)</p>
|
|
246
374
|
<li class="public ">
|
247
375
|
<span class="summary_signature">
|
248
376
|
|
377
|
+
<a href="#check_params-class_method" title="check_params (class method)">+ (Object) <strong>check_params</strong>(cls, params) </a>
|
378
|
+
|
379
|
+
|
380
|
+
|
381
|
+
</span>
|
382
|
+
|
383
|
+
|
384
|
+
|
385
|
+
|
386
|
+
|
387
|
+
|
388
|
+
|
389
|
+
|
390
|
+
|
391
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
392
|
+
|
393
|
+
</li>
|
394
|
+
|
395
|
+
|
396
|
+
<li class="public ">
|
397
|
+
<span class="summary_signature">
|
398
|
+
|
249
399
|
<a href="#create_and_execute-class_method" title="create_and_execute (class method)">+ (Object) <strong>create_and_execute</strong>(cls, params, parent, result) </a>
|
250
400
|
|
251
401
|
|
@@ -312,6 +462,30 @@ controller, etc)</p>
|
|
312
462
|
<p>Create a global description of the inputs and outputs of a command.</p>
|
313
463
|
</div></span>
|
314
464
|
|
465
|
+
</li>
|
466
|
+
|
467
|
+
|
468
|
+
<li class="public ">
|
469
|
+
<span class="summary_signature">
|
470
|
+
|
471
|
+
<a href="#execute_api-class_method" title="execute_api (class method)">+ (ActionCommand::Result) <strong>execute_api</strong>(cls, params = {}) </a>
|
472
|
+
|
473
|
+
|
474
|
+
|
475
|
+
</span>
|
476
|
+
|
477
|
+
|
478
|
+
|
479
|
+
|
480
|
+
|
481
|
+
|
482
|
+
|
483
|
+
|
484
|
+
|
485
|
+
<span class="summary_desc"><div class='inline'>
|
486
|
+
<p>Execute a command at the root level of an api context.</p>
|
487
|
+
</div></span>
|
488
|
+
|
315
489
|
</li>
|
316
490
|
|
317
491
|
|
@@ -469,9 +643,9 @@ controller, etc)</p>
|
|
469
643
|
|
470
644
|
|
471
645
|
<div class="method_details first">
|
472
|
-
<h3 class="signature first" id="
|
646
|
+
<h3 class="signature first" id="check_params-class_method">
|
473
647
|
|
474
|
-
+ (<tt>Object</tt>) <strong>
|
648
|
+
+ (<tt>Object</tt>) <strong>check_params</strong>(cls, params)
|
475
649
|
|
476
650
|
|
477
651
|
|
@@ -480,8 +654,6 @@ controller, etc)</p>
|
|
480
654
|
</h3><div class="docstring">
|
481
655
|
<div class="discussion">
|
482
656
|
|
483
|
-
<p>Used internally, not for general purpose use.</p>
|
484
|
-
|
485
657
|
|
486
658
|
</div>
|
487
659
|
</div>
|
@@ -507,31 +679,84 @@ controller, etc)</p>
|
|
507
679
|
<pre class="lines">
|
508
680
|
|
509
681
|
|
510
|
-
|
511
|
-
|
512
|
-
|
513
|
-
|
514
|
-
|
515
|
-
|
516
|
-
|
517
|
-
122
|
518
|
-
123
|
519
|
-
124
|
520
|
-
125</pre>
|
682
|
+
168
|
683
|
+
169
|
684
|
+
170
|
685
|
+
171
|
686
|
+
172
|
687
|
+
173
|
688
|
+
174</pre>
|
521
689
|
</td>
|
522
690
|
<td>
|
523
|
-
<pre class="code"><span class="info file"># File 'lib/action_command.rb', line
|
691
|
+
<pre class="code"><span class="info file"># File 'lib/action_command.rb', line 168</span>
|
524
692
|
|
525
|
-
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier
|
693
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_check_params'>check_params</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='rparen'>)</span>
|
526
694
|
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Expected params to be a Hash</span><span class='tstring_end'>'</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>
|
527
695
|
|
528
696
|
<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'>&&</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>
|
529
697
|
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Expected an ActionCommand::Executable as class</span><span class='tstring_end'>'</span></span>
|
530
698
|
<span class='kw'>end</span>
|
699
|
+
<span class='kw'>end</span></pre>
|
700
|
+
</td>
|
701
|
+
</tr>
|
702
|
+
</table>
|
703
|
+
</div>
|
704
|
+
|
705
|
+
<div class="method_details ">
|
706
|
+
<h3 class="signature " id="create_and_execute-class_method">
|
707
|
+
|
708
|
+
+ (<tt>Object</tt>) <strong>create_and_execute</strong>(cls, params, parent, result)
|
709
|
+
|
710
|
+
|
531
711
|
|
712
|
+
|
713
|
+
|
714
|
+
</h3><div class="docstring">
|
715
|
+
<div class="discussion">
|
716
|
+
|
717
|
+
<p>Used internally, not for general purpose use.</p>
|
718
|
+
|
719
|
+
|
720
|
+
</div>
|
721
|
+
</div>
|
722
|
+
<div class="tags">
|
723
|
+
|
724
|
+
|
725
|
+
</div><table class="source_code">
|
726
|
+
<tr>
|
727
|
+
<td>
|
728
|
+
<pre class="lines">
|
729
|
+
|
730
|
+
|
731
|
+
154
|
732
|
+
155
|
733
|
+
156
|
734
|
+
157
|
735
|
+
158
|
736
|
+
159
|
737
|
+
160
|
738
|
+
161
|
739
|
+
162
|
740
|
+
163
|
741
|
+
164
|
742
|
+
165
|
743
|
+
166</pre>
|
744
|
+
</td>
|
745
|
+
<td>
|
746
|
+
<pre class="code"><span class="info file"># File 'lib/action_command.rb', line 154</span>
|
747
|
+
|
748
|
+
<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>
|
749
|
+
<span class='id identifier rubyid_check_params'>check_params</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='rparen'>)</span>
|
532
750
|
<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>
|
751
|
+
<span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_logger'>logger</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:logger</span><span class='rbracket'>]</span>
|
752
|
+
<span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_logger'>logger</span> <span class='op'>=</span> <span class='cvar'>@@logger</span> <span class='kw'>unless</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:logger</span><span class='rbracket'>]</span>
|
753
|
+
<span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_root_command'>root_command</span><span class='lparen'>(</span><span class='id identifier rubyid_cls'>cls</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_parent'>parent</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>Symbol</span>
|
533
754
|
<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>
|
534
|
-
|
755
|
+
|
756
|
+
<span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_log_input'>log_input</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
757
|
+
<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>
|
758
|
+
<span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_log_output'>log_output</span>
|
759
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_result'>result</span>
|
535
760
|
<span class='kw'>end</span></pre>
|
536
761
|
</td>
|
537
762
|
</tr>
|
@@ -582,15 +807,15 @@ controller, etc)</p>
|
|
582
807
|
<pre class="lines">
|
583
808
|
|
584
809
|
|
585
|
-
|
586
|
-
|
587
|
-
|
810
|
+
62
|
811
|
+
63
|
812
|
+
64</pre>
|
588
813
|
</td>
|
589
814
|
<td>
|
590
|
-
<pre class="code"><span class="info file"># File 'lib/action_command.rb', line
|
815
|
+
<pre class="code"><span class="info file"># File 'lib/action_command.rb', line 62</span>
|
591
816
|
|
592
817
|
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_create_result'>create_result</span>
|
593
|
-
<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
|
818
|
+
<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>
|
594
819
|
<span class='kw'>end</span></pre>
|
595
820
|
</td>
|
596
821
|
</tr>
|
@@ -625,19 +850,20 @@ self.describe_io method</p>
|
|
625
850
|
<pre class="lines">
|
626
851
|
|
627
852
|
|
628
|
-
|
629
|
-
|
630
|
-
|
631
|
-
|
632
|
-
|
633
|
-
|
634
|
-
|
635
|
-
|
636
|
-
|
637
|
-
|
853
|
+
141
|
854
|
+
142
|
855
|
+
143
|
856
|
+
144
|
857
|
+
145
|
858
|
+
146
|
859
|
+
147
|
860
|
+
148
|
861
|
+
149
|
862
|
+
150
|
863
|
+
151</pre>
|
638
864
|
</td>
|
639
865
|
<td>
|
640
|
-
<pre class="code"><span class="info file"># File 'lib/action_command.rb', line
|
866
|
+
<pre class="code"><span class="info file"># File 'lib/action_command.rb', line 141</span>
|
641
867
|
|
642
868
|
<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>
|
643
869
|
<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>
|
@@ -646,12 +872,107 @@ self.describe_io method</p>
|
|
646
872
|
<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>
|
647
873
|
<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>
|
648
874
|
<span class='kw'>yield</span> <span class='id identifier rubyid_params'>params</span>
|
875
|
+
<span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_input'>input</span><span class='lparen'>(</span><span class='symbol'>:help</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Help for this command</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='const'>OPTIONAL</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_input_count'>input_count</span> <span class='op'>==</span> <span class='int'>0</span>
|
649
876
|
<span class='kw'>end</span>
|
650
877
|
<span class='kw'>return</span> <span class='id identifier rubyid_params'>params</span>
|
651
878
|
<span class='kw'>end</span></pre>
|
652
879
|
</td>
|
653
880
|
</tr>
|
654
881
|
</table>
|
882
|
+
</div>
|
883
|
+
|
884
|
+
<div class="method_details ">
|
885
|
+
<h3 class="signature " id="execute_api-class_method">
|
886
|
+
|
887
|
+
+ (<tt><span class='object_link'><a href="ActionCommand/Result.html" title="ActionCommand::Result (class)">ActionCommand::Result</a></span></tt>) <strong>execute_api</strong>(cls, params = {})
|
888
|
+
|
889
|
+
|
890
|
+
|
891
|
+
|
892
|
+
|
893
|
+
</h3><div class="docstring">
|
894
|
+
<div class="discussion">
|
895
|
+
|
896
|
+
<p>Execute a command at the root level of an api context</p>
|
897
|
+
|
898
|
+
|
899
|
+
</div>
|
900
|
+
</div>
|
901
|
+
<div class="tags">
|
902
|
+
<p class="tag_title">Parameters:</p>
|
903
|
+
<ul class="param">
|
904
|
+
|
905
|
+
<li>
|
906
|
+
|
907
|
+
<span class='name'>cls</span>
|
908
|
+
|
909
|
+
|
910
|
+
<span class='type'>(<tt><span class='object_link'><a href="ActionCommand/Executable.html" title="ActionCommand::Executable (class)">ActionCommand::Executable</a></span></tt>)</span>
|
911
|
+
|
912
|
+
|
913
|
+
|
914
|
+
—
|
915
|
+
<div class='inline'>
|
916
|
+
<p>The class of an Executable subclass</p>
|
917
|
+
</div>
|
918
|
+
|
919
|
+
</li>
|
920
|
+
|
921
|
+
<li>
|
922
|
+
|
923
|
+
<span class='name'>params</span>
|
924
|
+
|
925
|
+
|
926
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
927
|
+
|
928
|
+
|
929
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
930
|
+
|
931
|
+
|
932
|
+
—
|
933
|
+
<div class='inline'>
|
934
|
+
<p>parameters used by the command.</p>
|
935
|
+
</div>
|
936
|
+
|
937
|
+
</li>
|
938
|
+
|
939
|
+
</ul>
|
940
|
+
|
941
|
+
<p class="tag_title">Returns:</p>
|
942
|
+
<ul class="return">
|
943
|
+
|
944
|
+
<li>
|
945
|
+
|
946
|
+
|
947
|
+
<span class='type'>(<tt><span class='object_link'><a href="ActionCommand/Result.html" title="ActionCommand::Result (class)">ActionCommand::Result</a></span></tt>)</span>
|
948
|
+
|
949
|
+
|
950
|
+
|
951
|
+
</li>
|
952
|
+
|
953
|
+
</ul>
|
954
|
+
|
955
|
+
</div><table class="source_code">
|
956
|
+
<tr>
|
957
|
+
<td>
|
958
|
+
<pre class="lines">
|
959
|
+
|
960
|
+
|
961
|
+
118
|
962
|
+
119
|
963
|
+
120
|
964
|
+
121</pre>
|
965
|
+
</td>
|
966
|
+
<td>
|
967
|
+
<pre class="code"><span class="info file"># File 'lib/action_command.rb', line 118</span>
|
968
|
+
|
969
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_execute_api'>execute_api</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>
|
970
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='id identifier rubyid_create_result'>create_result</span>
|
971
|
+
<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_API</span><span class='comma'>,</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
972
|
+
<span class='kw'>end</span></pre>
|
973
|
+
</td>
|
974
|
+
</tr>
|
975
|
+
</table>
|
655
976
|
</div>
|
656
977
|
|
657
978
|
<div class="method_details ">
|
@@ -780,19 +1101,21 @@ directly on the current results object.</p>
|
|
780
1101
|
<pre class="lines">
|
781
1102
|
|
782
1103
|
|
783
|
-
|
784
|
-
|
785
|
-
|
786
|
-
|
787
|
-
|
1104
|
+
131
|
1105
|
+
132
|
1106
|
+
133
|
1107
|
+
134
|
1108
|
+
135
|
1109
|
+
136</pre>
|
788
1110
|
</td>
|
789
1111
|
<td>
|
790
|
-
<pre class="code"><span class="info file"># File 'lib/action_command.rb', line
|
1112
|
+
<pre class="code"><span class="info file"># File 'lib/action_command.rb', line 131</span>
|
791
1113
|
|
792
1114
|
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_execute_child'>execute_child</span><span class='lparen'>(</span><span class='id identifier rubyid_parent'>parent</span><span class='comma'>,</span> <span class='id identifier rubyid_cls'>cls</span><span class='comma'>,</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> <span class='id identifier rubyid_result_key'>result_key</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>
|
793
|
-
<span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span><span class='lparen'>(</span><span class='id identifier rubyid_result_key'>result_key</span><span class='rparen'>)</span>
|
1115
|
+
<span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span><span class='lparen'>(</span><span class='id identifier rubyid_result_key'>result_key</span><span class='comma'>,</span> <span class='id identifier rubyid_cls'>cls</span><span class='rparen'>)</span>
|
794
1116
|
<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='id identifier rubyid_parent'>parent</span><span class='comma'>,</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
795
1117
|
<span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_pop'>pop</span><span class='lparen'>(</span><span class='id identifier rubyid_result_key'>result_key</span><span class='rparen'>)</span>
|
1118
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_result'>result</span>
|
796
1119
|
<span class='kw'>end</span></pre>
|
797
1120
|
</td>
|
798
1121
|
</tr>
|
@@ -876,13 +1199,13 @@ directly on the current results object.</p>
|
|
876
1199
|
<pre class="lines">
|
877
1200
|
|
878
1201
|
|
879
|
-
|
880
|
-
|
881
|
-
|
882
|
-
|
1202
|
+
109
|
1203
|
+
110
|
1204
|
+
111
|
1205
|
+
112</pre>
|
883
1206
|
</td>
|
884
1207
|
<td>
|
885
|
-
<pre class="code"><span class="info file"># File 'lib/action_command.rb', line
|
1208
|
+
<pre class="code"><span class="info file"># File 'lib/action_command.rb', line 109</span>
|
886
1209
|
|
887
1210
|
<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>
|
888
1211
|
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='id identifier rubyid_create_result'>create_result</span>
|
@@ -968,21 +1291,21 @@ directly on the current results object.</p>
|
|
968
1291
|
<pre class="lines">
|
969
1292
|
|
970
1293
|
|
971
|
-
|
972
|
-
|
973
|
-
|
974
|
-
|
975
|
-
|
976
|
-
|
977
|
-
|
978
|
-
|
979
|
-
|
980
|
-
|
981
|
-
|
982
|
-
|
1294
|
+
84
|
1295
|
+
85
|
1296
|
+
86
|
1297
|
+
87
|
1298
|
+
88
|
1299
|
+
89
|
1300
|
+
90
|
1301
|
+
91
|
1302
|
+
92
|
1303
|
+
93
|
1304
|
+
94
|
1305
|
+
95</pre>
|
983
1306
|
</td>
|
984
1307
|
<td>
|
985
|
-
<pre class="code"><span class="info file"># File 'lib/action_command.rb', line
|
1308
|
+
<pre class="code"><span class="info file"># File 'lib/action_command.rb', line 84</span>
|
986
1309
|
|
987
1310
|
<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='rparen'>)</span>
|
988
1311
|
<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>
|
@@ -1095,14 +1418,14 @@ validations. See <span class='object_link'><a href="ActionCommand/Executable.ht
|
|
1095
1418
|
<pre class="lines">
|
1096
1419
|
|
1097
1420
|
|
1098
|
-
|
1099
|
-
|
1100
|
-
|
1101
|
-
|
1102
|
-
|
1421
|
+
74
|
1422
|
+
75
|
1423
|
+
76
|
1424
|
+
77
|
1425
|
+
78</pre>
|
1103
1426
|
</td>
|
1104
1427
|
<td>
|
1105
|
-
<pre class="code"><span class="info file"># File 'lib/action_command.rb', line
|
1428
|
+
<pre class="code"><span class="info file"># File 'lib/action_command.rb', line 74</span>
|
1106
1429
|
|
1107
1430
|
<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>
|
1108
1431
|
<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>
|
@@ -1140,15 +1463,15 @@ validations. See <span class='object_link'><a href="ActionCommand/Executable.ht
|
|
1140
1463
|
<pre class="lines">
|
1141
1464
|
|
1142
1465
|
|
1143
|
-
|
1144
|
-
|
1145
|
-
|
1146
|
-
|
1147
|
-
|
1148
|
-
|
1466
|
+
98
|
1467
|
+
99
|
1468
|
+
100
|
1469
|
+
101
|
1470
|
+
102
|
1471
|
+
103</pre>
|
1149
1472
|
</td>
|
1150
1473
|
<td>
|
1151
|
-
<pre class="code"><span class="info file"># File 'lib/action_command.rb', line
|
1474
|
+
<pre class="code"><span class="info file"># File 'lib/action_command.rb', line 98</span>
|
1152
1475
|
|
1153
1476
|
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_install_rake'>install_rake</span><span class='lparen'>(</span><span class='id identifier rubyid_rake'>rake</span><span class='comma'>,</span> <span class='id identifier rubyid_sym'>sym</span><span class='comma'>,</span> <span class='id identifier rubyid_cls'>cls</span><span class='comma'>,</span> <span class='id identifier rubyid_deps'>deps</span><span class='rparen'>)</span>
|
1154
1477
|
<span class='id identifier rubyid_rake'>rake</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='symbol'>:desc</span><span class='comma'>,</span> <span class='id identifier rubyid_cls'>cls</span><span class='period'>.</span><span class='id identifier rubyid_describe_io'>describe_io</span><span class='period'>.</span><span class='id identifier rubyid_desc'>desc</span><span class='rparen'>)</span>
|
@@ -1207,12 +1530,12 @@ validations. See <span class='object_link'><a href="ActionCommand/Executable.ht
|
|
1207
1530
|
<pre class="lines">
|
1208
1531
|
|
1209
1532
|
|
1210
|
-
|
1211
|
-
|
1212
|
-
|
1533
|
+
57
|
1534
|
+
58
|
1535
|
+
59</pre>
|
1213
1536
|
</td>
|
1214
1537
|
<td>
|
1215
|
-
<pre class="code"><span class="info file"># File 'lib/action_command.rb', line
|
1538
|
+
<pre class="code"><span class="info file"># File 'lib/action_command.rb', line 57</span>
|
1216
1539
|
|
1217
1540
|
<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>
|
1218
1541
|
<span class='cvar'>@@logger</span> <span class='op'>=</span> <span class='id identifier rubyid_logger'>logger</span> <span class='comment'># rubocop:disable Style/ClassVars
|
@@ -1227,7 +1550,7 @@ validations. See <span class='object_link'><a href="ActionCommand/Executable.ht
|
|
1227
1550
|
</div>
|
1228
1551
|
|
1229
1552
|
<div id="footer">
|
1230
|
-
Generated on
|
1553
|
+
Generated on Mon Mar 7 14:27:17 2016 by
|
1231
1554
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
1232
1555
|
0.8.7.6 (ruby-2.2.3).
|
1233
1556
|
</div>
|