taskbag 2.0.0 → 2.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6616c9985c2c790afcb154a3cbd4712c54486033
+  data.tar.gz: 545ed492816ecc0247efec8950e66669e0d05174
+SHA512:
+  metadata.gz: 458768e9b9c0c79797b690458a1cf82aacd8ebafcf6a55f3ed8c03479da40f84e7b597d0a063d513ee83b89f0ad049110eab2ce3bf74dbbce87d9f207f289831
+  data.tar.gz: 5b2f71e994403c7bcc1046becdb7ca0d8c50e5fa59bde3a62a6d5cc07317384b6802105961b9670281c70de69ea71f84d5cec50f3a52066843fbfee141f2eab1

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+bundler_args: --without development
+cache: bundler
+rvm:
+  - "2.1.1"
+  - "2.0.0"
+  - "1.9.3"
+  - "1.9.2"
+script:  bundle exec rspec

data/README.md

@@ -1,4 +1,5 @@
 # TaskBag
+[![Gem Version](https://badge.fury.io/rb/taskbag.png)](http://badge.fury.io/rb/taskbag)
 
 A super simple implementation of the Bag-of-Tasks Paradigm [1].
 
@@ -31,7 +32,7 @@ In TaskBag you can actually have different tasks in the same bag.
 
 ### When not to use it
 
-If you don't in the above.
+If you're not in the above situation.
 
 ### How to use it
 
@@ -77,4 +78,5 @@ As said before, you can add more tasks as the result of a job, for example, if y
 ## References
 
 [1] http://www.cs.arizona.edu/~greg/mpdbook/glossary.html
-[2] http://www.eead.csic.es/compbio/material/programacion_rocks/pics/paral_tareas.pdf
+
+[2] http://www.eead.csic.es/compbio/material/programacion_rocks/pics/paral_tareas.pdf

data/lib/taskbag.rb

@@ -1,3 +1,11 @@
 require 'taskbag/bag'
 require 'taskbag/worker'
 require 'taskbag/version'
+
+module TaskBag
+  def self.work(nworkers)
+    bag = Bag.open(nworkers)
+    yield bag
+    bag.close!
+  end
+end

data/lib/taskbag/bag.rb

@@ -35,5 +35,13 @@ module TaskBag
     def next
       @jobs.pop unless @jobs.empty?
     end
+
+    def self.open(nworkers)
+      Bag.new.tap {|b| b.open(nworkers)}
+    end
+
+    def nworkers
+      @threads.size
+    end
   end
 end

data/lib/taskbag/version.rb

@@ -1,3 +1,3 @@
 module TaskBag
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end

data/spec/bag_spec.rb

@@ -1,79 +1,94 @@
 require 'spec_helper'
 
 describe TaskBag::Bag do
-	let(:mocked_queue) { double('mocked queue', empty?: true) }
-	subject { TaskBag::Bag.new }
-
-	it { should be_closed }
-
-	describe 'opening a bag' do
-		it 'makes the bag open' do
-			subject.open 0
-			subject.should_not be_closed
-			subject.close!
-		end
-
-		it 'raises an exception if already open' do
-			subject.open 0
-			expect { subject.open(0) }.to raise_error
-		end
-
-		it 'creates the given number of workers in different threads' do
-			TaskBag::Worker.should_receive(:start)
-										 .with(subject)
-										 .exactly(3).times
-										 .and_return 1, 2, 3
-
-			subject.open(3).should have(3).items
-			subject.close!
-		end
-	end
-
-	describe 'closing a bag' do
-		subject { TaskBag::Bag.new(mocked_queue) }
-
-		it 'should be closed after' do
-			mocked_queue.should_receive(:empty?).and_return true
-			subject.open 0
-			subject.close!
-			subject.should be_closed
-		end
-
-		it 'raises an exception if already closed' do
-			expect { subject.close! }.to raise_error
-		end
-
-		it 'waits for all jobs to be passed to workers before closing' do
-			mocked_queue.should_receive(:empty?).and_return false, false, true
-			subject.open 0
-			subject.close!
-		end
-
-		context 'a full bag' do
-			subject { TaskBag::Bag.new }
-			it 'waits for every worker to finish before it closes' do
-				finished = 0
-				job = double('job')
-				job.stub :run do
-					sleep 0.5
-					finished += 1
-				end
-				subject.open 2
-				subject.add job
-				subject.add job
-				subject.add job
-				subject.close!
-				finished.should == 3
-			end
-		end
-	end
-
-	it 'execute the jobs in a FIFO fashion' do
-		subject.add 1
-		subject.add 2
-
-		subject.next.should be 1
-		subject.next.should be 2
-		subject.next.should be_nil
-	end
-end
+  let(:mocked_queue) { double('mocked queue', empty?: true) }
+  subject { TaskBag::Bag.new }
+
+  it { should be_closed }
+
+  describe '.open' do
+    subject { TaskBag::Bag.open(5) }
+
+    it { should_not be_closed }
+
+    it 'is opened with the given number of workers' do
+      subject.nworkers.should == 5
+    end
+  end
+
+  describe 'opening a bag' do
+    it 'makes the bag open' do
+      subject.open 0
+      subject.should_not be_closed
+      subject.close!
+    end
+
+    it 'raises an exception if already open' do
+      subject.open 0
+      expect { subject.open(0) }.to raise_error
+    end
+
+    it 'creates the given number of workers in different threads' do
+      TaskBag::Worker.should_receive(:start)
+                     .with(subject)
+                     .exactly(3).times
+                     .and_return 1, 2, 3
+
+      subject.open(3).should have(3).items
+      subject.close!
+    end
+
+    it 'is opened with the given number of workers' do
+      subject.open 10
+      subject.nworkers.should == 10
+    end
+  end
+
+  describe 'closing a bag' do
+    subject { TaskBag::Bag.new(mocked_queue) }
+
+    it 'should be closed after' do
+      mocked_queue.should_receive(:empty?).and_return true
+      subject.open 0
+      subject.close!
+      subject.should be_closed
+    end
+
+    it 'raises an exception if already closed' do
+      expect { subject.close! }.to raise_error
+    end
+
+    it 'waits for all jobs to be passed to workers before closing' do
+      mocked_queue.should_receive(:empty?).and_return false, false, true
+      subject.open 0
+      subject.close!
+    end
+
+    context 'a full bag' do
+      subject { TaskBag::Bag.new }
+      it 'waits for every worker to finish before it closes' do
+        finished = 0
+        job = double('job')
+        job.stub :run do
+          sleep 0.5
+          finished += 1
+        end
+        subject.open 2
+        subject.add job
+        subject.add job
+        subject.add job
+        subject.close!
+        finished.should == 3
+      end
+    end
+  end
+
+  it 'execute the jobs in a FIFO fashion' do
+    subject.add 1
+    subject.add 2
+
+    subject.next.should be 1
+    subject.next.should be 2
+    subject.next.should be_nil
+  end
+end

data/spec/taskbag_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe TaskBag do
+  let(:bag) { double('task bag') }
+  around {|example| TaskBag.work(10, &example)}
+
+  describe '.work' do
+    it 'opens a bag with the given number of workers' do
+      allow(bag).to receive(:close!)
+      expect(TaskBag::Bag).to receive(:open).with(10) { bag }
+
+      TaskBag.work(10) do |b|
+        expect(b).to be bag
+      end
+    end
+
+    it 'closes the bag after it is done with the given block' do
+      allow(TaskBag::Bag).to receive(:open).and_return(bag)
+      TaskBag.work(10) do |b|
+        # This will guarantee that the close! method will only
+        # be called after this block is completed
+        expect(bag).to receive(:close!)
+      end
+    end
+  end
+end

metadata

@@ -1,62 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: taskbag
 version: !ruby/object:Gem::Version
-  version: 2.0.0
-  prerelease: 
+  version: 2.1.0
 platform: ruby
 authors:
 - Carlos Palhares
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-06 00:00:00.000000000 Z
+date: 2014-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: A simplistic task of bags implementation for multithreaded scripts
@@ -65,7 +58,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -76,34 +70,35 @@ files:
 - lib/taskbag/worker.rb
 - spec/bag_spec.rb
 - spec/spec_helper.rb
+- spec/taskbag_spec.rb
 - spec/worker_spec.rb
 - taskbag.gemspec
 homepage: https://github.com/xjunior/taskbag
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A simplistic task of bags implementation for multithreaded scripts
 test_files:
 - spec/bag_spec.rb
 - spec/spec_helper.rb
+- spec/taskbag_spec.rb
 - spec/worker_spec.rb