initial commit

Author: jamis

.gitignore

@@ -0,0 +1,8 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache

Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in bulk_insert.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]
+

Gemfile.lock

@@ -0,0 +1,110 @@
+PATH
+  remote: .
+  specs:
+    bulk_insert (1.0.0)
+      activerecord (~> 4.2.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.2.4)
+      actionpack (= 4.2.4)
+      actionview (= 4.2.4)
+      activejob (= 4.2.4)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.4)
+      actionview (= 4.2.4)
+      activesupport (= 4.2.4)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.4)
+      activesupport (= 4.2.4)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (4.2.4)
+      activesupport (= 4.2.4)
+      globalid (>= 0.3.0)
+    activemodel (4.2.4)
+      activesupport (= 4.2.4)
+      builder (~> 3.1)
+    activerecord (4.2.4)
+      activemodel (= 4.2.4)
+      activesupport (= 4.2.4)
+      arel (~> 6.0)
+    activesupport (4.2.4)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.3)
+    builder (3.2.2)
+    erubis (2.7.0)
+    globalid (0.3.6)
+      activesupport (>= 4.1.0)
+    i18n (0.7.0)
+    json (1.8.3)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    mime-types (2.6.2)
+    mini_portile (0.6.2)
+    minitest (5.8.1)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.4)
+      actionmailer (= 4.2.4)
+      actionpack (= 4.2.4)
+      actionview (= 4.2.4)
+      activejob (= 4.2.4)
+      activemodel (= 4.2.4)
+      activerecord (= 4.2.4)
+      activesupport (= 4.2.4)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.4)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.7)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.2)
+      loofah (~> 2.0)
+    railties (4.2.4)
+      actionpack (= 4.2.4)
+      activesupport (= 4.2.4)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.4.2)
+    sprockets (3.4.0)
+      rack (> 1, < 3)
+    sprockets-rails (2.3.3)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    sqlite3 (1.3.10)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bulk_insert!
+  rails (~> 4.2.2)
+  sqlite3
+
+BUNDLED WITH
+   1.10.6

MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Jamis Buck
+
+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.

README.md

@@ -0,0 +1,96 @@
+# BulkInsert
+
+A little ActiveRecord extension for helping to insert lots of rows in a
+single insert statement.
+
+## Installation
+
+Add it to your Gemfile:
+
+    gem 'bulk_insert'
+
+## Usage
+
+BulkInsert adds a new class method to your ActiveRecord models:
+
+    class Book < ActiveRecord::Base
+    end
+
+    book_attrs = ... # some array of hashes, for instance
+    Book.bulk_insert do |worker|
+      book_attrs.each do |attrs|
+        worker.add(attrs)
+      end
+    end
+
+All of those `#add` calls will be accumulated into a single SQL insert
+statement, vastly improving the performance of multiple sequential
+inserts (think data imports and the like).
+
+By default, the columns to be inserted will be all columns in the table,
+minus the `id` column, but if you want, you can explicitly enumerate
+the columns:
+
+    Book.bulk_insert(:title, :author) do |worker|
+      # specify a row as an array of values...
+      worker.add ["Eye of the World", "Robert Jordan"]
+
+      # or as a hash
+      worker.add title: "Lord of Light", author: "Roger Zelazny"
+    end
+
+It will automatically set created_at/updated_at columns to the current
+date, as well.
+
+    Book.bulk_insert(:title, :author, :created_at, :updated_at) do |worker|
+      # specify created_at/updated_at explicitly...
+      worker.add ["The Chosen", "Chaim Potok", Time.now, Time.now]
+
+      # or let BulkInsert set them by default...
+      worker.add ["Hello Ruby", "Linda Liukas"]
+    end
+
+By default, the batch is always saved when the block finishes, but you
+can explicitly save inside the block whenever you want, by calling
+`#save!` on the worker:
+
+    Book.bulk_insert do |worker|
+      worker.add(...)
+      worker.add(...)
+
+      worker.save!
+
+      worker.add(...)
+      #...
+    end
+
+That will save the batch as it has been defined to that point, and then
+empty the batch so that you can add more rows to it if you want.
+
+
+### Batch Set Size
+
+By default, the size of the insert is limited to 500 rows at a time.
+This is called the _set size_. If you add another row that causes the
+set to exceed the set size, the insert statement is automatically built
+and executed, and the batch is reset.
+
+If you want a larger (or smaller) set size, you can specify it in
+two ways:
+
+    # specify set_size when initializing the bulk insert...
+    Book.bulk_insert(set_size: 100) do |worker|
+      # ...
+    end
+
+    # specify it on the worker directly...
+    Book.bulk_insert do |worker|
+      worker.set_size = 100
+      # ...
+    end
+
+
+## License
+
+BulkInsert is released under the MIT license (see MIT-LICENSE) by
+Jamis Buck ([email protected]).

Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'BulkInsert'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

bulk_insert.gemspec

@@ -0,0 +1,24 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "bulk_insert/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "bulk_insert"
+  s.version     = BulkInsert::VERSION
+  s.authors     = ["Jamis Buck"]
+  s.email       = ["[email protected]"]
+  s.homepage    = "http://github.com/jamis/bulk_insert"
+  s.summary     = "An helper for doing batch (single-statement) inserts in ActiveRecord"
+  s.description = "Faster inserts! Insert N records in a single statement."
+  s.license     = "MIT"
+
+  s.files = Dir["{app,config,db,lib}/**/*", "MIT-LICENSE", "Rakefile", "README.md"]
+  s.test_files = Dir["test/**/*"]
+
+  s.add_dependency "activerecord", "~> 4.2.2"
+
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "rails", "~> 4.2.2"
+end

lib/bulk_insert.rb

@@ -0,0 +1,24 @@
+require 'bulk_insert/worker'
+
+module BulkInsert
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def bulk_insert(*columns, set_size:500)
+      columns = self.column_names - %w(id) if columns.empty?
+      worker = BulkInsert::Worker.new(connection, table_name, columns, set_size)
+
+      if block_given?
+        transaction do
+          yield worker
+          worker.save!
+        end
+        self
+      else
+        worker
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, BulkInsert

lib/bulk_insert/version.rb

@@ -0,0 +1,7 @@
+module BulkInsert
+  MAJOR = 1
+  MINOR = 0
+  TINY  = 0
+
+  VERSION = [MAJOR, MINOR, TINY].join(".")
+end