cmds 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5544a81fa667995302720f92e88872e4949466ee
-  data.tar.gz: 516e1876a14034bdba7b164684335bffbe1f07aa
+  metadata.gz: ec573a2d3357aa33be6e99e15cfbbf17208b5f7b
+  data.tar.gz: 3650ce87a15e971b126395e11e86063b7605312a
 SHA512:
-  metadata.gz: 1037d17f966fe5bc8ae2c463e4b02f3238eaa169463f57421d8890fe200a212aa15307b09adc2c3f87b68272318200d9709f12a4e56248593288c1988c7d9307
-  data.tar.gz: e24cdefc7757abaf9e22da51b80201698373952878d41f3f011fb11fd90ec0c48087fda7b4fafe3a7cad2a85d1130699bacfde90dec0a7898441ab142c74d6f4
+  metadata.gz: 7a162d0e9dd3acd278e7c73274a13f14771f7c8dbd19f3bbd2427ac1830acab26930cb7daac1adb5030cbef0083fd94974cd4efb838a638bcdc26ad64e09fd35
+  data.tar.gz: dd7ad5d87fb29f2f3b36d22c8f440e6521c07df69f73a29a067910fa03bb8bd4b551623376802ea33995e7c3413a46af20878b2a4c63b49fc74edeeddf607f93

data/cmds.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'nrser', '>= 0.0.13'
+  spec.add_dependency 'nrser', '>= 0.0.17'
   spec.add_dependency 'erubis', '~> 2.7'
 
   spec.add_development_dependency "bundler", "~> 1.5"

data/lib/cmds/result.rb

@@ -1,7 +1,5 @@
 require 'nrser/refinements'
 
-using NRSER
-
 class Cmds
   # a simple data structure returned from calling {Cmds#capture} 
   # on a {Cmd} instance.
@@ -55,14 +53,7 @@ class Cmds
     # @raise [SystemCallError] if the command failed.
     #
     def assert
-      if error?
-        msg = <<-BLOCK.squish
-          command `#{ @cmd }` exited with status #{ @status }
-          and stderr #{ err.inspect }
-        BLOCK
-
-        raise SystemCallError.new msg, @status
-      end
+      Cmds.check_status @cmd, @status, @err
       self
     end # raise_error
   end # Result

data/lib/cmds/spawn.rb

@@ -10,8 +10,6 @@ require 'nrser/refinements'
 require 'cmds/pipe'
 require 'cmds/io_handler'
 
-using NRSER
-
 class Cmds
   # internal core function to spawn and stream inputs and/or outputs using
   # threads.
@@ -42,6 +40,9 @@ class Cmds
   #       -   block is called with the {Cmds::IOHandler} instance for the
   #           execution, which it can use to handle input and outputs.
   # 
+  # @return [Fixnum]
+  #   command exit status.
+  # 
   # @raise [ArgumentError]
   #   if `&io_block` has arity greater than 1.
   # 
@@ -76,7 +77,7 @@ class Cmds
         input = handler.in unless handler.in.nil?
       else
         # bad block provided
-        raise ArgumentError.new <<-BLOCK.squish
+        raise ArgumentError.new NRSER.squish <<-BLOCK
           provided input block must have arity 0 or 1
         BLOCK
       end # case io_block.arity
@@ -207,7 +208,7 @@ class Cmds
             if line.nil?
               Cmds.debug "received nil, output done."
             else
-              Cmds.debug <<-BLOCK.squish
+              Cmds.debug NRSER.squish <<-BLOCK
                 received #{ line.bytesize } bytes, passing to handler.
               BLOCK
             end
@@ -250,7 +251,7 @@ class Cmds
     if @assert && status != 0
       # we don't necessarily have the err output, so we can't include it
       # in the error message
-      msg = <<-BLOCK.squish
+      msg = NRSER.squish <<-BLOCK
         streamed command `#{ cmd }` exited with status #{ status }
       BLOCK
 

data/lib/cmds/stream.rb

@@ -0,0 +1,51 @@
+class Cmds
+  # stream a command.
+  # 
+  # @param *args (see #capture)
+  # @param **kwds (see #capture)
+  # 
+  # @param [nil | String | #read] &io_block
+  #   string or readable IO-like object to use as input to the command.
+  # 
+  # @return [Fixnum]
+  #   command exit status.
+  # 
+  def stream *args, **kwds, &io_block
+    Cmds.debug "entering Cmd#stream",
+      args: args,
+      kwds: kwds,
+      io_block: io_block
+    
+    Cmds.spawn  prepare(*args, **kwds),
+                input: @input,
+                # include env if mode is spawn argument
+                env: (@env_mode == :spawn_arg ? @env : {}),
+                chdir: @chdir,
+                &io_block
+  end # #stream
+
+  # stream and raise an error if exit code is not 0.
+  # 
+  # @param *args (see #capture)
+  # @param **kwds (see #capture)
+  # @param &io_block (see #stream)
+  # @return [Fixnum] (see #stream)
+  # 
+  # @raise [SystemCallError]
+  #   if exit status is not 0.
+  # 
+  def stream! *args, **kwds, &io_block
+    cmd = prepare(*args, **kwds)
+    
+    status = Cmds.spawn cmd,
+                        input: @input,
+                        # include env if mode is spawn argument
+                        env: (@env_mode == :spawn_arg ? @env : {}),
+                        chdir: @chdir,
+                        &io_block
+    
+    Cmds.check_status cmd, status
+    
+    status
+  end # #stream!
+end # Cmds

data/lib/cmds/sugar.rb

@@ -93,8 +93,8 @@ class Cmds
   end
   
   
-  def self.stream! template, *subs, &input_block
-    Cmds.new(template, assert: true).stream *subs, &input_block
+  def self.stream! template, *args, **kwds, &io_block
+    Cmds.new(template).stream! *args, **kwds, &io_block
   end # ::stream!
 
   

data/lib/cmds/util/tokenize_option.rb

@@ -1,8 +1,6 @@
 require 'json'
 require 'nrser/refinements'
 
-using NRSER
-
 require_relative "defaults"
 
 class Cmds
@@ -39,7 +37,7 @@ class Cmds
     opts = defaults opts, [:array_mode, :array_join_string, :false_mode]
     
     unless name.is_a?(String) && name.length > 0
-      raise ArgumentError.new <<-END.squish
+      raise ArgumentError.new NRSER.squish <<-END
         `name` must be a String of length greater than zero,
         found #{ name.inspect }
       END
@@ -78,7 +76,7 @@ class Cmds
         
       else
         # SOL
-        raise ArgumentError.new <<-END.squish
+        raise ArgumentError.new NRSER.squish <<-END
           bad array_mode option: #{ opts[:array_mode] }, 
           should be :repeat, :join or :json
         END
@@ -103,7 +101,7 @@ class Cmds
         ["--no-#{ esc(name) }"]
         
       else
-        raise ArgumentError.new <<-END.squish
+        raise ArgumentError.new NRSER.squish <<-END
           bad :false_mode option: #{ opts[:false_mode] }, 
           should be :omit or :no
         END

data/lib/cmds/util.rb

@@ -3,6 +3,10 @@
 # stdlib
 require 'shellwords'
 
+# deps
+require 'nrser'
+
+# package
 require 'cmds/util/tokenize_options'
 
 class Cmds
@@ -105,4 +109,30 @@ class Cmds
       )
   end # ::replace_shortcuts
   
+  # raise an error unless the exit status is 0.
+  # 
+  # @param [String] cmd
+  #   the command sting that was executed.
+  # 
+  # @param [Fixnum] status
+  #   the command's exit status.
+  # 
+  # @return [nil]
+  # 
+  # @raise [SystemCallError]
+  #   if exit status is not 0.
+  # 
+  def self.check_status cmd, status, err = nil
+    unless status.equal? 0
+      msg = NRSER.squish <<-END
+        command `#{ cmd }` exited with status #{ status }
+      END
+      
+      if err
+        msg += " and stderr:\n\n" + err
+      end
+      
+      raise SystemCallError.new msg, status
+    end
+  end # .assert
 end # class Cmds

data/lib/cmds/version.rb

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

data/lib/cmds.rb

@@ -10,6 +10,7 @@ require 'cmds/erb_context'
 require 'cmds/shell_eruby'
 require 'cmds/result'
 require 'cmds/sugar'
+require 'cmds/stream'
 
 class Cmds
   # ERB stirng template (with Cmds-specific extensions) for the command.
@@ -180,35 +181,20 @@ class Cmds
   def prepare *args, **kwds
     Cmds.format render(*args, **kwds), @format
   end # #prepare
-
-
-  def stream *args, **kwds, &io_block
-    Cmds.debug "entering Cmd#stream",
-      args: args,
-      kwds: kwds,
-      io_block: io_block
-    
-    Cmds.spawn  prepare(*args, **kwds),
-                input: @input,
-                # include env if mode is spawn argument
-                env: (@env_mode == :spawn_arg ? @env : {}),
-                chdir: @chdir,
-                &io_block
-  end # #stream
-
+  
 
   # executes the command and returns a {Cmds::Result} with the captured
   # outputs.
   # 
-  # @param [Array<Object>] args
+  # @param [Array<Object>] *args
   #   positional parameters to append to those in `@args` for rendering 
   #   into the command string.
   # 
-  # @param [Hash{Symbol => Object}] kwds
+  # @param [Hash{Symbol => Object}] **kwds
   #   keyword parameters that override those in `@kwds` for rendering
   #   into the command string.
   # 
-  # @param [#call] input_block
+  # @param [#call] &input_block
   #   optional block that returns a string or readable object to override
   #   `@input`.
   # 
@@ -303,11 +289,6 @@ class Cmds
   end
 
 
-  # def assert
-  #   capture.raise_error
-  # end
-
-
   def proxy
     stream do |io|
       io.in = $stdin

data/spec/cmds/stream_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe "Cmds::stream" do
+describe 'Cmds#stream' do
   let(:times) { 5 }
 
   it "writes to $stdout and $stderr by default" do
@@ -54,5 +54,16 @@ describe "Cmds::stream" do
 
       expect(out).to match /^\s+3\n$/
     end
+  end # input
+  
+  it "returns the exit status" do
+    expect(Cmds.new('true').stream).to be 0
+    expect(Cmds.new('false').stream).to be 1
   end
-end # Cmds::stream
+end # Cmds#stream
+
+describe 'Cmds#stream!' do
+  it "raises when exit code is not 0" do
+    expect { Cmds.new('false').stream! }.to raise_error SystemCallError
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cmds
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - nrser
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.13
+        version: 0.0.17
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.13
+        version: 0.0.17
 - !ruby/object:Gem::Dependency
   name: erubis
   requirement: !ruby/object:Gem::Requirement
@@ -149,6 +149,7 @@ files:
 - lib/cmds/result.rb
 - lib/cmds/shell_eruby.rb
 - lib/cmds/spawn.rb
+- lib/cmds/stream.rb
 - lib/cmds/sugar.rb
 - lib/cmds/util.rb
 - lib/cmds/util/defaults.rb