sys_cmd 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10dbd56d23cb306a8131e7dca5bb2b4030029c12
-  data.tar.gz: 2c8af860be280b526ce6872f905192b26da8ac15
+  metadata.gz: 01dda967130fa079c9737dc1b506855dff005337
+  data.tar.gz: ff4830b731167310c474fc62ee986efe9f09aae1
 SHA512:
-  metadata.gz: f70e9c7c2ef3442d106b07d9a8141e9059890481c9efe8c449905a6ec15c4a8e5e0658f98d72e835633a60e548cd70b86a6efa2287e24e3e3b15984f11836879
-  data.tar.gz: 0a81e9ea7b04dcac8acec39760578aaaa8ecfc636e292759a52628ad244c763476a77753ac2a417259e3c7355e88fb433ffced9c00fc034398a235002b078902
+  metadata.gz: 928a7ee0a1a7073afb4cdf638646c4081963889362fd0b327f85d8f20946b208261f9d70640bd07f0f312ede928e362b28c28dde0c3104820b797129023ce27a
+  data.tar.gz: bc9c4e8fe7fd332812ab6b409913c7aeb6e913ef5dfd097d5d522c6e967055d26b086d047eb8fcb2cd7018231a6e049cabb63e3232ff18b6b8cd1ba65a6e95bc

data/README.md

@@ -31,37 +31,45 @@ Or install it yourself as:
 A command can be defined with a simple DSL (passing a block that defines
 the command arguments to the SysCmd.command method):
 
-    cmd = SysCmd.command 'ffmpeg' do
-      option '-i', file: 'input video file.mkv'
-      option '-vcodec', 'mjpeg'
-      file 'output.mkv'
-    end
+```ruby
+cmd = SysCmd.command 'ffmpeg' do
+  option '-i', file: 'input video file.mkv'
+  option '-vcodec', 'mjpeg'
+  file 'output.mkv'
+end
+```
 
 The block is executed with +instance_eval+ inside the command definition
 (an instance of SysCmd::Definicion), so +self+ and instance variables refer
 to the definition. If this is not desirable an argument can be passed to
 the block with the +Definition+ object:
 
-    cmd = SysCmd.command 'ffmpeg' do |cmd|
-      cmd.option '-i', file: 'input video file.mkv'
-      cmd.option '-vcodec', 'mjpeg'
-      cmd.file 'output.mkv'
-    end
+```ruby
+cmd = SysCmd.command 'ffmpeg' do |cmd|
+  cmd.option '-i', file: 'input video file.mkv'
+  cmd.option '-vcodec', 'mjpeg'
+  cmd.file 'output.mkv'
+end
+```
 
 The command can be converted to a String which represents it with
 arguments quoted for the target OS/shell (here we assume a UN*X system)
 
-    puts cmd.to_s # ffmpeg -i input\ video\ file.mkv -vcodec mjpeg output.mkv
+```ruby
+puts cmd.to_s # ffmpeg -i input\ video\ file.mkv -vcodec mjpeg output.mkv
+```
 
 A command can be generated for a system different from the current host
 by passing the +:os+ option:
 
-    wcmd = SysCmd.command 'ffmpeg', os: :windows do |cmd|
-      cmd.option '-i', file: 'input video file.mkv'
-      cmd.option '-vcodec', 'mjpeg'
-      cmd.file 'output.mkv'
-    end
-    puts cmd.to_s # ffmpeg -i "input video file.mkv" -vcodec mjpeg "output.mkv"
+```ruby
+wcmd = SysCmd.command 'ffmpeg', os: :windows do |cmd|
+  cmd.option '-i', file: 'input video file.mkv'
+  cmd.option '-vcodec', 'mjpeg'
+  cmd.file 'output.mkv'
+end
+puts cmd.to_s # ffmpeg -i "input video file.mkv" -vcodec mjpeg "output.mkv"
+```
 
 Currently only +:windows+ (for CMD.EXE syntax) and +:unix+ (for bash syntax) are
 accepted for the +:os+ parameter. +:unix+ represent any UN*X-like system
@@ -69,40 +77,61 @@ accepted for the +:os+ parameter. +:unix+ represent any UN*X-like system
 
 A Command can also be executed:
 
-    cmd.run
-    if cmd.success?
-      puts cmd.output
-    end
+```ruby
+cmd.run
+if cmd.success?
+  puts cmd.output
+end
+```
 
 By default execution is done by launching a shell to interpret the command.
 Unquoted arguments will be interpreted by the shell in that case:
 
-    cmd = SysCmd.command 'echo' do
-      argument '$BASH'
-    end
-    cmd.run
-    puts cmd.output # /bin/bash
+```ruby
+cmd = SysCmd.command 'echo' do
+  argument '$BASH'
+end
+cmd.run
+puts cmd.output # /bin/bash
+```
 
 Shell execution can be avoided by passing the +:direct+ option with value
 +true+ to the +run+ method. In that case the command is executed directly,
 and no shell interpretation takes place, so:
 
-    cmd.run direct: true
-    puts cmd.output # $BASH
+```ruby
+cmd.run direct: true
+puts cmd.output # $BASH
+```
 
 If the command options include
 an option with the name of the command being defined it is used to
 replace the command name. This can be handy to pass user configuration
 to define the location/name of commands in a particular system:
 
-    options = {
-      curl: "/usr/local/bin/curl"
-    }
-    cmd = SysCmd.command 'curl', options do
-      file 'http://jsonip.com'
-    end
-    puts cmd.to_s # /usr/local/bin/curl http://jsonip.com
+```ruby
+options = {
+  curl: "/usr/local/bin/curl"
+}
+cmd = SysCmd.command 'curl', options do
+  file 'http://jsonip.com'
+end
+puts cmd.to_s # /usr/local/bin/curl http://jsonip.com
+```
+
+A string can be provided as the standard input for a command
+by passing the :stdin_data option to the `run`  method:
 
+```ruby
+cmd = SysCmd.command 'curl' do
+  option '--config -'
+  file 'http://jsonip.com'
+end
+cmd.run stdin_data: %{
+  --head
+}
+puts cmd.output # "HTTP/1.1 200 OK ...
+```
 
 ## Development
 

data/lib/sys_cmd.rb

@@ -229,6 +229,9 @@ module SysCmd
     # The +:return+ option can be used to make this method return other
     # attribute of the executed command.
     #
+    # The +:stdin_data+ option can be used to pass a String as the
+    # command's standar input.
+    #
     def run(options = {})
       @output = @status = @error_output = @error = nil
       if options[:direct]
@@ -236,6 +239,9 @@ module SysCmd
       else
         command = [@command]
       end
+      if options[:stdin_data]
+        command << { stdin_data: options[:stdin_data] }
+      end
       begin
         case options[:error_output]
         when :mix # mix stderr with stdout
@@ -389,6 +395,9 @@ module SysCmd
     end
 
     def escape_filename(name)
+      if @type == :windows
+        name = name.gsub('/', '\\')
+      end
       escape name
     end
 

data/lib/sys_cmd/version.rb

@@ -1,3 +1,3 @@
 module SysCmd
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sys_cmd
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Javier Goizueta
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-04-27 00:00:00.000000000 Z
+date: 2015-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: os