barney 0.13.0 → 0.14.0

data/ChangeLog

@@ -1,62 +1,76 @@
+2011-05-23  Robert Gleeson <rob@flowof.info>
+
+	* lib/barney.rb:
+	Release 0.14.0
+
+	* lib/barney.rb lib/barney/emptystate.rb test/suite/lib/barney.rb: 
+	Add magic "Barney" method.
+
+2011-05-12  Robert Gleeson <rob@flowof.info>
+
+	* lib/barney/share.rb: 
+	Barney::Share#unshare no longer removes streams from @shared.
+	This means a variable stops being shared at the next call Share#fork.
+
 2011-05-09  Robert Gleeson <rob@flowof.info>
 
+	* README.md lib/barney.rb:
+	Release 0.13.0
+
 	* LICENSE README.md:
-		Change license from Lesser GPL(LGPL) to the MIT license.  
-		See LICENSE for details.
+	Change license from Lesser GPL(LGPL) to the MIT license.  
+	See LICENSE for details.
 
 2011-05-03  Robert Gleeson <rob@flowof.info>
 
-  * lib/barney.rb README.md ChangeLog:
-    	Release 0.12.0
+	* lib/barney.rb README.md: 
+	Release 0.12.0
 
-  * lib/barney.rb Rakefile.rb:
-    	Add support for 1.8.7
+	* lib/barney.rb Rakefile.rb:
+	Add support for 1.8.7
 
-	* lib/barney.rb README.md ChangeLog:
-		Release 0.11.0
+	* lib/barney.rb README.md:
+	Release 0.11.0
 
 	* lib/barney/share.rb: 
-		Rename @context to @scope.
+	Rename @context to @scope.
 
 	* lib/barney/share.rb: 
-		Add Barney::Share#wait_all.
+	Add Barney::Share#wait_all.
 
 	* test/suite/lib/barney.rb:
-		Add test suite for the 'Barney' module.
-	
-	* lib/barney.rb: 
-		Document Barney.method_missing, and Barney.respond_to?
+	Add test suite for the 'Barney' module.
 
 	* lib/barney.rb: 
-		Add Barney.respond_to? 
+	Document Barney.method_missing, and Barney.respond_to?
 
-	* ChangeLog:
-		Record Releases.
+	* lib/barney.rb: 
+	Add Barney.respond_to? 
 
 	* lib/barney/share.rb:
-		Remove Barney::Share#spawn_pipes (private method).
+	Remove Barney::Share#spawn_pipes (private method).
 
-	* lib/barney.rb README.md ChangeLog:
-		Release 0.10.1
+	* lib/barney.rb README.md:
+	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.	
+	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
+	Release 0.10.0
 
 	* lib/barney.rb:
-		Add Barney.method_missing …
-		Messages are passed onto an instance of Barney::Share. 
+	Add Barney.method_missing …
+	Messages are passed onto an instance of Barney::Share. 
 
 	* lib/barney.rb README.md:
-		Release 0.9.1
+	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.
+	Fix a bug where Barney::Share#share could return nil.
+	If there were no duplicates in @variables, `nil` would be returned.
 		

data/README.md

@@ -3,6 +3,9 @@
 Barney makes sharing data between processes easy and natural by providing a simple and easy to use DSL.  
 Barney is supported on any Ruby implementation that supports 1.8.7+, 1.9.1+, and that implements `Kernel.fork`.
 
+If you're looking for a library to do parallel jobs, check out [Parallel](https://github.com/grosser/parallel).  
+While possible in Barney, it was never a design goal and I'd definitely recommend you check out _Parallel_ instead.
+
 Limitations  
 -----------
 
@@ -19,43 +22,61 @@ Limitations
 Usage
 -----
 
+__Magic "Barney" method__
+
     #!/usr/bin/env ruby
+    # Magic "Barney" method
     require 'barney'
 
-    Barney.share :name
-    name = 'Robert'
+    Barney do
+      name = "Robert"
+      share :name
 
-    pid = Barney.fork do 
-      name.slice! 0..2
+      fork do
+        name.slice! 3..5
+      end
     end
 
-    Process.wait pid
-    Barney.sync
+    p name # "Rob"
 
-    puts name # "Rob"
+ __Barney module__
 
-* _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.
+    #!/usr/bin/env ruby
+    # Barney module sample
+    # Messages are forwarded onto a single instance of Barney::Share.
+    require 'barney'
 
-* _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.  
+    Barney.share :name
+    
+    Barney.fork do 
+      name.slice! 3..5
+    end
+
+    Barney.wait_all
+    Barney.sync
 
+    p name # "Rob"
 
+* _More!_  
+  Check out the [samples](https://github.com/robgleeson/barney/tree/master/samples) directory.  
+  Check out the API docs, too.
+
+* _Notes_  
+  The DSL is implemented in _Barney::Share_.  
+  You can create instances of(or subclasses) of _Barney::Share_ if you need to.  
+  
 Documentation
 --------------
 
 **API**  
 
 * [master (git)](http://rubydoc.info/github/robgleeson/barney/master/)
+* [0.14.0](http://rubydoc.info/gems/barney/0.14.0/)
 * [0.13.0](http://rubydoc.info/gems/barney/0.13.0/)
 * [0.12.0](http://rubydoc.info/gems/barney/0.12.0/)
 * [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/)
 * …
 
 
@@ -80,8 +101,7 @@ License
 --------
 
 Barney is released under the [_MIT License_](http://en.wikipedia.org/wiki/MIT_License).  
-See [LICENSE](http://github.com/robgleeson/barney/blob/master/README.md) for details.  
-
-Prior to 0.13.0, Barney was released under the Lesser GPL(LGPL).
+See [LICENSE](http://github.com/robgleeson/barney/blob/master/README.md) for details!  
+All versions before 0.13.0 are Lesser GPL(LGPL) licensed.
 
 

data/lib/barney/emptystate.rb

@@ -0,0 +1,26 @@
+module Barney
+
+  class EmptyState
+    attr_reader :__barney__
+    
+    Barney::Share.instance_methods(false).each do |meth|
+      define_method meth do |*args, &block|
+        @__barney__.send meth, *args, &block
+      end
+
+      undef_method :fork
+
+      define_method :fork do |*args, &block|
+        @__barney__.send :fork, *args, &block
+        @__barney__.sync
+      end
+    end
+
+    def initialize
+      @__barney__ = Barney::Share.new
+    end
+
+  end
+
+end
+

data/lib/barney/share.rb

@@ -64,20 +64,14 @@ module Barney
     # @param  [Symbol, #to_sym] 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.each do |variable|
-        variable = variable.to_sym
-        @streams.delete_if { |stream| stream.variable == variable }
-        @variables.delete variable 
-      end
+      variables.each { |variable| @variables.delete variable.to_sym }
       @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.each { |pid| Process.wait pid }
       @pids.clear
     end
 
@@ -91,20 +85,20 @@ module Barney
       raise ArgumentError, "A block or Proc object is expected" unless block_given?
       @scope = block.binding
 
-      tmp_streams = Array.new @variables.size do |index|
+      streams = Array.new @variables.size do |index|
         StreamPair.new @variables[index], *IO.pipe
       end
 
       @pid = Kernel.fork do
         block.call
-        tmp_streams.each do |stream|
+        streams.each do |stream|
           stream.in.close  
           stream.out.write Marshal.dump(@scope.eval("#{stream.variable}"))
           stream.out.close
         end
       end
       
-      @streams.push *tmp_streams
+      @streams.push *streams
       @pids.push @pid
       @pid
     end

data/lib/barney.rb

@@ -1,9 +1,10 @@
 require 'thread'
 require 'barney/share' 
+require 'barney/emptystate'
 
 module Barney 
 
-  VERSION = '0.13.0'
+  VERSION = '0.14.0'
   @proxy  = Barney::Share.new
 
   class << self
@@ -31,3 +32,28 @@ module Barney
   end
 
 end
+
+# Evaluates a block with access to all the methods available to a {Barney::Share Barney::Share} instance.  
+# Collecting the status of subprocesses and {Barney::Share#sync synchronization} is handled for you. 
+#
+# @example
+#     name = "Robert"
+#     
+#     Barney do
+#       share :name
+#
+#       fork do
+#         name.slice! 0..2
+#       end
+#     end
+#
+#     p name # "Rob"
+#
+# @raise [ArgumentError] If no block is supplied.
+# @return [void]
+def Barney &block
+  raise ArgumentError, "Block expected" unless block_given?
+  emptystate = Barney::EmptyState.new
+  emptystate.instance_eval &block
+  emptystate.__barney__.wait_all 
+end

data/samples/barney_module.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+#
+# Barney module sample
+# Messages are forwarded onto a single instance of Barney::Share.
+
+require 'barney'
+
+Barney.share :name
+
+Barney.fork do 
+  name.slice! 3..5
+end
+
+Barney.wait_all
+Barney.sync
+
+p name # "Rob"

data/samples/magic_barney_method.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+#
+# Magic "Barney" method
+
+require 'barney'
+
+Barney do
+  name = "Robert"
+  share :name
+
+  fork do
+    name.slice! 3..5
+  end
+end

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

@@ -27,17 +27,6 @@ describe Barney::Share do
       assert_equal true, @instance.variables.empty?
     end
 
-    it 'should assert a shared variable is removed from @shared' do
-      x = 5
-      @instance.share :x 
-      @instance.fork { }
-      assert_equal :x, @instance.instance_variable_get(:@streams).first.variable
-      
-      @instance.unshare :x
-      @instance.fork { }
-      assert_equal true, @instance.instance_variable_get(:@streams).empty?
-    end
-
  end
 
 end

data/test/suite/lib/barney.rb

@@ -8,3 +8,19 @@ describe 'Barney' do
   end
 
 end
+
+describe '#Barney' do
+
+  it 'should..' do
+    name = 'Robert'
+
+    Barney do
+      share :name
+      fork { name.slice! 3..5 }
+      fork { name.slice! 1..2 }
+    end
+
+    assert_equal "R", name
+  end
+
+end

metadata

@@ -2,7 +2,7 @@
 name: barney
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors: 
 - Robert Gleeson
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-09 00:00:00 +01:00
+date: 2011-05-23 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -50,6 +50,9 @@ files:
 - README.md
 - ChangeLog
 - .gemtest
+- samples/barney_module.rb
+- samples/magic_barney_method.rb
+- lib/barney/emptystate.rb
 - lib/barney/share.rb
 - lib/barney.rb
 - test/suite/lib/barney/share#fork.rb