barney 0.3.1 → 0.4.0

data/.yardopts

@@ -0,0 +1,9 @@
+-m markdown
+--no-private
+--readme README.md
+--hide-void-return
+--no-cache
+- 
+LICENSE
+ChangeLog
+

data/ChangeLog

@@ -1,7 +1,11 @@
+2011-02-12  Robert Gleeson <rob@flowof.info> v0.4.0
+
+* Add Barney::Share#history. 
+
 2011-01-16  Robert Gleeson <rob@flowof.info> v0.3.1
 
 * Bug Fix(See GH-Issue 1)
-* Process ID is available at Barney::Share#pid.
+* Add Barney::Share#pid.
 
 2011-01-04  Robert Gleeson <rob@flowof.info> v0.2.0
 

data/LICENSE

@@ -0,0 +1,166 @@
+                       GNU LESSER GENERAL PUBLIC LICENSE
+                           Version 3, 29 June 2007
+
+     Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+     Everyone is permitted to copy and distribute verbatim copies
+     of this license document, but changing it is not allowed.
+
+
+      This version of the GNU Lesser General Public License incorporates
+    the terms and conditions of version 3 of the GNU General Public
+    License, supplemented by the additional permissions listed below.
+
+      0. Additional Definitions.
+
+      As used herein, "this License" refers to version 3 of the GNU Lesser
+    General Public License, and the "GNU GPL" refers to version 3 of the GNU
+    General Public License.
+
+      "The Library" refers to a covered work governed by this License,
+    other than an Application or a Combined Work as defined below.
+
+      An "Application" is any work that makes use of an interface provided
+    by the Library, but which is not otherwise based on the Library.
+    Defining a subclass of a class defined by the Library is deemed a mode
+    of using an interface provided by the Library.
+
+      A "Combined Work" is a work produced by combining or linking an
+    Application with the Library.  The particular version of the Library
+    with which the Combined Work was made is also called the "Linked
+    Version".
+
+      The "Minimal Corresponding Source" for a Combined Work means the
+    Corresponding Source for the Combined Work, excluding any source code
+    for portions of the Combined Work that, considered in isolation, are
+    based on the Application, and not on the Linked Version.
+
+      The "Corresponding Application Code" for a Combined Work means the
+    object code and/or source code for the Application, including any data
+    and utility programs needed for reproducing the Combined Work from the
+    Application, but excluding the System Libraries of the Combined Work.
+
+      1. Exception to Section 3 of the GNU GPL.
+
+      You may convey a covered work under sections 3 and 4 of this License
+    without being bound by section 3 of the GNU GPL.
+
+      2. Conveying Modified Versions.
+
+      If you modify a copy of the Library, and, in your modifications, a
+    facility refers to a function or data to be supplied by an Application
+    that uses the facility (other than as an argument passed when the
+    facility is invoked), then you may convey a copy of the modified
+    version:
+
+       a) under this License, provided that you make a good faith effort to
+       ensure that, in the event an Application does not supply the
+       function or data, the facility still operates, and performs
+       whatever part of its purpose remains meaningful, or
+
+       b) under the GNU GPL, with none of the additional permissions of
+       this License applicable to that copy.
+
+      3. Object Code Incorporating Material from Library Header Files.
+
+      The object code form of an Application may incorporate material from
+    a header file that is part of the Library.  You may convey such object
+    code under terms of your choice, provided that, if the incorporated
+    material is not limited to numerical parameters, data structure
+    layouts and accessors, or small macros, inline functions and templates
+    (ten or fewer lines in length), you do both of the following:
+
+       a) Give prominent notice with each copy of the object code that the
+       Library is used in it and that the Library and its use are
+       covered by this License.
+
+       b) Accompany the object code with a copy of the GNU GPL and this license
+       document.
+
+      4. Combined Works.
+
+      You may convey a Combined Work under terms of your choice that,
+    taken together, effectively do not restrict modification of the
+    portions of the Library contained in the Combined Work and reverse
+    engineering for debugging such modifications, if you also do each of
+    the following:
+
+       a) Give prominent notice with each copy of the Combined Work that
+       the Library is used in it and that the Library and its use are
+       covered by this License.
+
+       b) Accompany the Combined Work with a copy of the GNU GPL and this license
+       document.
+
+       c) For a Combined Work that displays copyright notices during
+       execution, include the copyright notice for the Library among
+       these notices, as well as a reference directing the user to the
+       copies of the GNU GPL and this license document.
+
+       d) Do one of the following:
+
+           0) Convey the Minimal Corresponding Source under the terms of this
+           License, and the Corresponding Application Code in a form
+           suitable for, and under terms that permit, the user to
+           recombine or relink the Application with a modified version of
+           the Linked Version to produce a modified Combined Work, in the
+           manner specified by section 6 of the GNU GPL for conveying
+           Corresponding Source.
+
+           1) Use a suitable shared library mechanism for linking with the
+           Library.  A suitable mechanism is one that (a) uses at run time
+           a copy of the Library already present on the user's computer
+           system, and (b) will operate properly with a modified version
+           of the Library that is interface-compatible with the Linked
+           Version.
+
+       e) Provide Installation Information, but only if you would otherwise
+       be required to provide such information under section 6 of the
+       GNU GPL, and only to the extent that such information is
+       necessary to install and execute a modified version of the
+       Combined Work produced by recombining or relinking the
+       Application with a modified version of the Linked Version. (If
+       you use option 4d0, the Installation Information must accompany
+       the Minimal Corresponding Source and Corresponding Application
+       Code. If you use option 4d1, you must provide the Installation
+       Information in the manner specified by section 6 of the GNU GPL
+       for conveying Corresponding Source.)
+
+      5. Combined Libraries.
+
+      You may place library facilities that are a work based on the
+    Library side by side in a single library together with other library
+    facilities that are not Applications and are not covered by this
+    License, and convey such a combined library under terms of your
+    choice, if you do both of the following:
+
+       a) Accompany the combined library with a copy of the same work based
+       on the Library, uncombined with any other library facilities,
+       conveyed under the terms of this License.
+
+       b) Give prominent notice with the combined library that part of it
+       is a work based on the Library, and explaining where to find the
+       accompanying uncombined form of the same work.
+
+      6. Revised Versions of the GNU Lesser General Public License.
+
+      The Free Software Foundation may publish revised and/or new versions
+    of the GNU Lesser General Public License from time to time. Such new
+    versions will be similar in spirit to the present version, but may
+    differ in detail to address new problems or concerns.
+
+      Each version is given a distinguishing version number. If the
+    Library as you received it specifies that a certain numbered version
+    of the GNU Lesser General Public License "or any later version"
+    applies to it, you have the option of following the terms and
+    conditions either of that published version or of any later version
+    published by the Free Software Foundation. If the Library as you
+    received it does not specify a version number of the GNU Lesser
+    General Public License, you may choose any version of the GNU Lesser
+    General Public License ever published by the Free Software Foundation.
+
+      If the Library as you received it specifies that a proxy can decide
+    whether future versions of the GNU Lesser General Public License shall
+    apply, that proxy's public statement of acceptance of any version is
+    permanent authorization for you to choose that version for the
+    Library.
+

data/README.md

@@ -1,6 +1,7 @@
  ![Barney Picture](http://ompldr.org/vNnUwNA)
 
 Barney tries to make the sharing of data between processes as easy and **natural** as possible.  
+Barney is developed against Ruby 1.9.1 or later. I'm not knowingly supporting earlier versions of Ruby.
 
 ## Sharable objects
 Behind the scenes, Barney is using Marshal to send data between processes.  
@@ -18,7 +19,7 @@ among all instances of Barney::Share.
 
 Okay, now that we've got that out of the way, let's see what using Barney is like.
 
-**Example A**
+**Basic**
 
       #!/usr/bin/env ruby
       require 'barney'
@@ -37,15 +38,68 @@ Okay, now that we've got that out of the way, let's see what using Barney is lik
       obj.sync
       
       puts message * $times # output is 'boobooboo'.
-   
+ 
+**Sequential Jobs**
+      
+      #!/usr/bin/env ruby
+      require 'barney'
+
+      a = "12"
+
+      obj = Barney::Share.new
+      obj.share :a
+
+      3.upto(4).each do |i|
+        pid = obj.fork { a << i.to_s }
+        obj.sync
+        Process.wait pid
+      end
+
+      a # => "1234"
+
+**Paralell Jobs**
+
+      #/usr/bin/env ruby
+      require 'barney'
+
+      results = {}
+      pids    = []
+
+      obj = Barney::Share.new
+      obj.share :results
+
+      [1,2,3].each do |e|
+        pids << obj.fork do 
+          results.merge!(e => e)
+        end
+      end
+
+      pids.each { |pid| Process.wait(pid) }
+      obj.sync
+
+      obj.history.each_value do |history| 
+        results.merge! history[:results]
+      end
+
+      puts results.inspect # => { 1 => 1, 2 => 2, 3 => 3 }
+
 ## Documentation
 
 **API**  
 
 * [master (git)](http://rubydoc.info/github/robgleeson/Barney/master/)
+* [0.4.0](http://rubydoc.info/gems/barney/0.4.0)
+* [0.3.1](http://rubydoc.info/gems/barney/0.3.1)
 * [0.2.0](http://rubydoc.info/gems/barney/0.2.0)
 * [0.1.0](http://rubydoc.info/gems/barney/0.1.0)
 
+## License
+
+Barney is released under the LGPL.  
+You are free to **use** this library in free or commercial software, and license that software however you want, 
+but as soon as you modify the library itself, 
+you must share your changes under the same license. :)
+
 ## Install
 
       gem install barney

data/lib/barney/share.rb

@@ -25,10 +25,16 @@ module Barney
     # @return [Fixnum] Returns the Process ID as a Fixnum.
     attr_reader :pid
 
+    # Serves as a method to provide a history of changes made in multiple forks for a single instance of {Barney::Share}.
+    # @return [{ Fixnum => { Symbol => Object }}] Fixnum represents sequence, Symbol the variable, and Object its value. 
+    attr_reader :history
+    
     # @return [Barney::Share] Returns an instance of Barney::Share.
     def initialize
       @shared  = Hash.new
       @context = nil
+      @history = {}
+      @seq     = 0
     end
 
     # Serves as a method to mark a variable or constant to be shared between two processes. 
@@ -36,7 +42,7 @@ module Barney
     # @return [Array<Symbol>]     Returns a list of all variables that are being shared.
     def share *variables
       variables.map(&:to_sym).each do |variable|
-        @shared.store variable, IO.pipe 
+        @shared.store variable, (@shared[variable] || {}).merge({ @seq => IO.pipe })
       end
       @shared.keys
     end
@@ -68,13 +74,14 @@ module Barney
       @context = blk.binding
       @pid     = Kernel.fork do
         blk.call
-        @shared.each do |variable, pipes| 
-          pipes[0].close  
-          pipes[1].write Marshal.dump(eval("#{variable}", @context))
-          pipes[1].close
+        @shared.each do |variable, hash|
+          hash[@seq][0].close  
+          hash[@seq][1].write Marshal.dump(eval("#{variable}", @context))
+          hash[@seq][1].close
         end
       end
-
+      
+      @seq += 1
       @pid
     end
 
@@ -82,12 +89,17 @@ module Barney
     # It will block until the spawned child process has exited. 
     # @return [void]
     def synchronize 
-      @shared.each do |variable, pipes|
+      @shared.each do |variable, hash|
         Barney::Share.mutex.synchronize do
-          pipes[1].close
-          Barney::Share.value = Marshal.load pipes[0].read
-          pipes[0].close
-          eval "#{variable} = Barney::Share.value", @context
+          0.upto(@seq) do |seq|
+            unless hash[seq].nil? || hash[seq][0].closed? || hash[seq][1].closed?
+              hash[seq][1].close
+              Barney::Share.value = Marshal.load hash[seq][0].read
+              hash[seq][0].close
+              object = eval "#{variable} = Barney::Share.value", @context 
+              @history.merge!({ seq => { variable => object } })
+            end
+          end
         end
       end
     end

data/lib/barney.rb

@@ -2,7 +2,7 @@ require('barney/share')
 
 module Barney 
 
-  VERSION = '0.3.1'
+  VERSION = '0.4.0'
 
 end
 

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: barney
 version: !ruby/object:Gem::Version 
+  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 1
-  version: 0.3.1
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Robert Gleeson
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-16 00:00:00 +00:00
+date: 2011-02-13 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,6 +26,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -38,6 +40,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -51,6 +54,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -65,6 +69,8 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- LICENSE
+- .yardopts
 - README.md
 - ChangeLog
 - lib/barney/share.rb
@@ -83,14 +89,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 49
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 9
+      - 1
+      version: 1.9.1
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 23
       segments: 
       - 1
       - 3