bulk_data_methods 1.0.0 → 1.1.0

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+bundler_args: --without debug
+rvm:
+  - 1.9.3
+before_script:
+  - cp spec/dummy/config/database-sample.yml spec/dummy/config/database.yml; createdb bulk_data_methods_test
+script: bundle exec rake spec

data/Gemfile

@@ -1,4 +1,10 @@
 source 'https://rubygems.org'
 
+# NOTE(ahannon) Travis CI kindly requests that the debugger be split
+# out so that it does not install linecache during "bundle install":
+group :debug do 
+  gem 'debugger'
+end
+
 # Specify your gem's dependencies in bulk_data_methods.gemspec
 gemspec

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2012, Fiksu, Inc.
+Copyright (c) 2010-2013, Fiksu, Inc.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/README.md

@@ -0,0 +1,91 @@
+bulk_data_methods
+==================
+MixIn used to extend ActiveRecord::Base classes implementing bulk insert and update operations
+through {#create_many} and {#update_many}.
+
+Examples
+========
+
+```ruby
+class Company < ActiveRecord::Base
+  extend BulkMethodsMixin
+end
+```
+__________________________
+BULK creation of many rows:
+
+example no options used
+
+```ruby
+rows = [
+           { :name => 'Keith', :salary => 1000 },
+           { :name => 'Alex', :salary => 2000 }
+       ]
+Employee.create_many(rows)
+```
+
+example with :returning option to returns key value
+
+```ruby
+rows = [
+           { :name => 'Keith', :salary => 1000 },
+           { :name => 'Alex', :salary => 2000 }
+       ]
+options = { :returning => [:id] }
+Employee.create_many(rows, options)
+```
+
+example with :slice_size option (will generate two insert queries)
+
+```ruby
+rows = [
+           { :name => 'Keith', :salary => 1000 },
+           { :name => 'Alex', :salary => 2000 },
+           { :name => 'Mark', :salary => 3000 }
+     ]
+options = { :slice_size => 2 }
+Employee.create_many(rows, options)
+```
+
+_________________________
+BULK updates of many rows:
+
+example using "set_array" to add the value of "salary" to the specific
+employee's salary the default where clause matches IDs so, it works
+here.
+
+```ruby
+rows = [
+           { :id => 1, :salary => 1000 },
+           { :id => 10, :salary => 2000 },
+           { :id => 23, :salary => 2500 }
+     ]
+options = { :set_array => '"salary = datatable.salary"' }
+Employee.update_many(rows, options)
+```
+
+example using where clause to only update salaries that haven't already been updated (forced exampled).
+
+```ruby
+rows = [
+           { :id => 1, :salary => 1000, :company_id => 10 },
+           { :id => 10, :salary => 2000, :company_id => 12 },
+           { :id => 23, :salary => 2500, :company_id => 5 }
+     ]
+options = {
+     :set_array => '"salary = datatable.salary"',
+     :where_datatable => '"#{table_name}.salary <> datatable.salary"'
+          }
+  Employee.update_many(rows, options)
+```
+
+  example setting where clause to the KEY of the hash passed in and the set_array is generated from the VALUES
+
+```ruby
+rows = {
+           { :id => 1 } => { :salary => 100000, :company_id => 10 },
+           { :id => 10 } => { :salary => 110000, :company_id => 12 },
+           { :id => 23 } => { :salary => 90000, :company_id => 5 }
+     }
+Employee.update_many(rows)
+```

data/Rakefile

@@ -1 +1,10 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+  spec.ruby_opts="-w"
+end
+
+task :default => :spec

data/bulk_data_methods.gemspec

@@ -5,7 +5,7 @@ Gem::Specification.new do |s|
   s.name         = "bulk_data_methods"
   s.version      = BulkDataMethods::VERSION
   s.license      = 'New BSD License'
-  s.date         = '2012-09-21'
+  s.date         = '2013-05-30'
   s.summary      = 'MixIn used to extend ActiveRecord::Base classes implementing bulk insert and update operations through {#create_many} and {#update_many}.'
   s.description  = 'MixIn used to extend ActiveRecord::Base classes implementing bulk insert and update operations through {#create_many} and {#update_many}.'
   s.authors      = ["Keith Gabryelski"]
@@ -17,4 +17,4 @@ Gem::Specification.new do |s|
   s.add_dependency "pg"
   s.add_dependency "rails", '>= 3.0.0'
   s.add_dependency 'rspec-rails'
-end
+end

data/lib/bulk_data_methods/bulk_methods_mixin.rb

@@ -113,12 +113,14 @@ module BulkMethodsMixin
   # @overload update_many(rows = [], options = {})
   #   @param [Array<Hash>] rows ([]) data to be updated
   #   @option options [String] :set_array (built from first row passed in) the set clause
-  #   @option options [String] :where ('"#{table_name}.id = datatable.id"') the where clause
+  #   @option options [String] :where_datatable ('"#{table_name}.id = datatable.id"') the where clause specifying how to join the datatable against the real table
+  #   @option options [String] :where_constraint the rest of the where clause that limits what rows of the table get updated
   #
   # @overload update_many(rows = {}, options = {})
   #   @param [Hash<Hash, Hash>] rows ({}) data to be updated
   #   @option options [String] :set_array (built from the values in the first key/value pair of `rows`) the set clause
-  #   @option options [String] :where (built from the keys in the first key/value pair of `rows`) the where clause
+  #   @option options [String] :where_datatable ('"#{table_name}.id = datatable.id"') the where clause specifying how to join the datatable against the real table
+  #   @option options [String] :where_constraint the rest of the where clause that limits what rows of the table get updated
   #
   # @example using "set_array" to add the value of "salary" to the specific employee's salary the default where clause matches IDs so, it works here.
   #   rows = [
@@ -129,15 +131,27 @@ module BulkMethodsMixin
   #   options = { :set_array => '"salary = datatable.salary"' }
   #   Employee.update_many(rows, options)
   #
-  # @example using where clause to match salary.
+  # @example using where_datatable clause to match salary.
   #   rows = [
   #     { :id => 1, :salary => 1000, :company_id => 10 },
   #     { :id => 10, :salary => 2000, :company_id => 12 },
   #     { :id => 23, :salary => 2500, :company_id => 5 }
   #   ]
   #   options = {
-  #     :set_array => '"company_id = datatable.company_id"',
-  #     :where => '"#{table_name}.salary = datatable.salary"'
+  #     :set_array => '"salary = datatable.salary"',
+  #     :where_constraint => '"#{table_name}.salary <> datatable.salary"'
+  #   }
+  #   Employee.update_many(rows, options)
+  #
+  # @example using where_constraint clause to only update salary for active employees
+  #   rows = [
+  #     { :id => 1, :salary => 1000, :company_id => 10 },
+  #     { :id => 10, :salary => 2000, :company_id => 12 },
+  #     { :id => 23, :salary => 2500, :company_id => 5 }
+  #   ]
+  #   options = {
+  #     :set_array => '"salary = datatable.salary"',
+  #     :where_constraint => '"#{table_name}.active = true"'
   #   }
   #   Employee.update_many(rows, options)
   #
@@ -155,7 +169,7 @@ module BulkMethodsMixin
   def update_many(rows, options = {})
     return [] if rows.blank?
     if rows.is_a?(Hash)
-      options[:where] = '"' + rows.keys[0].keys.map{|key| '#{table_name}.' + "#{key} = datatable.#{key}"}.join(' and ') + '"'
+      options[:where_datatable] = '"' + rows.keys[0].keys.map{|key| '#{table_name}.' + "#{key} = datatable.#{key}"}.join(' and ') + '"'
       options[:set_array] = '"' + rows.values[0].keys.map{|key| "#{key} = datatable.#{key}"}.join(',') + '"' unless options[:set_array]
       r = []
       rows.each do |key,value|
@@ -166,8 +180,8 @@ module BulkMethodsMixin
     unless options[:set_array]
       column_names =  rows[0].keys
       columns_to_remove = [:id]
-      columns_to_remove += [partition_keys].map{|k| k.to_sym} if respond_to?(:partition_keys)
-      options[:set_array] = '"' + (column_names - columns_to_remove.flatten).map{|cn| "#{cn} = datatable.#{cn}"}.join(',') + '"'
+      columns_to_remove += partition_keys.flatten.map{|k| k.to_sym} if respond_to?(:partition_keys)
+      options[:set_array] = '"' + (column_names - columns_to_remove).map{|cn| "#{cn} = datatable.#{cn}"}.join(',') + '"'
     end
     options[:slice_size] = 1000 unless options[:slice_size]
     options[:check_consistency] = true unless options.has_key?(:check_consistency)
@@ -180,8 +194,11 @@ module BulkMethodsMixin
       end
       returning_clause = "\" returning #{returning_list}\""
     end
-    options[:where] = '"#{table_name}.id = datatable.id"' unless options[:where]
-
+    where_clause = options[:where_datatable] || '"#{table_name}.id = datatable.id"'
+    where_constraint = ""
+    if options[:where_constraint]
+      where_constraint = " AND #{eval(options[:where_constraint])}"
+    end
     returning = []
 
     rows.group_by do |row|
@@ -217,7 +234,8 @@ module BulkMethodsMixin
             #{datatable}
           ) as datatable
           where
-            #{eval(options[:where])}
+            #{eval(where_clause)}
+            #{where_constraint}
           #{eval(returning_clause)}
         SQL
         returning += find_by_sql(sql_update_string)

data/lib/bulk_data_methods/version.rb

@@ -1,3 +1,3 @@
 module BulkDataMethods
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/spec/bulk_data_methods/bulk_methods_mixin_spec.rb

@@ -346,15 +346,18 @@ describe "BulkMethodsMixin" do
       end
     end # when update method with options :set_array equal 'salary = datatable.salary'
 
-    context "when update method with options :where" do
+    context "when update method with options :where_constraint" do
       it "updates only name column, where salary equal input values" do
         Employee.update_many([{ :id => 1, :name => 'Elvis', :salary => 12 },
-                              { :id => 2, :name => 'Freddi',:salary => 22}],
-                              { :where => '"#{table_name}.salary = datatable.salary"' })
+                              { :id => 2, :name => 'Freddi',:salary => 22},
+                              { :id => 3, :name => 'Robert', :salary => 13}],
+                              { :where_constraint => '"#{table_name}.salary = datatable.salary AND datatable.salary < 13"' })
         Employee.find(1).name.should_not == "Elvis"
         Employee.find(1).salary.should == 3
         Employee.find(2).name.should_not == "Freddi"
         Employee.find(2).salary.should == 3
+        Employee.find(3).name.should_not == "Robert"
+        Employee.find(3).salary.should == 3
       end
     end # when update method with options :where
 
@@ -433,4 +436,4 @@ describe "BulkMethodsMixin" do
 
   end # update_many
 
-end # BulkMethodsMixin
+end # BulkMethodsMixin

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bulk_data_methods
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-21 00:00:00.000000000 Z
+date: 2013-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -68,10 +68,10 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
-- Gemfile.lock
 - LICENSE
-- README
+- README.md
 - Rakefile
 - bulk_data_methods.gemspec
 - lib/bulk_data_methods.rb
@@ -132,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: MixIn used to extend ActiveRecord::Base classes implementing bulk insert

data/Gemfile.lock

@@ -1,108 +0,0 @@
-PATH
-  remote: .
-  specs:
-    bulk_data_methods (1.0.0)
-      pg
-      rails (>= 3.0.0)
-      rspec-rails
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actionmailer (3.2.8)
-      actionpack (= 3.2.8)
-      mail (~> 2.4.4)
-    actionpack (3.2.8)
-      activemodel (= 3.2.8)
-      activesupport (= 3.2.8)
-      builder (~> 3.0.0)
-      erubis (~> 2.7.0)
-      journey (~> 1.0.4)
-      rack (~> 1.4.0)
-      rack-cache (~> 1.2)
-      rack-test (~> 0.6.1)
-      sprockets (~> 2.1.3)
-    activemodel (3.2.8)
-      activesupport (= 3.2.8)
-      builder (~> 3.0.0)
-    activerecord (3.2.8)
-      activemodel (= 3.2.8)
-      activesupport (= 3.2.8)
-      arel (~> 3.0.2)
-      tzinfo (~> 0.3.29)
-    activeresource (3.2.8)
-      activemodel (= 3.2.8)
-      activesupport (= 3.2.8)
-    activesupport (3.2.8)
-      i18n (~> 0.6)
-      multi_json (~> 1.0)
-    arel (3.0.2)
-    builder (3.0.3)
-    diff-lcs (1.1.3)
-    erubis (2.7.0)
-    hike (1.2.1)
-    i18n (0.6.1)
-    journey (1.0.4)
-    json (1.7.5)
-    mail (2.4.4)
-      i18n (>= 0.4.0)
-      mime-types (~> 1.16)
-      treetop (~> 1.4.8)
-    mime-types (1.19)
-    multi_json (1.3.6)
-    pg (0.14.1)
-    polyglot (0.3.3)
-    rack (1.4.1)
-    rack-cache (1.2)
-      rack (>= 0.4)
-    rack-ssl (1.3.2)
-      rack
-    rack-test (0.6.1)
-      rack (>= 1.0)
-    rails (3.2.8)
-      actionmailer (= 3.2.8)
-      actionpack (= 3.2.8)
-      activerecord (= 3.2.8)
-      activeresource (= 3.2.8)
-      activesupport (= 3.2.8)
-      bundler (~> 1.0)
-      railties (= 3.2.8)
-    railties (3.2.8)
-      actionpack (= 3.2.8)
-      activesupport (= 3.2.8)
-      rack-ssl (~> 1.3.2)
-      rake (>= 0.8.7)
-      rdoc (~> 3.4)
-      thor (>= 0.14.6, < 2.0)
-    rake (0.9.2.2)
-    rdoc (3.12)
-      json (~> 1.4)
-    rspec (2.11.0)
-      rspec-core (~> 2.11.0)
-      rspec-expectations (~> 2.11.0)
-      rspec-mocks (~> 2.11.0)
-    rspec-core (2.11.1)
-    rspec-expectations (2.11.3)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.11.3)
-    rspec-rails (2.11.0)
-      actionpack (>= 3.0)
-      activesupport (>= 3.0)
-      railties (>= 3.0)
-      rspec (~> 2.11.0)
-    sprockets (2.1.3)
-      hike (~> 1.2)
-      rack (~> 1.0)
-      tilt (~> 1.1, != 1.3.0)
-    thor (0.16.0)
-    tilt (1.3.3)
-    treetop (1.4.10)
-      polyglot
-      polyglot (>= 0.3.1)
-    tzinfo (0.3.33)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bulk_data_methods!

data/README

@@ -1,68 +0,0 @@
-bulk_data_methods
-==================
-MixIn used to extend ActiveRecord::Base classes implementing bulk insert and update operations
-through {#create_many} and {#update_many}.
-
-Examples
-========
-
-class Company < ActiveRecord::Base
-  extend BulkMethodsMixin
-end
-__________________________
-BULK creation of many rows:
-
-example no options used
-  rows = [
-             { :name => 'Keith', :salary => 1000 },
-             { :name => 'Alex', :salary => 2000 }
-         ]
-  Employee.create_many(rows)
-
-example with :returning option to returns key value
-  rows = [
-             { :name => 'Keith', :salary => 1000 },
-             { :name => 'Alex', :salary => 2000 }
-         ]
-  options = { :returning => [:id] }
-  Employee.create_many(rows, options)
-
-example with :slice_size option (will generate two insert queries)
-  rows = [
-             { :name => 'Keith', :salary => 1000 },
-             { :name => 'Alex', :salary => 2000 },
-             { :name => 'Mark', :salary => 3000 }
-       ]
-  options = { :slice_size => 2 }
-  Employee.create_many(rows, options)
-_________________________
-BULK updates of many rows:
-
-example using "set_array" to add the value of "salary" to the specific employee's salary the default where clause matches IDs so, it works here.
-  rows = [
-             { :id => 1, :salary => 1000 },
-             { :id => 10, :salary => 2000 },
-             { :id => 23, :salary => 2500 }
-       ]
-  options = { :set_array => '"salary = datatable.salary"' }
-  Employee.update_many(rows, options)
-
-example using where clause to match salary.
-  rows = [
-             { :id => 1, :salary => 1000, :company_id => 10 },
-             { :id => 10, :salary => 2000, :company_id => 12 },
-             { :id => 23, :salary => 2500, :company_id => 5 }
-       ]
-  options = {
-              :set_array => '"company_id = datatable.company_id"',
-              :where => '"#{table_name}.salary = datatable.salary"'
-            }
-  Employee.update_many(rows, options)
-
-  example setting where clause to the KEY of the hash passed in and the set_array is generated from the VALUES
-  rows = {
-             { :id => 1 } => { :salary => 100000, :company_id => 10 },
-             { :id => 10 } => { :salary => 110000, :company_id => 12 },
-             { :id => 23 } => { :salary => 90000, :company_id => 5 }
-       }
-  Employee.update_many(rows)