command-builder 0.1.1 → 0.2.0

data/CHANGES.txt

@@ -1,4 +1,9 @@
 
+0.2.0 (2011-07-30)
+* asynchronous executing support using 'pipe-run'
+* two more aliases for the #execute method
+* readme correction
+
 0.1.1 (2011-07-24)
 * #reset method added
 * internal switch to more modern 'hash-utils'

data/Gemfile

@@ -2,6 +2,7 @@ source "http://rubygems.org"
 # Add dependencies required to use your gem here.
 # Example:
   gem "hash-utils", ">= 0.18.0"
+  gem "pipe-run", ">= 0.2.1"
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.

data/Gemfile.lock

@@ -7,6 +7,7 @@ GEM
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
+    pipe-run (0.2.1)
     rake (0.9.2)
 
 PLATFORMS
@@ -16,3 +17,4 @@ DEPENDENCIES
   bundler (>= 1.0.0)
   hash-utils (>= 0.18.0)
   jeweler (>= 1.5.2)
+  pipe-run (>= 0.2.1)

data/README.md

@@ -1,9 +1,10 @@
 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`:
+**Command Builder** builds command runnable from shell by simple and 
+ellegant way. Also allows both synchronous executing or asynchronous 
+one using [EventMachine][1]. Here is an real example of call 
+to `jpegoptim`:
 
     require "command-builder"
     cmd = CommandBuilder::new(:jpegoptim)
@@ -16,18 +17,33 @@ command line from its arguments. Here is real example of call to
     
 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.
 
+### Executing
+
+Command can be executed directly by call:
+
+    cmd.execute!               # for synchronous executing or...
+    cmd.execute do |output|    # ...for asynchronous executing
+        # ...
+    end
+    
+Asynchronous executing requires [EventMachine][1] environment to be run.
+    
+
 ### 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 `["-", " ", "--", "="]`.
@@ -50,5 +66,6 @@ Copyright
 Copyright © 2011 [Martin Kozák][3]. See `LICENSE.txt` for
 further details.
 
+[1]: http://rubyeventmachine.com/
 [2]: http://github.com/martinkozak/command-builder/issues
 [3]: http://www.martinkozak.net/

data/Rakefile

@@ -18,7 +18,7 @@ Jeweler::Tasks.new do |gem|
   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.summary = 'Builds command runnable from shell by simple and ellegant way. Also allows both synchronous executing or asynchronous one using EventMachine.'
   gem.email = "martinkozak@martinkozak.net"
   gem.authors = ["Martin Kozák"]
   # Include your dependencies below. Runtime dependencies are required when using your gem,

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/command-builder.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{command-builder}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Martin Kozák}]
-  s.date = %q{2011-07-24}
+  s.date = %q{2011-07-30}
   s.email = %q{martinkozak@martinkozak.net}
   s.extra_rdoc_files = [
     "LICENSE.txt",
@@ -32,22 +32,25 @@ Gem::Specification.new do |s|
   s.licenses = [%q{MIT}]
   s.require_paths = [%q{lib}]
   s.rubygems_version = %q{1.8.5}
-  s.summary = %q{Builds call to some command runnable from shell command line from its arguments.}
+  s.summary = %q{Builds command runnable from shell by simple and ellegant way. Also allows both synchronous executing or asynchronous one using EventMachine.}
 
   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.18.0"])
+      s.add_runtime_dependency(%q<pipe-run>, [">= 0.2.1"])
       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.18.0"])
+      s.add_dependency(%q<pipe-run>, [">= 0.2.1"])
       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.18.0"])
+    s.add_dependency(%q<pipe-run>, [">= 0.2.1"])
     s.add_dependency(%q<bundler>, [">= 1.0.0"])
     s.add_dependency(%q<jeweler>, [">= 1.5.2"])
   end

data/lib/command-builder.rb

@@ -3,6 +3,7 @@
 
 require "hash-utils/object"
 require "hash-utils/array"
+require "pipe-run"
 
 ##
 # Represents one command line command with arguments and parameters.
@@ -224,14 +225,21 @@ class CommandBuilder
     end
     
     ##
-    # Executes the command.
+    # Executes the command. If block given, takes it output of the 
+    # command and runs it asynchronously using EventMachine.
+    #
+    # @see https://github.com/martinkozak/pipe-run
+    # @param [Proc] block if asynchronous run
+    # @return [String] output of the command or nil if asynchronous
     #
     
-    def execute
-        Kernel.system(self.to_s)
+    def execute(&block)
+        Pipe::run(self.to_s, &block)
     end
     
     alias :exec :execute
+    alias :"exec!" :execute
+    alias :"execute!" :execute
     
     ##
     # Converts command to string.
@@ -256,12 +264,15 @@ class CommandBuilder
     
     ##
     # Resets the arguments and parameters so prepares it for new build.
+    #
+    # @return [CommandBuilder] self instance
     # @since 0.1.1
     #
     
     def reset!
         @args = [ ]
         @params = [ ]
+        self
     end
     
     alias :reset :"reset!"

data/test.rb

@@ -2,19 +2,27 @@
 
 $:.push("./lib")
 require "command-builder"
+require "eventmachine"
 
-cmd = CommandBuilder::new(:jpegoptim)
-cmd << :preserve
-cmd << :p
-cmd << "file.jpg"
-cmd << ["1 1.jpg", "2.jpg"]
-cmd.arg(:max, 3)
-cmd.arg(:m, 3)
-cmd[:other] = "value"
-cmd[:o] = "another '\" value"
-puts cmd
+EM::run do
+    cmd = CommandBuilder::new(:jpegoptim)
+    cmd << :preserve
+    cmd << :p
+    cmd << "file.jpg"
+    cmd << ["1 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
+    puts cmd[:max].inspect
+    cmd.execute do |out|
+        p out
+    end
+    
+    p cmd.execute
 
-cmd.reset!
-puts cmd
+    cmd.reset!
+    puts cmd
+end

metadata

@@ -2,7 +2,7 @@
 name: command-builder
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - "Martin Koz\xC3\xA1k"
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-24 00:00:00 Z
+date: 2011-07-30 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: hash-utils
@@ -24,8 +24,19 @@ dependencies:
   prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: bundler
+  name: pipe-run
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -33,10 +44,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: jeweler
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -44,7 +55,7 @@ dependencies:
         version: 1.5.2
   type: :development
   prerelease: false
-  version_requirements: *id003
+  version_requirements: *id004
 description: 
 email: martinkozak@martinkozak.net
 executables: []
@@ -79,7 +90,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 1643594554722513454
+      hash: -3638148640227519764
       segments: 
       - 0
       version: "0"
@@ -95,6 +106,6 @@ rubyforge_project:
 rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
-summary: Builds call to some command runnable from shell command line from its arguments.
+summary: Builds command runnable from shell by simple and ellegant way. Also allows both synchronous executing or asynchronous one using EventMachine.
 test_files: []