activerecord-updateinbulk 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b333b357426d210ed69dfa18de2f7f77ae8088e9fc47819198118f22f7647fc
-  data.tar.gz: 96eb8a466eb413735de1e1ed4e80dbbc18402b356b5870d9b24b92826828b425
+  metadata.gz: c5130d637025d39db5e0eab8ecb59b22252decd67a56a089c7e1a749ac70385f
+  data.tar.gz: 44dbf800efb3d5b0e4d405864cf1ed0e2c3e87d461c10a72cf03513aa6878c5e
 SHA512:
-  metadata.gz: 7a9ff7817a67baf305cd391c855e7607b7adc4c756abadf8d11bba119ad137bd378e83841e80dacaa0abe8265cd3c6d432f58faa4029608fe783c3ab410b7b14
-  data.tar.gz: b71a70301fa255f1c52ae9472b6cce357b2d8f10313226398e74294af0a76179b04383d3d2c5fa52b82fa05dc5dd3581fe4da0330414c1394d8ab900dd4863e9
+  metadata.gz: 02f007dd0c1c2a9f46f48a414bbe352598c0b7a36793f71070e63e7160c4decc01db790c727f90882a40fc302a7b486608548908b8c4ad996d1b858ff998220f
+  data.tar.gz: a54913d72fe2bed929e7676e2cf09d39bd589519529eb7576f1833108f77984072645829b453333968a2d4eca90f455493260970ee8e937929e0a00ed46fdc4f

data/.yardopts

@@ -0,0 +1,8 @@
+--quiet
+lib/activerecord-updateinbulk/relation.rb
+lib/activerecord-updateinbulk/adapters/abstract_adapter.rb
+lib/activerecord-updateinbulk/arel/nodes/values_table.rb
+lib/activerecord-updateinbulk/railtie.rb
+lib/activerecord-updateinbulk/version.rb
+-
+README.md

data/lib/activerecord-updateinbulk/adapters/abstract_adapter.rb

@@ -21,7 +21,7 @@ module ActiveRecord::UpdateInBulk
     end
 
     # Whether VALUES table serialization must always include explicit column
-    # aliases (because defaults are missing or not statically known).
+    # aliases because there are no default names. This is a mariadb quirk.
     def values_table_requires_aliasing?
       false
     end
@@ -44,10 +44,15 @@ module ActiveRecord::UpdateInBulk
     # possibly modified in place.
     #
     # The default implementation does no explicit type casting.
-    def typecast_values_table(values_table, _columns)
+    def typecast_values_table(values_table, columns)
       values_table
     end
   end
 end
 
 ActiveRecord::ConnectionAdapters::AbstractAdapter.include(ActiveRecord::UpdateInBulk::AbstractAdapter)
+
+# @!parse
+#   class ActiveRecord::ConnectionAdapters::AbstractAdapter
+#     include ActiveRecord::UpdateInBulk::AbstractAdapter
+#   end

data/lib/activerecord-updateinbulk/adapters/abstract_mysql_adapter.rb

@@ -3,7 +3,7 @@
 require "active_record/connection_adapters/abstract_mysql_adapter"
 
 module ActiveRecord::UpdateInBulk
-  module AbstractMysqlAdapter
+  module AbstractMysqlAdapter # :nodoc: all
     def supports_values_tables?
       mariadb? ? database_version >= "10.3.3" : database_version >= "8.0.19"
     end

data/lib/activerecord-updateinbulk/adapters/postgresql_adapter.rb

@@ -3,7 +3,7 @@
 require "active_record/connection_adapters/postgresql_adapter"
 
 module ActiveRecord::UpdateInBulk
-  module PostgreSQLAdapter
+  module PostgreSQLAdapter # :nodoc: all
     SAFE_TYPES_FOR_VALUES_TABLE = [:integer, :string, :text, :boolean].freeze
 
 

data/lib/activerecord-updateinbulk/adapters/sqlite3_adapter.rb

@@ -3,7 +3,7 @@
 require "active_record/connection_adapters/sqlite3_adapter"
 
 module ActiveRecord::UpdateInBulk
-  module SQLite3Adapter
+  module SQLite3Adapter # :nodoc: all
   end
 end
 

data/lib/activerecord-updateinbulk/arel/nodes/values_table.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
 module Arel::Nodes
-  # Represents a SQL VALUES table constructor as an Arel node.
-  # Mirrors Arel::Table behavior by requiring a name at construction time.
-  # Column names are also required because adapter defaults vary; obtain
-  # defaults through <tt>connection.values_table_default_column_names(width)</tt>.
+  # Represents the +VALUES+ table constructor as an Arel node.
+  # Mirrors +Arel::Table+ behavior by requiring a name at construction time.
+  # Column names are also required because adapter defaults vary; prefer using the
+  # default names from <tt>connection.values_table_default_column_names(width)</tt>
+  # to keep the generated query simple.
+  #
+  # This is a private class that may be used by typecasting logic in custom adapters.
   #
   class ValuesTable < Arel::Nodes::Node
     attr_reader :name, :width, :rows, :columns
@@ -35,7 +38,9 @@ module Arel::Nodes
       Arel::Nodes::TableAlias.new(grouping(self), table)
     end
 
-    delegate :to_cte, to: :alias
+    def to_cte
+      self.alias.to_cte
+    end
 
     def hash
       [@name, @rows, @columns].hash

data/lib/activerecord-updateinbulk/arel/select_manager.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module ActiveRecord::UpdateInBulk
-  module SelectManager # :nodoc:
+  module SelectManager # :nodoc: all
     def alias(name) # :nodoc:
       Arel::Nodes::TableAlias.new(self, name)
     end

data/lib/activerecord-updateinbulk/arel/visitors/to_sql.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module ActiveRecord::UpdateInBulk
-  module ToSql
+  module ToSql # :nodoc: all
     def visit_Arel_Nodes_ValuesTable(o, collector)
       row_prefix = @connection.values_table_row_prefix
 

data/lib/activerecord-updateinbulk/base.rb

@@ -19,15 +19,15 @@ module ActiveRecord
       require_adapter connection_pool.db_config.adapter
     end
 
-    def self.register_formula(name, &formula)
+    def self.register_formula(name, &formula) # :nodoc:
       Builder.register_formula(name, &formula)
     end
 
-    def self.unregister_formula(name)
+    def self.unregister_formula(name) # :nodoc:
       Builder.unregister_formula(name)
     end
 
-    def self.registered_formula?(name)
+    def self.registered_formula?(name) # :nodoc:
       Builder.registered_formula?(name)
     end
   end
@@ -43,7 +43,7 @@ require "activerecord-updateinbulk/querying"
 require "activerecord-updateinbulk/adapters/abstract_adapter"
 
 module ActiveRecord::UpdateInBulk
-  module ConnectionHandler # :nodoc:
+  module ConnectionHandler # :nodoc: all
     def establish_connection(*args, **kwargs, &block) # :nodoc:
       pool = super(*args, **kwargs, &block)
       ActiveRecord::UpdateInBulk.load_from_connection_pool pool

data/lib/activerecord-updateinbulk/builder.rb

@@ -3,7 +3,7 @@
 require "active_support/core_ext/enumerable"
 
 module ActiveRecord::UpdateInBulk
-  class Builder # :nodoc:
+  class Builder # :nodoc: all
     SAFE_COMPARISON_TYPES = [:boolean, :string, :text, :integer, :float, :decimal].freeze
 
     class << self

data/lib/activerecord-updateinbulk/querying.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module ActiveRecord::UpdateInBulk
-  module Querying # :nodoc:
+  module Querying # :nodoc: all
     def update_in_bulk(...) # :nodoc:
       all.update_in_bulk(...)
     end

data/lib/activerecord-updateinbulk/railtie.rb

@@ -15,16 +15,15 @@ module ActiveRecord
     #   Rails.application.config.active_record_update_in_bulk.ignore_scope_order = true
     #
     # [config.active_record_update_in_bulk.values_table_alias]
-    #   Optional string alias to use for the generated VALUES table.
-    #   Defaults to <tt>"t"</tt>.
+    #   Table alias for the generated +VALUES+ table. Defaults to <tt>"t"</tt>.
     #
     # [config.active_record_update_in_bulk.ignore_scope_order]
-    #   Whether <tt>Relation#update_in_bulk</tt> should ignore any ORDER BY scope
-    #   on the input relation. Necessary for invoking the method on scope-ordered
-    #   associations, or models with a default scope that includes an order.
+    #   Whether <tt>Relation#update_in_bulk</tt> should ignore any +ORDER BY+ scope
+    #   on the input relation. Necessary for invoking the method casually on scope
+    #   ordered associations, or models with a default scope that includes an order.
     #
-    #   * <tt>true</tt> (default): ORDER BY scopes are stripped.
-    #   * <tt>false</tt>: ordered relations raise NotImplementedError.
+    #   * <tt>true</tt> (default): +ORDER BY+ clause is stripped.
+    #   * <tt>false</tt>: ordered relations raise +NotImplementedError+.
     class Railtie < Rails::Railtie
       config.active_record_update_in_bulk = ActiveSupport::OrderedOptions.new
       config.active_record_update_in_bulk.ignore_scope_order = true

data/lib/activerecord-updateinbulk/relation.rb

@@ -3,14 +3,14 @@
 module ActiveRecord::UpdateInBulk
   module Relation
     # Updates multiple groups of records in the current relation using a single
-    # SQL UPDATE statement. This does not instantiate models and does not
+    # SQL +UPDATE+ statement. This does not instantiate models and does not
     # trigger Active Record callbacks or validations. However, values passed
     # through still use Active Record's normal type casting and serialization.
     # Returns the number of rows affected.
     #
-    # Three equivalent input formats are supported:
+    # Three equivalent input formats are supported for convenience:
     #
-    # *Indexed format* — a hash mapping primary keys to attribute updates:
+    # <b>Indexed format</b> — a hash mapping primary keys to attribute updates:
     #
     #   Book.update_in_bulk({
     #     1 => { title: "Agile", price: 10.0 },
@@ -24,7 +24,7 @@ module ActiveRecord::UpdateInBulk
     #     ["AA100", "12B"] => { passenger: "Bob" }
     #   })
     #
-    # *Paired format* — an array of <tt>[conditions, assigns]</tt> pairs.
+    # <b>Paired format</b> — an array of <tt>[conditions, assigns]</tt> pairs.
     # Conditions do not need to be primary keys; they may reference any columns in
     # the target table. All pairs must specify the same set of condition
     # columns:
@@ -34,7 +34,7 @@ module ActiveRecord::UpdateInBulk
     #     [{ department: "Engineering" }, { bonus: 500 }]
     #   ])
     #
-    # *Separated format* — parallel arrays of conditions and assigns:
+    # <b>Separated format</b> — parallel arrays of conditions and assigns:
     #
     #   Employee.update_in_bulk(
     #     [1, 2, { id: 3 }],
@@ -90,6 +90,12 @@ module ActiveRecord::UpdateInBulk
     #     2 => { department: "Sales" }
     #   })
     #
+    # ==== Restrictions
+    #
+    # This method does not support relations with <tt>offset</tt>, <tt>limit</tt>,
+    # <tt>group</tt>, or <tt>having</tt> clauses. An <tt>order</tt> clause is supported
+    # by default <b>by being stripped</b> to keep the method usable on ordered associations.
+    #
     def update_in_bulk(updates, values = nil, record_timestamps: nil, formulas: nil)
       unless limit_value.nil? && offset_value.nil? && group_values.empty? && having_clause.empty?
         raise NotImplementedError, "No support to update relations with offset, limit, group, or having clauses"
@@ -137,3 +143,8 @@ module ActiveRecord::UpdateInBulk
 end
 
 ActiveRecord::Relation.prepend(ActiveRecord::UpdateInBulk::Relation)
+
+# @!parse
+#   class ActiveRecord::Relation
+#     include ActiveRecord::UpdateInBulk::Relation
+#   end

data/lib/activerecord-updateinbulk/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveRecord
   module UpdateInBulk
-    VERSION = "0.3.0"
+    VERSION = "0.3.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-updateinbulk
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Bruno Carvalho
@@ -31,6 +31,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
 - LICENSE
 - README.md
 - lib/activerecord-updateinbulk.rb