Update for Rails 6.0.0.rc1

Author: tbuehlmann

Gemfile.lock

@@ -2,32 +2,31 @@ PATH
   remote: .
   specs:
     active_record-returning_attributes (0.1.0)
-      activerecord
+      activerecord (= 6.0.0.rc1)
       pg
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (5.2.0)
-      activesupport (= 5.2.0)
-    activerecord (5.2.0)
-      activemodel (= 5.2.0)
-      activesupport (= 5.2.0)
-      arel (>= 9.0)
-    activesupport (5.2.0)
+    activemodel (6.0.0.rc1)
+      activesupport (= 6.0.0.rc1)
+    activerecord (6.0.0.rc1)
+      activemodel (= 6.0.0.rc1)
+      activesupport (= 6.0.0.rc1)
+    activesupport (6.0.0.rc1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    arel (9.0.0)
+      zeitwerk (~> 2.1, >= 2.1.4)
     coderay (1.1.2)
-    concurrent-ruby (1.0.5)
+    concurrent-ruby (1.1.5)
     diff-lcs (1.3)
-    i18n (1.0.1)
+    i18n (1.6.0)
       concurrent-ruby (~> 1.0)
     method_source (0.9.0)
     minitest (5.11.3)
-    pg (1.0.0)
+    pg (1.1.4)
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
@@ -52,6 +51,7 @@ GEM
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
     yard (0.9.12)
+    zeitwerk (2.1.9)
 
 PLATFORMS
   ruby
@@ -65,4 +65,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.16.2
+   1.17.2

README.md

@@ -11,7 +11,7 @@ Internally this library changes the `RETURNING` clause for inserts and adds it f
 Caveats:
 
 - PostgreSQL only
-- Only tested in Rails 5.2.0
+- Only tested in Rails 6.0.0.rc1
 - Overrides ActiveRecord core code
 
 ## Installation

activerecord-returning_attributes.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'activerecord'
+  spec.add_runtime_dependency 'activerecord', '6.0.0.rc1'
   spec.add_runtime_dependency 'pg'
 
   spec.add_development_dependency 'bundler', '~> 1.16'

lib/active_record/returning_attributes.rb

@@ -22,7 +22,7 @@ def self.postgresql?
       end
     end
 
-    def self.active_record_5_2_tested_only
+    def self.active_record_6_0_0_rc1_tested_only
       unless ActiveRecord.version == Gem::Version.new('5.2.0')
         warn 'ActiveRecord::ReturningAttributes was only tested on ActiveRecord 5.2.0 and might not work with your version.'
       end
@@ -36,7 +36,7 @@ def self.active_record_5_2_tested_only
         ReturningAttributes::Patching.patch_postgresql_database_statements
         ReturningAttributes::Patching.patch_postgresql_adapter
 
-        ReturningAttributes.active_record_5_2_tested_only
+        ReturningAttributes.active_record_6_0_0_rc1_tested_only
       end
     end
   end

lib/active_record/returning_attributes/accessor.rb

@@ -5,8 +5,16 @@ module ReturningAttributes
     module Accessor
       extend ActiveSupport::Concern
 
-      included do
-        class_attribute :returning_attributes, default: []
+      def returning_attributes
+        self.class.returning_attributes
+      end
+
+      module ClassMethods
+        attr_reader :returning_attributes
+
+        def returning_attributes=(attributes)
+          @returning_attributes = attributes.map(&:to_s)
+        end
       end
     end
   end

lib/active_record/returning_attributes/patching.rb

@@ -12,18 +12,32 @@ def self.patch_persistence
         Persistence.module_eval do
           private
 
+          # def _create_record(attribute_names = self.attribute_names)
+          #   attribute_names = attributes_for_create(attribute_names)
+
+          #   new_id = self.class._insert_record(
+          #     attributes_with_values(attribute_names)
+          #   )
+
+          #   self.id ||= new_id if @primary_key
+
+          #   @new_record = false
+
+          #   yield(self) if block_given?
+
+          #   id
+          # end
           def _create_record(attribute_names = self.attribute_names)
-            attribute_names &= self.class.column_names
-            attributes_values = attributes_with_values_for_create(attribute_names)
+            attribute_names = attributes_for_create(attribute_names)
 
             new_id, returned_attributes = self.class.connection.with_returning_attributes(returning_attributes) do
-              self.class._insert_record(attributes_values)
+              self.class._insert_record(attributes_with_values(attribute_names))
             end
 
-            self.id ||= new_id if self.class.primary_key
+            self.id ||= new_id if @primary_key
 
             returning_attributes.each do |attribute|
-              write_attribute(attribute, returned_attributes[attribute.to_s]) if returned_attributes.key?(attribute.to_s)
+              write_attribute(attribute, returned_attributes[attribute]) if returned_attributes.key?(attribute)
             end
 
             @new_record = false
@@ -33,8 +47,22 @@ def _create_record(attribute_names = self.attribute_names)
             id
           end
 
+          # def _update_record(attribute_names = self.attribute_names)
+          #   attribute_names = attributes_for_update(attribute_names)
+
+          #   if attribute_names.empty?
+          #     affected_rows = 0
+          #     @_trigger_update_callback = true
+          #   else
+          #     affected_rows = _update_row(attribute_names)
+          #     @_trigger_update_callback = affected_rows == 1
+          #   end
+
+          #   yield(self) if block_given?
+
+          #   affected_rows
+          # end
           def _update_record(attribute_names = self.attribute_names)
-            attribute_names &= self.class.column_names
             attribute_names = attributes_for_update(attribute_names)
 
             if attribute_names.empty?
@@ -46,7 +74,7 @@ def _update_record(attribute_names = self.attribute_names)
               end
 
               returning_attributes.each do |attribute|
-                write_attribute(attribute, returned_attributes[attribute.to_s]) if returned_attributes.key?(attribute.to_s)
+                write_attribute(attribute, returned_attributes[attribute]) if returned_attributes.key?(attribute)
               end
 
               @_trigger_update_callback = affected_rows == 1
@@ -61,8 +89,12 @@ def _update_record(attribute_names = self.attribute_names)
 
       def self.patch_database_statements
         ConnectionAdapters::DatabaseStatements.module_eval do
+          # def exec_insert(sql, name = nil, binds = [], pk = nil, sequence_name = nil)
+          #   sql, binds = sql_for_insert(sql, pk, binds)
+          #   exec_query(sql, name, binds)
+          # end
           def exec_insert(sql, name = nil, binds = [], pk = nil, sequence_name = nil)
-            sql, binds = sql_for_insert(sql, pk, nil, sequence_name, binds)
+            sql, binds = sql_for_insert(sql, pk, binds)
 
             exec_query(sql, name, binds).tap do |result|
               if @_returning_attributes.present?
@@ -71,6 +103,10 @@ def exec_insert(sql, name = nil, binds = [], pk = nil, sequence_name = nil)
             end
           end
 
+          # def update(arel, name = nil, binds = [])
+          #   sql, binds = to_sql_and_binds(arel, binds)
+          #   exec_update(sql, name, binds)
+          # end
           def update(arel, name = nil, binds = [])
             sql, binds = to_sql_and_binds(arel, binds)
 
@@ -89,7 +125,20 @@ def self.patch_postgresql_database_statements
         ConnectionAdapters::PostgreSQL::DatabaseStatements.module_eval do
           private
 
-          def sql_for_insert(sql, pk, id_value, sequence_name, binds)
+          # def sql_for_insert(sql, pk, binds) # :nodoc:
+          #   if pk.nil?
+          #     # Extract the table from the insert sql. Yuck.
+          #     table_ref = extract_table_ref_from_insert_sql(sql)
+          #     pk = primary_key(table_ref) if table_ref
+          #   end
+
+          #   if pk = suppress_composite_primary_key(pk)
+          #     sql = "#{sql} RETURNING #{quote_column_name(pk)}"
+          #   end
+
+          #   super
+          # end
+          def sql_for_insert(sql, pk, binds)
             if pk.nil?
               # Extract the table from the insert sql. Yuck.
               table_ref = extract_table_ref_from_insert_sql(sql)
@@ -117,7 +166,27 @@ def self.patch_postgresql_adapter
 
           private
 
+          # def execute_and_clear(sql, name, binds, prepare: false)
+          #   if preventing_writes? && write_query?(sql)
+          #     raise ActiveRecord::ReadOnlyError, "Write query attempted while in readonly mode: #{sql}"
+          #   end
+
+          #   if without_prepared_statement?(binds)
+          #     result = exec_no_cache(sql, name, [])
+          #   elsif !prepare
+          #     result = exec_no_cache(sql, name, binds)
+          #   else
+          #     result = exec_cache(sql, name, binds)
+          #   end
+          #   ret = yield result
+          #   result.clear
+          #   ret
+          # end
           def execute_and_clear(sql, name, binds, prepare: false)
+            if preventing_writes? && write_query?(sql)
+              raise ActiveRecord::ReadOnlyError, "Write query attempted while in readonly mode: #{sql}"
+            end
+
             if without_prepared_statement?(binds)
               result = exec_no_cache(sql, name, [])
             elsif !prepare

spec/support/schema_and_models.rb

@@ -1,3 +1,10 @@
+ActiveRecord::Base.establish_connection(adapter: 'postgresql')
+
+begin
+  ActiveRecord::Base.connection.create_database('returning_attributes')
+rescue ActiveRecord::StatementInvalid
+end
+
 ActiveRecord::Base.establish_connection(adapter: 'postgresql', database: 'returning_attributes')
 ActiveRecord::Base.logger = Logger.new(STDOUT)