cmds 0.0.3 → 0.0.4

data/spec/cmds/replace_shortcuts_spec.rb

@@ -1,78 +1,118 @@
 require 'spec_helper'
 
-def expect_to_replace input, output
-  [
-    "#{ input }",
-    "blah #{ input }",
-    "#{ input } blah",
-    "blah\n#{ input }\nblah",
-  ].each do |str|
-    expect( Cmds.replace_shortcuts input ).to eq output
-  end
-end
-
 describe 'Cmds::replace_shortcuts' do
+  meth = Cmds.method(:replace_shortcuts)
+  
   it "should replace %s with <%= arg %>" do
-    expect_to_replace "%s", "<%= arg %>"
-  end
-
+    expect_map meth, {
+      ["%s"]              => "<%= arg %>",
+      ["blah %s"]         => "blah <%= arg %>",
+      ["%s blah"]         => "<%= arg %> blah",
+      ["blah\n%s\nblah"]  => "blah\n<%= arg %>\nblah",
+      ["%s %s"]           => "<%= arg %> <%= arg %>",
+    }
+  end
+  
   it "should replace %%s with %s (escaping)" do
-    expect_to_replace "%%s", "%s"
-  end
-
-it "should replace %%%s with %%s (escaping)" do
-    expect_to_replace "%%%s", "%%s"
-  end
-
+    expect_map meth, {
+      ["%%s"]              => "%s",
+      ["blah %%s"]         => "blah %s",
+      ["%%s blah"]         => "%s blah",
+      ["blah\n%%s\nblah"]  => "blah\n%s\nblah",
+      ["%%s %%s"]          => "%s %s",
+      ["%%%s"]             => "%%s",
+    }
+  end
+   
   it "should replace %{key} with <%= key %>" do
-    expect_to_replace "%{key}", "<%= key %>"
-  end
-
-  it "should replace %%{key} with %{key} (escaping)" do
-    expect_to_replace '%%{key}', '%{key}'
-  end
-
-  it "should replace %%%{key} with %%{key} (escaping)" do
-    expect_to_replace '%%%{key}', '%%{key}'
-  end
-
+    expect_map meth, {
+      ["%{key}"]              => "<%= key %>",
+      ["blah %{key}"]         => "blah <%= key %>",
+      ["%{key} blah"]         => "<%= key %> blah",
+      ["blah\n%{key}\nblah"]  => "blah\n<%= key %>\nblah",
+      ["%{x} %{y}"]           => "<%= x %> <%= y %>",
+    }
+  end
+  
   it "should replace %{key?} with <%= key? %>" do
-    expect_to_replace "%{key?}", "<%= key? %>"
-  end
-
+    expect_map meth, {
+      ["%{key?}"]              => "<%= key? %>",
+      ["blah %{key?}"]         => "blah <%= key? %>",
+      ["%{key?} blah"]         => "<%= key? %> blah",
+      ["blah\n%{key?}\nblah"]  => "blah\n<%= key? %>\nblah",
+      ["%{x?} %{y?}"]          => "<%= x? %> <%= y? %>",
+    }
+  end
+  
+  it "should replace %%{key} with %{key} (escaping)" do
+    expect_map meth, {
+      ["%%{key}"]              => "%{key}",
+      ["blah %%{key}"]         => "blah %{key}",
+      ["%%{key} blah"]         => "%{key} blah",
+      ["blah\n%%{key}\nblah"]  => "blah\n%{key}\nblah",
+      ["%%{x} %%{y}"]          => "%{x} %{y}",
+      ["%%%{key}"]             => "%%{key}",
+    }
+  end
+  
   it "should replace %%{key?} with %{key?} (escaping)" do
-    expect_to_replace '%%{key?}', '%{key?}'
-  end
-
-  it "should replace %%%{key?} with %%{key?} (escaping)" do
-    expect_to_replace '%%%{key?}', '%%{key?}'
-  end
-
+    expect_map meth, {
+      ["%%{key?}"]              => "%{key?}",
+      ["blah %%{key?}"]         => "blah %{key?}",
+      ["%%{key?} blah"]         => "%{key?} blah",
+      ["blah\n%%{key?}\nblah"]  => "blah\n%{key?}\nblah",
+      ["%%{x?} %%{y?}"]         => "%{x?} %{y?}",
+      ["%%%{key?}"]             => "%%{key?}",
+    }
+  end
+   
   it "should replace %<key>s with <%= key %>" do
-    expect_to_replace "%<key>s", "<%= key %>"
-  end
-
-  it "should replace %%<key>s with %<key>s (escaping)" do
-    expect_to_replace "%%<key>s", "%<key>s"
-  end
-
-  it "should replace %%%<key>s with %%<key>s (escaping)" do
-    expect_to_replace "%%%<key>s", "%%<key>s"
-  end
-
+    expect_map meth, {
+      ["%<key>s"]              => "<%= key %>",
+      ["blah %<key>s"]         => "blah <%= key %>",
+      ["%<key>s blah"]         => "<%= key %> blah",
+      ["blah\n%<key>s\nblah"]  => "blah\n<%= key %>\nblah",
+      ["%<x>s %<y>s"]          => "<%= x %> <%= y %>",
+    }
+  end
+  
   it "should replace %<key?>s with <%= key? %>" do
-    expect_to_replace '%<key?>s', '<%= key? %>'
-  end
-
+    expect_map meth, {
+      ["%<key?>s"]              => "<%= key? %>",
+      ["blah %<key?>s"]         => "blah <%= key? %>",
+      ["%<key?>s blah"]         => "<%= key? %> blah",
+      ["blah\n%<key?>s\nblah"]  => "blah\n<%= key? %>\nblah",
+      ["%<x?>s %<y?>s"]         => "<%= x? %> <%= y? %>",
+    }
+  end
+  
+  it "should replace %%<key>s with %<key>s (escaping)" do
+    expect_map meth, {
+      ["%%<key>s"]              => "%<key>s",
+      ["blah %%<key>s"]         => "blah %<key>s",
+      ["%%<key>s blah"]         => "%<key>s blah",
+      ["blah\n%%<key>s\nblah"]  => "blah\n%<key>s\nblah",
+      ["%%<x>s %%<y>s"]         => "%<x>s %<y>s",
+      ["%%%<key>s"]             => "%%<key>s",
+    }
+  end
+  
   it "should replace %%<key?>s with %<key?>s (escaping)" do
-    expect_to_replace '%%<key?>s', '%<key?>s'
-  end
-
-  it "should replace %%%<key?>s with %%<key?>s (escaping)" do
-    expect_to_replace '%%%<key?>s', '%%<key?>s'
-  end
-
+    expect_map meth, {
+      ["%%<key?>s"]              => "%<key?>s",
+      ["blah %%<key?>s"]         => "blah %<key?>s",
+      ["%%<key?>s blah"]         => "%<key?>s blah",
+      ["blah\n%%<key?>s\nblah"]  => "blah\n%<key?>s\nblah",
+      ["%%<x?>s %%<y?>s"]        => "%<x?>s %<y?>s",
+      ["%%%<key?>s"]             => "%%<key?>s",
+    }
+  end
+  
+  
   it "should not touch % that don't fit the shortcut sytax" do
-    expect( Cmds.replace_shortcuts "50%" ).to eq "50%"
+    expect_map meth, {
+      ["50%"]                     => "50%",
+      ["50%savings!"]             => "50%savings!",
+    }
   end
-end
+end

data/spec/cmds/stream_spec.rb

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

data/spec/debug_helper.rb

@@ -0,0 +1,3 @@
+require 'cmds/debug'
+
+Cmds::Debug.on

data/spec/spec_helper.rb

@@ -1,13 +1,72 @@
+require 'pathname'
+require 'json'
+
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'cmds'
 
-def argv result
-  expect(result.ok?).to be true
-  JSON.load(result.out)['ARGV']
+ECHO_CMD = "./test/echo_cmd.rb"
+
+def echo_cmd_data result
+  expect( result.cmd ).to start_with ECHO_CMD
+  expect( result ).to be_instance_of Cmds::Result
+  expect( result.ok? ).to be true
+  data = JSON.load result.out
+  expect( data ).to be_instance_of Hash
+  data
+end
+
+def echo_cmd_key result, key
+  data = echo_cmd_data result
+  expect( data.key? key ).to be true
+  data[key]
+end
+
+def echo_cmd_argv result
+  echo_cmd_key result, 'ARGV'
+end
+
+def echo_cmd_stdin result
+  echo_cmd_key result, 'stdin'
 end
 
-def expect_argv result
-  expect(argv(result))
+# rspec uses StringIO for stdout and stderr, which spawn doesn't like.
+# this function swaps in tempfiles for $stdout and $stderr and returns
+# there outputs as strings.
+def temp_outs
+  # save ref to $stdout and $stderr
+  prev_stdout, prev_stderr = $stdout, $stderr
+
+  # create templfiles for out and err
+  out_f, err_f = ['out', 'err'].map {|s|
+    Tempfile.new "rspec_std#{ s }"
+  }
+
+  # assign those to $stdout and $stderr
+  $stdout, $stderr = out_f, err_f
+
+  # run the provided block
+  yield
+
+  # get the out and err strings and clean up
+  out, err = [out_f, err_f].map {|f|
+    f.rewind
+    str = f.read
+    f.close
+    f.unlink
+    str
+  }
+
+  # swap back to the old $stdout and $stderr
+  $stdout, $stderr = prev_stdout, prev_stderr
+
+  # return the output strings
+  [out, err]
+end # temp_out
+
+def expect_map method, map
+  map.each do |input, output|
+    expect( method.call *input ).to eq output
+  end
 end
 
 shared_examples "ok" do

data/test/answers.txt

@@ -0,0 +1,3 @@
+nrser
+blah
+blue

data/test/bin/dspec

@@ -0,0 +1 @@
+rspec -r ./spec/debug_helper.rb "$@"

data/test/echo_cmd.rb

@@ -10,6 +10,7 @@ argv = ARGV.clone
 data = {
   '$0' => $0,
   'ARGV' => argv,
+  'stdin' => $stdin.read,
 }
 
 puts JSON.pretty_generate(data)

data/test/lines.txt

@@ -0,0 +1,4 @@
+one
+two
+three
+four!

data/test/questions.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+# ask some questions
+
+qs = [
+  "what is your name?",
+  "what is your quest?",
+  "what is you favorite color?",
+]
+
+qs.each do |q|
+  puts q
+  response = gets
+  $stderr.puts "response: #{ response.inspect }"
+end

data/test/tick.rb

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+ARGV[0].to_i.times do |i|
+  puts i
+  sleep 0.1
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cmds
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - nrser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-09 00:00:00.000000000 Z
+date: 2015-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nrser
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pastel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - neil@ztkae.com
@@ -97,22 +111,39 @@ files:
 - ansible/hosts
 - cmds.gemspec
 - lib/cmds.rb
+- lib/cmds/capture.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/sugar.rb
+- lib/cmds/util.rb
 - lib/cmds/version.rb
-- scratch/blah.rb
 - scratch/erb.rb
-- spec/cmds/call_spec.rb
+- scratch/popen3.rb
+- scratch/proxy.rb
+- spec/cmds/assert_spec.rb
+- spec/cmds/capture_spec.rb
 - spec/cmds/curry_spec.rb
 - spec/cmds/erb_context_spec.rb
 - spec/cmds/error_spec.rb
 - spec/cmds/expand_option_hash_spec.rb
 - spec/cmds/ok_spec.rb
-- spec/cmds/raise_on_error_spec.rb
 - spec/cmds/replace_shortcuts_spec.rb
-- spec/cmds/run_spec.rb
+- spec/cmds/stream_spec.rb
 - spec/cmds/sub_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
 homepage: ''
 licenses:
 - MIT
@@ -138,16 +169,22 @@ signing_key:
 specification_version: 4
 summary: helps read, write and remember commands.
 test_files:
-- spec/cmds/call_spec.rb
+- spec/cmds/assert_spec.rb
+- spec/cmds/capture_spec.rb
 - spec/cmds/curry_spec.rb
 - spec/cmds/erb_context_spec.rb
 - spec/cmds/error_spec.rb
 - spec/cmds/expand_option_hash_spec.rb
 - spec/cmds/ok_spec.rb
-- spec/cmds/raise_on_error_spec.rb
 - spec/cmds/replace_shortcuts_spec.rb
-- spec/cmds/run_spec.rb
+- spec/cmds/stream_spec.rb
 - spec/cmds/sub_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

data/scratch/blah.rb

@@ -1,6 +0,0 @@
-def f *args
-  p args
-  p kwargs
-end
-
-f 1, 2, 3

data/spec/cmds/call_spec.rb

@@ -1,27 +0,0 @@
-require 'json'
-
-require 'spec_helper'
-
-describe "Cmds::call" do
-  it "is reusable" do
-    args_cmd = Cmds.new "./test/echo_cmd.rb <%= arg %>"
-    kwds_cmd = Cmds.new "./test/echo_cmd.rb <%= s %>"
-
-    ["arg one", "arg two", "arg three"].each do |arg|
-      [args_cmd.call([arg]), kwds_cmd.call(s: arg)].each do |result|
-        expect_argv( result ).to eq [arg]
-      end
-    end
-  end # is reusable
-
-  it "accepts input" do
-    input = <<-BLOCK
-    one
-    two
-    three
-    four!
-    BLOCK
-
-    expect( Cmds.new("wc -l", input: input).call.out ).to match /^\s+4$/
-  end
-end # Cmds::call

data/spec/cmds/raise_on_error_spec.rb

@@ -1,11 +0,0 @@
-require 'spec_helper'
-
-describe "Cmds::raise_on_error" do
-  it "should raise an error when the command fails" do
-    expect{ Cmds.raise_on_error "exit 1" }.to raise_error Errno::EPERM
-  end
-
-  it "should do the same for Cmds!" do
-    expect{ Cmds! "exit 1" }.to raise_error Errno::EPERM
-  end
-end # Cmds::run

data/spec/cmds/run_spec.rb

@@ -1,49 +0,0 @@
-require 'json'
-
-require 'spec_helper'
-
-describe "Cmds::run" do
-  context "echo_cmd.rb 'hello world!'" do
-
-    shared_examples "executes correctly" do
-      it_behaves_like "ok"
-
-      it "should have 'hello world!' as ARGV[0]" do
-        expect( JSON.load(result.out)['ARGV'][0] ).to eq "hello world!"
-      end
-    end # executes correctly
-
-    context "positional args" do
-      let(:result) {
-        Cmds "./test/echo_cmd.rb <%= arg %>", ["hello world!"]
-      }
-
-      it_behaves_like "executes correctly"
-    end
-
-    context "keyword args" do
-      let(:result) {
-        Cmds "./test/echo_cmd.rb <%= s %>", s: "hello world!"
-      }
-
-      it_behaves_like "executes correctly"
-    end
-
-  end # context echo_cmd.rb 'hello world!'
-
-  # context "feeding kwargs to args cmd" do
-  #   let(:result) {
-  #     Cmds "./test/echo_cmd.rb %s", s: "sup y'all"
-  #   }
-
-  #   it "" do
-  #     expect( result.cmd ).to eq nil
-  #   end
-  # end
-
-  it "should error when second (subs) arg is not a hash or array" do
-    expect {
-      Cmds "./test/echo_cmd.rb <%= arg %>", "hello world!"
-    }.to raise_error TypeError
-  end
-end # Cmds::run