activerecord-import 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7cd19fa557186daf34db96db71f26a7db70b15e66a0a42eaab33be304945ab0
-  data.tar.gz: ff8afe763d437210ea1c78e21bacd0b4ae84f113fbadbda087077bf402f08e64
+  metadata.gz: 18ab977c921d6e9c51ca329d136998d858ddbe3cae0a186160886cd43ee6b6e9
+  data.tar.gz: 98d166b037d997de14492f621099ffb63af16505da1c8c36a2e302a903213777
 SHA512:
-  metadata.gz: 402d2087c8c35a2adfa3787ee4e183883df74cc1f4ad2276de1227ba9778b630bfbee546faa3b53b7dcbe1142232bd7d03de046ccab5c6caa5c475a3bc4f15c1
-  data.tar.gz: ef5ce7d4dba744b3c58a0affbe326b50d764c7e4c4726b468ad4d18eacee13fbaa8d7b5d78459bc048e8eeb0628cf34b52a59f759f0a1f4d9d491b7439d5845a
+  metadata.gz: 2a593859fb0b568b88e29e99e849257b536a78b87c9557e1f98fe196a8c1c0be3116c88676c74c58044f76cb69a2ae17a6093fcc463bd2ad5d914f551229c9b2
+  data.tar.gz: 10b347057b09a027bbaafc752363553ed117ada314ced7c383276863b9989eda8ec92e9eabee8697099c5b6db7b6e909002a7f86d40df821438b9dabadb15f55

data/CHANGELOG.md

@@ -1,3 +1,36 @@
+## Changes in 2.3.0
+
+### New Features
+
+* Add Support for trilogy_proxy from [active_record_proxy_adapters](https://rubygems.org/gems/active_record_proxy_adapters) by @mateuscruz via #887.
+* Add Support for sqlite3_proxy from [active_record_proxy_adapters](https://rubygems.org/gems/active_record_proxy_adapters) by @mateuscruz via #887.
+* Add affected rows support for the MySQL adapter. `ActiveRecord::Import::Result` now carries an
+  `affected_rows` member, which reports the number of rows the server actually reported as
+  affected when the adapter exposes it (`nil` otherwise). This is most useful with
+  `on_duplicate_key_update`, where the count distinguishes inserted from updated rows.
+  Thanks to @ehasrouni via #882 and #885.
+
+### Fixes
+
+* Fix `NoMethodError: undefined method 'validation_context='` when importing with validations
+  against Rails main (8.2.0.alpha). Rails removed ActiveModel's private `validation_context=`
+  writer in rails/rails@0f9d1270834a6407a59637650bf910d8ae826169 in favor of a validation
+  context object reachable through `context_for_validation`. `ActiveRecord::Import::Validator`
+  now sets and restores the validation context through whichever API the loaded ActiveModel
+  provides. Thanks to @yu-yaba via #900.
+* Fix adapter-specific import support (e.g. `on_duplicate_key_update`) never loading for
+  a connection established via `connects_to`/`ActiveRecord::ConnectionAdapters::
+  ConnectionHandler#establish_connection` instead of `ActiveRecord::Base.establish_connection`
+  directly - most commonly hit with a Rails multi-database secondary connection. The lazy
+  adapter loader now hooks `ConnectionHandler#establish_connection` instead of
+  `ActiveRecord::Base.establish_connection`, so it fires for every connection regardless of
+  how it was established. Thanks to @mateuscruz via #886.
+* Fix `active_record_proxy_adapters` support, which was not loading the import adapter for
+  proxied connections. Thanks to @mateuscruz via #880.
+* Use `with_connection` instead of `ActiveRecord::Base.connection`, which is deprecated as of
+  ActiveRecord 7.2. Thanks to @nerdrew via #875 and #876.
+* Reduce the size of the published gem by excluding test files. Thanks to @yuri-zubov via #893.
+
 ## Changes in 2.2.0
 
 ### New Features

data/README.markdown

@@ -121,20 +121,20 @@ Book.import values
 The `import` method can take an array of column names and an array of hash objects. The column names are used to determine what fields of data should be imported. The following example will only import books with the `title` field:
 
 ```ruby
-books = [
+values = [
   { title: "Book 1", author: "George Orwell" },
   { title: "Book 2", author: "Bob Jones" }
 ]
 columns = [ :title ]
 
 # without validations
-Book.import columns, books, validate: false
+Book.import columns, values, validate: false
 
 # with validations
-Book.import columns, books, validate: true
+Book.import columns, values, validate: true
 
 # when not specified :validate defaults to true
-Book.import columns, books
+Book.import columns, values
 
 # result in table books
 # title  | author
@@ -296,7 +296,7 @@ book.reload.title  # => "Book1"     (stayed the same)
 book.reload.author # => "George Orwell" (stayed the same)
 ```
 
-The option `:on_duplicate_key_ignore` is bypassed when `:recursive` is enabled for [PostgreSQL imports](https://github.com/zdennis/activerecord-import/wiki#recursive-example-postgresql-only).
+The option `:on_duplicate_key_ignore` is bypassed when `:recursive` is enabled for [PostgreSQL imports](https://rubydoc.info/gems/activerecord-import/ActiveRecord/Base#label-Options) (`:recursive` is not supported with other adapters).
 
 #### Duplicate Key Update
 
@@ -507,10 +507,10 @@ The following database adapters are currently supported:
 * MySQL2 - supports core import functionality plus on duplicate key update support (included in activerecord-import 0.2.0 and higher)
 * PostgreSQL - supports core import functionality (included in activerecord-import 0.1.0 and higher)
 * SQLite3 - supports core import functionality (included in activerecord-import 0.1.0 and higher)
-* Oracle - supports core import functionality through DML trigger (available as an external gem: [activerecord-import-oracle_enhanced](https://github.com/keeguon/activerecord-import-oracle_enhanced)
-* SQL Server - supports core import functionality (available as an external gem: [activerecord-import-sqlserver](https://github.com/keeguon/activerecord-import-sqlserver)
+* Oracle - supports core import functionality through DML trigger (available as an external gem: [activerecord-import-oracle_enhanced](https://github.com/keeguon/activerecord-import-oracle_enhanced))
+* SQL Server - supports core import functionality (available as an external gem: [activerecord-import-sqlserver](https://github.com/keeguon/activerecord-import-sqlserver))
 
-If your adapter isn't listed here, please consider creating an external gem as described in the README to provide support. If you do, feel free to update this wiki to include a link to the new adapter's repository!
+If your adapter isn't listed here, please consider creating an external gem as described in the README to provide support. If you do, feel free to update this README to include a link to the new adapter's repository!
 
 To test which features are supported by your adapter, use the following methods on a model class:
 * `supports_import?(*args)`
@@ -624,7 +624,7 @@ See https://github.com/zdennis/activerecord-import/issues/233 for further discus
 
 ### More Information
 
-For more information on Activerecord-Import please see its wiki: https://github.com/zdennis/activerecord-import/wiki
+For more information on Activerecord-Import please see its docs: https://rubydoc.info/gems/activerecord-import/ActiveRecord/Base
 
 To document new information, please add to the README instead of the wiki. See https://github.com/zdennis/activerecord-import/issues/397 for discussion.
 

data/lib/activerecord-import/active_record/adapters/mysql2_proxy_adapter.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "active_record/connection_adapters/mysql2_proxy_adapter"
+require "activerecord-import/adapters/mysql2_proxy_adapter"
+
+ActiveSupport.on_load(:active_record_mysql2proxyadapter) do |klass|
+  klass.include(ActiveRecord::Import::Mysql2ProxyAdapter)
+end

data/lib/activerecord-import/active_record/adapters/postgresql_proxy_adapter.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "active_record/connection_adapters/postgresql_proxy_adapter"
+require "activerecord-import/adapters/postgresql_proxy_adapter"
+
+ActiveSupport.on_load(:active_record_postgresqlproxyadapter) do |klass|
+  klass.include(ActiveRecord::Import::PostgreSQLProxyAdapter)
+end

data/lib/activerecord-import/active_record/adapters/sqlite3_proxy_adapter.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "active_record/connection_adapters/sqlite3_proxy_adapter"
+require "activerecord-import/adapters/sqlite3_proxy_adapter"
+
+ActiveSupport.on_load(:active_record_sqlite3proxyadapter) do |klass|
+  klass.include(ActiveRecord::Import::SQLite3ProxyAdapter)
+end

data/lib/activerecord-import/active_record/adapters/trilogy_proxy_adapter.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "active_record/connection_adapters/trilogy_proxy_adapter"
+require "activerecord-import/adapters/trilogy_proxy_adapter"
+
+ActiveSupport.on_load(:active_record_trilogyproxyadapter) do |klass|
+  klass.include(ActiveRecord::Import::TrilogyProxyAdapter)
+end

data/lib/activerecord-import/adapters/active_record_proxy_adapter.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ActiveRecord::Import::ActiveRecordProxyAdapter
+  def insert_many(*args, **kwargs, &block)
+    sticking_to_primary { super(*args, **kwargs, &block) }
+  end
+
+  def insert(*args, **kwargs, &block)
+    sticking_to_primary { super(*args, **kwargs, &block) }
+  end
+
+  def sticking_to_primary(&block)
+    ActiveRecord::Base.connected_to(role: writing_role, &block)
+  end
+
+  def writing_role
+    ActiveRecord.try(:writing_role) || ActiveRecord::Base.try(:writing_role) || :writing
+  end
+end

data/lib/activerecord-import/adapters/mysql2_proxy_adapter.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "activerecord-import/adapters/mysql2_adapter"
+require "activerecord-import/adapters/active_record_proxy_adapter"
+
+module ActiveRecord::Import::Mysql2ProxyAdapter
+  include ActiveRecord::Import::Mysql2Adapter
+  include ActiveRecord::Import::ActiveRecordProxyAdapter
+end

data/lib/activerecord-import/adapters/mysql_adapter.rb

@@ -12,6 +12,7 @@ module ActiveRecord::Import::MysqlAdapter
   def insert_many( sql, values, options = {}, *args ) # :nodoc:
     # the number of inserts default
     number_of_inserts = 0
+    affected_rows = nil
 
     base_sql, post_sql = case sql
                          when String
@@ -37,7 +38,10 @@ module ActiveRecord::Import::MysqlAdapter
     if max == NO_MAX_PACKET || total_bytes <= max || options[:force_single_insert]
       number_of_inserts += 1
       sql2insert = base_sql + values.join( ',' ) + post_sql
-      insert( sql2insert, *args )
+      result = execute( sql2insert, *args )
+      if result.respond_to?(:affected_rows)
+        affected_rows = (affected_rows || 0) + result.affected_rows
+      end
     else
       value_sets = ::ActiveRecord::Import::ValueSetsBytesParser.parse(values,
         reserved_bytes: sql_size,
@@ -47,12 +51,15 @@ module ActiveRecord::Import::MysqlAdapter
         value_sets.each do |value_set|
           number_of_inserts += 1
           sql2insert = base_sql + value_set.join( ',' ) + post_sql
-          insert( sql2insert, *args )
+          result = execute( sql2insert, *args )
+          if result.respond_to?(:affected_rows)
+            affected_rows = (affected_rows || 0) + result.affected_rows
+          end
         end
       end
     end
 
-    ActiveRecord::Import::Result.new([], number_of_inserts, [], [])
+    ActiveRecord::Import::Result.new([], number_of_inserts, [], [], affected_rows)
   end
 
   # Returns the maximum number of bytes that the server will allow

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

@@ -93,7 +93,7 @@ module ActiveRecord::Import::PostgreSQLAdapter
       sql << " RETURNING #{selections.join(', ')}"
     end
 
-    sql
+    sql.uniq
   end
 
   def returning_selections(options)

data/lib/activerecord-import/adapters/postgresql_proxy_adapter.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "activerecord-import/adapters/postgresql_adapter"
+require "activerecord-import/adapters/active_record_proxy_adapter"
+
+module ActiveRecord::Import::PostgreSQLProxyAdapter
+  include ActiveRecord::Import::PostgreSQLAdapter
+  include ActiveRecord::Import::ActiveRecordProxyAdapter
+end

data/lib/activerecord-import/adapters/sqlite3_proxy_adapter.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "activerecord-import/adapters/sqlite3_adapter"
+require "activerecord-import/adapters/active_record_proxy_adapter"
+
+module ActiveRecord::Import::SQLite3ProxyAdapter
+  include ActiveRecord::Import::SQLite3Adapter
+  include ActiveRecord::Import::ActiveRecordProxyAdapter
+end

data/lib/activerecord-import/adapters/trilogy_proxy_adapter.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "activerecord-import/adapters/trilogy_adapter"
+require "activerecord-import/adapters/active_record_proxy_adapter"
+
+module ActiveRecord::Import::TrilogyProxyAdapter
+  include ActiveRecord::Import::TrilogyAdapter
+  include ActiveRecord::Import::ActiveRecordProxyAdapter
+end

data/lib/activerecord-import/base.rb

@@ -11,11 +11,9 @@ module ActiveRecord::Import
     case adapter
     when 'mysql2_makara' then 'mysql2'
     when 'mysql2spatial' then 'mysql2'
-    when 'mysql2_proxy' then 'mysql2'
     when 'janus_mysql2' then 'mysql2'
     when 'spatialite' then 'sqlite3'
     when 'postgresql_makara' then 'postgresql'
-    when 'postgresql_proxy' then 'postgresql'
     when 'makara_postgis' then 'postgresql'
     when 'postgis' then 'postgresql'
     when 'cockroachdb' then 'postgresql'