abundance 1.2.0 → 1.2.1

data/lib/toolshed.rb

@@ -10,67 +10,93 @@
 # 
 # :title:Toolshed
 
-# TODO:
-# -dedicated server on garden for 'ready!' rows where rows go write their PID
-
 module Toolshed
   require 'ftools'
   require 'socket'
   SOCKET_ROOT = '/tmp/abundance/'
   Dir.mkdir(SOCKET_ROOT) unless File.exist?(SOCKET_ROOT)
         
-  # The Toolshed::block_size= method sets the UDP block size for socket operations.
+  # The Toolshed::block_size= method sets the Socket block size for UNIXSocket operations.
+  # === Parameters
+  # * _block_size_ = the block size in bytes
   def Toolshed::block_size=(block_size)
     @@block_size = block_size
   end
   
-  # The +assign_sockets+ method assign a value client and server variables
-  
+  # The +set_my_socket_as_a+ method sets a UNIXServer socket as an instance variable for the calling object in a role based fashion.
+  # When the specified role is not a :garden, the Garden's socket path is also stored as an instance variable for the calling object.
+  # === Parameters
+  # * _role_ = the role for which you wish to establish the socket
+  # * _garden_pid_ = the garden pid that will become the basename for the garden socket.  No need to specify this argument when _role_ is :garden.
   def set_my_socket_as_a(role,garden_pid=Process.pid)
     case role
     when :garden
-      set_my_socket
+      set_my_socket(Process.pid.to_s)
+    when :gardener
+      set_garden_path(garden_pid)
+      set_my_socket(Process.pid.to_s + Time.now.to_i.to_s + rand(10000).to_s)
     else
       set_garden_path(garden_pid)
-      set_my_socket
+      set_my_socket(Process.pid.to_s)
     end
   end
   
+  # The +my_socket_path+ method act as an attribute reader for the @my_socket_path instance variable of the calling object.
   def my_socket_path
     @my_socket_path
   end
   
-  # 
-  
+  # The +socket_send+ method open a UNIXSocket and send packets to a UNIXServer socket.
+  # When the _server_socket_path_ is not specified, it defaults sending to the Garden UNIXServer.
+  # === Parameters
+  # * _command_ = command part of the sent packet
+  # * _data_ = data part of the sent packet
+  # * _server_socket_path_ = a UNIXServer socket path for the packets to be sent to
   def socket_send(command,data,server_socket_path=@garden_path)
     send_block(command,data,server_socket_path)
   end
   
+  # The +socket_duplex+ method open a UNIXSocket and send packets to a UNIXServer socket, then wait for loopback communication from destination and return results like +socket_recv+.
+  # === Parameters
+  # * _command_ = command part of the sent packet
+  # * _data_ = data part of the sent packet
+  # * _server_socket_path_ = a UNIXServer socket path for the packets to be sent to
   def socket_duplex(command,data,server_socket_path=@garden_path)
     send_block(command,data,server_socket_path)
     Marshal.load(recv_whole_block)
   end
-    
+  
+  # The +socket_recv+ method calls _accept_ on a UNIXServer socket, receives all the packets from a UNIXSocket sender, join the packets back as the original block message.
   def socket_recv
     Marshal.load(recv_whole_block)
   end
     
   private 
   
-  def socket_path(pid)
-    File.catname(pid.to_s,SOCKET_ROOT)
+  # The +socket_path+ method takes a _socket_name_ as argument and returns the absolute path to this socket.
+  # === Parameters
+  # * _socket_name_ = the socket file name
+  def socket_path(socket_name)
+    File.catname(socket_name,SOCKET_ROOT)
   end
   
-  def set_my_socket
-    @my_socket_path = socket_path(Process.pid)
+  # The +set_my_socket+ method stores a UNIXServer socket inside @my_socket instance variable and also stores this socket path inside @my_socket_path.
+  # === Parameters
+  # * _socket_name_ = the socket file name
+  def set_my_socket(socket_name)
+    @my_socket_path = socket_path(socket_name)
     File.delete(@my_socket_path) if File.exist?(@my_socket_path)
     @my_socket = UNIXServer.open(@my_socket_path)
   end
   
+  # The +set_garden_path+ method stores the Garden's UNIXServer socket path inside @garden_path.
+  # === Parameters
+  # * _garden_pid_ = the Garden process pid
   def set_garden_path(garden_pid)
-    @garden_path = socket_path(garden_pid)
+    @garden_path = socket_path(garden_pid.to_s)
   end
   
+  # The +recv_whole_block+ method loops receiving a sent block as packets, rebuilding the whole block and joining it.
   def recv_whole_block
     begin
       client = @my_socket.accept; block = []
@@ -90,6 +116,11 @@ module Toolshed
     end
   end
   
+  # The +send_block+ method sends a block to a server socket.
+  # === Parameters
+  # * _command_ = command part of the sent packet
+  # * _data_ = data part of the sent packet
+  # * _server_socket_path_ = the UNIXServer socket path to send to 
   def send_block(command,data,server_socket_path)
     begin
       client = UNIXSocket.open(server_socket_path)

data/test/tc_multi_gardener.rb

@@ -0,0 +1,50 @@
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require 'test/unit'
+require 'abundance'
+
+class TestHighAPI < Test::Unit::TestCase
+  
+  def test_two_gardeners
+    @rows = 2
+    set_gardener1
+    set_gardener2
+    check_both_gardener
+  end
+  
+  def teardown
+    @g1.close
+    @g2.close
+  end
+  
+  private
+  
+  def set_gardener1
+    @g1 = Abundance.gardener(:wheelbarrow => 128, :rows => @rows, :init_timeout => 3) do
+      Abundance.init_status(true,Process.pid)
+      Abundance.grow do |seed|
+        seed.crop(true, "gardener1: #{seed.sprout}")
+      end      
+    end
+  end
+  
+  def set_gardener2
+    @g2 = Abundance.gardener(:wheelbarrow => 128, :rows => @rows, :init_timeout => 3) do
+      Abundance.init_status(true,Process.pid)
+      Abundance.grow do |seed|
+        seed.crop(true, "gardener2: #{seed.sprout}")
+      end      
+    end
+  end
+  
+  def check_both_gardener
+    id1 = @g1.seed(Process.pid)
+    id2 = @g2.seed(Process.pid)
+    
+    answer1 = @g1.harvest(id1)
+    answer2 = @g2.harvest(id2)
+    
+    assert(answer1[:message] =~ /gardener1.*/)
+    assert(answer2[:message] =~ /gardener2.*/)
+  end
+  
+end

data/test/ts_abundance.rb

@@ -1,4 +1,5 @@
 $:.unshift File.join(File.dirname(__FILE__), "..", "lib")
 require 'test/unit'
 require 'test/tc_high_api'
-require 'test/tc_robustness'
+require 'test/tc_robustness'
+require 'test/tc_multi_gardener'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: abundance
 version: !ruby/object:Gem::Version 
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors: 
 - Louis-Philippe Perron
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-11 00:00:00 -05:00
+date: 2009-01-12 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -28,6 +28,7 @@ files:
 - lib/seed.rb
 - lib/toolshed.rb
 - test/tc_high_api.rb
+- test/tc_multi_gardener.rb
 - test/tc_robustness.rb
 - test/ts_abundance.rb
 has_rdoc: true