barney 0.10.1 → 0.11.0

data/ChangeLog

@@ -1,39 +1,50 @@
-2011-04-23  Robert Gleeson <rob@flowof.info>
+2011-05-03  Robert Gleeson <rob@flowof.info>
 
 	* lib/barney.rb README.md ChangeLog:
-		Release 0.10.1
-
-	* lib/barney/share.rb:
-		Fix a bug where Barney::Share#history could return unordered/incorrect data 
-		when subprocesses are spawned in parallel.
+		Release 0.11.0
 
 	* lib/barney/share.rb: 
-		Release 0.10.0
+		Rename @context to @scope.
 
 	* lib/barney/share.rb: 
-		Fix a bug where Barney::Share#share could return nil.
-		If there were no duplicates in @variables, `nil` would be returned.
+		Add Barney::Share#wait_all.
+
+	* test/suite/lib/barney.rb:
+		Add test suite for the 'Barney' module.
 	
-	* lib/barney.rb:
-		The Barney module proxies requests onto a Barney::Share object.
+	* lib/barney.rb: 
+		Document Barney.method_missing, and Barney.respond_to?
 
+	* lib/barney.rb: 
+		Add Barney.respond_to? 
 
-2011-04-21  Robert Gleeson <rob@flowof.info>
+	* ChangeLog:
+		Record Releases.
 
-	* ChangeLog: 
-		Change to GNU ChangeLog format.
+	* lib/barney/share.rb:
+		Remove Barney::Share#spawn_pipes (private method).
 
-	* 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.
-		
-	
+	* lib/barney.rb README.md ChangeLog:
+		Release 0.10.1
+
+	* lib/barney/share.rb:
+		Fix a bug where Barney::Share#history could return unordered/incorrect data 
+		when subprocesses are spawned in parallel.	
 
 
+2011-04-23  Robert Gleeson <rob@flowof.info>
 
-	
+	* lib/barney.rb README.md:
+		Release 0.10.0
+
+	* lib/barney.rb:
+		Add Barney.method_missing …
+		Messages are passed onto an instance of Barney::Share. 
+
+	* lib/barney.rb README.md:
+		Release 0.9.1
+
+	* lib/barney/share.rb: 
+		Fix a bug where Barney::Share#share could return nil.
+		If there were no duplicates in @variables, `nil` would be returned.
+		

data/README.md

@@ -1,66 +1,64 @@
- ![Barney Picture](http://ompldr.org/vNnUwNA)
+ ![Barney Picture](http://i.imgur.com/VblLQ.png)
 
-Barney tries to make the sharing of data between processes as easy and **natural** as possible.  
-Barney is developed to run on Ruby 1.9.1 or later, but it may work on earlier versions of Ruby as well.
+Barney makes sharing data between processes easy and natural by providing a simple and easy to use DSL.  
+Barney is developed against Ruby 1.9.1 and later, but it may work on earlier versions of Ruby as well.
 
 Limitations  
 -----------
 
 * Sharable objects  
-  Behind the scenes, Barney is using Marshal to send data between processes.  
+  Behind the scenes, Barney is using Marshal to send data between processes.   
   Any object that can be dumped through Marshal.dump can be shared.  
-  This excludes anonymous modules, anonymous classes, Proc objects, and possibly some other objects I
-  cannot think of.
+  This excludes anonymous modules, anonymous classes, Proc objects, and possibly some other objects I cannot think of.
 
 * Thread safety  
   Barney is thread-safe as long as one instance of Barney::Share is used per-thread.  
-  There is a mutex lock in place, but it only concerns Barney::Share#synchronize, where data is shared
-  among all instances of Barney::Share.
+  There is a mutex lock in place, but it only concerns Barney::Share#synchronize, where data is shared among all 
+  instances of Barney::Share.
 
-Examples
---------
-
-Okay, now that we've got that out of the way, let's see what using Barney is like:  
-(The [Samples](https://github.com/robgleeson/barney/tree/develop/samples) directory has more examples …)
+Usage
+-----
 
-**Barney::Share**
+    #!/usr/bin/env ruby
+    require 'barney'
 
-      #!/usr/bin/env ruby
-      require 'barney'
+    Barney.share :name
+    name = 'Robert'
 
-      obj = Barney::Share.new
-      obj.share :message
-      message = 'Hello, '
+    pid = Barney.fork do 
+      name.slice! 0..2
+    end
 
-      pid = obj.fork do 
-        message << 'World!'
-      end
+    Process.wait pid
+    Barney.sync
 
-      Process.wait pid
-      obj.sync
-      
-      puts message # 'Hello, World!' 
+    puts name # "Rob"
 
+* _More!_  
+  Check out the [samples](https://github.com/robgleeson/barney/tree/master/samples) directory or if you're looking 
+  for precise and detailed info, check out the API docs.
 
-      
-**Barney (Module)** 
+* _Notes!_  
+  It's worth mentioning that the _Barney_ module is passing method calls to an instance of _Barney::Share_, 
+  where the DSL is implemented. If you prefer, or your situation requires, feel free to create instance(s) of 
+  _Barney::Share_ yourself.  
 
-The Barney module will forward requests onto an instance of Barney::Share:
 
-      #!/usr/bin/env ruby
-      require 'barney'
-
-      Barney.share :name
-      name = 'Robert'
+Documentation
+--------------
 
-      pid = Barney.fork do 
-        name.slice! 0..2
-      end
+**API**  
 
-      Process.wait pid
-      Barney.sync
+* [master (git)](http://rubydoc.info/github/robgleeson/barney/master/)
+* [0.10.0](http://rubydoc.info/gems/barney/0.10.0/)
+* [0.9.1](http://rubydoc.info/gems/barney/0.9.1/)
+* [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)
+* …
 
-      puts name # "Rob"
+  
 
 Install
 --------
@@ -84,12 +82,12 @@ Documentation
 **API**  
 
 * [master (git)](http://rubydoc.info/github/robgleeson/barney/master/)
+* [0.11.0](http://rubydoc.info/gems/barney/0.11.0/)
 * [0.10.1](http://rubydoc.info/gems/barney/0.10.1/)  
 * [0.10.0](http://rubydoc.info/gems/barney/0.10.0/)
 * [0.9.1](http://rubydoc.info/gems/barney/0.9.1/)
 * [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/)
 * …
 
 

data/lib/barney/share.rb

@@ -45,7 +45,9 @@ module Barney
       @streams   = []
       @variables = []
       @history   = []
-      @context   = nil
+      @pids      = []
+      @pid       = nil
+      @scope     = nil
       yield self if block_given? 
     end
 
@@ -66,38 +68,47 @@ module Barney
         @streams.delete_if { |stream| stream.variable == variable }
         @variables.delete variable 
       end
-
       @variables
     end
 
+    # Collect the status of all subprocesses spawned by a {Barney::Share Barney::Share} instance.
+    # @return [void]
+    def wait_all
+      @pids.each do |pid|
+        Process.wait pid
+      end
+      @pids.clear
+    end
+
     # 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] 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
+    def fork &block
       raise ArgumentError, "A block or Proc object is expected" unless block_given?
+      @scope = block.binding
 
       tmp_streams = Array.new @variables.size do |index|
         StreamPair.new @variables[index], *IO.pipe
       end
 
-      @context = blk.binding
       @pid = Kernel.fork do
-        blk.call
+        block.call
         tmp_streams.each do |stream|
           stream.in.close  
-          stream.out.write Marshal.dump(eval("#{stream.variable}", @context))
+          stream.out.write Marshal.dump(eval("#{stream.variable}", @scope))
           stream.out.close
         end
       end
-
+      
+      @pids.push @pid
       @streams.push *tmp_streams
       @pid
     end
 
     # 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
@@ -105,7 +116,7 @@ module Barney
           stream.out.close
           Barney::Share.value = Marshal.load stream.in.read
           stream.in.close
-          value = eval "#{stream.variable} = Barney::Share.value", @context 
+          value = eval "#{stream.variable} = Barney::Share.value", @scope 
           @history.push HistoryItem.new(stream.variable, value)
         end
 

data/lib/barney.rb

@@ -2,11 +2,14 @@ require 'barney/share'
 
 module Barney 
 
-  VERSION = '0.10.1'
+  VERSION = '0.11.0'
   @proxy  = Barney::Share.new
 
   class << self
 
+    # Forward message to an instance of {Barney::Share Barney::Share}.
+    #
+    # @see Barney::Share Barney::Share.
     def method_missing meth, *args, &blk
       if @proxy.respond_to? meth
         @proxy.send meth, *args, &blk
@@ -15,6 +18,15 @@ module Barney
       end
     end
 
+    # Ask {Barney} does it respond to _meth_.
+    #
+    # @param  [String, Symbol, #to_sym] Name  The method name.
+    # @param  [Boolean]                 Scope Pass true to extend scope to include private methods.
+    # @return [Boolean]                       Return true if {Barney} can respond to _meth_.
+    def respond_to? meth, with_private = false
+      super || @proxy.respond_to?(meth, with_private)
+    end
+
   end
 
 end

data/test/suite/lib/barney.rb

@@ -0,0 +1,10 @@
+describe 'Barney' do
+
+  it 'should respond to all Barney::Share methods.' do
+    methods = Barney::Share.instance_methods false
+    methods.each do |meth|
+      assert Barney.respond_to?(meth.to_sym), "Barney should respond to #{meth}"
+    end
+  end
+
+end

metadata

@@ -2,7 +2,7 @@
 name: barney
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.10.1
+  version: 0.11.0
 platform: ruby
 authors: 
 - Robert Gleeson
@@ -58,6 +58,7 @@ files:
 - test/suite/lib/barney/share#shared.rb
 - test/suite/lib/barney/share#synchronize.rb
 - test/suite/lib/barney/share#unshare.rb
+- test/suite/lib/barney.rb
 has_rdoc: true
 homepage: http://github.com/robgleeson/barney
 licenses: []
@@ -93,3 +94,4 @@ test_files:
 - test/suite/lib/barney/share#shared.rb
 - test/suite/lib/barney/share#synchronize.rb
 - test/suite/lib/barney/share#unshare.rb
+- test/suite/lib/barney.rb