batch_insert 0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Shaun Mangelsdorf
+
+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.md

@@ -0,0 +1,53 @@
+Batch Insert
+============
+
+This plugin adds batch insertion capabilities to ActiveRecord model classes.
+
+The API is very similar to the standard `new` and `create` functions provided
+by ActiveRecord, but will not return a saved object to the caller.
+
+
+Example
+=======
+
+Previously:
+-----------
+
+	100.times { ModelClass.create! :name => 'Test', :description => 'An example object being created.' }
+
+Now:
+----
+
+	ModelClass.batch_insert do
+		100.times { ModelClass.insert :name => 'Test', :description => 'An example object being created.' }
+	end
+
+Batch insertions return the same result as new()
+------------------------------------------------
+
+	ModelClass.batch_insert do
+		args = {:name => 'Test', :description => 'An example object being created.'}
+
+		ModelClass.insert(args)					# ModelClass instance
+		ModelClass.insert(args).new_record?		# true
+		ModelClass.insert(args).id				# nil
+	end		# The insertion is done at this point in the code.
+
+Invalid objects will immediately cause an exception
+---------------------------------------------------
+
+	ModelClass.batch_insert do
+		invalid_args = {}
+		ModelClass.insert(invalid_args)			# Exception!
+	end
+
+Constraint violations will cause an exception when the batch is inserted
+------------------------------------------------------------------------
+
+	ModelClass.batch_insert do
+		conflict = {:unique_value => 'Collide!'}
+		ModelClass.insert(args)
+		ModelClass.insert(args)
+	end		# Exception!
+
+Copyright (c) 2010 Shaun Mangelsdorf, released under the MIT license

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rake'
+require 'spec/rake/spectask'
+
+require 'rubygems'
+require 'rake/gempackagetask'
+
+PKG_FILES = FileList[
+  '[a-zA-Z]*',
+  'generators/**/*',
+  'lib/**/*',
+  'rails/**/*',
+  'spec/**/*'
+]
+
+spec = Gem::Specification.new do |s|
+  s.name = 'batch_insert'
+  s.version = '0.1'
+  s.author = 'Shaun Mangelsdorf'
+  s.email = 's.mangelsdorf@gmail.com'
+  s.homepage = 'http://smangelsdorf.github.com'
+  s.platform = Gem::Platform::RUBY
+  s.summary = 'Extends ActiveRecord to provide batch insertion capabilities'
+  s.files = PKG_FILES.to_a
+  s.require_path = 'lib'
+  s.has_rdoc = false
+  s.extra_rdoc_files = ['README.md']
+  s.rubyforge_project = 'batch_insert'
+  s.description = <<EOF
+Adds batch insertion capabilities to ActiveRecord model classes.
+EOF
+end
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc 'Run the specs'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--colour --format progress --loadby mtime --reverse']
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+desc 'Turn this plugin into a gem.'
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+

data/init.rb

@@ -0,0 +1 @@
+ActiveRecord::Base.send :include, ActiveRecord::BatchInsert

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/batch_insert.rb

@@ -0,0 +1,41 @@
+# Released under the MIT license. See the MIT-LICENSE file for details
+module ActiveRecord
+  module BatchInsert
+    def self.included(base)
+      base.class_inheritable_accessor :batched_inserts
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def batch_insert
+        self.batched_inserts = returning(batched_inserts) do
+          self.batched_inserts = []
+          yield
+
+          unless self.batched_inserts.empty?
+            column_names = columns.map(&:name).sort - [primary_key]
+            connection.execute %Q{
+              INSERT INTO #{connection.quote_table_name(table_name)}
+              (#{column_names.map{|n| connection.quote_column_name(n)}.join(',')})
+              VALUES
+              #{batch_insert_values_string(column_names)}
+            }.gsub(/\s+/,' ').squeeze(' ').strip
+          end
+        end
+      end
+
+      def batch_insert_values_string(column_names)
+        self.batched_inserts.collect do |attributes|
+          "(#{column_names.map{|n| attributes[n]}.collect{|v|quote_value(v)}.join(',')})"
+        end.join ','
+      end
+
+      def insert(opts={})
+        returning new(opts) do |obj|
+          raise RecordInvalid.new(obj) unless obj.valid?
+          self.batched_inserts << obj.attributes
+        end
+      end
+    end
+  end
+end

data/lib/tasks/batch_insert.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :batch_insert do
+#   # Task goes here
+# end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: batch_insert
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Shaun Mangelsdorf
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-10 00:00:00 +10:00
+default_executable: 
+dependencies: []
+
+description: |
+  Adds batch insertion capabilities to ActiveRecord model classes.
+
+email: s.mangelsdorf@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- uninstall.rb
+- init.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+- install.rb
+- lib/batch_insert.rb
+- lib/tasks/batch_insert.rake
+has_rdoc: true
+homepage: http://smangelsdorf.github.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: batch_insert
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Extends ActiveRecord to provide batch insertion capabilities
+test_files: []
+