forkomatic 0.0.1 → 0.0.2

data/README.rdoc

@@ -1,6 +1,48 @@
 = forkomatic
 
-Description goes here.
+* http://github.com/gdi/forkomatic
+
+== Description
+* forkomatic makes parallel processing extremely simple and powerful.
+* forkomatic can be used to quickly process data with 'n' processes.
+* forkomatic can also maintain a set number of processes for any number of iterations, adding new processes as child processes finish.
+
+== Synopsis
+  class YourForkomaticClass < Forkomatic
+    class Job < Forkomatic::Job
+      attr_accessor :data
+  
+      def initialize(data)
+        self.data = data
+      end
+  
+      def work!
+        puts "Working on #{data}"
+        sleep 1
+      end
+    end
+  
+    def build_jobs(count)
+      (1..count).each.collect {|i| YourForkomaticClass::Job.new(i)}
+    end
+  end
+
+  # To just create 20 child processes:
+  Forkomatic.new(20)
+
+  # 10 child processes will be maintained, and the loop will will run twice, waiting 1 second between iterations.
+  Forkomatic.new({:max_children => 10, :work_interval => 1, :max_iterations => 2})
+
+  # The work function will run continuously, adding new child processes as old ones die to maintain a constant 10 processes.
+  Forkomatic.new({:max_children => 10, :work_interval => 1})
+
+* Override the Job initialize function to give your child processes data to work with.
+* Override the Job work! function to do whatever processing is required.
+* Override the Forkomatic build_jobs() function to create 'count' child processes as needed.
+* Create a new instance of your Forkomatic class by giving it a number of processes to create or manually specifying parameters.
+
+== Examples
+* Examples are found in the test/ directory
 
 == Contributing to forkomatic
  
@@ -12,8 +54,14 @@ Description goes here.
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
+== Related projects
+forkify: https://github.com/dakrone/forkify
+* based on forkoff and threadify, used to processes a bunch of data using 'n' processes.  Limited to one iteration, but very simple to use.
+
+forkoff: https://github.com/ahoward/forkoff
+* works on enumerable objects, iterating a code block to run in each child processes and collecting results.  Also limited to a single iteration.
+
 == Copyright
 
 Copyright (c) 2012 Jon Durbin. See LICENSE.txt for
 further details.
-

data/Rakefile

@@ -18,10 +18,10 @@ Jeweler::Tasks.new do |gem|
   gem.homepage = "http://github.com/gdi/forkomatic"
   gem.license = "MIT"
   gem.summary = %Q{Easily run multiple processes continuously in parallel.}
-  gem.description = %Q{Easily create parallel processes to do work.  The process count can be dynamic (between min_children and max_children), can loop continuously (by setting max_iterations => nil), etc}
+  gem.description = %Q{Easily create parallel processes to do work, continuously maintain a number of processes or perform a single iteration, etc.}
   gem.email = "jond@greenviewdata.com"
   gem.authors = ["Jon Durbin"]
-  gem.version = '0.0.1'
+  gem.version = '0.0.2'
   # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: forkomatic
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Jon Durbin
@@ -78,7 +78,7 @@ dependencies:
   name: rdoc
   version_requirements: *id004
   prerelease: false
-description: Easily create parallel processes to do work.  The process count can be dynamic (between min_children and max_children), can loop continuously (by setting max_iterations => nil), etc
+description: Easily create parallel processes to do work, continuously maintain a number of processes or perform a single iteration, etc.
 email: jond@greenviewdata.com
 executables: []