parallel_batch 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in parallel_batch.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Alexis Bernard
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,9 @@
+ParallelBatch runs concurrent batches on tables with huge amount of rows.
+
+To Contribute:
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/parallel_batch.rb

@@ -0,0 +1,72 @@
+# encoding: utf-8
+
+class ParallelBatch < ActiveRecord::Base
+
+  #################
+  ### Constants ###
+  #################
+
+  VERSION = "0.0.1"
+
+  #####################
+  ### Class methods ###
+  #####################
+
+  def self.find_or_create!
+    first || create!(offset: 0)
+  # When starting many batches at the same time we are pretty sure to get a MySQL
+  # error reporting a duplicated entry. That's why we are retrying one time only.
+  rescue ActiveRecord::StatementInvalid
+    first || create!(offset: 0)
+  end
+
+  def self.start(concurrency = 1)
+    concurrency.times { fork { start_fork } }
+  end
+
+  def self.start_fork
+    puts "#{self} has started with pid #{Process.pid}"
+    ActiveRecord::Base.connection.reconnect!
+    find_or_create!.run
+  end
+
+  def self.reset
+    find_or_create!.update_attributes!(offset: null)
+  end
+
+  ########################
+  ### Instance methods ###
+  ########################
+
+  def find_records
+    offset ? scope.where('id > ?', offset).order(:id).limit(batch_size) : scope.order(:id).limit(batch_size)
+  end
+
+  def next_batch
+    transaction do
+      reload(lock: true)
+      next unless (records = find_records).last
+      update_attributes!(offset: records.last.id)
+      records
+    end
+  end
+
+  def run
+    while records = next_batch
+      records.each { |record| perform(record) }
+    end
+  end
+
+  def perfom(record)
+    raise NotImplementedError, 'You must override this method to perform your batch.'
+  end
+
+  def scope
+    raise NotImplementedError, 'You must override this method to scope your records.'
+  end
+
+  def batch_size
+    1000
+  end
+  
+end

data/parallel_batch.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/parallel_batch/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Alexis Bernard"]
+  gem.email         = ["alexis@official.com"]
+  gem.description   = "Run safely concurent batches"
+  gem.summary       = "Run safely concurent batches"
+  gem.homepage      = "https://github.com/officialfm/parallel_batch"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "parallel_batch"
+  gem.require_paths = ["lib"]
+  gem.version       = ParallelBatch::VERSION.dup
+end

data/test/parallel_batch_test.rb

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'test_helper'
+
+class ParallelBatchTest < ActiveSupport::TestCase
+  # Sample batch for testing purposes
+  class SampleBatch < ParallelBatch
+    def perform(record)
+      record.name.upcase! and record.save!
+    end
+  end
+
+  def test_find_or_create_when_batch_does_not_exist
+    ParallelBatch.expects(:first => nil)
+    ParallelBatch.expects(:create! => batch = ParallelBatch.new)
+    assert_equal(batch, ParallelBatch.find_or_create!)
+  end
+
+  def test_find_or_create_when_batch_already_present
+    ParallelBatch.expects(:first => batch = ParallelBatch.new)
+    ParallelBatch.expects(:create!).never
+    assert_equal(batch, ParallelBatch.find_or_create!)
+  end
+
+  def test_find_records
+    (scope = mock).expects(:where).with('id > ?', 2000).returns(where = mock)
+    where.expects(:order).with(:id).returns(order = mock)
+    order.expects(:limit).with(1000).returns([1, 2, 3])
+    batch = ParallelBatch.new(offset: 2000)
+    batch.expects(scope: scope)
+    assert_equal([1, 2, 3], batch.find_records)
+  end
+
+  def test_next_batch
+    batch = SampleBatch.new
+    batch.expects(:reload).with(:lock => true)
+    batch.expects(:find_records => records = [stub(:id => 123)])
+    batch.expects(:update_attributes!).with(:offset => 123)
+    assert_equal(records, batch.next_batch)
+  end
+
+  def test_run
+    batch = SampleBatch.new
+    batch.expects(:perform).with(u = User.new)
+    batch.expects(:next_batch => [u]).in_sequence(run = sequence('run'))
+    batch.expects(:next_batch => nil).in_sequence(run)
+    batch.run
+  end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: parallel_batch
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Alexis Bernard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-17 00:00:00.000000000 Z
+dependencies: []
+description: Run safely concurent batches
+email:
+- alexis@official.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README
+- Rakefile
+- lib/parallel_batch.rb
+- parallel_batch.gemspec
+- test/parallel_batch_test.rb
+homepage: https://github.com/officialfm/parallel_batch
+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.10
+signing_key: 
+specification_version: 3
+summary: Run safely concurent batches
+test_files:
+- test/parallel_batch_test.rb