batchr 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rvmrc

@@ -0,0 +1,7 @@
+# if you're using system, let's use 1.9.2. Otherwise, leave the ruby alone
+[[ `rvm tools identifier` == 'system' ]] && rvm use 1.9.2
+
+# create idkfa gemset if necessary
+(rvm gemset list | grep batchr &> /dev/null) || rvm gemset create batchr
+
+rvm gemset use batchr

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/README.md

@@ -0,0 +1,41 @@
+Batchr
+======
+
+Installation
+------------
+
+### With Bundler
+
+    gem 'batchr'
+
+### With Only Rubygems
+
+    $ gem install batchr
+
+Usage
+-----
+
+    class Receiver
+      def self.message objects = []
+        # your code do deal with a "batch" of objects
+      end
+    end
+
+    Batchr.batch(Receiver, :message) do |batchr|
+      # batchr.batch_size = 400 (default)
+      1_000_000.times do
+        batchr << rand
+      end
+    end
+
+Contributing
+------------
+
+Want to contribute? Great!
+
+1. Fork it.
+1. Create a branch (git checkout -b my_feature).
+1. Commit your changes (git commit -am "Added Awesomeness").
+1. Push to the branch (git push origin my_feature).
+1. Create an Issue with a link to your branch.
+1. Enjoy a refreshing beverage of your choice and wait.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/batchr.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "batchr/version"
+
+Gem::Specification.new do |s|
+  s.name        = "batchr"
+  s.version     = Batchr::VERSION
+  s.authors     = ["Bradley Grzesiak"]
+  s.email       = ["brad@bendyworks.com"]
+  s.homepage    = ""
+  s.summary     = %q{Batching library for ruby}
+  s.description = %q{Perfect for batching operations over long enumerables}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec,features}/*`.split("\n")
+  s.executables   = [] # `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec"
+end

data/lib/batchr.rb

@@ -0,0 +1,45 @@
+class Batchr
+
+  attr_reader :batch_size, :bucket
+  attr_accessor :receiver, :message
+
+  def self.batch receiver, message
+    batchr = new
+    batchr.receiver = receiver
+    batchr.message = message
+    yield batchr
+    batchr.finish
+  end
+
+  def initialize opts = {}
+    @batch_size = opts[:batch_size] ? opts[:batch_size] : 400
+    @bucket = []
+  end
+
+  def batch_size= value
+    @batch_size = value
+    run_if_necessary
+  end
+
+  def << value
+    @bucket << value
+    run_if_necessary
+  end
+
+  def run_if_necessary
+    run_batch if @bucket.size >= @batch_size
+  end
+
+  def empty_bucket
+    @bucket = []
+  end
+
+  def run_batch
+    unless bucket.empty?
+      receiver.send(message, bucket)
+      empty_bucket
+    end
+  end
+  alias_method :finish, :run_batch
+
+end

data/lib/batchr/version.rb

@@ -0,0 +1,3 @@
+class Batchr
+  VERSION = "0.1.0"
+end

data/spec/batchr_spec.rb

@@ -0,0 +1,132 @@
+require 'rspec'
+require_relative '../lib/batchr'
+
+class Receiver
+  def self.message batch
+  end
+end
+
+describe Batchr do
+  describe '.batch' do
+
+    it 'yields an instance of Batchr' do
+      Batchr.batch(Receiver, :message) do |b|
+        b.stub(:finish)
+        b.should be_a(Batchr)
+      end
+    end
+
+    it 'calls finish at the end of the block' do
+      Batchr.batch(Receiver, :message) do |b|
+        b.should_receive(:finish)
+      end
+    end
+
+  end
+
+  describe '#initialize' do
+    context 'with batch_size opt' do
+      it 'sets the batch_size' do
+        Batchr.new(batch_size: 3).batch_size.should == 3
+      end
+    end
+  end
+
+  describe '#batch_size=' do
+    let(:batchr) { Batchr.new }
+    it 'sets the batch size' do
+      batchr.stub(:run_if_necessary)
+      batchr.batch_size = 2
+      batchr.batch_size.should == 2
+    end
+    it 'calls run_if_necessary' do
+      batchr.should_receive(:run_if_necessary).once
+      batchr.batch_size = 2
+    end
+  end
+
+  describe '#<<' do
+    let(:batchr) { Batchr.new }
+    it 'adds the element to the bucket' do
+      batchr << :a
+      batchr.bucket.should == [:a]
+    end
+    it 'calls run_if_necessary' do
+      batchr.should_receive(:run_if_necessary)
+      batchr << :foo
+    end
+  end
+
+  describe '#run_if_necessary' do
+    let(:batchr) { Batchr.new(batch_size: 1) }
+    after { batchr.run_if_necessary }
+
+    context 'buffered size is greater than batch_size' do
+      it 'calls run_batch' do
+        batchr.should_receive(:run_batch)
+        batchr.instance_variable_set("@bucket", [:foo, :bar])
+      end
+    end
+
+    context 'buffered size is equal to batch_size' do
+      it 'calls run_batch' do
+        batchr.should_receive(:run_batch)
+        batchr.instance_variable_set("@bucket", [:foo])
+      end
+    end
+
+    context 'buffered size is less than batch_size' do
+      it 'does not call run_batch' do
+        batchr.should_not_receive(:run_batch)
+      end
+    end
+
+  end
+
+  describe '#run_batch' do
+    let(:batchr) { Batchr.new }
+    before do
+      batchr.receiver, batchr.message = Receiver, :message
+      batchr.bucket.stub(empty?: empty_bucket)
+    end
+    context 'when bucket has something' do
+      let(:empty_bucket) { false }
+      it 'calls message on reciever with the bucket as an arg' do
+        Receiver.should_receive(:message).with(batchr.bucket)
+        batchr.run_batch
+      end
+      it 'empties the bucket' do
+        batchr.run_batch
+        batchr.bucket.should == []
+      end
+    end
+    context 'when bucket is empty' do
+      let(:empty_bucket) { true }
+      it 'does not call message on receiver' do
+        Receiver.should_not_receive(:message)
+        batchr.run_batch
+      end
+    end
+  end
+
+  example 'batch_size = 2, elements = 2' do
+    Receiver.should_receive(:message).with([:a, :b]).once
+    Batchr.batch(Receiver, :message) do |batchr|
+      batchr.batch_size = 2
+      batchr << :a
+      batchr << :b
+      batchr.bucket.should == []
+    end
+  end
+
+  example 'batch_size = 3, elements = 2' do
+    Receiver.should_receive(:message).with([:a, :b]).once
+    Batchr.batch(Receiver, :message) do |batchr|
+      batchr.batch_size = 3
+      batchr << :a
+      batchr << :b
+      batchr.bucket.should == [:a, :b]
+    end
+  end
+
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: batchr
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Bradley Grzesiak
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-28 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Perfect for batching operations over long enumerables
+email: 
+- brad@bendyworks.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- README.md
+- Rakefile
+- batchr.gemspec
+- lib/batchr.rb
+- lib/batchr/version.rb
+- spec/batchr_spec.rb
+homepage: ""
+licenses: []
+
+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.3
+signing_key: 
+specification_version: 3
+summary: Batching library for ruby
+test_files: 
+- spec/batchr_spec.rb