cmds 0.2.10 → 0.2.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb76b191ec12117d2d68bef750fe3f613d770cc5
-  data.tar.gz: 5afb4768e3fada0c9d088b2552ead175c46d7a94
+  metadata.gz: 49607e4b3abe1cdace16b1315240d076c4140f99
+  data.tar.gz: e1d27dafc9a3a02f3c058f0a331b482097955a28
 SHA512:
-  metadata.gz: ce525833832fd9d2086296e587233e91c4fa86f76bd4ff2ba2913b49d8816a3dd6261f4b768316782598d5e215ab76dbf794591701f927318dbddcf2b2f96b1f
-  data.tar.gz: 9c03d0736dd8c17559c86211bcbf4a4d384703362cd3b954370417d51da6e0c9a27b3ae3600fda6a07fae1814af24fd27d181b5e60fd78f2914847eb73eb844b
+  metadata.gz: a6eef1e155c1dd4d3ae3d5670b15ec24d330f8137d7272a822a80653490d2ba2350e2d4442c45e718a2fab282c210fabd7547479ba45f2ec7cd11d9f065cbf9d
+  data.tar.gz: 38ac00432f28b3851cd53ba9ad00beb2037ec71a572a16df9ab1644b37e8de8181baece24d9e860993233dd480211d04abc0a15c02a1b65a53fa3f7e3d7a38e5

data/Gemfile

@@ -1,7 +1,7 @@
 source 'https://rubygems.org'
 
 # use local
-# gem 'nrser', '~> 0.0', :path => '../nrser'
+# gem 'nrser', '~> 0.3.0.dev', :path => '../nrser'
 
 # Specify your gem's dependencies in cmds.gemspec
 gemspec

data/bin/console

@@ -5,8 +5,10 @@ require 'nrser'
 require 'cmds'
 
 
-require 'nrser/refinements'
-using NRSER
+NRSER::Log.setup_for_console! application: 'cmds'
+
+require 'nrser/refinements/types'
+using NRSER::Types
 
 
 # You can add fixtures and/or initialization code here to make experimenting

data/cmds.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   # ----------------------------------------------------------------------------
   
   # Mu guns
-  spec.add_dependency             "nrser",          ">= 0.2.0.pre.3"
+  spec.add_dependency             "nrser",          '~> 0.3.0'
   
   # ERB replacement with more features
   # 

data/lib/cmds.rb

@@ -23,11 +23,19 @@ require 'cmds/stream'
 require 'cmds/capture'
 
 
+
+
 # Definitions
 # =======================================================================
 
 class Cmds
   
+  # Mixins
+  # ========================================================================
+  
+  include NRSER::Log::Mixin
+  
+  
   # Attributes
   # ============================================================================
   
@@ -226,17 +234,21 @@ class Cmds
   #   
   #   Available as the {#kwds} attribute.
   # 
-  def initialize  template, **opts
-    opts = defaults opts
+  def initialize  template, **options
+    options = defaults options
+    
+    if options.key? :opts
+      options[:kwds][:opts] = options.delete :opts
+    end
     
-    Cmds.debug "Cmd constructing...",
+    logger.trace "Cmd constructing...",
       template: template,
-      opts: opts
+      options: options
 
     @template = template
     
     # Assign options to instance variables
-    opts.each { |key, value|
+    options.each { |key, value|
       instance_variable_set "@#{ key }", value
     }
     

data/lib/cmds/capture.rb

@@ -4,7 +4,7 @@ class Cmds
   # outputs.
   # 
   # @param [Array<Object>] *args
-  #   positional parameters to append to those in `@args` for rendering 
+  #   positional parameters to append to those in `@args` for rendering
   #   into the command string.
   # 
   # @param [Hash{Symbol => Object}] **kwds
@@ -19,7 +19,7 @@ class Cmds
   #   result of execution with command string, status, stdout and stderr.
   # 
   def capture *args, **kwds, &input_block
-    Cmds.debug "entering Cmds#capture",
+    logger.trace "entering Cmds#capture",
       args: args,
       kwds: kwds,
       input: input
@@ -28,14 +28,14 @@ class Cmds
     # otherwise default to instance variable (which may be `nil`)
     input = input_block.nil? ? input : input_block.call
     
-    Cmds.debug "configured input",
+    logger.trace "configured input",
       input: input
     
     # strings output will be concatenated onto
     out = ''
     err = ''
 
-    Cmds.debug "calling Cmds.spawn..."
+    logger.trace "calling Cmds.spawn..."
     
     status = spawn(*args, **kwds) do |io|
       # send the input to stream, which sends it to spawn
@@ -51,7 +51,7 @@ class Cmds
       end
     end
     
-    Cmds.debug "Cmds.spawn completed",
+    logger.trace "Cmds.spawn completed",
       status: status
 
     # build a Result
@@ -68,4 +68,4 @@ class Cmds
 
   alias_method :call, :capture
   
-end # class Cmds
+end # class Cmds

data/lib/cmds/result.rb

@@ -1,4 +1,3 @@
-require 'nrser/refinements'
 
 class Cmds
   # A simple data structure returned from calling {Cmds#capture}

data/lib/cmds/spawn.rb

@@ -118,7 +118,7 @@ class Cmds
                   input: nil,
                   **spawn_opts,
                   &io_block
-    Cmds.debug "entering Cmds#spawn",
+    logger.trace "entering Cmds#spawn",
       cmd: cmd,
       env: env,
       input: input,
@@ -175,7 +175,7 @@ class Cmds
       end # case io_block.arity
     end # if io_block
 
-    Cmds.debug "looking at input...",
+    logger.trace "looking at input...",
       input: input
 
     # (possibly) create the input pipe... this will be nil if the provided
@@ -183,7 +183,7 @@ class Cmds
     # `spawn` options.
     in_pipe = case input
     when nil, String
-      Cmds.debug "input is a String or nil, creating pipe..."
+      logger.trace "input is a String or nil, creating pipe..."
 
       in_pipe = Cmds::Pipe.new "INPUT", :in
       spawn_opts[:in] = in_pipe.r
@@ -193,10 +193,10 @@ class Cmds
       in_pipe
 
     else
-      Cmds.debug "input should be io-like, setting spawn opt.",
+      logger.trace "input should be io-like, setting spawn opt.",
         input: input
       if input == $stdin
-        Cmds.debug "input is $stdin."
+        logger.trace "input is $stdin."
       end
       spawn_opts[:in] = input
       nil
@@ -221,13 +221,13 @@ class Cmds
       ["ERROR", :err],
       ["OUTPUT", :out],
     ].map do |name, sym|
-      Cmds.debug "looking at #{ name }..."
+      logger.trace "looking at #{ name }..."
       
       dest = handler.public_send sym
       
       # see if hanlder.out or hanlder.err is a Proc
       if dest.is_a? Proc
-        Cmds.debug "#{ name } is a Proc, creating pipe..."
+        logger.trace "#{ name } is a Proc, creating pipe..."
         pipe = Cmds::Pipe.new name, sym
         # the corresponding :out or :err option for spawn needs to be
         # the pipe's write handle
@@ -236,7 +236,7 @@ class Cmds
         pipe
 
       else
-        Cmds.debug "#{ name } should be io-like, setting spawn opt.",
+        logger.trace "#{ name } should be io-like, setting spawn opt.",
           output: dest
         spawn_opts[sym] = dest
         # the pipe is nil!
@@ -244,7 +244,7 @@ class Cmds
       end
     end # map outputs
 
-    Cmds.debug "spawning...",
+    logger.trace "spawning...",
       env: env,
       cmd: cmd,
       opts: spawn_opts
@@ -253,13 +253,13 @@ class Cmds
                         cmd,
                         spawn_opts
 
-    Cmds.debug "spawned.",
+    logger.trace "spawned.",
       pid: pid
 
     wait_thread = Process.detach pid
     wait_thread[:name] = "WAIT"
 
-    Cmds.debug "wait thread created.",
+    logger.trace "wait thread created.",
       thread: wait_thread
 
     # close child ios if created
@@ -274,14 +274,14 @@ class Cmds
     in_thread = if in_pipe
       Thread.new do
         Thread.current[:name] = in_pipe.name
-        Cmds.debug "thread started, writing input..."
+        logger.trace "thread started, writing input..."
 
         in_pipe.w.write input unless input.nil?
 
-        Cmds.debug "write done, closing in_pipe.w..."
+        logger.trace "write done, closing in_pipe.w..."
         in_pipe.w.close
 
-        Cmds.debug "thread done."
+        logger.trace "thread done."
       end # Thread
     end
 
@@ -289,54 +289,54 @@ class Cmds
       if pipe
         Thread.new do
           Thread.current[:name] = pipe.name
-          Cmds.debug "thread started"
+          logger.trace "thread started"
 
           loop do
-            Cmds.debug "blocking on gets..."
+            logger.trace "blocking on gets..."
             line = pipe.r.gets
             if line.nil?
-              Cmds.debug "received nil, output done."
+              logger.trace "received nil, output done."
             else
-              Cmds.debug NRSER.squish <<-BLOCK
-                received #{ line.bytesize } bytes, passing to handler.
-              BLOCK
+              logger.trace \
+                "received #{ line.bytesize } bytes, passing to handler."
             end
             handler.thread_send_line pipe.sym, line
             break if line.nil?
           end
 
-          Cmds.debug "reading done, closing pipe.r (unless already closed)..."
+          logger.trace \
+            "reading done, closing pipe.r (unless already closed)..."
           pipe.r.close unless pipe.r.closed?
 
-          Cmds.debug "thread done."
+          logger.trace "thread done."
         end # thread
       end # if pipe
     end # map threads
 
-    Cmds.debug "handing off main thread control to the handler..."
+    logger.trace "handing off main thread control to the handler..."
     begin
       handler.start
 
-      Cmds.debug "handler done."
+      logger.trace "handler done."
 
     ensure
       # wait for the threads to complete
-      Cmds.debug "joining threads..."
+      logger.trace "joining threads..."
 
       [in_thread, out_thread, err_thread, wait_thread].each do |thread|
         if thread
-          Cmds.debug "joining #{ thread[:name] } thread..."
+          logger.trace "joining #{ thread[:name] } thread..."
           thread.join
         end
       end
 
-      Cmds.debug "all threads done."
+      logger.trace "all threads done."
     end
 
     status = wait_thread.value.exitstatus
-    Cmds.debug "exit status: #{ status.inspect }"
+    logger.trace "exit status: #{ status.inspect }"
 
-    Cmds.debug "checking @assert and exit status..."
+    logger.trace "checking @assert and exit status..."
     if @assert && status != 0
       # we don't necessarily have the err output, so we can't include it
       # in the error message
@@ -347,7 +347,7 @@ class Cmds
       raise SystemCallError.new msg, status
     end
 
-    Cmds.debug "streaming completed."
+    logger.trace "streaming completed."
 
     return status
   end # .spawn

data/lib/cmds/stream.rb

@@ -11,7 +11,7 @@ class Cmds
   #   command exit status.
   # 
   def stream *args, **kwds, &io_block
-    Cmds.debug "entering Cmds#stream",
+    logger.trace "entering Cmds#stream",
       args: args,
       kwds: kwds,
       io_block: io_block

data/lib/cmds/util/defaults.rb

@@ -1,5 +1,8 @@
+# encoding: UTF-8
 # frozen_string_literal: true
 
+require 'active_support/core_ext/object/deep_dup'
+
 class Cmds
   # hash of common default values used in method options.
   # 
@@ -32,6 +35,11 @@ class Cmds
     # Don't change directories
     chdir: nil,
     
+    # Commands often use dash-separated option names, but it's a lot more
+    # convenient in Ruby to use underscored when using {Symbol}. This option
+    # will convert the underscores to dashes.
+    dash_opt_names: false,
+    
     # No additional environment
     env: {},
     
@@ -97,7 +105,7 @@ class Cmds
   #   
   def self.defaults opts, keys = '*', extras = {}
     if keys == '*'
-      DEFAULTS.dup
+      DEFAULTS.deep_dup
     else
       keys.
         map {|key|

data/lib/cmds/util/tokenize_option.rb

@@ -52,6 +52,8 @@ class Cmds
       END
     end
     
+    name = name.gsub( '_', '-' ) if opts[:dash_opt_names]
+    
     # Set type (`:short` or `:long`) prefix and name/value separator depending
     # on if name is "short" (single character) or "long" (anything else)
     # 

data/lib/cmds/util/tokenize_value.rb

@@ -16,6 +16,7 @@ class Cmds
   TOKENIZE_OPT_KEYS = [
     :array_mode,
     :array_join_string,
+    :dash_opt_names,
     :false_mode,
     :flatten_array_values,
     :hash_mode,

data/lib/cmds/version.rb

@@ -16,6 +16,6 @@ class Cmds
   # 
   # @return [String]
   # 
-  VERSION = '0.2.10'
+  VERSION = '0.2.11'
   
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: cmds
 version: !ruby/object:Gem::Version
-  version: 0.2.10
+  version: 0.2.11
 platform: ruby
 authors:
 - nrser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-03 00:00:00.000000000 Z
+date: 2018-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nrser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0.pre.3
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0.pre.3
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: erubis
   requirement: !ruby/object:Gem::Requirement