pthread 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dafcdd2900f027b28215e12e83f2aa4aeff4a59c
-  data.tar.gz: 31fa0fab9742a9c6fe677e62a6be238f89761591
+  metadata.gz: ab2e480b2458075f38532a9e4d66ed2432e71402
+  data.tar.gz: ab4a5edef41900153124ffa68173570b3d713e53
 SHA512:
-  metadata.gz: 9453e1c25209cb0d5ecabf94b5c5323b7bd7f7527d7a7fd20f3ff28b18c81ea095c561e6159ffd02edc527cfd1cb8f67457295f4dcf402b57b2f59cd33a9df2d
-  data.tar.gz: 882c89a3653ce66bb42acc97d94c7735d9a50df5607d198a565036d35cd9eb19ae74b9621ad3037b5ad7fa9c75bba09197011c940b8d670650a5ee0c5c554e96
+  metadata.gz: c431e34a38e3c2007c8ca1e5ed96d09d43ad5c0bc21af3b2f0b188181b4a58bcb472b4b478771d7093af2a834d24a0830b5b3e5b314ab0f3b59862da4642e03a
+  data.tar.gz: 0f7c4a73d6274c2a15cd4c7034d7c86a2fd7012213be9e9647cfa7aec1d7cb3cb13afe607dbecdd2cbec2ce9b3ee1313d4ec40f533d43cf61955059ec3cc6bec

data/lib/pthread/pthread.rb

@@ -4,15 +4,15 @@ module Pthread
 
   # 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
+  # including on remote machines.
   class Pthread
 
     @@ts   = Rinda::TupleSpace.new
     @@pids = []
 
-    # Starts the drb server
+    # Starts the drb server.
     #
-    # @param [ String ] that contains host url and port
+    # @param [String] host that contains host url and port.
     #
     # @example Start service
     #   Pthread::Pthread.start_service '192.168.1.100:12345'
@@ -21,16 +21,15 @@ module Pthread
       DRb.start_service("druby://#{@@host}", @@ts)
     end
 
-    # Adds executors on the same machine as the main programm
+    # 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
+    # @param [FixNum] count amount of executors to start.
+    # @param [Symbol, String] queue 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
@@ -40,19 +39,19 @@ module Pthread
       end
     end
 
-    # Adds a single executor on the same machine as the main programm
+    # 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
+    # @param [Symbol, String] queue name of the queue for executor to be attached to.
     #
-    # @example Add executor without a queue
+    # @example Add an executor without a queue
     #   Pthread::Pthread.add_executor
-    # @example Add executor for specific queue
+    # @example Add an executor for a specific queue
     #   Pthread::Pthread.add_executor, :tasks
     def self.add_executor(queue=nil)
       add_executors(1, queue)
     end
 
-    # Kills all launched executors on this machine
+    # Kills all launched executors on this machine.
     #
     # @example Add executors without a queue
     #   Pthread::Pthread.kill_executors
@@ -61,9 +60,9 @@ module Pthread
       @@pids = []
     end
 
-    # Initializes new pthread and schedules execution of the job
+    # Initializes new pthread and schedules execution of the job.
     #
-    # @param [ Hash ] should containt :code, :context and optionally :queue
+    # @param [Hash] job should contain :code, :context and optionally :queue
     # 
     # @example Initialize new parrallel job
     #   pthread = Pthread::Pthread.new queue: 'tasks', code: %{
@@ -74,25 +73,26 @@ module Pthread
     end
 
 
-    # Returns value of a pthread
+    # 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
+    # @note If value is not yet calculated it will block the execution.
+    # @note If pthread resulted in an exception it will be raised.
     #
-    # @example pthread.value
+    # @example
+    #  pthread.value
     #
-    # @return [ Object ] value of a pthread
+    # @return [Object] value of a pthread.
     def value
       raw_value.is_a?(StandardError) ? raise(raw_value) : raw_value
     end
 
   private
 
-    # Returns raw value of a pthread even if it was an exception
+    # Returns raw value of a pthread even if it was an exception.
     #
-    # @note If value if not yet calculated will block the execution
+    # @note If value is not yet calculated will block the execution.
     #
-    # @return [ Object ] raw value of a pthread    
+    # @return [Object] raw value of a pthread.
     def raw_value
       @raw_value ||= @@ts.take([self.object_id, nil])[1]
     end

data/lib/pthread/pthread_executor.rb

@@ -8,10 +8,10 @@ module Pthread
 
     # Initliazes new executor.
     #
-    # @param [ String ] DRB host that has main programm running
-    # @param [ String, Symbol ] optinal queue name to attach executor
+    # @param [ String ] host DRB host that has main programm running.
+    # @param [ String, Symbol ] queue optinal queue name to attach executor.
     #
-    # @example Connect to remote Drb service
+    # @example Connect to remote dRb service
     #   Pthread::PthreadExecutor.new '192.168.1.100:12345', :tasks
     def initialize(host, queue=nil)
       DRb.start_service

data/lib/pthread/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pthread
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Nikita Cernovs