barney 0.8.1 → 0.9.0

data/.yardopts

@@ -3,6 +3,7 @@
 --readme README.md
 --hide-void-return
 --no-cache
+--main README.md
 - 
 LICENSE
 ChangeLog

data/ChangeLog

@@ -1,51 +1,19 @@
-2011-04-19  Robert Gleeson <rob@flowof.info> v0.8.1
+2011-04-21  Robert Gleeson <rob@flowof.info>
 
-* Don't call #to_sym when it isn't required.
-* Don't allow @variables be populated with duplicates. (bugfix)
+	* ChangeLog: 
+		Change to GNU ChangeLog format.
 
-2011-04-19  Robert Gleeson <rob@flowof.info> v0.8.0
+	* lib/barney/share.rb: 
+		Don't lazy-delete objects from @streams.
+		Objects are removed from @streams during a call to #unshare now.
+	* lib/barney/share.rb: 
+		Add the member 'variable' to StreamPair.
+	* lib/barney/share.rb: 
+		Remove @shared.
+		Replaced by @streams, an Array of StreamPair objects.
+		
+	
 
-* Remove "seq" attribute from StreamPair.
-* Banish @seq.
-* Add HistoryItem (subclass of Struct).
-* Share#history returns an Array of HistoryItem objects.
-* Share#shared is deprecated. Use Shared#variables instead.
 
 
-2011-03-14  Robert Gleeson <rob@flowof.info> v0.7.0
-
-* Barney::Share#initialize yields a block.  
-
-2011-03-04  Robert Gleeson <rob@flowof.info> v0.6.0
-
-* Store instances of StreamPair in an array. 
-* Store sequence and pipe objects in a Struct referenced by StreamPair.  
-
-2011-03-04  Robert Gleeson <rob@flowof.info> v0.5.0
-
-* Solve Github Issue no. 3
-* Solve Github Issue no. 2
-* Write a more efficient and easier to understand Barney::Share#sync method. 
-
-2011-02-16  Robert Gleeson <rob@flowof.info> v0.4.1
-
-* Add http://www.gem-testers.org support.
-* Rewrite test suite using 'minitest'.
-
-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
-
-* Solve Github Issue no. 1.
-* Add Barney::Share#pid.
-
-2011-01-04  Robert Gleeson <rob@flowof.info> v0.2.0
-
-* Alias #synchronize as #sync. 
-
-2011-01-03  Robert Gleeson <rob@flowof.info> v0.2.0
-
-* Add Barney::Share#unshare.
-* Add Barney::Share#shared. 
+	

data/README.md

@@ -26,7 +26,6 @@ Okay, now that we've got that out of the way, let's see what using Barney is lik
       #!/usr/bin/env ruby
       require 'barney'
 
-
       obj = Barney::Share.new
       obj.share :message
       message = 'Hello, '
@@ -60,14 +59,13 @@ I'm following the [Semantic Versioning](http://www.semver.org) policy.
 
 **API**  
 
-* [master (git)](http://rubydoc.info/github/robgleeson/Barney/master/)
+* [master (git)](http://rubydoc.info/github/robgleeson/barney/master/)
+* [0.9.0](http://rubydoc.info/gems/barney/0.9.0/)
 * [0.8.1](http://rubydoc.info/gems/barney/0.8.1/)
 * [0.8.0](http://rubydoc.info/gems/barney/0.8.0/)
 * [0.7.0](http://rubydoc.info/gems/barney/0.7.0)
 * [0.6.0](http://rubydoc.info/gems/barney/0.6.0)
 * [0.5.0](http://rubydoc.info/gems/barney/0.5.0)
-* [0.4.1](http://rubydoc.info/gems/barney/0.4.1)
-* [0.4.0](http://rubydoc.info/gems/barney/0.4.0)  
 * …
 
 

data/lib/barney/share.rb

@@ -2,10 +2,11 @@ module Barney
 
   class Share
 
-    # @attr [IO] in      The pipe which is used to read data.       
-    # @attr [IO] out     The pipe which is used to write data.
+    # @attr [Symbol] variable The name of the variable associated with _in_, and _out_.
+    # @attr [IO]     in       The pipe which is used to read data.       
+    # @attr [IO]     out      The pipe which is used to write data.
     # @api private
-    StreamPair = Struct.new :in, :out
+    StreamPair = Struct.new :variable, :in, :out
 
     # @attr [Symbol] variable The variable name.
     # @attr [Object] value    The value of the variable.
@@ -14,12 +15,12 @@ module Barney
     @mutex = Mutex.new
 
     class << self
-      # Returns the latest value read from a spawned child process. 
+      # Returns the last value read from a spawned child process.
       # @api private
       # @return [Object]
       attr_accessor :value
 
-      # Returns a Mutex that is used when {Barney::Share.value Barney::Share.value} is being accessed by {Barney::Share#synchronize}
+      # Returns a Mutex that is used by the {Barney::Share#sync} method.
       # @api private
       # @return [Mutex] 
       attr_reader :mutex
@@ -33,55 +34,55 @@ module Barney
     # @return [Fixnum]
     attr_reader :pid
 
+    # Returns an Array of {HistoryItem} objects.
+    # @see HistoryItem
     # @return [Array<HistoryItem>]
     attr_reader :history
     
     # @yieldparam [Barney::Share] self Yields an instance of {Barney::Share}.
     # @return [Barney::Share]
     def initialize
-      @shared    = Hash.new { |h,k| h[k] = [] }
+      @streams   = []
       @variables = []
       @history   = []
       @context   = nil
       yield self if block_given? 
     end
 
-    # Serves as a method to mark a variable or constant to be shared between two processes. 
-    # @param  [Symbol] Variable   Accepts a variable amount of Symbol objects.
+    # Marks a variable or constant to be shared between two processes. 
+    # @param  [Symbol] Variable   Accepts the name(s) of the variables or constants you want to share.
     # @return [Array<Symbol>]     Returns a list of all variables that are being shared.
     def share *variables
       @variables.push *variables.map(&:to_sym)
       @variables.uniq!
     end
 
-    # Serves as a method to remove a variable or constant from being shared between two processes.
-    # @param  [Symbol] Variable Accepts a variable amount of Symbol objects.
+    # Removes a variable or constant from being shared between two processes.
+    # @param  [Symbol] Variable Accepts the name(s) of the variables or constants you want to stop sharing.
     # @return [Array<Symbol>]   Returns a list of the variables that are still being shared.
     def unshare *variables
-      variables.map(&:to_sym).each { |variable| @variables.delete variable }
+      variables.map(&:to_sym).each do |variable| 
+        @streams.delete_if { |stream| stream.variable == variable }
+        @variables.delete variable 
+      end
       @variables
     end
 
-    # Serves as a method to spawn a new child process.  
+    # Spawns a child process.  
     # It can be treated like the Kernel.fork method, but a block or Proc object is a required argument.
-    # @param  [Proc]  Proc    Accepts a block or Proc object that will be executed in a child 
-    #                         process.
-    # 
-    # @raise  [ArgumentError] It will raise an ArgumentError if a block or Proc object isn't 
-    #                         supplied as an argument. 
-    #                         
+    # @param  [Proc]  Proc    Accepts a block or Proc object that will be executed in a child process.
+    # @raise  [ArgumentError] Raises an ArgumentError if a block or Proc object isn't supplied.                        
     # @return [Fixnum]        Returns the Process ID(PID) of the spawned child process.  
     def fork &blk
       raise ArgumentError, "A block or Proc object is expected" unless block_given?
       spawn_pipes
 
       @context = blk.binding
-      @pid     = Kernel.fork do
+      @pid = Kernel.fork do
         blk.call
-        @shared.each do |variable, history|
-          stream = history[-1]
+        @streams.each do |stream|
           stream.in.close  
-          stream.out.write Marshal.dump(eval("#{variable}", @context))
+          stream.out.write Marshal.dump(eval("#{stream.variable}", @context))
           stream.out.close
         end
       end
@@ -89,33 +90,30 @@ module Barney
       @pid
     end
 
-    # Serves as a method that synchronizes data between the parent and child process.  
-    # It will block until the spawned child process has exited. 
+    # Synchronizes data between the parent and child process.  
+    # It will block until the spawned child process has exited.
     # @return [void]
     def synchronize 
       Barney::Share.mutex.synchronize do
-        @shared.each do |variable, history|
-          history.each do |stream|
-            stream.out.close
-            Barney::Share.value = Marshal.load stream.in.read
-            stream.in.close
-            value = eval "#{variable} = Barney::Share.value", @context 
-            @history.push HistoryItem.new variable, value
-          end
+        @streams.each do |stream|
+          stream.out.close
+          Barney::Share.value = Marshal.load stream.in.read
+          stream.in.close
+          value = eval "#{stream.variable} = Barney::Share.value", @context 
+          @history.push HistoryItem.new(stream.variable, value)
         end
+        @streams.clear
       end
     end
     alias_method :sync, :synchronize
 
     private
 
+    # Manages the creation of pipes used for cross-process communcation.
+    # @api private
     def spawn_pipes
-      @shared.keep_if do |variable|
-        @variables.member? variable
-      end
-
-      @variables.each do |variable|
-        @shared[variable].push StreamPair.new *IO.pipe
+      @variables.each do |variable| 
+        @streams.push StreamPair.new(variable, *IO.pipe)
       end
     end
 

data/lib/barney.rb

@@ -1,6 +1,6 @@
 require 'barney/share' 
 
 module Barney 
-  VERSION = '0.8.1'
+  VERSION = '0.9.0'
 end
 

data/test/suite/lib/barney/share#synchronize.rb

@@ -90,6 +90,16 @@ describe Barney::Share do
       assert_equal 5, @instance.history[1].value
     end
 
+    it 'should assert a IOError (Closed Stream) is not raised.' do
+      x = 5
+      pids = []
+      @instance.share :x
+      pids << @instance.fork { }
+      @instance.sync
+      pids << @instance.fork { }
+      pids.each { |pid| Process.wait pid }
+    end
+
   end
 
 end

data/test/suite/lib/barney/share#unshare.rb

@@ -31,11 +31,11 @@ describe Barney::Share do
       x = 5
       @instance.share :x 
       @instance.fork { }
-      assert true, @instance.instance_variable_get(:@shared).has_key?(:x)
+      assert true, @instance.instance_variable_get(:@streams).first.variable == :x
       
       @instance.unshare :x
       @instance.fork { }
-      assert true, @instance.instance_variable_get(:@shared).empty?
+      assert_equal true, @instance.instance_variable_get(:@streams).empty?
     end
 
  end

metadata

@@ -2,7 +2,7 @@
 name: barney
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors: 
 - Robert Gleeson
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-19 00:00:00 +01:00
+date: 2011-04-21 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency