bulker 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.8.3"
+  gem "rcov", ">= 0"
+  gem "sqlite3"
+  gem "activerecord"
+end

data/Gemfile.lock

@@ -0,0 +1,50 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.5)
+      activesupport (= 3.0.5)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.5)
+    arel (2.0.9)
+    builder (2.1.2)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    i18n (0.5.0)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.6.5)
+    rake (0.9.2.2)
+    rcov (0.9.10)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    sqlite3 (1.3.3)
+    tzinfo (0.3.24)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  bundler (~> 1.0.0)
+  jeweler (~> 1.8.3)
+  rcov
+  rdoc (~> 3.12)
+  rspec (~> 2.8.0)
+  sqlite3

data/README.md

@@ -0,0 +1,96 @@
+bulker
+========================
+
+*bulker* is library that privides bulk execution functionality for paging and buffering.
+*bulker* provides *Bulker::Pager* and *Bulker::Buffer*.  
+
+ *Bulker::Pager* gives you paging functionality to split large number of data to devided segments. When 1000,000 records in your database, and you're going to do some process for each record, *Bulker::Pager* will help you. It can handle large data very easily such like array with *each* method.
+
+*Bulker::Buffer* provides simple buffer that enables implimenting bulk insert or bulk upload behavior.
+
+## Installation
+
+Install bulker with RubyGems
+
+    $ gem install bulker
+
+or add this to your Gemfile if you use Bundler:
+
+    $ gem "bulker"
+
+## Usage
+### Bulker::Pager
+
+*Bulker::Pager* is especially designed for ActiveRecord. For other data source, *Bulker::Criteria* provides interface for *Bulker::Pager*.
+
+#### Working with ActiveRecord
+
+If you have large records in *items* table and want to process each item, then:
+
+    require 'bulker'
+    class Item < ActiveRecord::Base; end
+    Bulker::Pager.each(Item.where(:status => "selling"), 100) do
+      # do some process for each item
+    end
+
+This sample, *Bulker::Pager* fetches 100 items for each sql query, and continues fetching until all records are covered. Block that given to *each* method is called for each record.
+
+#### Working with Criteria
+
+When you use library other than ActiveRecord for accessing data soruce, you can use *Bulker::Criteria*.
+
+    require 'bulker'
+    data = (1..20).to_a
+    criteria = Bulker::Criteria.new data
+    criteria.define_each lambda { |values, offset, limit, block|
+      values[offset..(offset + limit - 1)].each do |v|
+        block.call(v)
+      end
+    }
+    Bulker::Pager.each(criteria, 10) do |v|
+      #  do some process
+    end
+
+Wrap your data objects with *Bulker::Criteria*, and define behavior of *each* method through *define_each* using lambda. Then Bulker::Pager can work with the criteria.
+
+By default, same *each* implementation for array as above is bundled in *Bulker::Criteria* as *from_array*.
+
+    criteria = Bulker::Criteria.from_array([1, 2, 3, 4, 5])
+
+### Bulker::Buffer
+
+It's easy to understand *Bulker::Buffer* behavior through seeing our RSPEC.
+
+    require 'bulker'
+    result = []
+    # create buffer with size = 4
+    buffer = Bulker::Buffer.new(4) do |ary|
+      result << ary # when buffer filled
+    end
+    (1..10).each do |i|
+      buffer << i
+    end
+    buffer.flush
+    result.should == [
+      [1, 2, 3, 4],
+      [5, 6, 7, 8],
+      [9, 10]
+    ]
+
+## Contributing to bulker
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+
+## License
+bulker is released under the MIT license.
+
+## Copyright
+Copyright (c) 2012 daisuke sugimori. 
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "bulker"
+  gem.homepage = "http://github.com/daixque/bulker"
+  gem.license = "MIT"
+  gem.summary = %Q{bulk execution library.}
+  gem.description = %Q{bulker is library that privides bulk execution functionality for paging and buffering.}
+  gem.email = "daixque@gmail.com"
+  gem.authors = ["daixque"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "bulker #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bulker.gemspec

@@ -0,0 +1,72 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{bulker}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{daixque}]
+  s.date = %q{2012-02-05}
+  s.description = %q{bulker is library that privides bulk execution functionality for paging and buffering.}
+  s.email = %q{daixque@gmail.com}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "bulker.gemspec",
+    "lib/bulker.rb",
+    "lib/bulker/buffer.rb",
+    "lib/bulker/criteria.rb",
+    "lib/bulker/pager.rb",
+    "spec/buffer_spec.rb",
+    "spec/criteria_spec.rb",
+    "spec/pager_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/daixque/bulker}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.6}
+  s.summary = %q{bulk execution library.}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<sqlite3>, [">= 0"])
+      s.add_development_dependency(%q<activerecord>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<sqlite3>, [">= 0"])
+      s.add_dependency(%q<activerecord>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<sqlite3>, [">= 0"])
+    s.add_dependency(%q<activerecord>, [">= 0"])
+  end
+end
+

data/lib/bulker.rb

@@ -0,0 +1,14 @@
+require 'bulker/buffer'
+require 'bulker/pager'
+require 'bulker/criteria'
+
+# *bulker* provides Bulker::Pager and Bulker::Buffer.  
+#
+# Bulker::Pager gives you paging functionality to split large number of data to devided segments.
+# When 1000,000 records in your database, and you're going to do some process for each record,
+# Bulker::Pager will help you.
+# It can handle large data very easily such like array with Bulker::Pager#each method.
+#
+# Bulker::Buffer provides simple buffer that enables implimenting bulk insert or bulk upload behavior.
+module Bulker
+end

data/lib/bulker/buffer.rb

@@ -0,0 +1,34 @@
+module Bulker
+  # Bulker::Buffer provides buffer pool and bulk execution functionality.
+  #
+  #   result = []
+  #   buffer = Bulker::Buffer.new(4) do |ary|
+  #     result << ary # when buffer filled
+  #   end
+  #   (1..10).each do |i|
+  #     buffer << i
+  #   end
+  #   buffer.flush
+  #   result #=> [[1, 2, 3, 4], [5, 6, 7, 8], [9, 10]]
+  class Buffer
+    # +size+ specify size of buffer.  
+    # +block+ specify callback on filled buffer.
+    def initialize(size, &block)
+      @size = size
+      @buffer = []
+      @on_buffered = block
+    end
+    
+    # add +obj+ into buffer
+    def << (obj)
+      @buffer << obj
+      flush if @buffer.size == @size
+    end
+    
+    # do bulk execution and clear buffer.
+    def flush
+      @on_buffered.call(@buffer)
+      @buffer = []
+    end
+  end
+end

data/lib/bulker/criteria.rb

@@ -0,0 +1,68 @@
+module Bulker
+  # Bulker::Criteria provides interface for Bulker::Pager.
+  #
+  #  data = (1..20).to_a
+  #  criteria = Bulker::Criteria.new data
+  #  criteria.define_each lambda { |values, offset, limit, block|
+  #    values[offset..(offset + limit - 1)].each do |v|
+  #      block.call(v)
+  #    end
+  #  }
+  #  Bulker::Pager.each(criteria, 10) do |v|
+  #    #  do some process
+  #  end
+  class Criteria
+    
+    class << self
+      # create criteria from +ary+
+      def from_array(ary)
+        criteria = Criteria.new ary
+        criteria.define_each lambda { |values, offset, limit, block|
+          values[offset..(offset + limit - 1)].each do |v|
+            block.call(v)
+          end
+        }
+      end
+    end
+    
+    attr_accessor :values
+    
+    # create criteria with +values+.  
+    # defaults:  
+    # - +offset+ : 0
+    # - +limit+ : 10
+    def initialize(values)
+      @values = values
+      @offset = 0
+      @limit = 10
+    end
+    
+    # set +offset+ to specify offset from head of data.
+    def offset(offset)
+      @offset = offset
+      self
+    end
+    
+    # set +limit+ to specify numbers to fetch data.
+    def limit(limit)
+      @limit = limit
+      self
+    end
+    
+    # get size of +values+.
+    def count
+      @values.size
+    end
+    
+    # set implementation of +each+ by lambda.
+    def define_each(each_proc)
+      @each_proc = each_proc
+      self
+    end
+    
+    # do +block+ for each data
+    def each(&block)
+      @each_proc.call(values, @offset, @limit, block)
+    end
+  end
+end

data/lib/bulker/pager.rb

@@ -0,0 +1,41 @@
+module Bulker
+  # Bulker::Pager provides paging functionality to split large number of data to devided segments.
+  # It can handle large data very easily such like array with each method.
+  #
+  # Bulker::Pager is especially designed for ActiveRecord.
+  #
+  #  class Item < ActiveRecord::Base; end
+  #  Bulker::Pager.each(Item.where(:status => "selling"), 100) do
+  #    # do some process for each item
+  #  end
+  #
+  # For other data source, Bulker::Criteria provides interface for Bulker::Pager.
+  class Pager
+    class << self
+      # access to every +cursor+ data with fetch limitation +limit+.
+      def each(cursor, limit, &block)
+        pager = Pager.new cursor, limit
+        pager.each { |page| block.call(page) }
+      end
+    end
+    
+    # create pager from +cursor+ data and limitaion +limit+
+    def initialize(cursor, limit)
+      raise RangeError.new("limit must be positive number, but #{limit}") if limit <= 0
+      @cursor = cursor
+      @limit = limit
+    end
+    
+    # access to every data.
+    def each(&block)
+      size = @cursor.count
+      pages = size / @limit + (size % @limit == 0 ? 0 : 1)
+      pages.times do |i|
+        offset = i * @limit
+        @cursor.offset(offset).limit(@limit).each do |row|
+          yield row
+        end
+      end
+    end
+  end
+end

data/spec/buffer_spec.rb

@@ -0,0 +1,20 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Bulker" do
+  it "can buffer" do
+    result = []
+    buffer = Bulker::Buffer.new(4) do |ary|
+      result << ary
+    end
+    (1..10).each do |i|
+      buffer << i
+    end
+    buffer.flush
+    
+    result.should == [
+      [1, 2, 3, 4],
+      [5, 6, 7, 8],
+      [9, 10]
+    ]
+  end
+end

data/spec/criteria_spec.rb

@@ -0,0 +1,31 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Criteria" do
+  it "create array criteria with defaut offset and limit" do
+    criteria = Bulker::Criteria.new (1..20).to_a
+    criteria.define_each lambda { |values, offset, limit, block|
+        values[offset..(offset + limit - 1)].each do |v|
+          block.call(v)
+        end
+    }
+    result = []
+    criteria.each do |v|
+      result << v
+    end
+    result.should == (1..10).to_a
+  end
+  
+  it "create array criteria with custom offset and limit" do
+    criteria = Bulker::Criteria.new (1..20).to_a
+    criteria.define_each lambda { |values, offset, limit, block|
+        values[offset..(offset + limit - 1)].each do |v|
+          block.call(v)
+        end
+    }
+    result = []
+    criteria.offset(3).limit(4).each do |v|
+      result << v
+    end
+    result.should == [4, 5, 6, 7]
+  end
+end

data/spec/pager_spec.rb

@@ -0,0 +1,70 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'rubygems'
+require 'sqlite3'
+require 'active_record'
+require 'logger'
+require 'Fileutils'
+
+describe "Pager" do
+  DATABASE_CONFIG = {
+    :adapter  => "sqlite3",
+    :database => ":memory:",
+    :timeout  => 5000
+  }
+  class TestValue < ActiveRecord::Base; end
+  def insert_test_data(size)
+    (1..size).each do |i|
+      TestValue.create(:data => i.hash.to_s)
+    end
+  end
+  before do
+    ActiveRecord::Base.establish_connection DATABASE_CONFIG
+    ActiveRecord::Base.connection.execute "
+      create table if not exists test_values(
+      id INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL,
+      data TEXT)"
+    
+    @size = 20
+    insert_test_data(@size)
+  end
+  
+  describe "Pager#each" do
+    it "can paging" do
+      TestValue.all.count.should == @size
+      #TestValue.should_receive(:offset).exactly(4)
+      pager = Bulker::Pager.new(TestValue, 5)
+      result = []
+      pager.each do |value|
+        result << value
+      end
+      result.map {|v| v.id}.should == (1..@size).to_a
+    end
+    
+    it "raise RangeError when not positive limit given" do
+      lambda {
+        pager = Bulker::Pager.new(TestValue, 0)
+      }.should raise_error(RangeError)
+    end
+  end
+  
+  describe "Pager.each" do
+    it "can paging" do
+      result = []
+      Bulker::Pager.each(TestValue, 3) do |value|
+        result << value
+      end
+      result.map {|v| v.id}.should == (1..@size).to_a
+    end
+  end
+  
+  describe "Pager with Criteria" do
+    it "retrieve pages from array with criteria" do
+      criteria = Bulker::Criteria.from_array (1..10).to_a
+      result = []
+      Bulker::Pager.each(criteria, 3) do |v|
+        result << v
+      end
+      result.should == (1..10).to_a
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'bulker'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: bulker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- daixque
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-05 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2154111900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *2154111900
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &2154111420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: *2154111420
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2154110880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *2154110880
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2154110400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: *2154110400
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &2154109920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2154109920
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &2154109380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2154109380
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &2154108860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2154108860
+description: bulker is library that privides bulk execution functionality for paging
+  and buffering.
+email: daixque@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- VERSION
+- bulker.gemspec
+- lib/bulker.rb
+- lib/bulker/buffer.rb
+- lib/bulker/criteria.rb
+- lib/bulker/pager.rb
+- spec/buffer_spec.rb
+- spec/criteria_spec.rb
+- spec/pager_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/daixque/bulker
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4368483780974676083
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: bulk execution library.
+test_files: []