barney 0.14.0 → 0.15.0

data/.yardopts

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

data/ChangeLog

@@ -1,10 +1,22 @@
+2011-05-25  Robert Gleeson <rob@flowof.info>
+
+	* lib/barney.rb:
+	Release 0.15.0
+
+
 2011-05-23  Robert Gleeson <rob@flowof.info>
 
+	* lib/barney.rb:
+	Deprecate the Barney module responding to Barney::Share methods.
+
+	* lib/barney.rb lib/barney/jobs.rb:
+	Add Jobs() method.
+
 	* lib/barney.rb:
 	Release 0.14.0
 
 	* lib/barney.rb lib/barney/emptystate.rb test/suite/lib/barney.rb: 
-	Add magic "Barney" method.
+	Add Barney() method.
 
 2011-05-12  Robert Gleeson <rob@flowof.info>
 

data/README.md

@@ -3,33 +3,22 @@
 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.
+Underneath the hood, Barney is using the `Marshal` (the module) to serialize objects and send them across pipes created by `IO.pipe`.  
+If an object can't be serialized by `Marshal`, it can't be shared.  That means objects such as anonymous modules, 
+anonymous classes, and Proc objects can't be shared by Barney.
 
-Limitations  
------------
-
-* Sharable objects  
-  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.
-
-* 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.
+Below is an example of how _simple_ it is to use Barney, but please take the time to look at 
+[The Wiki](https://github.com/robgleeson/barney/wiki) if you're interested in Barney, because I cover other APIs 
+and everything else in much more depth.
 
 Usage
 -----
 
-__Magic "Barney" method__
-
-    #!/usr/bin/env ruby
-    # Magic "Barney" method
     require 'barney'
-
+    
+    name = "Robert"
+    
     Barney do
-      name = "Robert"
       share :name
 
       fork do
@@ -39,38 +28,17 @@ __Magic "Barney" method__
 
     p name # "Rob"
 
- __Barney module__
-
-    #!/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"
-
-* _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
 --------------
 
+**Wiki**  
+
+* [Wiki](https://github.com/robgleeson/barney/wiki)
+
 **API**  
 
 * [master (git)](http://rubydoc.info/github/robgleeson/barney/master/)
+* [0.15.0](http://rubydoc.info/gems/barney/0.15.0/)
 * [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/)
@@ -80,22 +48,14 @@ Documentation
 * …
 
 
+**Samples**
+
+* [Samples](https://github.com/robgleeson/tree/master/samples)
 
 Install
 --------
-
-RubyGems.org  
-
-      gem install barney
-
-Github  
-
-      git clone git://github.com/robgleeson/barney.git
-      cd barney
-      gem build *.gemspec
-      gem install *.gem
-
-I'm following the [Semantic Versioning](http://www.semver.org) policy.  
+  
+    $ [sudo] gem install barney
 
 License
 --------

data/lib/barney.rb

@@ -1,34 +1,22 @@
 require 'thread'
-require 'barney/share' 
+require 'barney/share'
+require 'barney/jobs'
 require 'barney/emptystate'
 
 module Barney 
 
-  VERSION = '0.14.0'
+  VERSION = '0.15.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
-      else
-        super
+    Barney::Share.instance_methods(false).each do |method|
+      define_method method do |*args, &block|
+        $stderr.puts "[WARNING] Barney.#{method} is deprecated and will be removed in the next release."
+        @proxy.send method, *args, &block
       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/lib/barney/jobs.rb

@@ -0,0 +1,23 @@
+# Returns an Array populated by the return value of the block.  
+# Each block is executed in a subprocess.
+#
+# @param  [Proc]   Block      The block to execute in a subprocess. 
+# @param  [Fixnum] Processes  The number of subprocesses to spawn.
+# @return [Array<Object>] 
+def Jobs number, &block
+  barney = Barney::Share.new
+  barney.share :queue
+  queue = []
+
+  number.times do
+    barney.fork do
+      queue << block.call
+    end
+  end
+
+  barney.wait_all
+  barney.sync
+
+  barney.history.map(&:value).flatten
+end
+ 

data/samples/{magic_barney_method.rb → Barney_method.rb}

@@ -4,11 +4,14 @@
 
 require 'barney'
 
+name = 'Robert'
+
 Barney do
-  name = "Robert"
   share :name
 
   fork do
     name.slice! 3..5
   end
 end
+
+p name # "Rob"

data/test/suite/lib/barney.rb

@@ -11,12 +11,12 @@ end
 
 describe '#Barney' do
 
-  it 'should..' do
+  it 'should synchronize data using the #Barney() method.' do
     name = 'Robert'
 
     Barney do
       share :name
-      fork { name.slice! 3..5 }
+      fork { name.slice! 3..5}
       fork { name.slice! 1..2 }
     end
 

data/test/suite/lib/barney/jobs.rb

@@ -0,0 +1,9 @@
+describe '#Jobs' do
+
+  it 'should spawn workers, and share their return value with the parent.' do
+    result = Jobs(5) { 42 }
+    assert_equal [42, 42, 42, 42, 42], result
+  end
+
+
+end

metadata

@@ -2,7 +2,7 @@
 name: barney
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors: 
 - Robert Gleeson
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-23 00:00:00 +01:00
+date: 2011-05-25 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -50,11 +50,12 @@ files:
 - README.md
 - ChangeLog
 - .gemtest
-- samples/barney_module.rb
-- samples/magic_barney_method.rb
+- samples/Barney_method.rb
 - lib/barney/emptystate.rb
+- lib/barney/jobs.rb
 - lib/barney/share.rb
 - lib/barney.rb
+- test/suite/lib/barney/jobs.rb
 - test/suite/lib/barney/share#fork.rb
 - test/suite/lib/barney/share#history.rb
 - test/suite/lib/barney/share#initialize.rb
@@ -91,6 +92,7 @@ signing_key:
 specification_version: 3
 summary: Barney tries to make the sharing of data between processes as easy and natural as possible.
 test_files: 
+- test/suite/lib/barney/jobs.rb
 - test/suite/lib/barney/share#fork.rb
 - test/suite/lib/barney/share#history.rb
 - test/suite/lib/barney/share#initialize.rb

data/samples/barney_module.rb

@@ -1,17 +0,0 @@
-#!/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"