runnable 0.1.1 → 0.1.2

data/README.markdown

@@ -2,88 +2,79 @@
 A Ruby gem that allow programmer to control UNIX system commands as a Ruby class.
 
 # Usage
-All you have to do is to create a class named exactly as command and make it inherit from class Runnable.
+All you have to do is to create a class named exactly as command and make it 
+inherit from class Runnable.
 
-```ruby    
-class LS < Runnable
-end
-```
+    class LS < Runnable
+    end
 
-That gives you the basics to control the execution of `ls` command.
+That gives you the basics to control the execution of ```ls``` command.
 
 Now you can create an instance like this:
 
-```ruby
-my_command = LS.new
-```
+    my_command = LS.new
 
 And run the command as follows
 
-```ruby
-my_command.run
-```
+    my_command.run
 
 Many other options are available; you can stop the command, kill it or look 
 for some important information about the command and its process. Entire 
-documentation of this gem can be found under `./doc` directory or been generated 
-by `yardoc`.
+documentation of this gem can be generated using ```yardoc```. To do this use 
+```rake doc```.
 
 ## Return values
-Runnable uses another gems called `Publisher`. It allow Runnable to fire 
+Runnable uses another gems called ```Publisher```. It allow Runnable to fire 
 events that can be processed or ignored. When a command ends its execution, 
-Runnable always fire and event: `:finish` if commands finalized in a correct way 
-or `:fail` if an error ocurred. In case something went wrong and a `:fail` 
+Runnable always fire and event: ```:finish``` if commands finalized in a correct way 
+or ```:fail``` if an error ocurred. In case something went wrong and a ```:fail``` 
 events was fired, Runnable also provide an array containing the command return 
 value as the parameter of a SystemCallError exception and optionally others 
 exceptions ocurred at runtime.
 
 This is an example of how can we receive the return value of a command:
 
-```ruby
-class LS < Runnable
-end
+    class LS < Runnable
+    end
 
-my_command = LS.new
+    my_command = LS.new
 
-my_command.when :finish do
-  puts "Everything went better than expected :)"
-end
+    my_command.when :finish do
+      puts "Everything went better than expected :)"
+    end
 
-my_command.when :fail do |exceptions|
-  puts "Something went wrong"
-  exceptions.each do |exception|
-    puts exception.message
-  end
-end
+    my_command.when :fail do |exceptions|
+      puts "Something went wrong"
+      exceptions.each do |exception|
+        puts exception.message
+      end
+    end
 
-my_command.run
-```
+    my_command.run
 
 ## Custom exceptions
 As we saw in previous chapter, if a command execution does not ends 
-succesfully, Runnable fires a `:fail` event whit an exceptions array. We can
+succesfully, Runnable fires a ```:fail``` event whit an exceptions array. We can
 add exceptions to that array based on the output of command. For example, we 
 can controll that parameters passed to a command are valids if we know the 
 command output for an invalid parameters.
 
-First we have to do is override the method `exceptions` defined in runnable
+First we have to do is override the method ```exceptions``` defined in runnable
 as follows
 
-```ruby
-class LS < Runnable
-  def exceptions
-    { /ls: (invalid option.*)/ => ArgumentError }
-  end
-end
-```
+    class LS < Runnable
+      def exceptions
+        { /ls: (invalid option.*)/ => ArgumentError }
+      end
+    end
 
-`exceptions` method should return a hash containing a regular expression 
+```exceptions``` method should return a hash containing a regular expression 
 which will be match against the command output, and a value which will be the
 exception added to exception array. This means that if the command output match
-the regular expression, a new exception will be include in `:fail` event parameter.
+the regular expression, a new exception will be include in ```:fail``` event parameter.
 
 # About
-Runnable is a gem develop by [NoSoloSoftware](http://nosolosoftware.biz)
+Runnable is a gem developed by [NoSoloSoftware](http://nosolosoftware.biz).
 
 # License
 Runnable is Copyright 2011 NoSoloSoftware, it is free software.

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/runnable.rb

@@ -16,6 +16,11 @@
 # along with Runnable.  If not, see <http://www.gnu.org/licenses/>.
 
 
+require 'runnable/gnu'
+require 'runnable/extended'
+
+require 'publisher'
+
 # Convert a executable command in a Ruby-like class
 # you are able to start, define params and send signals (like kill, or stop)
 #
@@ -27,11 +32,6 @@
 #   ls = LS.new
 #   ls.alh
 #   ls.run
-#
-$LOAD_PATH << File.expand_path( './runnable', __FILE__ )
-
-require 'publisher'
-
 class Runnable
   extend Publisher
   
@@ -115,9 +115,7 @@ class Runnable
     @excep_array = []
     
 
-    # Metaprogramming part
-    # Require the class to parse the command line options
-    require command_style.to_s.downcase
+    # Metaprogramming part  
     # Create a new instance of the parser class
     @command_line_interface = Object.const_get( command_style.to_s.capitalize.to_sym ).new
     # End Metaprogramming part
@@ -139,8 +137,7 @@ class Runnable
     out_rd, out_wr = IO.pipe
     # Redirect Error I/O
     err_rd, err_wr = IO.pipe
-
-    # 
+ 
     @pid = Process.spawn( "#{@command} #{@input.join( " " )} \
                          #{@options} #{@command_line_interface.parse} \
                          #{@output.join( " " )}", { :out => out_wr, :err => err_wr } )
@@ -306,7 +303,6 @@ class Runnable
   # @param [Array] params Params in the call
   # @param [Block] block Block code in method
   # @return [nil]
-  # @override
   def method_missing( method, *params, &block )
     if params.length > 1
       super( method, params, block )

data/lib/runnable/command_parser.rb

@@ -16,10 +16,11 @@
 # along with Runnable.  If not, see <http://www.gnu.org/licenses/>.
 
 
-# <p>Base class to create a command-line parameter parser.</p>
-# <p>It holds that parameters in a hash and the child has
+# Base class to create a command-line parameter parser.
+#
+# It holds that parameters in a hash and the child has
 # to be the one who return the formatted string according
-# to the standard used.</p>
+# to the standard used.
 class Command_parser
   # Create a new instance of the parser.
   def initialize

data/lib/runnable/extended.rb

@@ -15,9 +15,9 @@
 # You should have received a copy of the GNU General Public License
 # along with Runnable.  If not, see <http://www.gnu.org/licenses/>.
 
-require 'command_parser'
+require 'runnable/command_parser'
 
-# <p>Parse the parameter hash using the extended standard.</p>
+# Parse the parameter hash using the extended standard.
 class Extended < Command_parser  
 
   # Convert a hash in a Extended style string options.

data/lib/runnable/gnu.rb

@@ -15,9 +15,9 @@
 # You should have received a copy of the GNU General Public License
 # along with Runnable.  If not, see <http://www.gnu.org/licenses/>.
 
-require 'command_parser'
+require 'runnable/command_parser'
 
-# <p>Parse the parameter hash using the GNU standard.</p>
+# Parse the parameter hash using the GNU standard.
 class Gnu < Command_parser
 
   # This method convert a hash in a string ready to

metadata

@@ -2,7 +2,7 @@
 name: runnable
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - "Rafael Garc\xC3\xADa"
@@ -13,7 +13,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-05 00:00:00 Z
+date: 2011-05-09 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: publisher
@@ -81,6 +81,17 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: bluecloth
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: *id007
 description: Convert a executable command in a Ruby-like class you are able to start, define params and send signals (like kill, or stop)
 email: 
 - rgarcia@nosolosoftware.biz
@@ -114,7 +125,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 1892356239618464581
+      hash: 2247934159745161744
       segments: 
       - 0
       version: "0"