sys_cmd 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 307b77667d06748740cea3b10c0b0112475dac60
-  data.tar.gz: d584ecfcfb2cbbdce499adede7c68bf59014cd24
+  metadata.gz: 1699ccea4cb7b0bc8248c247383683ba89dfa43a
+  data.tar.gz: eeb6ffc30f8bfc9a9cec6ad680adcd0c7b33fed8
 SHA512:
-  metadata.gz: 24290cf375b93fb4414d85f6534535285fd528b11be30f37fa5662226382df7eaae663006ce6c01133dff20fd1e1ab13c4878ec0df1ab04079e1af41e0a961fe
-  data.tar.gz: 85b2d3089a50c50e30d25bd70b9a0ea3ce19c0661d8d486a8d2d10759a988eecd224ca4d1a4f8cb15c4c5b0c699389ad9bea53b7aaa630e7891dcef8b4e05dfc
+  metadata.gz: 316a8757c455ecd7ae0cb136a5b444e70c33fcee0263277dd287421d1360bef5e4922f31fc29877f34b92d9a2c197838f68dd45ffe6b6be3eab462ec29f360c1
+  data.tar.gz: 480aaa5ec37aad47601d8890be1a164e1eda342d688bb88c0a7c70d8d1d86c23a3d0272b66c1e512f6e761608dc386975e30de216ac6956511d0f970a77009f8

data/.travis.yml

@@ -1,3 +1,5 @@
 language: ruby
 rvm:
-  - 2.2.1
+  - 2.2.2
+  - 2.1.6
+  - 1.9.3

data/README.md

@@ -1,5 +1,8 @@
 # SysCmd
 
+[![Gem Version](https://badge.fury.io/rb/sys_cmd.svg)](http://badge.fury.io/rb/sys_cmd)
+[![Build Status](https://travis-ci.org/jgoizueta/sys_cmd.svg)](https://travis-ci.org/jgoizueta/sys_cmd)
+
 SysCmd is a DSL to define commands to be executed by the system.
 
 The command arguments will we escaped properly for bash or
@@ -25,19 +28,82 @@ Or install it yourself as:
 
 ## Usage
 
-Example:
+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
+
+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
+
+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
+
+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"
+
+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
+(including linux, OSX, etc.)
+
+A Command can also be executed:
+
     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
+
+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
+
+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
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/sys_cmd.rb

@@ -26,7 +26,7 @@ module SysCmd
       @last_arg = :command
     end
 
-    attr_reader :command
+    attr_reader :command, :shell
 
     def to_s
       command
@@ -124,14 +124,13 @@ module SysCmd
       @last_arg = :file
     end
 
-    # Add the value of an option.
+    # Add the value of an option (or a quoted argument)
     #
     #    option '-x'
     #    join_value 123  # -x 123
     #
     def value(value, options = {})
       return unless @shell.applicable?(options)
-      raise "An option is required for value" unless @last_arg == :option
       @command << ' ' << @shell.escape_filename(value.to_s)
       @last_arg = :value
     end
@@ -162,10 +161,12 @@ module SysCmd
       @last_arg = :value
     end
 
-    # Add a generic argument to the command.
+    # Add an unquoted argument to the command.
+    # This is not useful for commands executed directly, since the arguments
+    # are note interpreted by a shell in that case.
     def argument(value, options = {})
       return unless @shell.applicable?(options)
-      @command << ' ' << @shell.escape_value(value)
+      @command << ' ' << value.to_s
       @last_arg = :argument
     end
 
@@ -173,8 +174,14 @@ module SysCmd
 
   # An executable system command
   class Command
-    def initialize(command)
-      @command = command
+    def initialize(command, options = {})
+      if command.respond_to?(:shell)
+        @command = command.command
+        @shell = command.shell
+      else
+        @command = command
+        @shell = Shell.new(options)
+      end
       @output = nil
       @status = nil
       @error_output = nil
@@ -185,6 +192,17 @@ module SysCmd
 
     # Execute the command.
     #
+    # By default the command is executed by a shell. In this case,
+    # unquoted arguments are interpreted by the shell, e.g.
+    #
+    #   SysCmd.command('echo $BASH').run # /bin/bash
+    #
+    # When the +:direct+ option is set to true, no shell is used and
+    # the command is directly executed; in this case unquoted arguments
+    # are not interpreted:
+    #
+    #   SysCmd.command('echo $BASH').run # $BASH
+    #
     # The exit status of the command is retained in the +status+ attribute
     # (and its numeric value in the +status_value+ attribute).
     #
@@ -213,14 +231,19 @@ module SysCmd
     #
     def run(options = {})
       @output = @status = @error_output = @error = nil
+      if options[:direct]
+        command = @shell.split(@command)
+      else
+        command = [@command]
+      end
       begin
         case options[:error_output]
         when :mix # mix stderr with stdout
-          @output, @status = Open3.capture2e(@command)
+          @output, @status = Open3.capture2e(*command)
         when :separate
-          @output, @error_output, @status = Open3.capture3(@command)
+          @output, @error_output, @status = Open3.capture3(*command)
         else # :console (do not capture stderr output)
-          @output, @status = Open3.capture2(@command)
+          @output, @status = Open3.capture2(*command)
         end
       rescue => error
         @error = error.dup
@@ -265,8 +288,14 @@ module SysCmd
   #
   def self.command(command, options = {}, &block)
     definition = Definition.new(command, options)
-    definition.instance_eval &block if block
-    Command.new definition.command
+    if block
+      if block.arity == 1
+        block.call definition
+      else
+        definition.instance_eval &block
+      end
+    end
+    Command.new definition
   end
 
   # Build and run a command
@@ -305,6 +334,26 @@ module SysCmd
     end
   end
 
+  def self.split(text, options = {})
+    case os_type(options)
+    when :windows
+      words = []
+      field = ''
+      line.scan(/\G\s*(?>([^\s\^\'\"]+)|'([^\']*)'|"((?:[^\"\^]|\\.)*)"|(\^.?)|(\S))(\s|\z)?/m) do
+        |word, sq, dq, esc, garbage, sep|
+        raise ArgumentError, "Unmatched double quote: #{line.inspect}" if garbage
+        field << (word || sq || (dq || esc).gsub(/\^(.)/, '\\1'))
+        if sep
+          words << field
+          field = ''
+        end
+      end
+      words
+    else
+      Shellwords.shellsplit(text)
+    end
+  end
+
   def self.line_separator(options = {})
     case os_type(options)
     when :windows
@@ -335,6 +384,10 @@ module SysCmd
       SysCmd.escape(text, os: @type)
     end
 
+    def split(text)
+      SysCmd.split(text, os: @type)
+    end
+
     def escape_filename(name)
       escape name
     end

data/lib/sys_cmd/version.rb

@@ -1,3 +1,3 @@
 module SysCmd
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/sys_cmd.gemspec

@@ -24,4 +24,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.9"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.4"
+
+  spec.required_ruby_version = '>= 1.9.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sys_cmd
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Javier Goizueta
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-04-26 00:00:00.000000000 Z
+date: 2015-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: os
@@ -96,7 +96,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -104,8 +104,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Execute shell commands.
 test_files: []
+has_rdoc: