cmds 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce280edce2a5280b59577c6ed628d1272fb56837
-  data.tar.gz: 721ae47183a85e44ae7cdc2a15457fd5f1fbdf6c
+  metadata.gz: a0d4f58d017003bd4ff1f97a41a31a1e092281de
+  data.tar.gz: 94f1272024e6d65078d597bc7c306c9c554b5780
 SHA512:
-  metadata.gz: 71ac3174bc664c621b5abc3bbf2489f0f4eff8aee8702f2513e7770bfbe9a1051eb24724be91d6130aaff1a32c34b97d5d88761617bedb3908994f9f06d00ecf
-  data.tar.gz: f712b163665cd228bf8066fe44fb0cb73df538902b6e874ea05328762c44937e47a1d231da192798e6ce00e1e3a622ad84b097ca1f598968ddbb4995a692610a
+  metadata.gz: b07ecf238f17240dc52bacb958d1368cabaa5c577db49623a5b8a52544110a27661ee9b428d4438584d3cae65b9dbb989012c3c17de15d2b1df28fc53399930e
+  data.tar.gz: 973a978ed2fb08958413c1cb163ebf88be9975475bb55da5d8f2d96cdc3e42f1ea39820bed70de1eb3c1de0eac5448a6f3346ff488c65f10b699e20aba65b45d

data/README.md

@@ -445,19 +445,23 @@ It's a clumsy hack from when I was first writing this library, and I've pretty m
 
 It pretty much just replaces some special patterns with their ERB-equivalent via the {Cmds.replace_shortcuts} method before moving on to ERB processing:
 
-1.  `%s`        => `<%= arg %>`
-2.  `%{key}`    => `<%= key %>`
-3.  `%{key?}`   => `<%= key? %>`
-4.  `%<key>s`   => `<%= key %>`
-5.  `%<key?>s`  => `<%= key? %>`
+| Format      | ERB Replacement |
+| ----------- | --------------- |
+| `%s`        |  `<%= arg %>`   |
+| `%{key}`    |  `<%= key %>`   |
+| `%{key?}`   |  `<%= key? %>`  |
+| `%<key>s`   |  `<%= key %>`   |
+| `%<key?>s`  |  `<%= key? %>`  |
 
 And the escaping versions, where you can put anothe `%` in front to get the literal intead of the subsitution:
 
-1.  `%%s`       => `%s`
-2.  `%%{key}`   => `%{key}`
-3.  `%%{key?}`  => `%{key?}`
-4.  `%%<key>s`  => `%<key>s`
-5.  `%%<key?>s` => `%<key?>s`
+| Format      | ERB Replacement |
+| ----------- | --------------- |
+| `%%s`       | `%s`            |
+| `%%{key}`   | `%{key}`        |
+| `%%{key?}`  | `%{key?}`       |
+| `%%<key>s`  | `%<key>s`       |
+| `%%<key?>s` | `%<key?>s`      |
 
 That's it. No `printf` formatting beyond besides `s` (string).
 

data/lib/cmds.rb

@@ -28,16 +28,6 @@ require 'cmds/capture'
 
 class Cmds
   
-  # Constants
-  # ============================================================================
-  
-  # Absolute, expanded path to the gem's root directory.
-  # 
-  # @return [Pathname]
-  # 
-  ROOT = ( Pathname.new(__FILE__).dirname / '..' ).expand_path
-  
-  
   # Attributes
   # ============================================================================
   

data/lib/cmds/result.rb

@@ -1,28 +1,43 @@
 require 'nrser/refinements'
 
 class Cmds
-  # a simple data structure returned from calling {Cmds#capture} 
+  # A simple data structure returned from calling {Cmds#capture}
   # on a {Cmds} instance.
   # 
-  # it contains the exit status code, standard output and standard error,
+  # It contains the exit status code, standard output and standard error,
   # as well as the actual string command issued (after all substitutions).
   #
-  # instances also have a few convenience methods.
-  #
-  # @!attribute [r] cmd
-  #   @return [String] the command string that was executed.
-  #
-  # @!attribute [r] status
-  #   @return [Fixnum] the command process' exit status code.
-  #
-  # @!attribute [r] out
-  #   @return [String] the command process' standard output.
-  #
-  # @!attribute [r] err
-  #   @return [String] the command process' standard error.
-  #
+  # Instances also have a few convenience methods.
+  # 
   class Result
-    attr_reader :cmd, :status, :out, :err
+    
+    # The command string that was executed.
+    # 
+    # @return [String]
+    #     
+    attr_reader :cmd
+    
+    
+    # The command process' exit status code.
+    # 
+    # @return [Fixnum]
+    #     
+    attr_reader :status
+    
+    
+    # The command process' standard output.
+    # 
+    # @return [String]
+    #     
+    attr_reader :out
+    
+    
+    # The command process' standard error.
+    # 
+    # @return [String]
+    #     
+    attr_reader :err
+    
     
     # @param cmd [String] {#cmd} attribute.
     # @param status [Fixnum] {#status} attribute.
@@ -35,17 +50,22 @@ class Cmds
       @err = err
     end
     
-    # @return [Boolean] true if {#status} is `0`.
+    
+    # @return [Boolean]
+    #   `true` if {#status} is `0`.
     def ok?
       @status == 0
     end
     
-    # @return [Boolean] true if {#status} is not `0`.
+    
+    # @return [Boolean]
+    #   `true` if {#status} is not `0`.
     def error?
       ! ok?
     end
     
-    # raises an error if the command failed (exited with a {#status} other 
+    
+    # Raises an error if the command failed (exited with a {#status} other
     # than `0`).
     #
     # @return [Result] it's self (so that it can be chained).
@@ -56,5 +76,22 @@ class Cmds
       Cmds.check_status @cmd, @status, @err
       self
     end # raise_error
+    
+    
+    # Get a {Hash} containing the instance variable values for easy logging,
+    # JSON dumping, etc.
+    # 
+    # @example
+    #   Cmds( "echo %s", "hey" ).to_h
+    #   # => {:cmd=>"echo hey", :status=>0, :out=>"hey\n", :err=>""}
+    # 
+    # @return [Hash<Symbol, V>]
+    # 
+    def to_h
+      instance_variables.map { |name|
+        [name.to_s.sub('@', '').to_sym, instance_variable_get( name )]
+      }.to_h
+    end
+    
   end # Result
 end # Cmds

data/lib/cmds/util.rb

@@ -135,6 +135,9 @@ class Cmds
         msg += " and stderr:\n\n" + err
       end
       
+      # Remove NULL bytes (not sure how they get in there...)
+      msg = msg.delete("\000")
+      
       raise SystemCallError.new msg, status
     end
   end # .assert

data/lib/cmds/version.rb

@@ -1,3 +1,21 @@
+require 'pathname'
+
 class Cmds
-  VERSION = "0.2.6"
+  
+  # Constants
+  # ============================================================================
+  
+  # Absolute, expanded path to the gem's root directory.
+  # 
+  # @return [Pathname]
+  # 
+  ROOT = (Pathname.new( __FILE__ ).dirname / '..' / '..').expand_path
+  
+  
+  # Library version string.
+  # 
+  # @return [String]
+  # 
+  VERSION = "0.2.7"
+  
 end

data/spec/spec_helper.rb

@@ -7,6 +7,17 @@ require 'cmds'
 
 require 'nrser/rspex'
 
+
+# RSpec Configuration
+# ============================================================================
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = \
+    Cmds::ROOT / 'tmp' / ".rspec_status"
+end
+
+
 ECHO_CMD = "./test/echo_cmd.rb"
 
 def echo_cmd_data result

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cmds
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - nrser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-26 00:00:00.000000000 Z
+date: 2018-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nrser
@@ -222,6 +222,7 @@ files:
 - test/lines.txt
 - test/questions.rb
 - test/tick.rb
+- tmp/.gitkeep
 homepage: https://github.com/nrser/cmds
 licenses:
 - MIT