bulk_update 1.1.4 → 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 67b504f96d894fd77d2298b021c3176c7ba46fc0
+  data.tar.gz: 5eb6122b5aed465c5765a5f3438a6d9e84e829b2
+SHA512:
+  metadata.gz: 42e704fca218625c5f77d3c479e6b678fb42cf9f6e4e1e1d6b0a498125cbdae7cef9ee9a6bbdd51393f988b20cb15ee72b4d73df5a156210626c3f98ece93469
+  data.tar.gz: 7aeb01c91beea5431af17d81795ee3329c1760ee83a0e5562a281b18a99421f46472ca3e7b265e928df89d9e4943103cf90c127756eae62a0ef81c25f772d14c

data/README.md

@@ -1,4 +1,5 @@
 # BulkUpdate
+[![Code Climate](https://codeclimate.com/github/InWork/bulk_update.png)](https://codeclimate.com/github/InWork/bulk_update)
 
 Updates a large amount of Records in a highliy efficient way.
 Enhances Active Record with a method for bulk inserts and a method for bulk updates. Both methods are used for inserting or updating large amount of Records.

data/lib/bulk_update/active_record_inflections.rb

@@ -2,7 +2,7 @@ module BulkUpdate
   module ActiveRecordInflections
     #
     # Clone the database structure of a table
-    def clone_table args = {}
+    def clone_table(args = {})
       if args[:to]
         case ActiveRecord::Base.connection_config[:adapter]
         when 'sqlite3'
@@ -17,7 +17,7 @@ module BulkUpdate
     end
 
 
-    def insert_str element
+    def insert_str(element)
       if element.class == Fixnum || element.class == Float
         element
       elsif element.class == NilClass
@@ -34,15 +34,15 @@ module BulkUpdate
 
     #
     # Bulk insert records
-    def bulk_insert columns, values, args = {}
+    def bulk_insert(columns, values, args = {})
       # Limit inserts
       max_records_per_insert = args[:max_records_per_insert] || 100
-      table = args[:into] || table_name
-      columns = columns.clone
+      table                  = args[:into] || table_name
+      columns                = columns.clone
 
       # Add timestamp
-      timestamp = Time.now.to_s(:db)
-      add_timestamp = false
+      timestamp      = Time.now.to_s(:db)
+      add_timestamp  = false
       add_updated_at = false
       unless columns.map(&:to_sym).include?(:created_at)
         columns << :created_at
@@ -84,14 +84,14 @@ module BulkUpdate
     #
     # Create, update and delete Records according to a set of new values through ActiveRecord but optimized for performance by
     # finding all diferences by SQL.
-    def bulk_update columns, values, args = {}
-      temp_table = "#{table_name}_temp_table_#{$$}"
-      key = args[:key] || args[:keys] || 'id'
-      condition = args[:condition]
+    def bulk_update(columns, values, args = {})
+      temp_table     = "#{table_name}_temp_table_#{$$}"
+      key            = args[:key] || args[:keys] || 'id'
+      condition      = args[:condition]
       exclude_fields = args[:exclude_fields]
-      insert = args[:insert].nil? ? true : args[:insert]
-      update = args[:update].nil? ? true : args[:update]
-      remove = args[:remove].nil? ? true : args[:remove]
+      insert         = args[:insert].nil? ? true : args[:insert]
+      update         = args[:update].nil? ? true : args[:update]
+      remove         = args[:remove].nil? ? true : args[:remove]
 
       # Clone temp-table and load it
       clone_table to: temp_table
@@ -115,23 +115,30 @@ module BulkUpdate
     #
     # Exclude List
     def default_exclude
-      ['id', 'version', 'created_at', 'updated_at']
+      @default_exclude ||= ['id', 'created_at', 'updated_at']
+    end
+
+
+    #
+    # Exclude List
+    def default_exclude=(excludes)
+      @default_exclude = excludes
     end
 
 
     #
     # Compare Table of args[:model] with its temporary table args[:compare_with] and return all new records as a Array of Hashes
-    def get_new_records args = {}
-      model = args[:for] || self
-      compare_table = args[:compare_with]
-      keys = args[:on] || 'id'
-      exclude = args[:exclude_fields] || []
-      exclude |= default_exclude
+    def get_new_records(args = {})
+      model         =  args[:for] || self
+      compare_table =  args[:compare_with]
+      keys          =  args[:on] || 'id'
+      exclude       =  args[:exclude_fields] || []
+      exclude       |= default_exclude - %w(created_at updated_at)
 
       # Generate conditions for query and sub-query
-      conditions = []
-      conditions2 = []
-      conditions << "#{args[:condition].gsub('--tt--', compare_table)}" if args[:condition]
+      conditions  =  []
+      conditions2 =  []
+      conditions  << "#{args[:condition].gsub('--tt--', compare_table)}" if args[:condition]
       conditions2 << "#{args[:condition].gsub('--tt--', model.table_name)}" if args[:condition]
       if keys.class == String || keys.class == Symbol
         key = keys.to_s
@@ -141,7 +148,7 @@ module BulkUpdate
       end
 
       # Generate and execute SQL-Statement
-      condition = conditions.join(' AND ')
+      condition  = conditions.join(' AND ')
       condition2 = conditions2.join(' AND ')
       sql = "SELECT * FROM #{compare_table} WHERE #{condition} #{'AND' unless conditions.blank?} #{compare_table}.#{key} NOT IN " +
             "(SELECT #{key} FROM #{model.table_name} #{'WHERE' unless conditions2.blank?} #{condition2})"
@@ -163,26 +170,26 @@ module BulkUpdate
     #
     # Compare Table of args[:model] with its temporary table args[:compare_with] and return all updated records as a Hash of Hashes whose
     # key is the ID of the changed record
-    def get_updated_records args = {}
-      model = args[:for] || self
-      compare_table = args[:compare_with]
-      keys = args[:on] || 'id'
-      exclude = args[:exclude_fields] || []
-      exclude |= default_exclude
-      exclude_virtual = args[:exclude_virtual].nil? ? false : args[:exclude_virtual]
+    def get_updated_records(args = {})
+      model           =  args[:for] || self
+      compare_table   =  args[:compare_with]
+      keys            =  args[:on] || 'id'
+      exclude         =  args[:exclude_fields] || []
+      exclude         |= default_exclude
+      exclude_virtual =  args[:exclude_virtual].nil? ? false : args[:exclude_virtual]
 
       # Generate conditions for query and sub-query
-      conditions = []
+      conditions  = []
       conditions2 = []
       conditions << "NOT #{model.table_name}.virtual" if exclude_virtual
       if keys.class == String || keys.class == Symbol
-        key = keys.to_s
+        key        =  keys.to_s
         conditions << "#{model.table_name}.#{key} = #{compare_table}.#{key}"
-        exclude |= [keys.to_s]
+        exclude    |= [keys.to_s]
       else
-        key = keys[0].to_s
+        key        =  keys[0].to_s
         conditions |= keys.map{|k| "#{model.table_name}.#{k.to_s} = #{compare_table}.#{k.to_s}" }
-        exclude |= keys.map(&:to_s)
+        exclude    |= keys.map(&:to_s)
       end
       conditions << "#{args[:condition].gsub('--tt--', model.table_name)} AND #{args[:condition].gsub('--tt--', compare_table)}" if args[:condition]
       model.attribute_names.each do |an|
@@ -199,20 +206,20 @@ module BulkUpdate
       end
 
       # Generate and execute SQL-Statement
-      condition = conditions.join(' AND ')
-      condition += " AND (#{conditions2.join(' OR ')})" unless conditions2.blank?
-      compare_columns = attribute_names.select { |e| e != 'id' }.map { |e| "#{compare_table}.#{e}" }.join(', ')
-      sql = "SELECT #{model.table_name}.id, #{compare_columns} FROM #{model.table_name}, #{compare_table} WHERE #{condition}"
-      results = ActiveRecord::Base.connection.execute sql
+      condition       =  conditions.join(' AND ')
+      condition       += " AND (#{conditions2.join(' OR ')})" unless conditions2.blank?
+      compare_columns =  attribute_names.select { |e| e != 'id' }.map { |e| "#{compare_table}.#{e}" }.join(', ')
+      sql             =  "SELECT #{model.table_name}.id, #{compare_columns} FROM #{model.table_name}, #{compare_table} WHERE #{condition}"
+      results         =  ActiveRecord::Base.connection.execute sql
 
       # Generate Hash with id as the key and values as a Hashes of all changed records
       results_hash = {}
-      keys_to_log = []
+      keys_to_log  = []
       results.each do |attributes|
-        attributes = attributes2array(attributes)
-        id = attributes[0]
-        results_hash[id] = result2hash attributes, exclude
-        keys_to_log << (args[:debug] ? model.find(id).send(key) : id)
+        attributes       =  attributes2array(attributes)
+        id               =  attributes[0]
+        results_hash[id] =  result2hash attributes, exclude - %w(updated_at)
+        keys_to_log      << (args[:debug] ? model.find(id).send(key) : id)
       end
       args[:logger].info "Change Records for Model #{model.to_s}: #{keys_to_log.join(', ')}" unless keys_to_log.blank? || args[:logger].blank?
 
@@ -222,18 +229,18 @@ module BulkUpdate
 
     #
     # Compare Table of args[:model] with its temporary table args[:compare_with] and return all deleted records as a Array of IDs
-    def get_deleted_records args = {}
-      model = args[:for] || self
-      compare_table = args[:compare_with]
-      keys = args[:on] || 'id'
+    def get_deleted_records(args = {})
+      model           = args[:for] || self
+      compare_table   = args[:compare_with]
+      keys            = args[:on] || 'id'
       exclude_virtual = args[:exclude_virtual].nil? ? false : args[:exclude_virtual]
 
       # Generate conditions for query and sub-query
-      conditions = []
-      conditions2 = []
-      conditions << "NOT #{model.table_name}.virtual" if exclude_virtual
-      conditions << "#{args[:condition].gsub('--tt--', model.table_name)}" if args[:condition]
-      conditions2 << "#{args[:condition].gsub('--tt--', compare_table)}" if args[:condition]
+      conditions    =  []
+      conditions2   =  []
+      conditions    << "NOT #{model.table_name}.virtual" if exclude_virtual
+      conditions    << "#{args[:condition].gsub('--tt--', model.table_name)}" if args[:condition]
+      conditions2   << "#{args[:condition].gsub('--tt--', compare_table)}" if args[:condition]
       if keys.class == String || keys.class == Symbol
         key = keys.to_s
       else
@@ -242,19 +249,19 @@ module BulkUpdate
       end
 
       # Generate and execute SQL-Statement
-      condition = conditions.join(' AND ')
+      condition  = conditions.join(' AND ')
       condition2 = conditions2.join(' AND ')
-      sql = "SELECT id, #{key} FROM #{model.table_name} WHERE #{condition} #{'AND' unless conditions.blank?} #{model.table_name}.#{key} NOT IN " +
-            "(SELECT #{key} FROM #{compare_table} #{'WHERE' unless conditions2.blank?} #{condition2})"
-      results = ActiveRecord::Base.connection.execute sql
+      sql        = "SELECT id, #{key} FROM #{model.table_name} WHERE #{condition} #{'AND' unless conditions.blank?} #{model.table_name}.#{key} NOT IN " +
+                   "(SELECT #{key} FROM #{compare_table} #{'WHERE' unless conditions2.blank?} #{condition2})"
+      results    = ActiveRecord::Base.connection.execute sql
 
       # Generate Array with ids of all deleted records
       deleted_records = []
-      keys_to_log = []
+      keys_to_log     = []
       results.each do |attributes|
-        attributes = attributes2array(attributes)
+        attributes      =  attributes2array(attributes)
         deleted_records << attributes[0]
-        keys_to_log << attributes[1]
+        keys_to_log     << attributes[1]
       end
       args[:logger].info "Deleting Records from Model #{model.to_s}: #{keys_to_log.join(', ')}" unless keys_to_log.blank? || args[:logger].blank?
       deleted_records
@@ -267,8 +274,8 @@ module BulkUpdate
     def result2hash(attributes, exclude, attribute_nr = 0)
       hash = {}
       attribute_names.each do |an|
-        hash[an.to_sym] = attributes[attribute_nr] unless exclude.include?(an)
-        attribute_nr += 1
+        hash[an.to_sym] =  attributes[attribute_nr] unless exclude.include?(an)
+        attribute_nr    += 1
       end
       hash
     end

data/lib/bulk_update/version.rb

@@ -1,3 +1,3 @@
 module BulkUpdate
-  VERSION = "1.1.4"
+  VERSION = "1.2.0"
 end

data/spec/bulk_update_spec.rb

@@ -7,6 +7,7 @@ describe BulkUpdate do
     @columns = [:name, :value]
     @values  = [['test1', 'value1'], ['test2', 'value2'], ['test3', 'value3'], ['test4', 'value4']]
     MyHash.bulk_insert @columns, @values
+    @ts = MyHash.first.created_at
   end
 
 
@@ -20,10 +21,43 @@ describe BulkUpdate do
     MyHash.bulk_update @columns, @values, key: 'name'
     MyHash.count.should be 4
     MyHash.where(name: 'test1').first.value.should eq 'value1.1'
+    MyHash.where(name: 'test1').first.created_at.to_i.should eq @ts.to_i
+    MyHash.where(name: 'test1').first.updated_at.to_i.should eq @ts.to_i
     MyHash.where(name: 'test2').first.value.should eq 'value2'
+    MyHash.where(name: 'test2').first.created_at.to_i.should eq @ts.to_i
+    MyHash.where(name: 'test2').first.updated_at.to_i.should eq @ts.to_i
     MyHash.where(name: 'test3').first.should be nil
     MyHash.where(name: 'test4').first.value.should eq 'value4.4'
+    MyHash.where(name: 'test4').first.created_at.to_i.should eq @ts.to_i
+    MyHash.where(name: 'test4').first.updated_at.to_i.should eq @ts.to_i
     MyHash.where(name: 'test5').first.value.should eq 'value5.5'
+    MyHash.where(name: 'test5').first.created_at.to_i.should eq @ts.to_i
+    MyHash.where(name: 'test5').first.updated_at.to_i.should eq @ts.to_i
+  end
+
+
+  it 'should update the created_at and updated_at timestamps if specified' do
+    columns = [:name, :value, :updated_at, :created_at]
+    ts_1    = 1.hour.ago
+    ts_2    = 2.hour.ago
+    ts_1_s  = ts_1.to_s(:db)
+    ts_2_s  = ts_2.to_s(:db)
+    values  = [['test1', 'value1.1', ts_1_s, ts_2_s], ['test2', 'value2', ts_1_s, ts_2_s], ['test4', 'value4.4', ts_1_s, ts_2_s], ['test5', 'value5.5', ts_1_s, ts_2_s]]
+    MyHash.bulk_update columns, values, key: 'name'
+    MyHash.count.should be 4
+    MyHash.where(name: 'test1').first.value.should eq 'value1.1'
+    MyHash.where(name: 'test1').first.created_at.to_i.should eq @ts.to_i
+    MyHash.where(name: 'test1').first.updated_at.to_i.should eq ts_1.to_i
+    MyHash.where(name: 'test2').first.value.should eq 'value2'
+    MyHash.where(name: 'test2').first.created_at.to_i.should eq @ts.to_i
+    MyHash.where(name: 'test2').first.updated_at.to_i.should eq @ts.to_i
+    MyHash.where(name: 'test3').first.should be nil
+    MyHash.where(name: 'test4').first.value.should eq 'value4.4'
+    MyHash.where(name: 'test4').first.created_at.to_i.should eq @ts.to_i
+    MyHash.where(name: 'test4').first.updated_at.to_i.should eq ts_1.to_i
+    MyHash.where(name: 'test5').first.value.should eq 'value5.5'
+    MyHash.where(name: 'test5').first.created_at.to_i.should eq ts_2.to_i
+    MyHash.where(name: 'test5').first.updated_at.to_i.should eq ts_1.to_i
   end
 
 end

metadata

@@ -1,110 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: bulk_update
 version: !ruby/object:Gem::Version
-  version: 1.1.4
-  prerelease: 
+  version: 1.2.0
 platform: ruby
 authors:
 - Philip Kurmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-02 00:00:00.000000000 Z
+date: 2015-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Updates a large amount of Records in a highly efficient way
@@ -114,7 +101,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE
 - README.md
@@ -130,27 +117,26 @@ files:
 - spec/support/schema.rb
 homepage: ''
 licenses: []
+metadata: {}
 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.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Enhances Active Record with a method for bulk inserts and a method for bulk
   updates. Both merthods are used for inserting or updating large amount of Records.
 test_files: