cmds 0.0.9 → 0.1.0

data/spec/cmds/chomp_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe "Cmds.chomp" do
   it "gets echo output" do
-    expect( Cmds.chomp "echo %s", ["hey there!"] ).to eq "hey there!"
+    expect( Cmds.chomp "echo %s", "hey there!" ).to eq "hey there!"
   end
 
   it "reads input" do
@@ -16,7 +16,7 @@ end # Cmds.chomp
 
 describe "Cmds.chomp!" do
   it "gets echo output" do
-    expect( Cmds.chomp! "echo %s", ["hey there!"] ).to eq "hey there!"
+    expect( Cmds.chomp! "echo %s", "hey there!" ).to eq "hey there!"
   end
 
   it "reads input" do
@@ -34,12 +34,12 @@ end # Cmds.chomp!
 
 describe "Cmds#chomp" do
   it "gets echo output" do
-    expect( Cmds.new("echo %s").chomp ["hey there!"] ).to eq "hey there!"
+    expect( Cmds::Cmd.new("echo %s").chomp "hey there!" ).to eq "hey there!"
   end
 
   it "reads input" do
     expect(
-      Cmds.new("ruby -e %{script}").chomp(script: "puts STDIN.read") {
+      Cmds::Cmd.new("ruby -e %{script}").chomp(script: "puts STDIN.read") {
         "hey there!"
       }
     ).to eq "hey there!"
@@ -48,18 +48,18 @@ end # Cmds#chomp
 
 describe "Cmds#chomp!" do
   it "gets echo output" do
-    expect( Cmds.new("echo %s").chomp! ["hey there!"] ).to eq "hey there!"
+    expect( Cmds::Cmd.new("echo %s").chomp! "hey there!" ).to eq "hey there!"
   end
 
   it "reads input" do
     expect(
-      Cmds.new("ruby -e %{script}").chomp!(script: "puts STDIN.read") {
+      Cmds::Cmd.new("ruby -e %{script}").chomp!(script: "puts STDIN.read") {
         "hey there!"
       }
     ).to eq "hey there!"
   end
 
   it "errors when the command fails" do
-    expect { Cmds.new("false").chomp! }.to raise_error SystemCallError
+    expect { Cmds::Cmd.new("false").chomp! }.to raise_error SystemCallError
   end
 end # Cmds#chomp!

data/spec/cmds/curry_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe "Cmds::curry" do
   it "currys" do
-    base = Cmds.new "#{ ECHO_CMD } <%= x %> <%= y %>"
+    base = Cmds::Cmd.new "#{ ECHO_CMD } <%= x %> <%= y %>"
 
     x1 = base.curry x: 1
     x2 = base.curry x: 2

data/spec/cmds/err_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe "Cmds.err" do
   it "gets echo error output" do
-    expect( Cmds.err "echo %s 1>&2", ["hey there!"] ).to eq "hey there!\n"
+    expect( Cmds.err "echo %s 1>&2", "hey there!" ).to eq "hey there!\n"
   end
 
   it "reads input" do
@@ -16,14 +16,17 @@ end # Cmds.err
 
 describe "Cmds#err" do
   it "gets echo error output" do
-    expect( Cmds.new("echo %s 1>&2").err ["hey there!"] ).to eq "hey there!\n"
+    expect( 
+      Cmds::Cmd.new("echo %s 1>&2").err "hey there!"
+    ).to eq "hey there!\n"
   end
 
   it "reads input" do
     expect(
-      Cmds.new("ruby -e %{script}").err(script: "$stderr.puts STDIN.read") {
-        "hey there!"
-      }
+      Cmds::Cmd.new("ruby -e %{script}").
+        err(script: "$stderr.puts STDIN.read") {
+          "hey there!"
+        }
     ).to eq "hey there!\n"
   end
-end # Cmds#err
+end # Cmds.err

data/spec/cmds/error_spec.rb

@@ -1,13 +1,13 @@
 require 'spec_helper'
 
-describe "Cmds::error?" do
+describe "Cmds.error?" do
   it "works through instance method" do
-    expect( Cmds.new("true").error? ).to be false
-    expect( Cmds.new("false").error? ).to be true
+    expect( Cmds::Cmd.new("true").error? ).to be false
+    expect( Cmds::Cmd.new("false").error? ).to be true
   end
 
   it "works through class method" do
-    expect( Cmds.error? "true").to be false
-    expect( Cmds.error? "false").to be true
+    expect( Cmds.error? "true" ).to be false
+    expect( Cmds.error? "false" ).to be true
   end
-end # Cmds::error?
+end # Cmds.error?

data/spec/cmds/ok_spec.rb

@@ -2,8 +2,8 @@ require 'spec_helper'
 
 describe "Cmds::ok?" do
   it "works through instance method" do
-    expect( Cmds.new("true").ok? ).to be true
-    expect( Cmds.new("false").ok? ).to be false
+    expect( Cmds::Cmd.new("true").ok? ).to be true
+    expect( Cmds::Cmd.new("false").ok? ).to be false
   end
 
   it "works through class method" do

data/spec/cmds/out_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe "Cmds.out" do
   it "gets echo output" do
-    expect( Cmds.out "echo %s", ["hey there!"] ).to eq "hey there!\n"
+    expect( Cmds.out "echo %s", "hey there!" ).to eq "hey there!\n"
   end
 
   it "reads input" do
@@ -16,7 +16,7 @@ end # Cmds.out
 
 describe "Cmds.out!" do
   it "gets echo output" do
-    expect( Cmds.out! "echo %s", ["hey there!"] ).to eq "hey there!\n"
+    expect( Cmds.out! "echo %s", "hey there!" ).to eq "hey there!\n"
   end
 
   it "reads input" do
@@ -34,12 +34,12 @@ end # Cmds.out!
 
 describe "Cmds#out" do
   it "gets echo output" do
-    expect( Cmds.new("echo %s").out ["hey there!"] ).to eq "hey there!\n"
+    expect( Cmds::Cmd.new("echo %s").out "hey there!" ).to eq "hey there!\n"
   end
 
   it "reads input" do
     expect(
-      Cmds.new("ruby -e %{script}").out(script: "puts STDIN.read") {
+      Cmds::Cmd.new("ruby -e %{script}").out(script: "puts STDIN.read") {
         "hey there!"
       }
     ).to eq "hey there!\n"
@@ -48,18 +48,18 @@ end # Cmds#out
 
 describe "Cmds#out!" do
   it "gets echo output" do
-    expect( Cmds.new("echo %s").out! ["hey there!"] ).to eq "hey there!\n"
+    expect( Cmds::Cmd.new("echo %s").out! "hey there!" ).to eq "hey there!\n"
   end
 
   it "reads input" do
     expect(
-      Cmds.new("ruby -e %{script}").out!(script: "puts STDIN.read") {
+      Cmds::Cmd.new("ruby -e %{script}").out!(script: "puts STDIN.read") {
         "hey there!"
       }
     ).to eq "hey there!\n"
   end
 
   it "errors when the command fails" do
-    expect { Cmds.new("false").out! }.to raise_error SystemCallError
+    expect { Cmds::Cmd.new("false").out! }.to raise_error SystemCallError
   end
 end # Cmds#out!

data/spec/cmds/{sub_spec.rb → prepare_spec.rb}

@@ -1,9 +1,9 @@
 require 'spec_helper'
 
-describe "Cmds::sub" do
+describe "Cmds.prepare" do
   it "should work with a keyword substitutions" do
     expect(
-      Cmds.sub "psql <%= opts %> <%= database %> < <%= filepath %>",
+      Cmds.prepare "psql <%= opts %> <%= database %> < <%= filepath %>",
         [],
         database: "blah",
         filepath: "/where ever/it/is.psql",
@@ -17,41 +17,39 @@ describe "Cmds::sub" do
 
   it "should work with positional substitutions" do
     expect(
-      Cmds.sub "psql <%= arg %> <%= arg %> < <%= arg %>", [
+      Cmds.prepare "psql <%= arg %> <%= arg %> < <%= arg %>",
         {
           username: "bingo bob",
           host: "localhost",
           port: 12345,
         },
         "blah",
-        "/where ever/it/is.psql",
-      ]
+        "/where ever/it/is.psql"
     ).to eq 'psql --host=localhost --port=12345 --username=bingo\ bob blah < /where\ ever/it/is.psql'
   end
 
   it "should work with no arguments" do
     expect(
-      Cmds.sub "blah <% if true %>blow<% end %>"
+      Cmds.prepare "blah <% if true %>blow<% end %>"
     ).to eq "blah blow"
   end
-
+  
   it "should work with positional and keyword substitutions" do
     expect(
-      Cmds.sub "blah <%= arg %> <%= y %>", ["ex"], y: "why"
+      Cmds.prepare "blah <%= arg %> <%= y %>", "ex", y: "why"
     ).to eq "blah ex why"
   end
-
+  
   it "should work with direct reference to args" do
     expect(
-      Cmds.sub "psql <%= @args[2] %> <%= @args[0] %> < <%= @args[1] %>", [
+      Cmds.prepare "psql <%= @args[1] %> <%= @args[0] %> < <%= @args[2] %>",
         "blah",
-        "/where ever/it/is.psql",
         {
           username: "bingo bob",
           host: "localhost",
           port: 12345,
         },
-      ]
+        "/where ever/it/is.psql"
     ).to eq 'psql --host=localhost --port=12345 --username=bingo\ bob blah < /where\ ever/it/is.psql'
   end
 
@@ -68,7 +66,7 @@ describe "Cmds::sub" do
 
     it "should work when value is present" do
       expect(
-        Cmds.sub tpl, [], current_host: 'xyz',
+        Cmds.prepare tpl, current_host: 'xyz',
                           domain: 'com.nrser.blah',
                           filepath: '/tmp/export.plist'
       ).to eq "defaults -currentHost xyz export com.nrser.blah /tmp/export.plist"
@@ -76,7 +74,7 @@ describe "Cmds::sub" do
 
     it "should work when value is missing" do
       expect(
-        Cmds.sub tpl, [], domain: 'com.nrser.blah',
+        Cmds.prepare tpl, domain: 'com.nrser.blah',
                           filepath: '/tmp/export.plist'
       ).to eq "defaults export com.nrser.blah /tmp/export.plist"
     end
@@ -94,7 +92,7 @@ describe "Cmds::sub" do
 
     it "should loop correctly and escape values" do
       expect(
-        Cmds.sub tpl, [], domain: "com.nrser.blah",
+        Cmds.prepare tpl, domain: "com.nrser.blah",
                           key: 'k',
                           values: {x: '<ex>', y: 'why'}
       ).to eq "defaults write com.nrser.blah k -dict x \\<ex\\> y why"
@@ -109,54 +107,44 @@ describe "Cmds::sub" do
     }
 
     it "should omit the missing subs" do
-      expect(Cmds.sub tpl, [], x: "ex", z: "zee").to eq "blah ex zee"
+      expect(Cmds.prepare tpl, x: "ex", z: "zee").to eq "blah ex zee"
     end
     
     it "should omit a sub if it's value is false" do
-      expect(Cmds.sub "%{x?}", [], x: false).to eq ""
+      expect(Cmds.prepare "%{x?}", x: false).to eq ""
     end
   end
 
   context "errors" do
-    it "should raise TypeError if subs in not an array or a hash" do
-      expect{Cmds.sub "a <%= b %> <%= c %>", "dee!"}.to raise_error TypeError
-    end
-
     it "should error when a kwarg is missing" do
       expect {
-        Cmds.sub "a <%= b %> <%= c %>", [], b: 'bee!'
+        Cmds.prepare "a <%= b %> <%= c %>", b: 'bee!'
       }.to raise_error KeyError
     end
 
     it "should error when an arg is missing" do
       expect {
-        Cmds.sub "a <%= arg %> <%= arg %>", ['bee!']
+        Cmds.prepare "a <%= arg %> <%= arg %>", 'bee!'
       }.to raise_error IndexError
     end
-
-    it "should error when more than two args are passed" do
-      expect {
-        Cmds.sub "blah", 1, 2, 3
-      }.to raise_error ArgumentError
-    end
   end # errors
 
   context "shortcuts" do
     it "should replace %s" do
       expect(
-        Cmds.sub "./test/echo_cmd.rb %s", ["hello world!"]
+        Cmds.prepare "./test/echo_cmd.rb %s", "hello world!"
       ).to eq './test/echo_cmd.rb hello\ world\!'
     end
 
     it "should replace %{key}" do
       expect(
-        Cmds.sub "./test/echo_cmd.rb %{key}", [], key: "hello world!"
+        Cmds.prepare "./test/echo_cmd.rb %{key}", key: "hello world!"
       ).to eq './test/echo_cmd.rb hello\ world\!'
     end
 
     it "should replace %<key>s" do
       expect(
-        Cmds.sub "./test/echo_cmd.rb %<key>s", [], key: "hello world!"
+        Cmds.prepare "./test/echo_cmd.rb %<key>s", key: "hello world!"
       ).to eq './test/echo_cmd.rb hello\ world\!'
     end
   end # shortcuts

data/spec/cmds/stream_spec.rb

@@ -5,7 +5,7 @@ describe "Cmds::stream" do
 
   it "writes to $stdout and $stderr by default" do
     out, err = temp_outs do
-      Cmds.new('./test/tick.rb <%= times %>').stream times: times
+      Cmds::Cmd.new('./test/tick.rb <%= times %>').stream times: times
     end
 
     expect(out).to eq times.times.map{|_| "#{_}\n"}.join
@@ -15,7 +15,7 @@ describe "Cmds::stream" do
   it "handles writes in blocks" do
     out_count = 0
     err_count = 0
-    Cmds.new('./test/tick.rb <%= times %>').stream(times: times) do |io|
+    Cmds::Cmd.new('./test/tick.rb <%= times %>').stream(times: times) do |io|
       io.on_out do |line|
         out_count += 1
       end
@@ -32,7 +32,7 @@ describe "Cmds::stream" do
     it "accepts string value input from a block" do
 
       out, err = temp_outs do
-        Cmds.new("wc -l").stream do
+        Cmds::Cmd.new("wc -l").stream do
           <<-BLOCK
             one
             two
@@ -47,7 +47,7 @@ describe "Cmds::stream" do
 
     it "accepts stream value input from a block" do
       out, err = temp_outs do
-        Cmds.new("wc -l").stream do
+        Cmds::Cmd.new("wc -l").stream do
           File.open "./test/lines.txt"
         end
       end

data/spec/cmds/util/tokenize_option_spec.rb

@@ -0,0 +1,119 @@
+require 'spec_helper'
+
+describe "Cmds.tokenize_option" do
+  context "default options" do
+    it "handles integer value" do
+      expect(Cmds.tokenize_option 'x', 1).to eq ["-x 1"]
+      expect(Cmds.tokenize_option 'blah', 1).to eq ["--blah=1"]
+    end
+    
+    it "handles string value" do
+      expect(
+        Cmds.tokenize_option 'x', "hey there!"
+      ).to eq ["-x hey\\ there\\!"]
+      
+      expect(
+        Cmds.tokenize_option 'blah', "hey there!"
+      ).to eq ["--blah=hey\\ there\\!"]
+    end
+    
+    it "emits just name token for true value" do
+      expect(Cmds.tokenize_option 'x', true).to eq ["-x"]
+      expect(Cmds.tokenize_option 'blah', true).to eq ["--blah"]
+    end
+    
+    it "omits token for false value" do
+      expect(Cmds.tokenize_option 'x', false).to eq []
+      expect(Cmds.tokenize_option 'blah', false).to eq []
+    end
+    
+    it "omits token for nil value" do
+      expect(Cmds.tokenize_option 'x', nil).to eq []
+      expect(Cmds.tokenize_option 'blah', nil).to eq []
+    end
+  end # default options
+  
+  describe "array_mode option" do
+    context "array_mode default" do
+      it "emits joined tokens for array value" do 
+        expect(
+          Cmds.tokenize_option 'b', [1, 2, 3]
+        ).to eq ['-b 1,2,3']
+        
+        expect(
+          Cmds.tokenize_option 'blah', [1, 2, 3]
+        ).to eq ['--blah=1,2,3']
+      end
+      
+      it "flattens nested arrays" do
+        expect(
+          Cmds.tokenize_option 'blah', [1, [:a, [:b, 3]]]
+        ).to eq ['--blah=1,a,b,3']
+      end
+    end # default
+    
+    context "array_mode = :join" do
+      def f(name, value)
+        Cmds.tokenize_option name, value, array_mode: :join
+      end
+      
+      it "emits joined tokens for array value" do 
+        expect(f 'b', [1, 2, 3]).to eq ['-b 1,2,3']
+        
+        expect(f 'blah', [1, 2, 3]).to eq ['--blah=1,2,3']
+      end
+      
+      it "flattens nested arrays" do
+        expect(f 'blah', [1, [:a, [:b, 3]]]).to eq ['--blah=1,a,b,3']
+      end
+      
+      describe "array_join_string option" do
+        context "array_join_string = ', ' (has space in it)" do
+          def f(name, value)
+            Cmds.tokenize_option name, value,
+              array_mode: :join,
+              array_join_string: ', '
+          end
+          
+          it "encodes the value as a single shell token" do
+            tokens = f 'b', [1, 2, 3]
+            expect(f 'b', [1, 2, 3]).to eq ['-b 1,\\ 2,\\ 3']
+            
+            expect(tokens[0].shellsplit).to eq ['-b', '1, 2, 3']
+          end
+        end
+      end # array_join_string option
+    end # array_mode = :join
+    
+    context "array_mode = :repeat" do
+      def f(name, value)
+        Cmds.tokenize_option name, value, array_mode: :repeat
+      end
+      
+      it "emits multiple tokens for array value" do 
+        expect(f 'b', [1, 2, 3]).to eq ['-b 1', '-b 2', '-b 3']
+        expect(f 'blah', [1, 2, 3]).to eq ['--blah=1', '--blah=2', '--blah=3']
+      end
+      
+      it "flattens nested arrays" do
+        expect(f 'blah', [1, [:a, [:b, 3]]]).
+          to eq ['--blah=1', '--blah=a', '--blah=b', '--blah=3']
+      end
+    end # array_mode = :repeat
+    
+    context "array_mode = :json" do
+      def f(name, value)
+        Cmds.tokenize_option name, value, array_mode: :json
+      end
+      
+      it "emits single json token for array value" do
+        short_tokens = f 'b', [1, 2, 3]
+        
+        expect(short_tokens.length).to be 1
+        expect(JSON.load short_tokens[0].shellsplit[1]).to eq [1, 2, 3]
+      end
+    end # array_mode = :json
+    
+  end # array_mode option
+
+end # .tokenize_option

data/spec/cmds_spec.rb

@@ -4,4 +4,15 @@ describe Cmds do
   it 'has a version number' do
     expect(Cmds::VERSION).not_to be nil
   end
+  
+  it "has dees syntax" do
+    expect(Cmds.chomp! "echo 'here'").to eq 'here'
+    
+    expect(
+      Cmds::Cmd.new("head %{opts} %s").
+        prepare("/dev/random", opts: {c: 64})
+    ).to eq "head -c 64 /dev/random"
+    
+    # expect(Cmds.chomp! "echo %s", 'here').to eq 'here'
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cmds
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - nrser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-14 00:00:00.000000000 Z
+date: 2017-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nrser
@@ -138,18 +138,24 @@ files:
 - Rakefile
 - ansible/dev.yml
 - ansible/hosts
+- bin/rake
+- bin/rspec
 - cmds.gemspec
 - lib/cmds.rb
-- lib/cmds/capture.rb
+- lib/cmds/cmd.rb
 - lib/cmds/debug.rb
 - lib/cmds/erb_context.rb
 - lib/cmds/io_handler.rb
 - lib/cmds/pipe.rb
 - lib/cmds/result.rb
 - lib/cmds/shell_eruby.rb
-- lib/cmds/stream.rb
+- lib/cmds/spawn.rb
 - lib/cmds/sugar.rb
 - lib/cmds/util.rb
+- lib/cmds/util/defaults.rb
+- lib/cmds/util/params.rb
+- lib/cmds/util/tokenize_option.rb
+- lib/cmds/util/tokenize_options.rb
 - lib/cmds/version.rb
 - scratch/erb.rb
 - scratch/popen3.rb
@@ -161,17 +167,16 @@ files:
 - spec/cmds/erb_context_spec.rb
 - spec/cmds/err_spec.rb
 - spec/cmds/error_spec.rb
-- spec/cmds/expand_option_hash_spec.rb
 - spec/cmds/ok_spec.rb
 - spec/cmds/out_spec.rb
+- spec/cmds/prepare_spec.rb
 - spec/cmds/replace_shortcuts_spec.rb
 - spec/cmds/stream_spec.rb
-- spec/cmds/sub_spec.rb
+- spec/cmds/util/tokenize_option_spec.rb
 - spec/cmds_spec.rb
 - spec/debug_helper.rb
 - spec/spec_helper.rb
 - test/answers.txt
-- test/bin/dspec
 - test/echo_cmd.rb
 - test/lines.txt
 - test/questions.rb
@@ -196,7 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: helps read, write and remember commands.
@@ -208,19 +213,17 @@ test_files:
 - spec/cmds/erb_context_spec.rb
 - spec/cmds/err_spec.rb
 - spec/cmds/error_spec.rb
-- spec/cmds/expand_option_hash_spec.rb
 - spec/cmds/ok_spec.rb
 - spec/cmds/out_spec.rb
+- spec/cmds/prepare_spec.rb
 - spec/cmds/replace_shortcuts_spec.rb
 - spec/cmds/stream_spec.rb
-- spec/cmds/sub_spec.rb
+- spec/cmds/util/tokenize_option_spec.rb
 - spec/cmds_spec.rb
 - spec/debug_helper.rb
 - spec/spec_helper.rb
 - test/answers.txt
-- test/bin/dspec
 - test/echo_cmd.rb
 - test/lines.txt
 - test/questions.rb
 - test/tick.rb
-has_rdoc: 

data/lib/cmds/capture.rb

@@ -1,47 +0,0 @@
-class Cmds
-  # invokes the command and returns a Result with the captured outputs
-  def capture *subs, &input_block
-    Cmds.debug "entering Cmds#capture",
-      subs: subs,
-      input_block: input_block
-
-    # merge any stored args and kwds and replace input if provided
-    options = merge_options subs, input_block
-    Cmds.debug "merged options:",
-      options: options
-
-    # build the command string
-    cmd = Cmds.sub @template, options[:args], options[:kwds]
-    Cmds.debug "built command string: #{ cmd.inspect }"
-
-    out = ''
-    err = ''
-
-    Cmds.debug "calling Cmds#really_stream..."
-    status = really_stream cmd, options do |io|
-      # send the input to stream, which sends it to spawn
-      io.in = options[:input]
-
-      # and concat the output lines as they come in
-      io.on_out do |line|
-        out += line
-      end
-
-      io.on_err do |line|
-        err += line
-      end
-    end
-    Cmds.debug "Cmds#really_stream completed",
-      status: status
-
-    # build a Result
-    # result = Cmds::Result.new cmd, status, out_reader.value, err_reader.value
-    result = Cmds::Result.new cmd, status, out, err
-
-    # tell the Result to assert if the Cmds has been told to, which will
-    # raise a SystemCallError with the exit status if it was non-zero
-    result.assert if @assert
-
-    return result
-  end # #capture
-end