cmds 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d4dd9eb9dad554191cff2d860c105b44339cdcae
-  data.tar.gz: f89fe5555622db117c1b94abf50307f9758bb062
+  metadata.gz: 5544a81fa667995302720f92e88872e4949466ee
+  data.tar.gz: 516e1876a14034bdba7b164684335bffbe1f07aa
 SHA512:
-  metadata.gz: cac624f99ca246ac0f13c101c8f2066110eed0af071ae159e9d6f41bb82dfaa2534c42c4f4636d4c37d77fadfea90edd546025d1975270eaecab676730b2bc6c
-  data.tar.gz: f5fd451da65e260f12bfa4b54b47aef1942e79bcc4c346b330e672133687f55cf702bbd2298ae2c9ca851f7f51ece6293bd5bfc99ba0fe32f2d641fdbbc893f9
+  metadata.gz: 1037d17f966fe5bc8ae2c463e4b02f3238eaa169463f57421d8890fe200a212aa15307b09adc2c3f87b68272318200d9709f12a4e56248593288c1988c7d9307
+  data.tar.gz: e24cdefc7757abaf9e22da51b80201698373952878d41f3f011fb11fd90ec0c48087fda7b4fafe3a7cad2a85d1130699bacfde90dec0a7898441ab142c74d6f4

data/README.md

@@ -244,7 +244,7 @@ though keys with those names may be accessed directly via `@kwds.fetch(key)` and
 to test for a key's presence or optionally include a value, append `?` to the method name:
 
 ```
-c = Cmds::Cmd.new <<-BLOCK
+c = Cmds.new <<-BLOCK
   defaults
   <% if current_host? %>
     -currentHost <%= current_host %>
@@ -350,7 +350,7 @@ Cmds.sub "50%" # => "50%"
 ## reuse commands
 
 ```
-playbook = Cmds::Cmd.new "ansible-playbook -i %{inventory} %{playbook}"
+playbook = Cmds.new "ansible-playbook -i %{inventory} %{playbook}"
 playbook.call inventory: "./hosts", playbook: "blah.yml"
 ```
 
@@ -376,7 +376,7 @@ NEEDS TEST
 can be accomplished with reuse and currying stuff
 
 ```
-playbook = Cmds::Cmd.new "ansible-playbook -i %{inventory} %{playbook}", inventory: "inventory/dev"
+playbook = Cmds.new "ansible-playbook -i %{inventory} %{playbook}", inventory: "inventory/dev"
 
 # run setup.yml on the development hosts
 playbook.call playbook: "setup.yml"
@@ -390,7 +390,7 @@ prod_playbook.call playbook: "setup.yml", inventory: "inventory/prod"
 ## input
 
 ```
-c = Cmds::Cmd.new("wc", input: "blah blah blah).call
+c = Cmds.new("wc", input: "blah blah blah).call
 ```
 
 

data/Rakefile

@@ -57,14 +57,14 @@ namespace :debug do
   end
 
   task :proxy => :conf do
-    Cmds::Cmd.new("./test/questions.rb").proxy
+    Cmds.new("./test/questions.rb").proxy
   end
 
   namespace :capture do
     desc "capture with io-like input with debugging enabled"
     task :io_input => :conf do
       File.open "./test/lines.txt" do |f|
-        Cmds::Cmd.new("./test/echo_cmd.rb", input: f).capture
+        Cmds.new("./test/echo_cmd.rb", input: f).capture
       end
     end
   end # ns capture

data/lib/cmds/debug.rb

@@ -1,7 +1,7 @@
 require 'logger'
 
 # debug logging stuff
-module Cmds
+class Cmds
 
   module Debug
     # constants
@@ -98,4 +98,4 @@ module Cmds
     return unless Debug.on?
     Debug.logger.debug Debug.format(msg, values)
   end
-end # module Cmds
+end # class Cmds

data/lib/cmds/erb_context.rb

@@ -1,5 +1,7 @@
-module Cmds
+class Cmds
   class ERBContext < BasicObject
+    attr_reader :args
+    
     def initialize args, kwds
       @args = args
       @kwds = kwds
@@ -38,4 +40,4 @@ module Cmds
       @args.fetch(@arg_index).tap {@arg_index += 1}
     end
   end # end ERBContext
-end # module Cmds
+end # class Cmds

data/lib/cmds/io_handler.rb

@@ -1,4 +1,4 @@
-module Cmds
+class Cmds
   class IOHandler
     attr_accessor :in, :out, :err
 
@@ -73,4 +73,4 @@ module Cmds
 
     # end private
   end # end IOHandler
-end # module Cmds
+end # class Cmds

data/lib/cmds/pipe.rb

@@ -1,4 +1,4 @@
-module Cmds
+class Cmds
   # stupid little wrapper around IO.pipe that can have some extra info
   # attached to it
   class Pipe

data/lib/cmds/result.rb

@@ -2,7 +2,7 @@ require 'nrser/refinements'
 
 using NRSER
 
-module Cmds
+class Cmds
   # a simple data structure returned from calling {Cmds#capture} 
   # on a {Cmd} instance.
   # 

data/lib/cmds/shell_eruby.rb

@@ -1,11 +1,11 @@
 require 'erubis'
 
-module Cmds
+class Cmds
   # extension of Erubis' EscapedEruby (which auto-escapes `<%= %>` and
   # leaves `<%== %>` raw) that calls `Cmds.expand_sub` on the value
   class ShellEruby < Erubis::EscapedEruby
     def escaped_expr code
-      "::Cmds.expand_sub(#{code.strip})"
+      "::Cmds.tokenize(#{code.strip})"
     end
   end
-end # module Cmds
+end # class Cmds

data/lib/cmds/spawn.rb

@@ -12,7 +12,7 @@ require 'cmds/io_handler'
 
 using NRSER
 
-module Cmds
+class Cmds
   # internal core function to spawn and stream inputs and/or outputs using
   # threads.
   # 

data/lib/cmds/sugar.rb

@@ -21,7 +21,7 @@ def Cmds! template, *args, **kwds, &io_block
 end
 
 
-module Cmds
+class Cmds
   # create a new {Cmd} instance with the template and parameters and
   # calls {Cmd#prepare}.
   # 
@@ -38,7 +38,7 @@ module Cmds
   #   rendered and formatted command string ready to be executed.
   # 
   def self.prepare template, *args, **kwds
-    Cmd.new(template).prepare *args, **kwds
+    Cmds.new(template).prepare *args, **kwds
   end
   
   
@@ -57,7 +57,7 @@ module Cmds
   #   result with command string, exist status, stdout and stderr.
   # 
   def self.capture template, *args, **kwds, &input_block
-    Cmd.new(template).capture *args, **kwds, &input_block
+    Cmds.new(template).capture *args, **kwds, &input_block
   end
   
   
@@ -73,28 +73,28 @@ module Cmds
   #   result with command string, exist status, stdout and stderr.
   # 
   def self.ok? template, *args, **kwds, &io_block
-    Cmd.new(template).ok? *args, **kwds, &io_block
+    Cmds.new(template).ok? *args, **kwds, &io_block
   end
   
   
   def self.error? template, *args, **kwds, &io_block
-    Cmd.new(template).error? *args, **kwds, &io_block
+    Cmds.new(template).error? *args, **kwds, &io_block
   end
   
   
   # create a new {Cmd} and 
   def self.assert template, *args, **kwds, &io_block
-    Cmd.new(template).capture(*args, **kwds, &io_block).assert
+    Cmds.new(template).capture(*args, **kwds, &io_block).assert
   end
   
   
   def self.stream template, *subs, &input_block
-    Cmds::Cmd.new(template).stream *subs, &input_block
+    Cmds.new(template).stream *subs, &input_block
   end
   
   
   def self.stream! template, *subs, &input_block
-    Cmds::Cmd.new(template, assert: true).stream *subs, &input_block
+    Cmds.new(template, assert: true).stream *subs, &input_block
   end # ::stream!
 
   
@@ -112,7 +112,7 @@ module Cmds
   #   the command's stdout.
   #
   def self.out template, *args, **kwds, &input_block
-    Cmd.new(template).out *args, **kwds, &input_block
+    Cmds.new(template).out *args, **kwds, &input_block
   end
   
   
@@ -133,7 +133,7 @@ module Cmds
   #   if the command fails (non-zero exit status).
   #
   def self.out! template, *args, **kwds, &input_block
-    Cmd.new(template).out! *args, **kwds, &input_block
+    Cmds.new(template).out! *args, **kwds, &input_block
   end
   
   

data/lib/cmds/util/defaults.rb

@@ -1,4 +1,4 @@
-module Cmds
+class Cmds
   # hash of common default values used in method options.
   # 
   # don't use them directly -- use {Cmds.defaults}.

data/lib/cmds/util/params.rb

@@ -1,4 +1,4 @@
-module Cmds
+class Cmds
   class Params
     # Cmds instance execution methods take a splat and block 
     def self.normalize *params, &input

data/lib/cmds/util/tokenize_option.rb

@@ -5,7 +5,7 @@ using NRSER
 
 require_relative "defaults"
 
-module Cmds
+class Cmds
   # turn an option name and value into an array of shell-escaped string
   # token suitable for use in a command.
   # 

data/lib/cmds/util/tokenize_options.rb

@@ -1,6 +1,6 @@
 require_relative 'tokenize_option'
 
-module Cmds
+class Cmds
   # escape option hash.
   #
   # this is only useful for the two common option styles: 

data/lib/cmds/util.rb

@@ -5,7 +5,7 @@ require 'shellwords'
 
 require 'cmds/util/tokenize_options'
 
-module Cmds
+class Cmds
   # class methods
   # =============
 
@@ -16,18 +16,28 @@ module Cmds
     Shellwords.escape str
   end  
 
-  # expand one of the substitutions
-  def self.expand_sub sub
-    case sub
-    when nil
-      # nil is just an empty string, NOT an empty string bash token
-      ''
-    when Hash
-      tokenize_options sub
-    else
-      esc sub.to_s
-    end
-  end # ::expand_sub
+  # tokenize values for the shell. each values is tokenized individually
+  # and the results are joined with a space.
+  # 
+  # @param [Array<Object>] *values
+  #   values to tokenize.
+  # 
+  # @return [String]
+  #   tokenized string ready for the shell.
+  # 
+  def self.tokenize *values
+    values.map {|value|
+      case value
+      when nil
+        # nil is just an empty string, NOT an empty string bash token
+        ''
+      when Hash
+        tokenize_options value
+      else
+        esc value.to_s
+      end
+    }.join ' '
+  end # ::tokenize
   
   # formats a command string 
   def self.format string, with = :squish
@@ -95,4 +105,4 @@ module Cmds
       )
   end # ::replace_shortcuts
   
-end # module Cmds
+end # class Cmds

data/lib/cmds/version.rb

@@ -1,3 +1,3 @@
-module Cmds
-  VERSION = "0.1.5"
+class Cmds
+  VERSION = "0.2.0"
 end