abundance 1.0.5 → 1.0.6

data/lib/abundance.rb

@@ -48,7 +48,7 @@ class Abundance
   
   # The +gardener+ class method initializes a gardener instance
   # with its garden supplied as a block.  The invocation block must include
-  # the +grow+ class method and a preceeding optional initialisation section.
+  # the +grow+ class method and a preceeding optional initialisation section that may include and +init_status+ return message.
   # === Parameters
   # * :seed_size = allowed seed size in bytes
   # * :rows = garden rows number, the number of concurent threads
@@ -57,6 +57,11 @@ class Abundance
   #  gardener = Abundance.gardener( :block_size => 8192, :rows => 2, :init_timeout => 2) do
   # 
   #   processor = SpecialProcess.new
+  #   if processor.started_successfully?
+  #     Abundance.init_status(true, processor.init_message)
+  #   else
+  #     Abundance.init_status(false, processor.init_message)
+  #   end
   # 
   #   Abundance.grow do |seed|
   #     command = seed.sprout 
@@ -92,5 +97,16 @@ class Abundance
     end
   end
   
+  # The +init_status+ class method can be used inside the gardener invocation to return an initialisation status message.
+  # The returned messages from all garden rows will then be accessible though the gardener's init_status instance method.
+  # === Parameters
+  # * _success_ = success of the initialisation, may be true or false
+  # * _message_ = a ruby expression or object
+  # === Example
+  #   Abundance.init_status(true,'Initialisation Successfull!!!')
+  def Abundance.init_status(success,message)
+    $seed = {:id => Process.pid, :seed => 'init_status', :success => success, :message => message}
+  end
+  
 end
 

data/lib/gardener.rb

@@ -2,12 +2,13 @@
 # 
 # The Gardener act as the client class for accessing and assessing the Garden ressources.
 # Its initialization occurs through the Abundance.gardener class method.
-# Its instance methods are fourthfold, following the 4 states of the garden.
-# Like the 4 seasons northern hemisphere gardening cycles:
-# * seed = the setting of your command cycle
+# 
+# The Gardener's instance methods are:
+# * init_status = the return message for the initialisation cycle, as set by the Abundance.init_status method.
+# * seed = the setting of your command
 # * growth = the evolution of your command growing period
 # * harvest = the getting of your command results
-# * close = the closing and dying cycle
+# * close = wrap everything up and does a legit close
 # 
 # Author:: lp (mailto:lp@spiralix.org)
 # Copyright:: 2008 Louis-Philippe Perron - Released under the terms of the MIT license
@@ -39,6 +40,20 @@ class Gardener
     @socket_client_perm = Toolshed.socket_client_perm
   end
   
+  # The +init_status+ method for the Gardener instance allow to harvest an initialisation status message
+  # that would have been set by the Abundance.init_status method, inside the Abundance.gardener's block. 
+  # It returns an array of hash, one hash for each garden rows.
+  # === Example
+  #   puts gardener.init_status.inspect   # => [{:message=>"init ok", :success=>true, :pid=>4760}, {:message=>"init failed", :success=>false, :pid=>4761}] 
+  def init_status
+    status = []
+    @garden_rows.pids.each do |pid|
+      command, data = socket_client_perm_duplex(:harvest,pid)
+      status << {:success => data[:success], :message => data[:message], :pid => data[:id]}
+    end
+    return status
+  end
+  
   # The +seed+ method for the Gardener instance allow to sow a command in the Gardener's Garden.
   # === Parameter
   # * _command_ = a ruby expression or object

data/lib/seed.rb

@@ -11,7 +11,7 @@
 # :title:Seed
 
 class Seed
-  
+  $seed = Hash.new
   # The +new+ class method initializes the class.
   # You don't have to initialize it inside of Abundance,
   # as it gets initialized automatically inside the +Abundance.grow+ method

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: abundance
 version: !ruby/object:Gem::Version 
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors: 
 - Louis-Philippe Perron
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-06 00:00:00 -05:00
+date: 2008-12-12 00:00:00 -05:00
 default_executable: 
 dependencies: []