junk_drawer 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f11e6f56418b14bf2a44d91ffadff154fcf79a6
-  data.tar.gz: 2240a549479b367d864b343fc3d5106821fa074c
+  metadata.gz: fa1bc248af13f000203f8c72364c382c44de203a
+  data.tar.gz: 05ad7bf2b95cb6630eab0129811dcb68cd8e1e6b
 SHA512:
-  metadata.gz: b1692ef49d130c6b5e761fe1587871cbc3ebced928965eb98464dfc88ec0e436fa80de0837f4fa87162f2d162c3aba70cd571e72d3844380a5c1811a0bbadb7e
-  data.tar.gz: baaa55a6d653c4f514b0850777e31616f93af87758bfb592f629240934e7f7675eb5fa03780e8933618bc9140f8a399bf969138b1ce0ce391ac8bf28100effdd
+  metadata.gz: 99d8ee5d88bc1bcd7d3253fc4dbac3be7be6418ede9a772bc4963233b0785344429ee40a2f8b2078e8d51e678aead1701eeba99ed4227ade2206b79e7af1912b
+  data.tar.gz: 108ff56c6ed5bbe24e81edcfa099e0ae7a55cada04469a0e9900d76b4b3623b64f334f39eaa52ed048b18811bf7fd8e907b83e95f7169d9f745de2ee93f4673b

data/.rubocop.yml

@@ -5,6 +5,18 @@ AllCops:
   TargetRubyVersion: 2.3
   DisplayCopNames: true
 
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - spec/**/*_spec.rb
+
+Metrics/AbcSize:
+  Exclude:
+    - lib/junk_drawer/rails/bulk_updatable.rb
+
+Metrics/MethodLength:
+  Exclude:
+    - lib/junk_drawer/rails/bulk_updatable.rb
+
 Metrics/BlockLength:
   Exclude:
     - junk_drawer.gemspec
@@ -59,6 +71,11 @@ Style/OptionHash:
 Style/Send:
   Enabled: true
 
+RSpec/FilePath:
+  IgnoreMethods: true
+  Exclude:
+    - spec/junk_drawer/rails/bulk_updatable_spec.rb
+
 RSpec/VerifiedDoubles:
   Enabled: true
 

data/.travis.yml

@@ -2,7 +2,11 @@ sudo: false
 language: ruby
 rvm:
   - 2.3.1
+addons:
+  postgresql: '9.4'
 before_install: gem install bundler -v 1.13.6
+before_script:
+  - createdb junk_drawer_test -U postgres
 script:
   - bundle exec rubocop
   - bundle exec rake

data/README.md

@@ -1,7 +1,7 @@
 # JunkDrawer
 
-`JunkDrawer` is a gem providing exactly one (and someday more) random utility
-that is commonly useful across projects.
+`JunkDrawer` is a gem providing a handful of random utility that are commonly
+useful across projects.
 
 ## Installation
 
@@ -19,6 +19,18 @@ Or install it yourself as:
 
     $ gem install junk_drawer
 
+If you want to include the Rails utilities, in your Gemfile you can instead use:
+
+```ruby
+gem 'junk_drawer', require: 'junk_drawer/rails'
+```
+
+### Contents
+
+- [JunkDrawer::Callable](#junkdrawercallable)
+- [JunkDrawer::Notifier](#junkdrawernotifier)
+- [JunkDrawer::BulkUpdatable](#junkdrawerbulkupdatable)
+
 ## Usage
 
 ### JunkDrawer::Callable
@@ -134,6 +146,68 @@ config.after_initialize do
 end
 ```
 
+-------------------------------------------------------------------------------
+
+## Rails
+
+For Rails specific tools, instead of requiring `'junk_drawer'`, you can require
+`'junk_drawer/rails'`. This will pull in both the plain Ruby and the Rails
+specific utilities.
+
+### JunkDrawer::BulkUpdatable
+
+`JunkDrawer::BulkUpdatable` is a utility to enable bulk updating of
+`ActiveRecord` models.  To enable it, extend in your models:
+
+```ruby
+class MyModel < ApplicationRecord
+  extend JunkDrawer::BulkUpdatable
+end
+```
+
+If you want to enable it for all models, you can also add it to your
+`ApplicationModel` class:
+
+```ruby
+class ApplicationRecord
+  self.abstract_class = true
+  extend JunkDrawer::BulkUpdatable
+end
+```
+
+To make use of it, you can pass an array of records into the `.bulk_update`
+class method on your model:
+
+```ruby
+my_model_1 = MyModel.find(1)
+my_model_1.name = 'Jabba'
+my_model_2 = MyModel.find(2)
+my_model_2.name = 'JarJar'
+
+MyModel.bulk_update([my_model_1, my_model_2])
+```
+
+This will generate a single SQL query to update both of the records in the
+database.
+
+#### Caveats
+
+- Right now this only supports PostgreSQL. PR's welcome!
+- It also only supports basic data types (including `hstore` and `jsonb`) for
+  your columns, so if you've got something weird you may have a bad time. Also
+  PR's welcome!
+- General advice: if you're updating many thousands of records at the same
+  time, you may still run into some performance bottlenecks. When you're
+  dealing with massive amounts of data, we suggest pairing
+  `JunkDrawer::BulkUpdatable` with Rails' built-in `find_in_batches`:
+
+  ```ruby
+  MyModel.find_in_batches(batch_size: 250) do |batch|
+    batch.each { |my_model| my_model.name = 'Jar' * rand(100) }
+    MyModel.bulk_update(batch)
+  end
+  ```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run

data/junk_drawer.gemspec

@@ -21,14 +21,18 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.1'
 
+  spec.add_development_dependency 'activerecord', '~> 4.2'
+  spec.add_development_dependency 'activesupport', '~> 4.2'
   spec.add_development_dependency 'bundler', '~> 1.13'
   spec.add_development_dependency 'guard', '~> 2.14'
   spec.add_development_dependency 'guard-rspec', '~> 4.7'
   spec.add_development_dependency 'guard-rubocop', '~> 1.2'
+  spec.add_development_dependency 'pg', '~> 0.20'
   spec.add_development_dependency 'pry', '~> 0.10'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 0.45.0'
-  spec.add_development_dependency 'rubocop-rspec', '~> 1.8.0'
-  spec.add_development_dependency 'simplecov', '~> 0.12'
+  spec.add_development_dependency 'rubocop', '~> 0.48.1'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.15.0'
+  spec.add_development_dependency 'simplecov', '~> 0.14'
+  spec.add_development_dependency 'with_model', '~> 2.0'
 end

data/lib/junk_drawer/rails/bulk_updatable.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'active_support/all'
+require 'active_record'
+require 'active_record/connection_adapters/postgresql_adapter'
+
+module JunkDrawer
+  # module to allow bulk updates for `ActiveRecord` models
+  module BulkUpdatable
+    ATTRIBUTE_TYPE_TO_POSTGRES_CAST = {
+      datetime: '::timestamp',
+      hstore: '::hstore',
+      boolean: '::boolean',
+      jsonb: '::jsonb',
+    }.freeze
+
+    POSTGRES_VALUE_CASTERS = {
+      hstore: ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Hstore.new,
+      jsonb: ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Jsonb.new,
+    }.freeze
+
+    def bulk_update(objects)
+      objects = objects.select(&:changed?)
+      return unless objects.any?
+
+      changed_attributes = extract_changed_attributes(objects)
+      query = build_query_for(objects, changed_attributes)
+      connection.execute(query)
+    end
+
+  private
+
+    def extract_changed_attributes(objects)
+      now = Time.zone.now
+      objects.each { |object| object.updated_at = now }
+
+      objects.flat_map(&:changed).uniq
+    end
+
+    def build_query_for(objects, attributes)
+      object_values = objects.map do |object|
+        sanitized_values(object, attributes)
+      end.join(', ')
+
+      assignment_query = attributes.map do |attribute|
+        quoted_column_name = connection.quote_column_name(attribute)
+        "#{quoted_column_name} = tmp_table.#{quoted_column_name}"
+      end.join(', ')
+
+      <<-SQL
+        UPDATE #{table_name}
+        SET #{assignment_query}
+        FROM (VALUES #{object_values}) AS tmp_table(id, #{attributes.join(', ')})
+        WHERE #{table_name}.id = tmp_table.id
+      SQL
+    end
+
+    def sanitized_values(object, attributes)
+      postgres_types = attributes.map do |attribute|
+        attribute_type = columns_hash[attribute.to_s].type
+        "?#{ATTRIBUTE_TYPE_TO_POSTGRES_CAST[attribute_type]}"
+      end
+
+      postgres_values = attributes.map do |attribute|
+        value = object[attribute]
+        attribute_type = columns_hash[attribute.to_s].type
+        caster = POSTGRES_VALUE_CASTERS[attribute_type]
+
+        caster ? caster.type_cast_for_database(value) : value
+      end
+
+      sanitize_sql_array(
+        ["(?, #{postgres_types.join(', ')})", object.id, *postgres_values],
+      )
+    end
+  end
+end

data/lib/junk_drawer/rails.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative '../junk_drawer'
+require_relative 'rails/bulk_updatable'

data/lib/junk_drawer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JunkDrawer
-  VERSION = '1.2.1'
+  VERSION = '1.3.0'
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: junk_drawer
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Robert Fletcher
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-19 00:00:00.000000000 Z
+date: 2017-07-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -114,42 +156,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.45.0
+        version: 0.48.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.45.0
+        version: 0.48.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 1.15.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 1.15.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: with_model
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '2.0'
 description: 
 email:
 - lobatifricha@gmail.com
@@ -176,6 +232,8 @@ files:
 - lib/junk_drawer/notifier/honeybadger_strategy.rb
 - lib/junk_drawer/notifier/null_strategy.rb
 - lib/junk_drawer/notifier/raise_strategy.rb
+- lib/junk_drawer/rails.rb
+- lib/junk_drawer/rails/bulk_updatable.rb
 - lib/junk_drawer/version.rb
 homepage: https://github.com/mockdeep/junk_drawer
 licenses: