sys_cmd 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 307b77667d06748740cea3b10c0b0112475dac60
+  data.tar.gz: d584ecfcfb2cbbdce499adede7c68bf59014cd24
+SHA512:
+  metadata.gz: 24290cf375b93fb4414d85f6534535285fd528b11be30f37fa5662226382df7eaae663006ce6c01133dff20fd1e1ab13c4878ec0df1ab04079e1af41e0a961fe
+  data.tar.gz: 85b2d3089a50c50e30d25bd70b9a0ea3ce19c0661d8d486a8d2d10759a988eecd224ca4d1a4f8cb15c4c5b0c699389ad9bea53b7aaa630e7891dcef8b4e05dfc

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/rdoc/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sys_cmd.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Javier Goizueta
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+# SysCmd
+
+SysCmd is a DSL to define commands to be executed by the system.
+
+The command arguments will we escaped properly for bash or
+Windows cmd.exe.
+
+The commands can be executed capturing its exit status and output.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sys_cmd'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sys_cmd
+
+## Usage
+
+Example:
+
+    cmd = SysCmd.command 'ffmpeg' do
+      option '-i', file: 'input video file.mkv'
+      option '-vcodec', 'mjpeg'
+      file 'output.mkv'
+    end
+    puts cmd.to_s # ffmpeg -i input\ video\ file.mkv -vcodec mjpeg output.mkv
+    cmd.run
+    if cmd.success?
+      puts cmd.output
+    end
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/sys_cmd/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,22 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = SysCmd::VERSION
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "SysCmd #{version}"
+  rdoc.main = "README.md"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.markup = 'markdown'
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sys_cmd"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sys_cmd.rb

@@ -0,0 +1,397 @@
+require "sys_cmd/version"
+
+require 'shellwords'
+require 'open3'
+require 'os'
+
+module SysCmd
+
+  # This class has methods to build a command to be executed by the system
+  #
+  # The target OS can be defined with the +:os+ option, which accepts
+  # values +:unix+ and +:windows+, and which defaults to the host system's type.
+  #
+  # All the methods to define command arguments (option, file, etc.)
+  # accept options +:only_on+, +:except_on+ to conditionally
+  # include the element depending on what the target OS is for the command.
+  #
+  class Definition
+
+    def initialize(command, options = {})
+      @shell = Shell.new(options)
+      @options = options.dup
+      @options.merge!(@options.delete(@shell.type) || {})
+      @command = ''
+      @command << (@options[command] || command)
+      @last_arg = :command
+    end
+
+    attr_reader :command
+
+    def to_s
+      command
+    end
+
+    # Add an option. If the option is nor prefixed by - or /
+    # then the default system option switch will be used.
+    #
+    #     option 'x' # will produce -x or /x
+    #     option '-x' # will always produce -x
+    #
+    # A value can be given as an option and will be space-separated from
+    # the option name:
+    #
+    #     option '-x', value: 123 # -x 123
+    #
+    # To avoid spacing the value use the +:join_value+ option
+    #
+    #     option '-x', join_value: 123 # -x123
+    #
+    # And to use an equal sign as separator, use +:equal_value+
+    #
+    #     option '-x', equal_value: 123 # -x=123
+    #
+    # If the option value is a file name, use the analogous
+    # +:file+, +:join_file+ or +:equal_file+ options:
+    #
+    #     option '-i', file: 'path/filename'
+    #
+    # Several of this options can be given simoultaneusly:
+    #
+    #     option '-d', join_value: 'x', equal_value: '1' # -dx=1
+    #
+    def option(option, *args)
+      options = args.pop if args.last.is_a?(Hash)
+      options ||= {}
+      raise "Invalid number of arguments (0 or 1 expected)" if args.size > 1
+      return unless @shell.applicable?(options)
+      value = args.shift || options[:value]
+      if /\A[a-z]/i =~ option
+        option = @shell.option_switch + option
+      else
+        option = option.dup
+      end
+      option << @shell.escape_value(value) if value
+      option << @shell.escape_value(options[:join_value]) if options[:join_value]
+      option << '=' << @shell.escape_value(options[:equal_value]) if options[:join_value]
+      if file = options[:file]
+        file_sep = ' '
+      elsif file = options[:join_file]
+        file_sep = ''
+      elsif file = options[:equal_file]
+        file_sep = '='
+      end
+      if file
+        option << file_sep << @shell.escape_filename(file)
+      end
+      @command << ' ' << option
+      @last_arg = :option
+    end
+
+    # Add a filename to the command.
+    #
+    #     file 'path/output'
+    #
+    def file(filename, options = {})
+      return unless @shell.applicable?(options)
+      @command << ' ' << @shell.escape_filename(filename)
+      @last_arg = :file
+    end
+
+    # Add a filename to the command, joinning it without a separator to
+    # the previous option added.
+    #
+    #     option '-i'
+    #     join_file 'path/output' # -ipath/output
+    #
+    def join_file(filename, options = {})
+      return unless @shell.applicable?(options)
+      raise "An option is required for join_file" unless @last_arg == :option
+      @command << @shell.escape_filename(filename)
+      @last_arg = :file
+    end
+
+    # Add a filename to the command, attaching it with an equal sign to
+    # the previous option added.
+    #
+    #     option '-i'
+    #     equal_file 'path/output' # -i=path/output
+    #
+    def equal_file(filename, options = {})
+      return unless @shell.applicable?(options)
+      raise "An option is required for equal_file" unless @last_arg == :option
+      @command << '=' << @shell.escape_filename(filename)
+      @last_arg = :file
+    end
+
+    # Add the value of an option.
+    #
+    #    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
+
+    # Add the value of an option, joinning it without a separator to
+    # the previous option added.
+    #
+    #    option '-x'
+    #    join_value 123  # -x123
+    #
+    def join_value(value, options = {})
+      return unless @shell.applicable?(options)
+      raise "An option is required for join_value" unless @last_arg == :option
+      @command << @shell.escape_value(value)
+      @last_arg = :value
+    end
+
+    # Add the value of an option, attaching it with an equal sign to
+    # the previous option added.
+    #
+    #    option '-x'
+    #    equal_value 123  # -x=123
+    #
+    def equal_value(value, options = {})
+      return unless @shell.applicable?(options)
+      raise "An option is required for equal_value" unless @last_arg == :option
+      @command << '=' << @shell.escape_value(value)
+      @last_arg = :value
+    end
+
+    # Add a generic argument to the command.
+    def argument(value, options = {})
+      return unless @shell.applicable?(options)
+      @command << ' ' << @shell.escape_value(value)
+      @last_arg = :argument
+    end
+
+  end
+
+  # An executable system command
+  class Command
+    def initialize(command)
+      @command = command
+      @output = nil
+      @status = nil
+      @error_output = nil
+      @error = nil
+    end
+
+    attr_reader :command, :output, :status, :error_output, :error
+
+    # Execute the command.
+    #
+    # The exit status of the command is retained in the +status+ attribute
+    # (and its numeric value in the +status_value+ attribute).
+    #
+    # The standard output of the command is captured and retained in the
+    # +output+ attribute.
+    #
+    # By default, the standar error output of the command is not
+    # captured, so it will be shown on the console unless redirected.
+    #
+    # Standard error can be captured and interleaved with the standard
+    # output passing the option
+    #
+    #     error_output: :mix
+    #
+    # Error output can be captured and keep separate inthe +error_output+
+    # attribute with this option:
+    #
+    #     error_output: :separate
+    #
+    # The value returned is by defaut, like in Kernel#system,
+    # true if the command gives zero exit status, false for non zero exit status,
+    # and nil if command execution fails.
+    #
+    # The +:return+ option can be used to make this method return other
+    # attribute of the executed command.
+    #
+    def run(options = {})
+      @output = @status = @error_output = @error = nil
+      begin
+        case options[:error_output]
+        when :mix # mix stderr with stdout
+          @output, @status = Open3.capture2e(@command)
+        when :separate
+          @output, @error_output, @status = Open3.capture3(@command)
+        else # :console (do not capture stderr output)
+          @output, @status = Open3.capture2(@command)
+        end
+      rescue => error
+        @error = error.dup
+      end
+      case options[:return]
+      when :status
+        @status
+      when :status_value
+        status_value
+      when :output
+        @output
+      when :error_output
+        @error_output
+      else
+        @error ? nil : @status.success? ? true : false
+      end
+    end
+
+    def status_value
+      @status && @status.exitstatus
+    end
+
+    # did the command execution caused an exception?
+    def error?
+      !@error.nil?
+    end
+
+    # did the command execute without error and returned a success status?
+    def success?
+      !error? && @status.success?
+    end
+
+    def to_s
+      command
+    end
+
+  end
+
+  # Build a command.
+  #
+  # See the Definition class.
+  #
+  def self.command(command, options = {}, &block)
+    definition = Definition.new(command, options)
+    definition.instance_eval &block if block
+    Command.new definition.command
+  end
+
+  # Build and run a command
+  def self.run(command, options = {}, &block)
+    command(command, options, &block).run
+  end
+
+  # Get the type of OS of the host.
+  def self.local_os_type
+    if OS.windows?
+      :windows
+    else
+      :unix
+    end
+  end
+
+  OS_TYPE_SYNONIMS = {
+    unix: :unix,
+    windows: :windows,
+    bash: :unix,
+    linux: :unix,
+    osx: :unix,
+    cmd: :windows
+  }
+
+  def self.os_type(options = {})
+    options[:os] || local_os_type
+  end
+
+  def self.escape(text, options = {})
+    case os_type(options)
+    when :windows
+      '"' + text.gsub('"', '""') + '"'
+    else
+      Shellwords.shellescape(text)
+    end
+  end
+
+  def self.line_separator(options = {})
+    case os_type(options)
+    when :windows
+      '^\n'
+    else
+      '\\\n'
+    end
+  end
+
+  def self.option_switch(options = {})
+    case os_type(options)
+    when :windows
+      '/'
+    else
+      '-'
+    end
+  end
+
+  class Shell
+
+    def initialize(options = {})
+      @type = SysCmd.os_type(options)
+    end
+
+    attr_reader :type
+
+    def escape(text)
+      SysCmd.escape(text, os: @type)
+    end
+
+    def escape_filename(name)
+      escape name
+    end
+
+    def escape_value(value)
+      escape value.to_s
+    end
+
+    def line_separator
+      SysCmd.line_separator(os: @type)
+    end
+
+    def option_switch
+      SysCmd.option_switch(os: @type)
+    end
+
+    def applicable?(options = {})
+      applicable = true
+      only_on = Array(options[:only_on])
+      unless only_on.empty?
+        applicable = false unless only_on.include?(@type)
+      end
+      except_on = Array(options[:except_on])
+      unless except_on.empty?
+        applicable = false if except_on.include?(@type)
+      end
+      applicable
+    end
+
+  end
+
+  # Execute a block of code only on some systems
+  #
+  #    cmd = nil
+  #    SysCmd.only_on :unix do
+  #      cmd = CmdSys.command('ls')
+  #    end
+  #    SysCmd.only_on :windows do
+  #      cmd = CmdSys.command('dir')
+  #    end
+  #    cmd.run
+  #    files = cmd.output
+  #
+  def self.only_on(*os_types)
+    return if os_types.empty?
+    yield if Shell.new.applicable?(only_on: os_types)
+  end
+
+  # Execute a block of code except on some system(s)
+  def self.except_on(*os_types)
+    yield if Shell.new.applicable?(except_on: os_types)
+  end
+
+  # Execute a block of code if the options +:only_on+,
+  # +:except_on+ are satisfied in the host system.
+  def self.execute(options = {})
+    yield if Shell.new.applicable?(options)
+  end
+
+end

data/lib/sys_cmd/version.rb

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

data/sys_cmd.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sys_cmd/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sys_cmd"
+  spec.version       = SysCmd::VERSION
+  spec.authors       = ["Javier Goizueta"]
+  spec.email         = ["jgoizueta@gmail.com"]
+
+  spec.summary       = %q{Execute shell commands.}
+  spec.description   = %q{Define and execute shell commands on Unix-like & Windows systems.}
+  spec.homepage      = "https://github.com/jgoizueta/sys_cmd"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "os", "~> 0.9.6"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.4"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: sys_cmd
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Javier Goizueta
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: os
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+description: Define and execute shell commands on Unix-like & Windows systems.
+email:
+- jgoizueta@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sys_cmd.rb
+- lib/sys_cmd/version.rb
+- sys_cmd.gemspec
+homepage: https://github.com/jgoizueta/sys_cmd
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Execute shell commands.
+test_files: []