cmds 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86dd72194bff91bb75b4d30183cebd97dd8c847e
-  data.tar.gz: 670e3f676d609b35590028de05b8ad5f85da8794
+  metadata.gz: 746aa0ec8697ab254e151c8000620c7a3a6d8c52
+  data.tar.gz: d15e1589321da1a22ad00d98cb12875d71a0ea7b
 SHA512:
-  metadata.gz: 600cb0e5445461a5d15285ead1600a1daf92b6d41733f61d7ced4921e24d5fecece1d15aa925c4a6ab01e1ae8a13d04a3faade74a0f67b0ddf7263c9c86d24a6
-  data.tar.gz: 5273c6639247119a0d527787bf6ce5b71e8004b4ea33b4ac599a5f21649f2bcc0c075c2e21b2083037aec1ce56d1ed81cf13fd8930103f9998d8da7cb3a67f9a
+  metadata.gz: 186e86b834c8d38aa58b624c394acc850848fff6faac92ff10ecd3336992beff7a6b9d3a139baaec9148b12e1fe036c04a29bf954dde6c27a14309cf69304f98
+  data.tar.gz: de1c715943e12a45f003e5e9a4b0c9b63f8443c8c42a64a35d983f6d742404d82b28eddc06ad238d1777e3aaf20bb1b95ccc4871abfce1090d3b52c822e7846b

data/Gemfile

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

data/lib/cmds.rb

@@ -27,6 +27,18 @@ class Cmds
     def error?
       ! ok?
     end
+
+    # raises an error if there was one
+    def raise_error
+      if error?
+        msg = NRSER.squish <<-BLOCK
+          command `#{ @cmd }` exited with status #{ @status }
+          and stderr output #{ err.inspect }
+        BLOCK
+
+        raise SystemCallError.new msg, @status
+      end
+    end
   end
 
   # extension of Erubis' EscapedEruby (which auto-escapes `<%= %>` and
@@ -199,14 +211,17 @@ class Cmds
     NRSER.squish erb.result(context.get_binding)
   end # ::sub
 
-  def self.subs_to_args_and_kwds subs
+  def self.subs_to_args_kwds_input subs
     args = []
     kwds = {}
+    input = nil
 
     case subs.length
     when 0
-      # pass
+      # nothing to do
     when 1
+      # can either be a hash, which is interpreted as a keywords,
+      # or an array, which is interpreted as positional arguments
       case subs[0]
       when Hash
         kwds = subs[0]
@@ -220,7 +235,9 @@ class Cmds
         BLOCK
       end
 
-    when 2
+    when 2, 3
+      # first arg needs to be an array, second a hash, and optional third
+      # can be input
       unless subs[0].is_a? Array
         raise TypeError.new NRSER.squish <<-BLOCK
           first *subs arg needs to be an array, not #{ subs[0].inspect }
@@ -229,23 +246,45 @@ class Cmds
 
       unless subs[1].is_a? Hash
         raise TypeError.new NRSER.squish <<-BLOCK
-          third *subs arg needs to be a Hash, not #{ subs[1].inspect }
+          second *subs arg needs to be a Hash, not #{ subs[1].inspect }
         BLOCK
       end
 
-      args, kwds = subs
+      args, kwds, input = subs
     else
       raise ArgumentError.new NRSER.squish <<-BLOCK
         must provide one or two *subs arguments, received #{ 1 + subs.length }
       BLOCK
     end
 
-    [args, kwds]
+    [args, kwds, input]
   end
 
   # create a new Cmd from template and subs and call it
   def self.run template, *subs
-    self.new(template, *subs).call
+    args, kwds, input = subs_to_args_kwds_input subs
+    self.new(template, args: args, kwds: kwds, input: input).call
+  end
+
+  def self.ok? template, *subs
+    args, kwds, input = subs_to_args_kwds_input subs
+    self.new(template, args: args, kwds: kwds, input: input).ok?
+  end
+
+  def self.error? template, *subs
+    args, kwds, input = subs_to_args_kwds_input subs
+    self.new(template, args: args, kwds: kwds, input: input).error?
+  end
+
+  def self.raise_on_error template, *subs
+    args, kwds, input = subs_to_args_kwds_input subs
+    self.new(
+      template,
+      args: args,
+      kwds: kwds,
+      input: input,
+      raise_on_error: true
+    ).call
   end
 
   def self.replace_shortcuts template
@@ -282,35 +321,59 @@ class Cmds
       )
   end
 
-  attr_reader :tempalte, :args, :kwds
+  attr_reader :tempalte, :args, :kwds, :input, :raise_on_error
 
-  def initialize template, *subs
+  def initialize template, opts = {}
     @template = template
-    @args, @kwds = Cmds.subs_to_args_and_kwds subs
+    @args = opts[:args] || []
+    @kwds = opts[:kwds] || {}
+    @input = opts[:input] || nil
+    @raise_on_error = opts[:raise_on_error] || false
   end #initialize
 
   def call *subs
-    args, kwds = merge_subs subs
+    # merge any stored args and kwds and get any overriding input
+    args, kwds, input = merge_subs subs
 
     cmd = Cmds.sub @template, args, kwds
 
-    out, err, status = Open3.capture3 cmd
+    out, err, status = if input.nil?
+      Open3.capture3 cmd
+    else
+      Open3.capture3 cmd, stdin_data: input
+    end
+
+    result = Cmds::Result.new cmd, status.exitstatus, out, err
+
+    result.raise_error if @raise_on_error
 
-    Cmds::Result.new cmd, status, out, err
+    return result
   end #call
 
   # returns a new `Cmds` with the subs merged in
   def curry *subs
-    self.class.new @template, *merge_subs(subs)
+    args, kwds, input = merge_subs(subs)
+    self.class.new @template, args: args, kwds: kwds, input: input
+  end
+
+  def ok?
+    call.ok?
+  end
+
+  def error?
+    call.error?
   end
 
   private
 
     def merge_subs subs
       # break `subs` into `args` and `kwds`
-      args, kwds = Cmds.subs_to_args_and_kwds subs
+      args, kwds, input = Cmds.subs_to_args_kwds_input subs
+
+      # use any default input if we didn't get a new one
+      input = @input if input.nil?
 
-      [@args + args, @kwds.merge(kwds)]
+      [@args + args, @kwds.merge(kwds), input]
     end #merge_subs
 
   # end private
@@ -320,3 +383,11 @@ end # Cmds
 def Cmds *args
   Cmds.run *args
 end
+
+def Cmds? *args
+  Cmds.ok? *args
+end
+
+def Cmds! *args
+  Cmds.raise_on_error *args
+end

data/lib/cmds/version.rb

@@ -1,3 +1,3 @@
 class Cmds
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/cmds/call_spec.rb

@@ -13,4 +13,15 @@ describe "Cmds::call" do
       end
     end
   end # is reusable
-end # Cmds::run
+
+  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/error_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe "Cmds::error?" do
+  it "works" do
+    expect( Cmds.error? "true").to be false
+    expect( Cmds.error? "false").to be true
+  end
+end # Cmds::ok?

data/spec/cmds/ok_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe "Cmds::ok?" do
+  it "works" do
+    expect( Cmds.ok? "true").to be true
+    expect( Cmds.ok? "false").to be false
+  end
+end # Cmds::ok?

data/spec/cmds/raise_on_error_spec.rb

@@ -0,0 +1,11 @@
+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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cmds
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - nrser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-07 00:00:00.000000000 Z
+date: 2015-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nrser
@@ -103,7 +103,10 @@ files:
 - spec/cmds/call_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/sub_spec.rb
@@ -138,7 +141,10 @@ test_files:
 - spec/cmds/call_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/sub_spec.rb