bulk_updater 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0602240cc3436e129c8b7aa97fbc9d4ac7e809fd
+  data.tar.gz: 7a5c7b5672aa89bb47067bb36b70364f33db0442
+SHA512:
+  metadata.gz: efd0b1749f840d68860c0a490d3ea4942d5d0b07bdf2c43bbff6a2e4c6cd35942082c1e4f6c656c1083c72862a9710166d61f7b7b184523abd514d81aed8b3c1
+  data.tar.gz: 0bac70e0c18c7fae2352f4da12dac97d47107ebad07e0dc435ec2cbaa87020ae5c1c0f45cde9ffe9b6cf6f5133d18dda75bfc57b4c937e106cfd3c78959f0f50

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Alex Teut
+
+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.md

@@ -0,0 +1,46 @@
+# BulkUpdater
+
+Generate and execute SQL UPDATE for bulk updating multiple records by one request. Required ActiveRecord.
+
+## Usage
+
+    BulkUpdater.update!(model, columns_to_find, columns_to_update, data)
+Input params:
+- `model` - model which table must be updated.
+- `columns_to_find` - array of columns for when condition. Must be array of symbols.
+- `columns_to_update` - array of columns for updating. Must be array of symbols.
+- `data` - array with all required data. Must be array of hashes. Each hash must contain all columns_to_find and required columns to update.
+
+## Example:
+
+    data = [{author_id: 1, is_adult: 1, name: 'Name 1', price: 9.99},
+            {author_id: 2, is_adult: 1, name: 'Name 2'}]
+    BulkUpdater.update!(App, [:author_id, :is_adult], [:name, :price], data)
+executes SQL like:
+
+    UPDATE apps
+      SET name = CASE
+        WHEN author_id = 1 AND is_adult = 1 THEN 'Name 1'
+        WHEN author_id = 2 AND is_adult = 1 THEN 'Name 2'
+        ELSE name
+      END,
+      price = CASE
+        WHEN author_id = 1 AND is_adult = 1 THEN 9.99
+        ELSE price
+      END
+    WHERE author_id IN (1, 2) AND is_adult IN (1)
+
+## Notes
+
+- Gem has fairly straightforward logic for generating SQL request. It generates only one type of request(as shown in example).
+- There are limitaions in idea. You can not find record by key and update the same key. E.g., `columns_to_find` and `columns_to_update` can not intersect.
+- Yet no tests. I've just extracted library from real project, it works, but I still have to idea how to write clean unit tests. Any ideas appreciated.
+- Again: any ideas appreciated.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/bulk_updater/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bulk_updater.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bulk_updater/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bulk_updater"
+  spec.version       = BulkUpdater::VERSION
+  spec.author        = "Alex Teut"
+  spec.email         = ["jaturken@gmail.com"]
+  spec.summary       = %q{Generate and execute SQL UPDATE for bulk updating multiple records by one request.}
+  spec.description   = %q{Gem for joining multiple UPDATE requests into one. Useful when you regular update multiple record.}
+  spec.homepage      = "https://github.com/jaturken/bulk_updater"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", '>= 0'
+  spec.add_runtime_dependency 'activerecord', '>= 0'
+end

data/lib/bulk_updater/version.rb

@@ -0,0 +1,3 @@
+module BulkUpdater
+  VERSION = "0.0.1"
+end

data/lib/bulk_updater.rb

@@ -0,0 +1,74 @@
+require "bulk_updater/version"
+
+class BulkUpdater
+  attr_reader :model, :columns_to_find, :columns_to_update, :data
+  
+  def self.update!(model, columns_to_find, columns_to_update, data)
+    new(model, columns_to_find, columns_to_update, data).update!
+  end
+
+  private
+
+  def initialize(model, columns_to_find, columns_to_update, data)
+    @model = model
+    @columns_to_update = columns_to_update
+    @columns_to_find = columns_to_find
+    @data = data
+  end
+
+  def update!
+    table = model.table_name
+    statement = update_statement
+    condition = update_condition
+    if statement.present?
+      sql= "UPDATE #{table} SET #{statement} WHERE #{condition}"
+      model.connection.execute(sql)
+    end
+  end
+
+  private
+
+  def update_condition
+    columns_to_find.map do |column|
+      values = data.map do |data_unit|
+        value = data_unit[column]
+        quote_value(value)
+      end.compact.uniq.join(', ')
+      "#{column.to_s} IN (#{values})"
+    end.join(' AND ')
+  end
+
+  def update_statement
+    columns_to_update.map do |column|
+      case_conditions = data.map do |data_unit|
+        case_condition = when_then(column, data_unit)
+      end.compact.join(' ')
+      if case_conditions.present?
+        "#{column.to_s} = CASE #{case_conditions} ELSE #{column.to_s} end"
+      end
+    end.compact.join(', ')
+  end
+
+  def when_then(column_to_update, data_unit)
+    one_record_condition = columns_to_find.map do |column_to_find|
+      value = data_unit[column_to_find]
+      value = quote_value(value)
+      "#{column_to_find.to_s} = #{value}"
+    end.compact.join(' AND ')
+    update_value = data_unit[column_to_update]
+    if update_value.present?
+      update_value = quote_value(update_value)
+      "WHEN #{one_record_condition} THEN #{update_value}" 
+    end
+  end
+
+  def quote_value(value)
+    if value.is_a?(Integer)
+      value.to_s
+    else
+      ActiveRecord::Base.connection.quote(value)
+    end
+  end
+
+end
+

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: bulk_updater
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alex Teut
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gem for joining multiple UPDATE requests into one. Useful when you regular
+  update multiple record.
+email:
+- jaturken@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bulk_updater.gemspec
+- lib/bulk_updater.rb
+- lib/bulk_updater/version.rb
+homepage: https://github.com/jaturken/bulk_updater
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Generate and execute SQL UPDATE for bulk updating multiple records by one
+  request.
+test_files: []