pthread 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8b4115d829039a0033707e7ee8c61c20b9811ce8
-  data.tar.gz: 914e7300414d2f88e9e0c4a1c570f49b1168e46e
+  metadata.gz: dafcdd2900f027b28215e12e83f2aa4aeff4a59c
+  data.tar.gz: 31fa0fab9742a9c6fe677e62a6be238f89761591
 SHA512:
-  metadata.gz: f55558ad0dce52d87478486f6c3e072bceecde87eaac811440f700b3b324f2cfc49f8c75b419290df2972c794361cb41042be2eb331a9fc2ba2eb42f3ee3c758
-  data.tar.gz: ad5ca10800236855b77ca24696d1a4828f62568f5e50c0259b270848fea202b16a0915d38989010f9a46f5ee5f8759439786babaedd86e79e5838aadaef7bd1b
+  metadata.gz: 9453e1c25209cb0d5ecabf94b5c5323b7bd7f7527d7a7fd20f3ff28b18c81ea095c561e6159ffd02edc527cfd1cb8f67457295f4dcf402b57b2f59cd33a9df2d
+  data.tar.gz: 882c89a3653ce66bb42acc97d94c7735d9a50df5607d198a565036d35cd9eb19ae74b9621ad3037b5ad7fa9c75bba09197011c940b8d670650a5ee0c5c554e96

data/lib/pthread/pthread.rb

@@ -1,43 +1,100 @@
 require 'rinda/tuplespace'
 
-class Pthread::Pthread
-  @@ts  = Rinda::TupleSpace.new
-  @@pids = []
+module Pthread
 
-  def self.start_service(host)
-    @@host = host
-    DRb.start_service("druby://#{@@host}", @@ts)
-  end
+  # The +Pthread+ class is the main class that users work with.
+  # It used for creating forks to be executed in a separate processes
+  # including other machines
+  class Pthread
+
+    @@ts   = Rinda::TupleSpace.new
+    @@pids = []
+
+    # Starts the drb server
+    #
+    # @param [ String ] that contains host url and port
+    #
+    # @example Start service
+    #   Pthread::Pthread.start_service '192.168.1.100:12345'
+    def self.start_service(host)
+      @@host = host
+      DRb.start_service("druby://#{@@host}", @@ts)
+    end
 
-  def self.add_executors(count = 1, queue=nil)
-    count.times do
-      @@pids << fork do
-        DRb.stop_service
-        Pthread::PthreadExecutor.new(@@host, queue)
+    # Adds executors on the same machine as the main programm
+    #
+    # @param [ FixNum ] amount of executors to start
+    # @param [ Symbol, String ] name of the queue for executors to be attached to
+    #
+    # @example Add executors without a queue
+    #   Pthread::Pthread.add_executors 5
+    # @example Add executors for specific queue
+    #   Pthread::Pthread.add_executors 5, :tasks
+
+    def self.add_executors(count = 1, queue=nil)
+      count.times do
+        @@pids << fork do
+          DRb.stop_service
+          Pthread::PthreadExecutor.new(@@host, queue)
+        end
       end
     end
-  end
 
-  def self.add_executor(queue=nil)
-    add_executors(1, queue)
-  end
+    # Adds a single executor on the same machine as the main programm
+    #
+    # @param [ Symbol, String ] name of the queue for executor to be attached to
+    #
+    # @example Add executor without a queue
+    #   Pthread::Pthread.add_executor
+    # @example Add executor for specific queue
+    #   Pthread::Pthread.add_executor, :tasks
+    def self.add_executor(queue=nil)
+      add_executors(1, queue)
+    end
 
-  def self.kill_executors
-    Process.kill 'HUP', *@@pids
-    @@pids = []
-  end
+    # Kills all launched executors on this machine
+    #
+    # @example Add executors without a queue
+    #   Pthread::Pthread.kill_executors
+    def self.kill_executors
+      Process.kill 'HUP', *@@pids
+      @@pids = []
+    end
 
-  def initialize(job)
-    @@ts.write([self.object_id, job[:queue], job[:code], job[:context]])
-  end
+    # Initializes new pthread and schedules execution of the job
+    #
+    # @param [ Hash ] should containt :code, :context and optionally :queue
+    # 
+    # @example Initialize new parrallel job
+    #   pthread = Pthread::Pthread.new queue: 'tasks', code: %{
+    #     x ** 2
+    #   }, context: { x: 5 }
+    def initialize(job)
+      @@ts.write([self.object_id, job[:queue], job[:code], job[:context]])
+    end
 
-  def value
-    raw_value.is_a?(StandardError) ? raise(raw_value) : raw_value
-  end
 
-private
+    # Returns value of a pthread
+    #
+    # @note If value if not yet calculated will block the execution
+    # @note If pthread resulted in an exception it will be raised
+    #
+    # @example pthread.value
+    #
+    # @return [ Object ] value of a pthread
+    def value
+      raw_value.is_a?(StandardError) ? raise(raw_value) : raw_value
+    end
+
+  private
 
-  def raw_value
-    @raw_value ||= @@ts.take([self.object_id, nil])[1]
+    # Returns raw value of a pthread even if it was an exception
+    #
+    # @note If value if not yet calculated will block the execution
+    #
+    # @return [ Object ] raw value of a pthread    
+    def raw_value
+      @raw_value ||= @@ts.take([self.object_id, nil])[1]
+    end
   end
 end

data/lib/pthread/pthread_executor.rb

@@ -1,27 +1,40 @@
 require 'drb/drb'
 
-class Pthread::PthreadExecutor
-  def initialize(host, queue=nil)
-    DRb.start_service
-    ts = DRbObject.new_with_uri("druby://#{host}")
+module Pthread
 
-    loop do
-      pthread_id, _, code, context = ts.take([nil, queue, nil, nil])
+  # +PthreadExecutor+ is used by Pthread to run code in a separate fork.
+  # Users can you this class to start executors manually on remote machines.
+  class PthreadExecutor
 
-      context && context.each do |a, v|
-        singleton_class.class_eval { attr_accessor a }
-        self.send("#{a}=", context[a])
-      end
+    # Initliazes new executor.
+    #
+    # @param [ String ] DRB host that has main programm running
+    # @param [ String, Symbol ] optinal queue name to attach executor
+    #
+    # @example Connect to remote Drb service
+    #   Pthread::PthreadExecutor.new '192.168.1.100:12345', :tasks
+    def initialize(host, queue=nil)
+      DRb.start_service
+      ts = DRbObject.new_with_uri("druby://#{host}")
 
-      value = begin
-        eval(code)
-      rescue => e
-        e
-      end
+      loop do
+        pthread_id, _, code, context = ts.take([nil, queue, nil, nil])
+
+        context && context.each do |a, v|
+          singleton_class.class_eval { attr_accessor a }
+          self.send("#{a}=", context[a])
+        end
 
-      ts.write([pthread_id, value])
+        value = begin
+          eval(code)
+        rescue => e
+          e
+        end
+
+        ts.write([pthread_id, value])
+      end
+    rescue DRb::DRbConnError
+      exit 0
     end
-  rescue DRb::DRbConnError
-    exit 0
   end
 end

data/lib/pthread/version.rb

@@ -1,3 +1,3 @@
 module Pthread
-  VERSION = '0.0.7'
+  VERSION = '0.0.8'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pthread
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Nikita Cernovs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-18 00:00:00.000000000 Z
+date: 2013-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler