junk_drawer 2.0.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10b296732de43157b6cdde42030553a98da2223a7c31d035e4a89b82db768df2
-  data.tar.gz: febc4381da50ed66564deecd40adf47444a8d7e7ccee07f212b8ed649a14ebaf
+  metadata.gz: af0c9f7f4aa7cd06e4d7f6aafb47263111d60d8039f2da8abc3a479d572a7d2a
+  data.tar.gz: a3b3420460631eb69b70771f4057cf3ed9980a41fb17aeda4a1cd8ec59d6e708
 SHA512:
-  metadata.gz: eedb847db634ecd05167f8861991941be34f7d2ddc5cfad041f0cd13c60a8894371b84556ae8d8770e3ebaf63055e5c0a19631ae146480d2baff6f0788aadcf6
-  data.tar.gz: a217f282c5f5083d4ffeea568431b93680a319564d71d0b17e0861ab37a19fb30b6466c5cdbad3a7f4cbc7351713cc6ba92b1eac3d94fe363d9a3d417967d273
+  metadata.gz: a6fc9b47023c4e1ee539191ec8862cbf982b62fb4a4e3f13dc9966d42bb00e20aa560858855deb6735bec907bcf61eefbbe7de35865451d0cd8724ad569ee2e6
+  data.tar.gz: eca53a28e48bd935474769d0cf5f56123caa2853f4ec8fb83f08b444a7f2d975b1f6aec9a33df058bb81d33a1a31e087e885ccefff03da329d7b03f406eb2ee6

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config --auto-gen-only-exclude --exclude-limit 400`
-# on 2023-04-08 01:57:20 UTC using RuboCop version 1.49.0.
+# on 2023-05-16 20:46:21 UTC using RuboCop version 1.49.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -36,7 +36,7 @@ Layout/LineEndStringConcatenationIndentation:
 # SupportedStyles: aligned, indented, indented_relative_to_receiver
 Layout/MultilineMethodCallIndentation:
   Exclude:
-    - 'spec/junk_drawer/rails/bulk_updatable_spec.rb'
+    - 'spec/support/shared_examples/bulk_updatable_model.rb'
 
 # Offense count: 14
 # Configuration parameters: AllowedMethods.
@@ -46,7 +46,7 @@ Lint/ConstantDefinitionInBlock:
     - 'spec/junk_drawer/callable_spec.rb'
     - 'spec/junk_drawer/notifier/honeybadger_strategy_spec.rb'
     - 'spec/junk_drawer/notifier/null_strategy_spec.rb'
-    - 'spec/junk_drawer/rails/bulk_updatable_spec.rb'
+    - 'spec/support/shared_examples/bulk_updatable_model.rb'
 
 # Offense count: 1
 # Configuration parameters: MaximumRangeSize.
@@ -65,6 +65,12 @@ Metrics/CyclomaticComplexity:
   Exclude:
     - 'lib/junk_drawer/rails/bulk_updatable.rb'
 
+# Offense count: 1
+# Configuration parameters: CountComments, Max, CountAsOne.
+Metrics/ModuleLength:
+  Exclude:
+    - 'lib/junk_drawer/rails/bulk_updatable.rb'
+
 # Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle.
@@ -88,7 +94,7 @@ RSpec/LeakyConstantDeclaration:
     - 'spec/junk_drawer/callable_spec.rb'
     - 'spec/junk_drawer/notifier/honeybadger_strategy_spec.rb'
     - 'spec/junk_drawer/notifier/null_strategy_spec.rb'
-    - 'spec/junk_drawer/rails/bulk_updatable_spec.rb'
+    - 'spec/support/shared_examples/bulk_updatable_model.rb'
 
 # Offense count: 1
 RSpec/StubbedMock:
@@ -102,10 +108,4 @@ RSpec/StubbedMock:
 Style/HashAsLastArrayItem:
   Exclude:
     - 'spec/junk_drawer/notifier/honeybadger_strategy_spec.rb'
-    - 'spec/junk_drawer/rails/bulk_updatable_spec.rb'
-
-# Offense count: 2
-# This cop supports safe autocorrection (--autocorrect).
-Style/RedundantConstantBase:
-  Exclude:
-    - 'spec/junk_drawer/rails/bulk_updatable_spec.rb'
+    - 'spec/support/shared_examples/bulk_updatable_model.rb'

data/README.md

@@ -219,7 +219,8 @@ 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.
+database. If `prepared_statements` is set to true, `BulkUpdatable` will generate
+queries that use bind parameters.
 
 #### Caveats
 
@@ -255,7 +256,7 @@ In order to run tests against different Rails versions, you can use
 `BUNDLE_GEMFILE`:
 
 ```sh
-$ BUNDLE_GEMFILE=gemfiles/rails_5.0.gems rake spec
+$ BUNDLE_GEMFILE=gemfiles/rails_7.0.gems rake spec
 ```
 
 ## Contributing

data/lib/junk_drawer/rails/bulk_updatable.rb

@@ -3,6 +3,7 @@
 require 'active_support/all'
 require 'active_record'
 require 'active_record/connection_adapters/postgresql_adapter'
+require 'active_record/relation/query_attribute'
 
 module JunkDrawer
   # module to allow bulk updates for `ActiveRecord` models
@@ -11,15 +12,35 @@ module JunkDrawer
       objects = objects.select(&:changed?)
       return unless objects.any?
 
-      unique_objects = uniquify_and_merge(objects)
-      changed_attributes = extract_changed_attributes(unique_objects)
-      query = build_query_for(unique_objects, changed_attributes)
-      connection.execute(query)
+      if connection.prepared_statements
+        build_and_exec_prepared_query(objects)
+      else
+        build_and_exec_unprepared_query(objects)
+      end
       objects.each(&:changes_applied)
     end
 
   private
 
+    def build_and_exec_prepared_query(objects)
+      unique_objects = uniquify_and_merge(objects)
+      changed_attributes = extract_changed_attributes(unique_objects)
+      attributes = ['id'] + changed_attributes
+
+      unique_objects.each_slice(batch_size(changed_attributes)) do |batch|
+        query = build_prepared_query_for(batch, attributes, changed_attributes)
+        values = values_for_objects(batch, attributes)
+        connection.exec_query(query, "#{name} Bulk Update", values, prepare: true)
+      end
+    end
+
+    def build_and_exec_unprepared_query(objects)
+      unique_objects = uniquify_and_merge(objects)
+      changed_attributes = extract_changed_attributes(unique_objects)
+      query = build_unprepared_query_for(unique_objects, changed_attributes)
+      connection.execute(query)
+    end
+
     def uniquify_and_merge(objects)
       grouped_objects = objects.group_by(&:id).values
       grouped_objects.each do |group|
@@ -40,19 +61,20 @@ module JunkDrawer
       objects.each { |object| object.updated_at = now }
 
       changed_attributes = objects.flat_map(&:changed).uniq
-      if ::ActiveRecord::VERSION::MAJOR >= 5
-        column_names & changed_attributes
-      else
-        # to remove virtual columns from jsonb_accessor 0.3.3
-        columns.select(&:sql_type).map(&:name) & changed_attributes
-      end
+      column_names & changed_attributes
     end
 
-    def build_query_for(objects, attributes)
-      object_values = objects.map do |object|
-        sanitized_values(object, attributes)
-      end.join(', ')
+    def build_unprepared_query_for(objects, attributes)
+      object_values = objects.map { |object| sanitized_values(object, attributes) }
+      build_query_for(attributes, object_values.join(', '))
+    end
+
+    def build_prepared_query_for(objects, attributes, changed_attributes)
+      object_placeholders = build_placeholders(objects, attributes)
+      build_query_for(changed_attributes, object_placeholders)
+    end
 
+    def build_query_for(attributes, values)
       assignment_query = attributes.map do |attribute|
         quoted_column_name = connection.quote_column_name(attribute)
         "#{quoted_column_name} = tmp_table.#{quoted_column_name}"
@@ -60,11 +82,50 @@ module JunkDrawer
 
       "UPDATE #{table_name} " \
       "SET #{assignment_query} " \
-      "FROM (VALUES #{object_values}) " \
+      "FROM (VALUES #{values}) " \
       "AS tmp_table(id, #{attributes.join(', ')}) " \
       "WHERE #{table_name}.id = tmp_table.id"
     end
 
+    def build_placeholders(objects, attributes)
+      index = 0
+      objects.map do
+        attribute_placeholders = attributes.map do |attribute|
+          index += 1
+          attribute_placeholder(attribute, index)
+        end.join(', ')
+
+        "(#{attribute_placeholders})"
+      end.join(', ')
+    end
+
+    def attribute_placeholder(attribute, index)
+      # AR internal `columns_hash`
+      column = columns_hash[attribute.to_s]
+
+      type_cast = "::#{column.sql_type}"
+      type_cast = "#{type_cast}[]" if column.array
+
+      "$#{index}#{type_cast}"
+    end
+
+    def values_for_objects(objects, attributes)
+      objects.flat_map { |object| values_for_object(object, attributes) }
+    end
+
+    def values_for_object(object, attributes)
+      attributes.map do |attribute|
+        value = object[attribute]
+
+        # AR internal `columns_hash`
+        column = columns_hash[attribute.to_s]
+
+        # AR internal `type_for_attribute`
+        type = type_for_attribute(column.name)
+        ActiveRecord::Relation::QueryAttribute.new(column.name, value, type)
+      end
+    end
+
     def sanitized_values(object, attributes)
       postgres_values = attributes.map do |attribute|
         value = object[attribute]
@@ -77,18 +138,15 @@ module JunkDrawer
         type_cast = "::#{column.sql_type}"
         type_cast = "#{type_cast}[]" if column.array
 
-        "#{connection.quote(serialized_value(type, value))}#{type_cast}"
+        "#{connection.quote(type.serialize(value))}#{type_cast}"
       end
 
       "(#{[object.id, *postgres_values].join(', ')})"
     end
 
-    def serialized_value(type, value)
-      if ::ActiveRecord::VERSION::MAJOR >= 5
-        type.serialize(value)
-      else
-        type.type_cast_for_database(value)
-      end
+    def batch_size(attribute_names)
+      max_bind_params = connection.__send__(:bind_params_length)
+      max_bind_params / attribute_names.length
     end
   end
 end

data/lib/junk_drawer/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: junk_drawer
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Robert Fletcher
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-12 00:00:00.000000000 Z
+date: 2023-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
@@ -164,7 +164,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: 
+description:
 email:
 - lobatifricha@gmail.com
 executables: []
@@ -199,7 +199,7 @@ homepage: https://github.com/thread-pond/junk_drawer
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -214,8 +214,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.2
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: random useful Ruby utilities
 test_files: []