active_record_upsert 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 861dbd4abac80eae38c3644d5a982f3b4c7d95a8
-  data.tar.gz: fe700280c47b2cff78e3f8eeed2a14d966a10b72
+SHA256:
+  metadata.gz: b6c3d046d77a439d261ab965fc32e843c070959b40300db46e299fe025bdbe2e
+  data.tar.gz: 21849093ff6d5ca811aa039d83da437cb9d2cb995e2e8e2c74248352f7b069ff
 SHA512:
-  metadata.gz: 3254084380ac0b9a14189ed071f53ec45e74d2701962b892720839d93b2855156e684f26e025742d19e8575031b3062e662c034bc19705caacabfafddde1a6ad
-  data.tar.gz: 859f1a55e2f6f2b64f192f18f305ae634fc50b4d24475a01bd5d0049cf4ad6d70cb931bd7215d4cfae492941046c04b4f15ca7a907fc2bbe844635bec5a0e340
+  metadata.gz: fe9a96f9703a0a3086bc83052d97093cf1aa377a3425e9e03d054e9248aa62fb0eabc9098f8483938ba1b343464470ebb015f8016a5df8bdc6564c193fb9400a
+  data.tar.gz: 17ef7f689953232f9ce646f8d3ff24708482d4009ea47bf9ffd26b5170928aadbf6b8d37c557a7e45995c73071eda076447b320db9a7d3bfcdc5bfd04c9acd5c

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Jesper Josefsson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -38,8 +38,10 @@ Or install it yourself as:
     $ gem install active_record_upsert
 
 ## Usage
-Just use `ActiveRecord.upsert` or `ActiveRecord#upsert`.
-*ActiveRecordUpsert* respects timestamps.
+
+### Create
+
+Use `ActiveRecord.upsert` or `ActiveRecord#upsert`. *ActiveRecordUpsert* respects timestamps.
 
 ```ruby
 class MyRecord < ActiveRecord::Base
@@ -57,7 +59,69 @@ r.upsert
 # => #<MyRecord id: 1, name: "bar", created_at: "2016-02-20 14:15:55", updated_at: "2016-02-20 14:18:49", wisdom: 3>
 ```
 
-Also, it's possible to specify which columns should be used for the conflict clause. **These must comprise a unique index in Postgres.**
+### Update
+
+If you need to specify a condition for the update, pass it as an Arel query:
+
+```ruby
+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):
+
+```ruby
+r = MyRecord.new(id: 1)
+r.name = 'bar'
+r.color = 'blue'
+r.upsert(attributes: [:name], arel_condition: MyRecord.arel_table[:updated_at].lt(1.day.ago))
+# will only update :name, and only if the record is older than 1 day;
+# but if the record does not exist, will insert with both :name and :colors
+```
+
+### 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:
+
+```ruby
+existing_record = MyRecord.create(id: 1, name: 'lemon', color: 'green')
+r = MyRecord.new(id: 1, name: 'banana', color: 'yellow')
+r.upsert(attributes: [:color])
+# => #<MyRecord id: 1, name: "lemon", color: "yellow", ...>
+
+r = MyRecord.new(id: 2, name: 'banana', color: 'yellow')
+r.upsert(attributes: [:color])
+
+# => #<MyRecord id: 2, name: "banana", color: "yellow", ...>
+
+# This is similar to:
+
+MyRecord.create_with(name: 'banana').find_or_initialize_by(id: 2).update(color: 'yellow')
+
+```
+
+### 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!
+```
+
+### Conflict Clauses
+
+It's possible to specify which columns should be used for the conflict clause. **These must comprise a unique index in Postgres.**
 
 ```ruby
 class Vehicle < ActiveRecord::Base
@@ -97,3 +161,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/jesjos
 - Olle Jonsson
 - Simon Dahlbacka
 - Paul Hoffer
+- Ivan ([@me](https://github.com/me))
+- Leon Miller-Out ([@sbleon](https://github.com/sbleon))
+- Andrii Dmytrenko ([@Antti](https://github.com/Antti))
+- Alexia McDonald ([@alexiamcdonald](https://github.com/alexiamcdonald))

data/active_record_upsert.gemspec

@@ -9,6 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Jesper Josefsson", "Olle Jonsson"]
   spec.email         = ["jesper.josefsson@gmail.com", "olle.jonsson@gmail.com"]
   spec.homepage      = "https://github.com/jesjos/active_record_upsert/"
+  spec.license       = 'MIT'
 
   spec.summary       = %q{Real PostgreSQL 9.5+ upserts using ON CONFLICT for ActiveRecord}
 

data/lib/active_record_upsert/active_record/persistence.rb

@@ -2,39 +2,60 @@ module ActiveRecordUpsert
   module ActiveRecord
     module PersistenceExtensions
 
-      def upsert(attribute_names=nil)
+      def upsert!(attributes: nil, arel_condition: nil, validate: true)
         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
         values = run_callbacks(:save) {
           run_callbacks(:create) {
-            attribute_names ||= changed
-            attribute_names = attribute_names.map(&:to_s) +
+            attributes ||= changed
+            attributes = attributes +
               timestamp_attributes_for_create_in_model +
               timestamp_attributes_for_update_in_model
-            _upsert_record(attribute_names.uniq)
+            _upsert_record(attributes.map(&:to_s).uniq, arel_condition)
           }
         }
-        assign_attributes(values.first.to_h)
+
+        # When a migration adds a column to a table, the upsert will start
+        # returning the new attribute, and assign_attributes will fail,
+        # because Rails doesn't know about it yet (until the app is restarted).
+        #
+        # This checks that only known attributes are being assigned.
+        assign_attributes(values.first.to_h.slice(*self.attributes.keys))
         self
+      end
+
+      def upsert(*args)
+        upsert!(*args)
       rescue ::ActiveRecord::RecordInvalid
         false
       end
 
-      def _upsert_record(attribute_names = changed)
-        attributes_values = arel_attributes_with_values_for_create(attribute_names)
-        values = self.class.unscoped.upsert attributes_values
+
+      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)
         @new_record = false
         values
       end
 
       module ClassMethods
-        def upsert(attributes, &block)
+        def upsert!(attributes, arel_condition: nil, &block)
           if attributes.is_a?(Array)
             attributes.collect { |hash| upsert(hash, &block) }
           else
-            new(attributes, &block).upsert(attributes.keys)
+            new(attributes, &block).upsert!(
+              attributes: attributes.keys, arel_condition: arel_condition, validate: true
+            )
           end
         end
+
+        def upsert(*args)
+          upsert!(*args)
+        rescue ::ActiveRecord::RecordInvalid
+          false
+        end
+
         def upsert_keys(*keys)
           return @_upsert_keys if keys.empty?
           keys = keys.first if keys.size == 1 # support single string/symbol, multiple string/symbols, and array

data/lib/active_record_upsert/active_record/relation.rb

@@ -1,38 +1,31 @@
 module ActiveRecordUpsert
   module ActiveRecord
     module RelationExtensions
-      def upsert(values) # :nodoc:
-        primary_key_value = nil
+      def upsert(existing_attributes, upsert_attributes, wheres) # :nodoc:
+        substitutes, binds = substitute_values(existing_attributes)
+        upsert_keys = self.klass.upsert_keys || [primary_key]
 
-        if primary_key && Hash === values
-          primary_key_value = values[values.keys.find { |k|
-            k.name == primary_key
-          }]
-        end
+        upsert_attributes = upsert_attributes - [*upsert_keys, 'created_at']
+        upsert_keys_filter = ->(o) { upsert_attributes.include?(o.name) }
 
-        im = arel_table.create_insert
-        im.into arel_table
+        on_conflict_binds = binds.select(&upsert_keys_filter)
+        vals_for_upsert = substitutes.select { |s| upsert_keys_filter.call(s.first) }
 
-        substitutes, binds = substitute_values values
-        column_arr = self.klass.upsert_keys || [primary_key]
-        column_name = column_arr.join(',')
+        on_conflict_do_update = arel_table.create_on_conflict_do_update
+        on_conflict_do_update.target = arel_table[upsert_keys.join(',')]
+        on_conflict_do_update.wheres = wheres
+        on_conflict_do_update.set(vals_for_upsert)
 
-        cm = arel_table.create_on_conflict_do_update
-        cm.target = arel_table[column_name]
-        filter = ->(o) { [*column_arr, 'created_at'].include?(o.name) }
-
-        cm.set(substitutes.reject { |s| filter.call(s.first) })
-        on_conflict_binds = binds.reject(&filter)
-
-        im.on_conflict = cm.to_node
-
-        im.insert substitutes
+        insert_manager = arel_table.create_insert
+        insert_manager.into arel_table
+        insert_manager.on_conflict = on_conflict_do_update.to_node
+        insert_manager.insert substitutes
 
         @klass.connection.upsert(
-          im,
+          insert_manager,
           'SQL',
-          primary_key,       # not used
-          primary_key_value, # not used
+          nil, # primary key (not used)
+          nil, # primary key value (not used)
           nil,
           binds + on_conflict_binds)
       end

data/lib/active_record_upsert/version.rb

@@ -1,3 +1,3 @@
 module ActiveRecordUpsert
-  VERSION = "0.7.0"
+  VERSION = "0.7.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_record_upsert
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Jesper Josefsson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-22 00:00:00.000000000 Z
+date: 2018-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -73,6 +73,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
 - README.md
 - Rakefile
 - active_record_upsert.gemspec
@@ -98,7 +99,8 @@ files:
 - lib/active_record_upsert/arel/visitors/to_sql.rb
 - lib/active_record_upsert/version.rb
 homepage: https://github.com/jesjos/active_record_upsert/
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -116,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: Real PostgreSQL 9.5+ upserts using ON CONFLICT for ActiveRecord