action_command 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f453f4bd9d5de25bb5d0509ce6572f83d9fb61f
-  data.tar.gz: 180d47f86c8e4121c5daa5e6ad22220ce8925907
+  metadata.gz: 2cd366bbe081e13a248bcff7ef460127574f2c73
+  data.tar.gz: 3d8a05a55480d5d10fa609d4e9d69ede0bd849c2
 SHA512:
-  metadata.gz: 93c26718dd95a05f3d739d757bcbed33ecde64b27a8b566cf31a188fb8cc8133f21fbc28843920ecad0170dc03102560ae5618c5dc8efce7ac43cf1ce16958ee
-  data.tar.gz: 09328459ee69b500f94c9931f816b3c27283d073ac01212982af0a50749cde885942468a129218795afab652b10857982e4be4eefca40ba906fc8f6659519310
+  metadata.gz: 1e7674270076303b570cd4687d4816218edd54eb8afa96a01611c9c0cc42a4eea0827dc769e8690958f3b737bdee6a2bcb09d7171fe9faee545b793c4b2c84f7
+  data.tar.gz: 3adbd8341c395686657dd8d9dd8a840e760dc1f0c96f93aa2c8af935b9a3b3ea6c4035f1efaa46f1a6342c7c12de9288acb991cd37233f94dd62a5fbe9425370

data/.byebug_history

@@ -0,0 +1,5 @@
+quit
+exit
+User.all
+created
+user

data/.codeclimate.yml

@@ -24,3 +24,4 @@ ratings:
   - "**.go"
 exclude_paths:
 - doc/**/*
+- spec/**/*

data/.rubocop.yml

@@ -1,9 +1,13 @@
 AllCops:
   Exclude:
     - Guardfile
+    - spec/**/*
 Metrics/LineLength:
   Max: 99
 
+Metrics/MethodLength:
+  Max: 15
+
 Style/TrailingWhitespace:
   Enabled: false
 

data/Gemfile.lock

@@ -1,15 +1,33 @@
 PATH
   remote: .
   specs:
-    action_command (0.1.3)
+    action_command (0.1.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activemodel (4.0.13)
+      activesupport (= 4.0.13)
+      builder (~> 3.1.0)
+    activerecord (4.0.13)
+      activemodel (= 4.0.13)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.13)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.4)
+    activesupport (4.0.13)
+      i18n (~> 0.6, >= 0.6.9)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    arel (4.0.2)
     ast (2.2.0)
-    codeclimate-test-reporter (0.4.8)
+    builder (3.1.4)
+    byebug (8.2.2)
+    codeclimate-test-reporter (0.5.0)
       simplecov (>= 0.7.1, < 1.0.0)
-    coderay (1.1.0)
+    coderay (1.1.1)
     colorize (0.7.7)
     diff-lcs (1.2.5)
     docile (1.1.5)
@@ -32,17 +50,20 @@ GEM
     guard-rubocop (1.2.0)
       guard (~> 2.0)
       rubocop (~> 0.20)
+    i18n (0.7.0)
     json (1.8.3)
     listen (3.0.6)
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9.7)
     lumberjack (1.0.10)
     method_source (0.8.2)
+    minitest (4.7.5)
+    multi_json (1.11.2)
     nenv (0.3.0)
     notiffany (0.0.8)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    parser (2.3.0.5)
+    parser (2.3.0.6)
       ast (~> 2.2)
     powerpack (0.1.1)
     pry (0.10.3)
@@ -60,7 +81,7 @@ GEM
       rspec-core (~> 3.4.0)
       rspec-expectations (~> 3.4.0)
       rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.2)
+    rspec-core (3.4.3)
       rspec-support (~> 3.4.0)
     rspec-expectations (3.4.0)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -83,9 +104,12 @@ GEM
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
     slop (3.6.0)
+    sqlite3 (1.3.11)
     terminal-notifier (1.6.3)
-    terminal-notifier-guard (1.6.4)
+    terminal-notifier-guard (1.7.0)
     thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (0.3.46)
     unicode-display_width (0.3.1)
     yard (0.8.7.6)
 
@@ -94,7 +118,9 @@ PLATFORMS
 
 DEPENDENCIES
   action_command!
+  activerecord (~> 4.0.0)
   bundler (~> 1.11)
+  byebug
   codeclimate-test-reporter
   guard
   guard-rspec
@@ -104,6 +130,7 @@ DEPENDENCIES
   rspec (~> 3.0)
   rubocop (~> 0.37.0)
   simplecov (~> 0.11)
+  sqlite3
   terminal-notifier
   terminal-notifier-guard
   yard (~> 0.8)

data/README.md

@@ -160,6 +160,68 @@ you should call additional actions via:
   end
 ```
 
+### Error Handling and Logging
+
+#### Error Handling
+
+Within a command, you can generically fail with an error message, or fail with a
+particular custom error code
+
+```ruby
+  def execute_internal(result)
+    # fail generically
+    result.failed("Something bad happened")
+  
+    my_custom_error = 10
+    result.failed_with_code("Something bad happened", my_custom_error)
+  end
+```
+
+You can check for errors in the result:
+
+```ruby
+  result = ActionCommand.execute_rails...
+  
+  return unless result.ok? # generic failure
+  
+  switch(result.result_code)
+  when ActionCommand::RESULT_CODE_OK
+    ...
+  when my_custom_error
+    ...
+  end
+```
+
+#### Logging
+
+You can turn on logging either globally, or for specific
+command executions:
+
+```ruby
+  # turn it on globally
+  ActionCommand.logger = your_logger
+  
+  # turn it on only for this command
+  params = { 
+    logger: your_logger,
+    # your other parameters
+  }
+  ActionCommand.execute_rails(YourCommand, params)
+```
+
+When logging is on, the logger will receive single-line JSON messages
+at the debugging level for all command inputs and outputs.  All child
+commands under a parent will automatically be tagged with a serial
+number for correlation.  The result looks like this:
+
+TODO
+
+You can also optionally add your own entries to the log by calling
+`result.debug`, `result.info`, or `result.failed`.   If you pass these
+calls a string, they will include it as `msg` in the JSON.   If you
+pass them a hash, its contents will be merged into the JSON.
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/action_command.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'byebug'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '~> 0.37.0'
@@ -33,4 +34,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'terminal-notifier'
   spec.add_development_dependency 'terminal-notifier-guard'
   spec.add_development_dependency 'rake_command_filter'
+  spec.add_development_dependency 'activerecord', '~> 4.0.0'
+  spec.add_development_dependency 'sqlite3'
 end

data/doc/ActionCommand/Executable.html

@@ -112,10 +112,14 @@ ActionCommand.execute_… to execute one.</p>
 <div class="tags">
   
 
+</div><div id="subclasses">
+  <h2>Direct Known Subclasses</h2>
+  <p class="children"><span class='object_link'><a href="ExecutableTransaction.html" title="ActionCommand::ExecutableTransaction (class)">ExecutableTransaction</a></span>, <span class='object_link'><a href="PrettyPrintLogAction.html" title="ActionCommand::PrettyPrintLogAction (class)">PrettyPrintLogAction</a></span></p>
 </div>
 
 
 
+
   <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
   <ul class="summary">
     
@@ -189,6 +193,30 @@ ActionCommand.execute_… to execute one.</p>
         <li class="public ">
   <span class="summary_signature">
     
+      <a href="#api_context%3F-instance_method" title="#api_context? (instance method)">- (Boolean) <strong>api_context?</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>True if this command was executed using ActionCommand.execute_api.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
       <a href="#child_context%3F-instance_method" title="#child_context? (instance method)">- (Boolean) <strong>child_context?</strong> </a>
     
 
@@ -551,9 +579,9 @@ validations within the testing context.</p>
 
     
       <div class="method_details first">
-  <h3 class="signature first" id="child_context?-instance_method">
+  <h3 class="signature first" id="api_context?-instance_method">
   
-    - (<tt>Boolean</tt>) <strong>child_context?</strong> 
+    - (<tt>Boolean</tt>) <strong>api_context?</strong> 
   
 
   
@@ -562,7 +590,7 @@ validations within the testing context.</p>
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Returns true if this command is a child of another command</p>
+<p>Returns true if this command was executed using ActionCommand.execute_api</p>
 
 
   </div>
@@ -581,7 +609,7 @@ validations within the testing context.</p>
       
         &mdash;
         <div class='inline'>
-<p>true if this command is a child of another command</p>
+<p>true if this command was executed using ActionCommand.execute_api</p>
 </div>
       
     </li>
@@ -601,6 +629,65 @@ validations within the testing context.</p>
     <td>
       <pre class="code"><span class="info file"># File 'lib/action_command/executable.rb', line 39</span>
 
+<span class='kw'>def</span> <span class='id identifier rubyid_api_context?'>api_context?</span>
+  <span class='kw'>return</span> <span class='id identifier rubyid_root_context'>root_context</span> <span class='op'>==</span> <span class='const'>ActionCommand</span><span class='op'>::</span><span class='const'>CONTEXT_API</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="child_context?-instance_method">
+  
+    - (<tt>Boolean</tt>) <strong>child_context?</strong> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Returns true if this command is a child of another command</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Boolean</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>true if this command is a child of another command</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+45
+46
+47</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/action_command/executable.rb', line 45</span>
+
 <span class='kw'>def</span> <span class='id identifier rubyid_child_context?'>child_context?</span>
   <span class='kw'>return</span> <span class='op'>!</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='lparen'>(</span><span class='const'>Symbol</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
@@ -650,14 +737,14 @@ Command implementors should override execute_internal.</p>
       <pre class="lines">
 
 
-48
-49
-50
-51
-52</pre>
+54
+55
+56
+57
+58</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/action_command/executable.rb', line 48</span>
+      <pre class="code"><span class="info file"># File 'lib/action_command/executable.rb', line 54</span>
 
 <span class='kw'>def</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>
   <span class='id identifier rubyid_execute_internal'>execute_internal</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
@@ -716,12 +803,12 @@ that the command failed.</p>
       <pre class="lines">
 
 
-69
-70
-71</pre>
+75
+76
+77</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/action_command/executable.rb', line 69</span>
+      <pre class="code"><span class="info file"># File 'lib/action_command/executable.rb', line 75</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_execute_internal'>execute_internal</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
   
@@ -1017,12 +1104,12 @@ ActionCommand#execute_test.</p>
       <pre class="lines">
 
 
-58
-59
-60</pre>
+64
+65
+66</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/action_command/executable.rb', line 58</span>
+      <pre class="code"><span class="info file"># File 'lib/action_command/executable.rb', line 64</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_testing'>testing</span>
   <span class='kw'>yield</span> <span class='ivar'>@test</span> <span class='kw'>if</span> <span class='ivar'>@test</span>
@@ -1037,7 +1124,7 @@ ActionCommand#execute_test.</p>
 </div>
 
     <div id="footer">
-  Generated on Fri Mar  4 10:20:15 2016 by
+  Generated on Mon Mar  7 14:27:17 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.3).
 </div>