active_record_upsert 0.9.2 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98aadc2aa0c0144f2e76c0ccfffa7102a93e3ef1ea1b073df4bc89f1f162f9cb
-  data.tar.gz: 9066f7f3cc3b0eedc43778de03ab2d9599d645992f4466f8aa987dfff3eaeb06
+  metadata.gz: e985d64fa74dedda4c75a2d8fb61f91e7ca89eca2d4c6e6c1bc62f9bf8c0499c
+  data.tar.gz: 3acce358c953805747e39c96d1028ed92715c38ac90a07f744eb8e12f76c278a
 SHA512:
-  metadata.gz: eec007a7ae73f4ccb52fda438a9c73182b2f87f8154a5bdfebd1ba49f7a4ea67289e224eafa9bfa1d571a028f37ddc12d8b795c1ef75772a8bde2c70369e11b7
-  data.tar.gz: e6d6f827e67c2c77c22eba302a9be7d3bf4fc435320e0725aa501c618f5ead4d592640f958bf316a866861549adc2bd293daeee816e448d954cc8a66c28fb9f6
+  metadata.gz: aea0bae90f0a51b27a1b3b8e24ad7bdf59c26a80433f4997892f7f5b1d1ea616f1b70731e56f052b7c9d7241b397f0613a6e2e8d0854021ba97c5ea623ab37af
+  data.tar.gz: 0c9ca9e4d570cbb4741cdd34feb71bc4b236a09c263dfc4c65a0d6092a63ec1c2a776a49cb4e64386f03e7d46502b6140ab3792b5b755c2a1e809a94cc866114

data/.github/workflows/ci.yml

@@ -0,0 +1,51 @@
+name: CI
+
+on:
+  pull_request:
+    branches: [$default-branches]
+  push:
+    branches: [$default-branch]
+
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    services:
+      postgres:
+        images: postgres
+        env:
+          POSTGRES_DB: upsert_test
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_USER: postgres
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: [2.5.x, 2.6.x, 2.7.x]
+        gemfile: [Gemfile, Gemfile.rails-master, Gemfile.rails-6-1, Gemfile.rails-5-2, Gemfile.rails-5-1, Gemfile.rails-5-0]
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Prepare database
+        run: |
+          createdb --echo -U $POSTGRES_USER $POSTGRES_DB
+          psql -U $POSTGRES_USER $POSTGRES_DB < spec/dummy/db/structure.sql
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+        env:
+          BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+
+      - name: Run Tests
+        run: bundle exec rake spec

data/Gemfile.base

@@ -5,7 +5,7 @@ gemspec
 group :development, :test do
   gem 'bundler', '>= 1.13'
   gem 'database_cleaner', '~> 1.6'
-  gem 'pg', '~> 0.18'
+  gem 'pg', '~> 1.1'
   gem 'pry', '> 0'
   gem 'rake', '>= 10.0'
   gem 'rspec', '>= 3.0', '< 4'

data/Gemfile.rails-5-2

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

data/Gemfile.rails-6-0

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

data/Gemfile.rails-6-1

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

data/README.md

@@ -1,11 +1,10 @@
 [![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)
-[![Dependency Status](https://gemnasium.com/badges/github.com/jesjos/active_record_upsert.svg)](https://gemnasium.com/github.com/jesjos/active_record_upsert)
 
 # ActiveRecordUpsert
 
-Real upsert for PostgreSQL 9.5+ and Rails 5 / ActiveRecord 5. Uses [ON CONFLICT DO UPDATE](http://www.postgresql.org/docs/9.5/static/sql-insert.html).
+Real upsert for PostgreSQL 9.5+ and Rails 5+ / ActiveRecord 5+. Uses [ON CONFLICT DO UPDATE](http://www.postgresql.org/docs/9.5/static/sql-insert.html).
 
 ## Main points
 
@@ -15,12 +14,17 @@ Real upsert for PostgreSQL 9.5+ and Rails 5 / ActiveRecord 5. Uses [ON CONFLICT
 
 ## Prerequisites
 
-- PostgreSQL 9.5+
-- ActiveRecord ~> 5
+- PostgreSQL 9.5+ (that's when UPSERT support was added; see Wikipedia's [PostgreSQL Release History](https://en.wikipedia.org/wiki/PostgreSQL#Release_history))
+- ActiveRecord >= 5
 - For MRI: pg
 
 - For JRuby: No support
 
+### NB: Releases to avoid
+
+Due to a broken build matrix, v0.9.2 and v0.9.3 are incompatible with Rails
+< 5.2.1. [v0.9.4](https://github.com/jesjos/active_record_upsert/releases/tag/v0.9.4) fixed this issue.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -119,6 +123,37 @@ r = MyRecord.new(id: 1, name: 'bar')
 r.upsert!
 ```
 
+### Gotcha with database defaults
+
+When a table is defined with a database default for a field, this gotcha can occur when trying to explicitly upsert a record _to_ the default value (from a non-default value).
+
+**Example**: a table called `hardwares` has a `prio` column with a default value.
+
+    ┌─────────┬─────────┬───────┬
+    │ 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`. 
+
+In this situation, upserting like:
+
+```ruby
+hw = { id: 1, prio: 999 }
+Hardware.new(prio: hw[:prio]).upsert
+```
+
+will not mention the `prio` column in the `ON CONFLICT` clause, resulting in no update.
+
+However, upserting like so:
+
+```ruby
+Hardware.upsert(prio: hw[:prio]).id
+```
+
+will indeed update the record in the database back to its default value, `999`.
+
 ### Conflict Clauses
 
 It's possible to specify which columns should be used for the conflict clause. **These must comprise a unique index in Postgres.**
@@ -156,6 +191,24 @@ class Account < ApplicationRecord
 end
 ```
 
+Overriding the models' `upsert_keys` when calling `#upsert` or `.upsert`:
+
+```ruby
+  Account.upsert(attrs, opts: { upsert_keys: [:foo, :bar] })
+  # Or, on an instance:
+  account = Account.new(attrs)
+  account.upsert(opts: { upsert_keys: [:foo, :bar] })
+```
+
+Overriding the models' `upsert_options` (partial index) when calling `#upsert` or `.upsert`:
+
+```ruby
+  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 } })
+```
+
 ## Tests
 
 Make sure to have an upsert_test database:
@@ -186,3 +239,6 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/jesjos
 - Daniel Cooper ([@danielcooper](https://github.com/danielcooper))
 - Laurent Vallar ([@val](https://github.com/val))
 - Emmanuel Quentin ([@manuquentin](https://github.com/manuquentin))
+- Jeff Wallace ([@tjwallace](https://github.com/tjwallace))
+- Kirill Zaitsev ([@Bugagazavr](https://github.com/Bugagazavr))
+- Nick Campbell ([@nickcampbell18](https://github.com/nickcampbell18))

data/active_record_upsert.gemspec

@@ -21,7 +21,6 @@ Gem::Specification.new do |spec|
 
   spec.platform = Gem::Platform::RUBY
 
-  spec.add_runtime_dependency 'activerecord', '>= 5.0', '< 6.0'
-  spec.add_runtime_dependency 'arel', '> 7.0', '< 10.0'
+  spec.add_runtime_dependency 'activerecord', '>= 5.0', '< 6.2'
   spec.add_runtime_dependency 'pg', '>= 0.18', '< 2.0'
 end

data/lib/active_record_upsert.rb

@@ -13,6 +13,7 @@ require 'active_record_upsert/active_record'
 
 version = defined?(Rails) ? Rails.version : ActiveRecord.version.to_s
 
+require 'active_record_upsert/compatibility/rails60.rb' if version >= '6.0.0' && version < '6.2.0'
 require 'active_record_upsert/compatibility/rails51.rb' if version >= '5.1.0' && version < '5.2.0'
 require 'active_record_upsert/compatibility/rails50.rb' if version >= '5.0.0' && version < '5.1.0'
 

data/lib/active_record_upsert/active_record/connection_adapters/postgresql/database_statements.rb

@@ -9,7 +9,7 @@ module ActiveRecordUpsert
           end
 
           def exec_upsert(sql, name, binds)
-            exec_query("#{sql} RETURNING *, (xmax::text::int = 0) AS _upsert_created_record", name, binds)
+            exec_query("#{sql} RETURNING *, (xmax = 0) AS _upsert_created_record", name, binds)
           end
         end
       end

data/lib/active_record_upsert/active_record/persistence.rb

@@ -1,7 +1,7 @@
 module ActiveRecordUpsert
   module ActiveRecord
     module PersistenceExtensions
-      def upsert!(attributes: nil, arel_condition: nil, validate: true)
+      def upsert!(attributes: nil, arel_condition: nil, validate: true, opts: {})
         raise ::ActiveRecord::ReadOnlyRecord, "#{self.class} is marked as readonly" if readonly?
         raise ::ActiveRecord::RecordSavedError, "Can't upsert a record that has already been saved" if persisted?
         validate == false || perform_validations || raise_validation_error
@@ -11,7 +11,7 @@ module ActiveRecordUpsert
             attributes = attributes +
               timestamp_attributes_for_create_in_model +
               timestamp_attributes_for_update_in_model
-            _upsert_record(attributes.map(&:to_s).uniq, arel_condition)
+            _upsert_record(attributes.map(&:to_s).uniq, arel_condition, opts)
           }
         }
 
@@ -24,11 +24,13 @@ module ActiveRecordUpsert
         false
       end
 
-      def _upsert_record(upsert_attribute_names = changed, arel_condition = nil)
-        existing_attributes = attributes_with_values_for_create(self.attributes.keys)
-        values = self.class._upsert_record(existing_attributes, upsert_attribute_names, [arel_condition].compact)
+      def _upsert_record(upsert_attribute_names = changed, arel_condition = nil, opts = {})
+        existing_attribute_names = attributes_for_create(attributes.keys)
+        existing_attributes = attributes_with_values(existing_attribute_names)
+        values = self.class._upsert_record(existing_attributes, upsert_attribute_names, [arel_condition].compact, opts)
         @attributes = self.class.attributes_builder.build_from_database(values.first.to_h)
         @new_record = false
+        changes_applied
         values
       end
 
@@ -39,12 +41,12 @@ module ActiveRecordUpsert
       end
 
       module ClassMethods
-        def upsert!(attributes, arel_condition: nil, validate: true, &block)
+        def upsert!(attributes, arel_condition: nil, validate: true, opts: {}, &block)
           if attributes.is_a?(Array)
             attributes.collect { |hash| upsert(hash, &block) }
           else
             new(attributes, &block).upsert!(
-              attributes: attributes.keys, arel_condition: arel_condition, validate: validate
+              attributes: attributes.keys, arel_condition: arel_condition, validate: validate, opts: opts
             )
           end
         end
@@ -55,8 +57,9 @@ module ActiveRecordUpsert
           false
         end
 
-        def _upsert_record(existing_attributes, upsert_attributes_names, wheres) # :nodoc:
-          upsert_keys = self.upsert_keys || [primary_key]
+        def _upsert_record(existing_attributes, upsert_attributes_names, wheres, opts) # :nodoc:
+          upsert_keys = opts[:upsert_keys] || self.upsert_keys || [primary_key]
+          upsert_options = opts[:upsert_options] || self.upsert_options
           upsert_attributes_names = upsert_attributes_names - [*upsert_keys, 'created_at']
 
           existing_attributes = existing_attributes

data/lib/active_record_upsert/compatibility/rails51.rb

@@ -1,18 +1,30 @@
 module ActiveRecordUpsert
   module ActiveRecord
     module PersistenceExtensions
-      def _upsert_record(upsert_attribute_names = changed, arel_condition = nil)
-        existing_attributes = arel_attributes_with_values_for_create(self.attributes.keys)
-        values = self.class.unscoped.upsert(existing_attributes, upsert_attribute_names, [arel_condition].compact)
+      def _upsert_record(upsert_attribute_names = changed, arel_condition = nil, opts = {})
+        upsert_attribute_names = upsert_attribute_names.map { |name| _prepare_column(name) } & self.class.column_names
+        existing_attributes = arel_attributes_with_values_for_create(self.class.column_names)
+        values = self.class.unscoped.upsert(existing_attributes, upsert_attribute_names, [arel_condition].compact, opts)
         @new_record = false
+        @attributes = self.class.attributes_builder.build_from_database(values.first.to_h)
+        changes_applied
         values
       end
+
+      def _prepare_column(name)
+        if self.class.reflections.key?(name)
+          self.class.reflections[name].foreign_key
+        else
+          name
+        end
+      end
     end
 
     module RelationExtensions
-      def upsert(existing_attributes, upsert_attributes, wheres) # :nodoc:
+      def upsert(existing_attributes, upsert_attributes, wheres, opts) # :nodoc:
         substitutes, binds = substitute_values(existing_attributes)
-        upsert_keys = self.klass.upsert_keys || [primary_key]
+        upsert_keys = opts[:upsert_keys] || self.klass.upsert_keys || [primary_key]
+        upsert_options = opts[:upsert_options] || self.klass.upsert_options
 
         upsert_attributes = upsert_attributes - [*upsert_keys, 'created_at']
         upsert_keys_filter = ->(o) { upsert_attributes.include?(o.name) }
@@ -20,9 +32,11 @@ module ActiveRecordUpsert
         on_conflict_binds = binds.select(&upsert_keys_filter)
         vals_for_upsert = substitutes.select { |s| upsert_keys_filter.call(s.first) }
 
+        target = arel_table[upsert_options.key?(:literal) ? ::Arel::Nodes::SqlLiteral.new(upsert_options[:literal]) : upsert_keys.join(',')]
+
         on_conflict_do_update = ::Arel::OnConflictDoUpdateManager.new
-        on_conflict_do_update.target = arel_table[upsert_keys.join(',')]
-        on_conflict_do_update.target_condition = self.klass.upsert_options[:where]
+        on_conflict_do_update.target = target
+        on_conflict_do_update.target_condition = upsert_options[:where]
         on_conflict_do_update.wheres = wheres
         on_conflict_do_update.set(vals_for_upsert)
 
@@ -31,7 +45,7 @@ module ActiveRecordUpsert
         insert_manager.on_conflict = on_conflict_do_update.to_node
         insert_manager.insert substitutes
 
-        @klass.connection.upsert(insert_manager, "#{self} Upsert", binds + on_conflict_binds)
+        @klass.connection.upsert(insert_manager, "#{@klass.name} Upsert", binds + on_conflict_binds)
       end
 
       ::ActiveRecord::Relation.include(self)

data/lib/active_record_upsert/compatibility/rails60.rb

@@ -0,0 +1,18 @@
+module ActiveRecordUpsert
+  module ActiveRecord
+    module TransactionsExtensions
+      def upsert(*args)
+        with_transaction_returning_status { super }
+      end
+    end
+
+    module ConnectAdapterExtension
+      def upsert(*args)
+        ::ActiveRecord::Base.clear_query_caches_for_current_thread
+        super
+      end
+
+      ::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.prepend(self)
+    end
+  end
+end

data/lib/active_record_upsert/version.rb

@@ -1,3 +1,3 @@
 module ActiveRecordUpsert
-  VERSION = "0.9.2"
+  VERSION = "0.10.1"
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: active_record_upsert
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.10.1
 platform: ruby
 authors:
 - Jesper Josefsson
 - Olle Jonsson
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-08-12 00:00:00.000000000 Z
+date: 2021-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -20,7 +20,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -30,27 +30,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
-- !ruby/object:Gem::Dependency
-  name: arel
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '7.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '7.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -71,7 +51,7 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: 
+description:
 email:
 - jesper.josefsson@gmail.com
 - olle.jonsson@gmail.com
@@ -79,10 +59,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - Gemfile.base
 - Gemfile.rails-5-0
 - Gemfile.rails-5-1
 - Gemfile.rails-5-2
+- Gemfile.rails-6-0
+- Gemfile.rails-6-1
 - Gemfile.rails-master
 - LICENSE
 - README.md
@@ -109,12 +92,13 @@ files:
 - lib/active_record_upsert/arel/visitors/to_sql.rb
 - lib/active_record_upsert/compatibility/rails50.rb
 - lib/active_record_upsert/compatibility/rails51.rb
+- lib/active_record_upsert/compatibility/rails60.rb
 - lib/active_record_upsert/version.rb
 homepage: https://github.com/jesjos/active_record_upsert/
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -129,9 +113,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.2.7
+signing_key:
 specification_version: 4
 summary: Real PostgreSQL 9.5+ upserts using ON CONFLICT for ActiveRecord
 test_files: []