active_record_upsert 0.11.0 → 0.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 459493128507f8a6ffd12fca94b8270cc93259601b4136c4686ae11f2acd7433
-  data.tar.gz: b3c8961297902a34a92d1f947980d4e1829d8e563401f54a7094d110df77fc66
+  metadata.gz: b647a02ad6d3383a5180bbe96ee50ec232434dabcbafc6ed58f37cfb4ebe9700
+  data.tar.gz: 761cd2ce8bceaf3ce856932aff29662d5b9dd861106bb723a8a3ef2ab79b018a
 SHA512:
-  metadata.gz: 9007d2d2c1889c6b2742783319b7d0c878cf47d01bee568126984390b8ba73e52384aa84ebff72f1cd0f895a42833a53bf55cfe6339b5a07de0353fe307b1f5c
-  data.tar.gz: 8e643c603a776f476a4a0407a5bfa301b0ef8afa726000a32b79fa95a6b036ab04f8360183cf7d33b694912e2577745efbe17418dc572a9a5b6554a757cad864
+  metadata.gz: c61f58fcf034b25c7e8f3e505ddd355decb422d827d2e1bebd6c5915c59b942c550853750e27c3248a9a222b75631ad33fed605de12d2ae33f6c95b30c1e766e
+  data.tar.gz: 82b587aea2863622cc87e7f443954f9087a1c2508a9b93c9a53681effcaec93d07aa933396337cae291261edfa813fda72874210b08b14d9b41b7870d36f7717

data/Gemfile.rails-5-2

@@ -1,5 +1,5 @@
 group :development, :test do
-  gem 'rails', '>= 5.2.1', '< 6.0'
+  gem 'rails', '~> 5.2.1'
 end
 
 eval_gemfile "#{__dir__}/Gemfile.base"

data/Gemfile.rails-6-0

@@ -1,5 +1,5 @@
 group :development, :test do
-  gem 'rails', '~> 6.0'
+  gem 'rails', '~> 6.0.0'
 end
 
 eval_gemfile "#{__dir__}/Gemfile.base"

data/Gemfile.rails-6-1

@@ -1,5 +1,5 @@
 group :development, :test do
-  gem 'rails', '~> 6.1'
+  gem 'rails', '~> 6.1.0'
 end
 
 eval_gemfile "#{__dir__}/Gemfile.base"

data/Gemfile.rails-7-0

@@ -1,5 +1,5 @@
 group :development, :test do
-  gem 'rails', '~> 7.0'
+  gem 'rails', '~> 7.0.0'
 end
 
 eval_gemfile "#{__dir__}/Gemfile.base"

data/Gemfile.rails-7-0-ruby-3-1

@@ -0,0 +1,5 @@
+group :development, :test do
+  gem 'rails', '~> 7.0.0', '>= 7.0.1' # 7.0.1 is the first version compatible with ruby 3.1
+end
+
+eval_gemfile "#{__dir__}/Gemfile.base"

data/Gemfile.rails-7-1

@@ -0,0 +1,5 @@
+group :development, :test do
+  gem 'rails', '~> 7.1.0'
+end
+
+eval_gemfile "#{__dir__}/Gemfile.base"

data/README.md

@@ -1,7 +1,5 @@
 [![Gem Version](https://badge.fury.io/rb/active_record_upsert.svg)](https://badge.fury.io/rb/active_record_upsert)
-[![Build Status](https://travis-ci.org/jesjos/active_record_upsert.svg?branch=master)](https://travis-ci.org/jesjos/active_record_upsert)
-[![Code Climate](https://codeclimate.com/github/jesjos/active_record_upsert/badges/gpa.svg)](https://codeclimate.com/github/jesjos/active_record_upsert)
-
+[![CI](https://github.com/jesjos/active_record_upsert/actions/workflows/ci.yml/badge.svg)](https://github.com/jesjos/active_record_upsert/actions/workflows/ci.yml)
 # ActiveRecordUpsert
 
 Real upsert for PostgreSQL 9.5+ and Rails 5.2+ / ActiveRecord 5.2+. Uses [ON CONFLICT DO UPDATE](http://www.postgresql.org/docs/9.5/static/sql-insert.html).
@@ -19,6 +17,12 @@ Real upsert for PostgreSQL 9.5+ and Rails 5.2+ / ActiveRecord 5.2+. Uses [ON CON
 - Ruby MRI, with the `pg` gem
 - _JRuby is currently not supported_
 
+## Alternatives
+
+This library was written at a time in history when Rails did not support any `#upsert` method.
+
+Instead of using this library, if you are using a current version of Rails, you may want to [use its `#upsert`](https://api.rubyonrails.org/classes/ActiveRecord/Persistence/ClassMethods.html#method-i-upsert). You may want to investigate how [newer PostgreSQL versions support `MERGE` statement](https://www.postgresql.org/docs/current/sql-merge.html).
+
 ### NB: Releases to avoid
 
 Due to a broken build matrix, v0.9.2 and v0.9.3 are incompatible with Rails
@@ -26,17 +30,11 @@ Due to a broken build matrix, v0.9.2 and v0.9.3 are incompatible with Rails
 
 ### Supported Rails versions
 
-This library is compatible with all major Rails versions covered by the Rails
-["Severe Security Issues" maintenance policy](https://guides.rubyonrails.org/maintenance_policy.html).
+This library is compatible with all major Rails versions covered by the Rails ["Severe Security Issues" maintenance policy](https://guides.rubyonrails.org/maintenance_policy.html).
 
 ### Supported Ruby versions
 
-This library may be compatible with older versions of Ruby, however we only run automated
-tests using the
-[officially supported Ruby versions](https://www.ruby-lang.org/en/downloads/branches/).
-
-Please note that Ruby 3.1 is not currently tested because it is incompatible with Rails
-`7.0.0`, `6.1.4.4`, `6.0.4.4` and `5.2.6` ([issue](https://github.com/rails/rails/issues/43998)).
+This library may be compatible with older versions of Ruby, however we only run automated tests using the [officially supported Ruby versions](https://www.ruby-lang.org/en/downloads/branches/).
 
 ## Installation
 
@@ -48,17 +46,21 @@ gem 'active_record_upsert'
 
 And then execute:
 
-    $ bundle
+```console
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install active_record_upsert
+```console
+gem install active_record_upsert
+```
 
 ## Usage
 
 ### Create
 
-Use `ActiveRecord.upsert` or `ActiveRecord#upsert`. *ActiveRecordUpsert* respects timestamps.
+Use `ActiveRecord.upsert` or `ActiveRecord#upsert`. _ActiveRecordUpsert_ respects timestamps.
 
 ```ruby
 class MyRecord < ActiveRecord::Base
@@ -84,8 +86,7 @@ If you need to specify a condition for the update, pass it as an Arel query:
 MyRecord.upsert({id: 1, wisdom: 3}, arel_condition: MyRecord.arel_table[:updated_at].lt(1.day.ago))
 ```
 
-The instance method `#upsert` can also take keyword arguments to specify a condition, or to limit which attributes to upsert
-(by default, all `changed` attributes will be passed to the upsert):
+The instance method `#upsert` can also take keyword arguments to specify a condition, or to limit which attributes to upsert (by default, all `changed` attributes will be passed to the upsert):
 
 ```ruby
 r = MyRecord.new(id: 1)
@@ -98,8 +99,7 @@ r.upsert(attributes: [:name], arel_condition: MyRecord.arel_table[:updated_at].l
 
 ### Create with specific Attributes
 
-If you want to create a record with the specific attributes, but update only a limited set of attributes,
-similar to how `ActiveRecord::Base.create_with` works, you can do the following:
+If you want to create a record with the specific attributes, but update only a limited set of attributes, similar to how `ActiveRecord::Base.create_with` works, you can do the following:
 
 ```ruby
 existing_record = MyRecord.create(id: 1, name: 'lemon', color: 'green')
@@ -121,16 +121,19 @@ MyRecord.create_with(name: 'banana').find_or_initialize_by(id: 2).update(color:
 ### Validations
 
 Upsert will perform validation on the object, and return false if it is not valid. To skip validation, pass `validate: false`:
+
 ```ruby
 MyRecord.upsert({id: 1, wisdom: 3}, validate: false)
 ```
 
 If you want validations to raise `ActiveRecord::RecordInvalid`, use `upsert!`:
+
 ```ruby
 MyRecord.upsert!(id: 1, wisdom: 3)
 ```
 
 Or using the instance method:
+
 ```ruby
 r = MyRecord.new(id: 1, name: 'bar')
 r.upsert!
@@ -142,11 +145,13 @@ When a table is defined with a database default for a field, this gotcha can occ
 
 **Example**: a table called `hardwares` has a `prio` column with a default value.
 
-    ┌─────────┬─────────┬───────┬
-    │ Column  │ Type    │Default│
-    ├─────────┼─────────┼───────┼
-    │ id      │ integer │ ...
-    │ prio    │ integer │ 999
+```text
+┌─────────┬─────────┬─────────┬
+│ Column  │ Type    │ Default │
+├─────────┼─────────┼─────────┼
+│ id      │ integer │ ...     |
+│ prio    │ integer │ 999     |
+```
 
 And `hardwares` has a record with a non-default value for `prio`. Say, the record with `id` 1 has a `prio` of `998`.
 
@@ -219,9 +224,26 @@ Overriding the models' `upsert_options` (partial index) when calling `#upsert` o
   Account.upsert(attrs, opts: { upsert_options: { where: 'foo IS NOT NULL' } })
   # Or, on an instance:
   account = Account.new(attrs)
-  account.upsert(opts: { upsert_options: { where: 'foo IS NOT NULLL } })
+  account.upsert(opts: { upsert_options: { where: 'foo IS NOT NULL' } })
 ```
 
+## Comparing to native Rails 6 Upsert
+
+Rails 6 (via the ["Add insert_many to ActiveRecord models" PR #35077](https://github.com/rails/rails/pull/35077)) added the ability to create or update individual records through `#insert` and `#upsert` and similarly the ability to create or update multiple records through `#insert_all` and `#upsert_all`.
+
+Here is a quick comparison of how the Rails native `ActiveRecord::Persistence#upsert` feature compares to what's offered in this gem:
+
+| Feature                                                 | `active_record_upsert`          | Rails native `ActiveRecord::Persistence#upsert`          |
+| ------------------------------------------------------- | ------------------------------- | -------------------------------------------------------- |
+| Set model level conflict clause                         | Yes, through `#upsert_keys`     | No, but can be passed in through the `:unique_by` option |
+| Ability to invoke validations and callbacks             | Yes                             | No                                                       |
+| Automatically sets `created_at`/`updated_at` timestamps | Yes                             | Yes (Rails 7.0+)                                         |
+| Checks for unique index on the database                 | No[^1]                          | Yes                                                      |
+| Use associations in upsert calls                        | Yes                             | No                                                       |
+| Return object type                                      | Instantiated ActiveRecord model | `ActiveRecord::Result`                                   |
+
+[^1]: Though the gem does not check for the index first, the upsert will still fail due to the database constraint.
+
 ## Tests
 
 Make sure to have an upsert_test database:
@@ -234,12 +256,12 @@ Then run `rspec`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/jesjos/active_record_upsert.
+Bug reports and pull requests are welcome on GitHub at <https://github.com/jesjos/active_record_upsert>.
 
 ## Contributors
 
 - Jesper Josefsson
-- Jens Nockert
+- Aurora Nockert
 - Olle Jonsson
 - Simon Dahlbacka
 - Paul Hoffer
@@ -256,3 +278,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/jesjos
 - Kirill Zaitsev ([@Bugagazavr](https://github.com/Bugagazavr))
 - Nick Campbell ([@nickcampbell18](https://github.com/nickcampbell18))
 - Mikhail Doronin ([@misdoro](https://github.com/misdoro))
+- Jan Graichen ([@jgraichen](https://github.com/jgraichen))

data/active_record_upsert.gemspec

@@ -21,6 +21,6 @@ Gem::Specification.new do |spec|
 
   spec.platform = Gem::Platform::RUBY
 
-  spec.add_runtime_dependency 'activerecord', '>= 5.2', '< 7.1'
+  spec.add_runtime_dependency 'activerecord', '>= 5.2', '< 7.2'
   spec.add_runtime_dependency 'pg', '>= 0.18', '< 2.0'
 end

data/lib/active_record_upsert/version.rb

@@ -1,3 +1,3 @@
 module ActiveRecordUpsert
-  VERSION = "0.11.0"
+  VERSION = "0.11.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_record_upsert
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.11.2
 platform: ruby
 authors:
 - Jesper Josefsson
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-07 00:00:00.000000000 Z
+date: 2023-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -20,7 +20,7 @@ dependencies:
         version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -30,7 +30,7 @@ dependencies:
         version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -64,7 +64,9 @@ files:
 - Gemfile.rails-6-0
 - Gemfile.rails-6-1
 - Gemfile.rails-7-0
-- Gemfile.rails-master
+- Gemfile.rails-7-0-ruby-3-1
+- Gemfile.rails-7-1
+- Gemfile.rails-main
 - LICENSE
 - README.md
 - Rakefile
@@ -110,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.7
+rubygems_version: 3.5.0.dev
 signing_key:
 specification_version: 4
 summary: Real PostgreSQL 9.5+ upserts using ON CONFLICT for ActiveRecord