command-builder 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "depq", ">= 0.4"
+   gem "hash-utils", ">= 0.7.0"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+end

data/Gemfile.lock

@@ -0,0 +1,18 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    hash-utils (0.8.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  hash-utils (>= 0.7.0)
+  jeweler (~> 1.5.2)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+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,54 @@
+Command Builder
+===============
+
+**Command Builder** builds call to some command runnable from shell 
+command line from its arguments. Here is real example of call to 
+`jpegoptim`:
+
+    require "command-builder"
+    cmd = CommandBuilder::new(:jpegoptim)
+    
+    cmd.arg(:m, 2)
+    cmd << :preserve
+    cmd << "image.jpg"
+    
+    cmd.to_s    # will return 'jpegoptim -m 2 --preserve
+    
+Value escaping and assignments are supported automatically of sure, 
+so call:
+    cmd.arg(:dest, './it\'s "my" folder')
+    
+…will be interpreted as `jpegoptim --dest="it's \"my\" folder"`. It also
+takes spaces into the account.
+
+### Flexibility
+
+Syntax described above is supported by default, but you can achieve for
+example an Windows like syntax:
+    jpegoptim /m:2 -dest "directory"
+    
+…simply by assigning:
+    cmd.separators = ["/", ":", "-", " "]
+    
+For illustration, the default one is `["-", " ", "--", "="]`.
+
+    
+Contributing
+------------
+
+1. Fork it.
+2. Create a branch (`git checkout -b 20101220-my-change`).
+3. Commit your changes (`git commit -am "Added something"`).
+4. Push to the branch (`git push origin 20101220-my-change`).
+5. Create an [Issue][2] with a link to your branch.
+6. Enjoy a refreshing Diet Coke and wait.
+
+
+Copyright
+---------
+
+Copyright &copy; 2011 [Martin Kozák][3]. See `LICENSE.txt` for
+further details.
+
+[2]: http://github.com/martinkozak/qrpc/issues
+[3]: http://www.martinkozak.net/

data/Rakefile

@@ -0,0 +1,37 @@
+# encoding: utf-8
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "command-builder"
+  gem.homepage = "https://github.com/martinkozak/command-builder"
+  gem.license = "MIT"
+  gem.summary = 'Builds call to some command runnable from shell command line from its arguments.'
+  gem.email = "martinkozak@martinkozak.net"
+  gem.authors = ["Martin Kozák"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "qrpc #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/command-builder.gemspec

@@ -0,0 +1,54 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{command-builder}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Martin Kozák"]
+  s.date = %q{2011-02-16}
+  s.email = %q{martinkozak@martinkozak.net}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "command-builder.gemspec",
+    "lib/command-builder.rb",
+    "test.rb"
+  ]
+  s.homepage = %q{https://github.com/martinkozak/command-builder}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.2}
+  s.summary = %q{Builds call to some command runnable from shell command line from its arguments.}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<hash-utils>, [">= 0.7.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+    else
+      s.add_dependency(%q<hash-utils>, [">= 0.7.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    end
+  else
+    s.add_dependency(%q<hash-utils>, [">= 0.7.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+  end
+end
+

data/lib/command-builder.rb

@@ -0,0 +1,288 @@
+# encoding: utf-8
+
+require "hash-utils/object"
+
+##
+# Represents one command line command with arguments and parameters.
+#
+
+class CommandBuilder
+
+    ##
+    # Holds command name.
+    # @return [String, Symbol] command body
+    #
+
+    attr_accessor :command
+    @command
+    
+    ##
+    # Holds separators matrix. It's four-items array:
+    # - short argument separator,
+    # - short argument name/value separator,
+    # - long argument separator,
+    # - short argument name/value separator.
+    #
+    # Here is some example in the same order as in command:
+    #
+    #   # ["-", " ", "--", "="]
+    #   command -s something --long=something
+    #
+    # @return [Array] separators matrix
+    #
+    
+    attr_accessor :separators
+    @separators
+    
+    ##
+    # Holds arguments array. Each item is array pair with argument 
+    # name and value.
+    #
+    # @return [Array] array of argument pairs
+    #
+
+    attr_accessor :args
+    @args
+    
+    ##
+    # Holds parameters array.
+    #
+    
+    @params
+    
+    ##
+    # Constructor.
+    #
+    # @param [String, Symbol] command target command
+    # @param [Array] separators separators matrix
+    # @see #separators
+    #
+    
+    def initialize(command, separators = ["-", " ", "--", "="])
+        @command = command
+        @separators = separators
+        @args = [ ]
+        @params = [ ]
+    end
+    
+    ##
+    # Adds argument to command.
+    #
+    # One-letter arguments will be treated as "short" arguments for the 
+    # syntax purposes, other as "long". See {#separators}.
+    #
+    # @example with default set of {#separators}
+    #   cmd = Command::new(:jpegoptim)
+    #   @cmd.argument(:p)           # will be rendered as 'jpegoptim -p'
+    #   @cmd.argument(:preserve)    # will be rendered as 'jpegoptim -p --preserve'
+    #   @cmd.argument(:m, 2)        # will be rendered as 'jpegoptim -p --preserve -m 2'
+    #   @cmd.argument(:max, 2)      # will be rendered as 'jpegoptim -p --preserve -m 2 --max=2'
+    # @example with array-like call
+    #   cmd = Command::new(:jpegoptim)
+    #   @cmd[:m] = 2                # will be rendered as 'jpegoptim -m 2'
+    #   @cmd[:max] = 2              # will be rendered as 'jpegoptim -m 2 --max=2'
+    #
+    #   # But be warn, it pushes to arguments array as you can se, so 
+    #   # already existing values will not be replaced!
+    #
+    # @param [String, Symbol] name of the argument
+    # @param [Object] value of the argument
+    #
+    
+    def argument(name, value = nil)
+        @args << [name, value]
+    end
+    
+    alias :arg :argument
+    alias :[]= :argument
+    
+    ##
+    # Returns array of argument pairs with given name.
+    #
+    # @param [String, Symbol] name argument name
+    # @return [Array] array of array pairs with this name
+    #
+    
+    def [](name)
+        @args.select { |k, v| name == k } 
+    end
+    
+    ##
+    # Adds parameter to command.
+    # @param [Object] value value of the prameter convertable to String.
+    # 
+    
+    def parameter(value)
+        @params << value
+    end
+    
+    alias :param :parameter
+    
+    ##
+    # Adds multiple parameters to command at once. If no values are 
+    # given, returns the current parameters array.
+    #
+    # @overload parameters
+    #   Returns current parameters array.
+    #   @return [Array] current parameters array
+    # @overload parameters(values)
+    #   Adds multiple parameters at once.
+    #   @param [Array] values array of values
+    #   @see #parameter
+    #
+    
+    def parameters(values = nil)
+        if values.nil?
+            return @params
+        else
+            @params += values
+        end
+    end
+    
+    alias :params :parameters
+
+    ##
+    # Adds an item to command. If option is Symbol or value isn't +nil+,
+    # it will apply the item as an argument, in otherwise, it will treat
+    # as an symbol.
+    #
+    # @overload add(option)
+    #   Adds parameter.
+    #   @param [Object] option parameter value
+    #   @see #parameter
+    # @overload add(options)
+    #   Adds parameters
+    #   @param [Array] options parameters values
+    #   @see #parameters
+    # @overload add(option, value = nil)
+    #   Adds argument.
+    #   @param [Symbol] option argument name
+    #   @param [Object] value argument value
+    #   @see #argument
+    #
+    # @example
+    #   cmd = Command::new(:jpegoptim)
+    #   cmd << :preserve    # will be rendered as 'jpegoptim --preserve'
+    #   cmd << "file.jpg"   # will be rendered as 'jpegoptiom --preserve file.jpg'
+    #
+    
+    def add(option, value = nil)
+        if option.kind_of? Symbol or not value.nil?
+            self.argument(option, value)
+        elsif option.kind_of? Array
+            self.parameters(option)
+        else
+            self.parameter(option)
+        end
+    end
+    
+    alias :<< :add
+    
+    ##
+    # Quotes value for use in command line.
+    #
+    # Uses some heuristic for setting the right quotation. If both 
+    # " and ' are found, escapes ' by \ and quotes by ". If only one of
+    # them found, escapes by the second one. If space found in the 
+    # string, quotes by " too.
+    #
+    # @example
+    #   cmd = Command::new(:jpegoptim)
+    #   cmd.escape("hello 'something' world")   # will result to < "hello 'something' world" >
+    #   cmd.escape('hello "something" world')   # will result to < 'hello "something" world' >
+    #   cmd.escape('hello "som\'thing" world')  # will result to < "hello \"som'thing\" world" >
+    #   cmd.escape('hello something world')     # will result to < "hello something world" >
+    #
+    # @param [String] value string for escaping
+    # @return [String] quoted value
+    #
+    
+    def quote(value)
+        value = value.to_s
+
+        # Looks for " and '
+        single = value["'"].to_b
+        double = value['"'].to_b
+        
+        # According to found characters selects quotation
+        if single and value
+            value = value.gsub('"', '\\"')
+            quotation = '"'
+        elsif single
+            quotation = '"'
+        elsif double
+            quotation = "'"
+        elsif value[" "]
+            quotation = '"'
+        else
+            quotation = ""
+        end
+
+        # Returns
+        return quotation + value + quotation
+    end
+    
+    ##
+    # Executes the command.
+    #
+    
+    def execute
+        Kernel.system(self.to_s)
+    end
+    
+    alias :exec :execute
+    
+    ##
+    # Converts command to string.
+    # @return [String] command in string form
+    #
+
+    def to_s
+        cmd = @command.to_s.gsub(" ", "\\ ")
+        
+        # Arguments
+        @args.each do |name, value|
+            __add_arg(cmd, name, value)
+        end
+        
+        # Parameters
+        @params.each do |param|
+            cmd << " " << self.quote(param.to_s)
+        end
+        
+        return cmd
+    end
+    
+    
+    private
+    
+    ##
+    # Adds argument to command.
+    #
+    
+    def __add_arg(cmd, name, value)
+        cmd << " "
+        name = name.to_s
+        
+        # Name
+        short = (name.length == 1)
+        
+        if short
+            cmd << @separators[0]
+        else
+            cmd << @separators[2]
+        end
+        cmd << name
+        
+        # Value
+        if not value.nil?
+            if short
+                cmd << @separators[1]
+            else
+                cmd << @separators[3]
+            end
+            cmd << self.quote(value.to_s)
+        end
+    end
+    
+end

data/test.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+require "./jpeg"
+
+cmd = CommandBuilder::new(:jpegoptim)
+cmd << :preserve
+cmd << :p
+cmd << "file.jpg"
+cmd << ["1.jpg", "2.jpg"]
+cmd.arg(:max, 3)
+cmd.arg(:m, 3)
+cmd[:other] = "value"
+cmd[:o] = "another '\" value"
+puts cmd
+
+puts cmd[:max].inspect

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: command-builder
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Martin Koz\xC3\xA1k"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-16 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hash-utils
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+description: 
+email: martinkozak@martinkozak.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- command-builder.gemspec
+- lib/command-builder.rb
+- test.rb
+has_rdoc: true
+homepage: https://github.com/martinkozak/command-builder
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -3460613354245492068
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Builds call to some command runnable from shell command line from its arguments.
+test_files: []
+