ar_transaction_changes 1.1.10 → 1.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 714d24f3fc939b5ab4170bd5863573aea0b5f9f918d3494f51656096579d0cc6
-  data.tar.gz: 62d4814dccd3e3f5623958e1182ba8654eca9d37cc01bf986cfa09527fc5b6b5
+  metadata.gz: b6fdf694a84d42dbffbe36a1f6cb7e44f6743e7d6d0f107235a87390a66da4e5
+  data.tar.gz: a3e154ff527f732da68b229c33a342a7a28a578c9c694d4c8565d0c1d34bc72e
 SHA512:
-  metadata.gz: 1a77baf0fd44d182e407c79ae17499933aa0a85aa1a9d2c7be3c4b1df2a0a6bee34a4d18d10bb82a5aea3b45aaa65dfde4d6254bf49b5aa8abb2dd293900b6ac
-  data.tar.gz: ab7fd9f52be45e78f6911159cb7c472ac9d78151891b1968bfcf1629ee97e65a944ef71178c5b5411f935b680d5a460f99f6884c3d8ce08aad6274b882b175f5
+  metadata.gz: 72cc3553913ba69636a5f9a0c64361aeefbceb0fad6933d273a67fadf5ddefec6cad09168bc6a17cbd04a4bb83af287ede6f4b7b894c7acb9facc1198697760b
+  data.tar.gz: 38a488f2626aea343a804696bb643976a0e2830bc39ee6036ba80d1cdb47454dad90435a3371d31fb8acf8d9a835b464b5fc956efa6d55f44056cdf6ca114469

data/.github/workflows/ci.yml

@@ -12,12 +12,15 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['3.2', '3.3', '3.4']
+        # Cover maintained Ruby branches, including security-only maintenance.
+        ruby: ['3.3', '3.4', '4.0']
         rails: ['7.0', '7.1', '7.2', '8.0']
         exclude:
           # Rails 7.0 requires Ruby < 3.4
           - ruby: '3.4'
             rails: '7.0'
+          - ruby: '4.0'
+            rails: '7.0'
 
     name: Ruby ${{ matrix.ruby }} / Rails ${{ matrix.rails }}
 
@@ -29,7 +32,7 @@ jobs:
       run: |
         sudo apt-get update
         sudo apt-get -y install libsqlite3-dev
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v7
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
@@ -45,7 +48,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['3.2', '3.3', '3.4']
+        ruby: ['3.3', '3.4', '4.0']
 
     name: Ruby ${{ matrix.ruby }} / Rails head
 
@@ -57,7 +60,7 @@ jobs:
       run: |
         sudo apt-get update
         sudo apt-get -y install libsqlite3-dev
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v7
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
@@ -82,7 +85,7 @@ jobs:
         fi
         echo "✅ All required tests passed"
         if [ "${{ needs.test-head.result }}" != "success" ]; then
-          echo "⚠️  Rails head tests failed (non-blocking)"
+          echo "Rails head tests failed (non-blocking)"
         else
-          echo "✅ Rails head tests passed"
+          echo "Rails head tests passed"
         fi

data/README.md

@@ -64,3 +64,8 @@ gem 'globalize', require: ['ar_transaction_changes', 'globalize']
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Releasing
+
+Publishing is restricted to [RubyGems.org](https://rubygems.org) through the
+`allowed_push_host` gem metadata.

data/ar_transaction_changes.gemspec

@@ -12,6 +12,7 @@ Gem::Specification.new do |gem|
   gem.summary       = %q{Store transaction changes for active record objects}
   gem.homepage      = "https://github.com/Shopify/ar_transaction_changes"
   gem.license       = "MIT"
+  gem.metadata["allowed_push_host"] = "https://rubygems.org"
 
   gem.required_ruby_version = ">= 3.2"
 

data/lib/ar_transaction_changes/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ArTransactionChanges
-  VERSION = "1.1.10"
+  VERSION = "1.1.12"
 end

data/lib/ar_transaction_changes.rb

@@ -4,37 +4,87 @@ require "ar_transaction_changes/version"
 require "active_record"
 
 module ArTransactionChanges
-  def self.included(base)
-    if base.respond_to?(:_commit_callbacks) && base.respond_to?(:_rollback_callbacks)
-      if !base._commit_callbacks.empty? || !base._rollback_callbacks.empty?
-        raise "ArTransactionChanges must be included before defining any after_commit or after_rollback callbacks"
+  # Since rails/rails#59191, generated attribute writers (`name=`) call
+  # `@attributes.write_from_user` directly instead of `_write_attribute`, so the
+  # `_write_attribute` override below no longer sees them. Generate writers that
+  # record the change around that same direct write.
+  module GeneratedWriters # :nodoc:
+    # Rails versions with that change also dropped the `owner` argument from
+    # `AttrNames.define_attribute_accessor_method`, which the code below relies on.
+    def self.needed?
+      ActiveModel::AttributeMethods::AttrNames
+        .method(:define_attribute_accessor_method)
+        .parameters.none? { |_type, name| name == :owner }
+    end
+
+    def self.raise_on_assign_to_attr_readonly?
+      if ActiveRecord.respond_to?(:_raise_on_assign_to_attr_readonly)
+        ActiveRecord._raise_on_assign_to_attr_readonly
+      else
+        ActiveRecord.raise_on_assign_to_attr_readonly
+      end
+    end
+
+    private
+
+    def define_method_attribute=(canonical_name, owner:, as: canonical_name)
+      return super unless self < ArTransactionChanges
+
+      readonly = GeneratedWriters.raise_on_assign_to_attr_readonly? && readonly_attribute?(canonical_name)
+
+      ActiveModel::AttributeMethods::AttrNames.define_attribute_accessor_method(
+        canonical_name, writer: true,
+      ) do |temp_method_name, attr_name_expr|
+        namespace = readonly ? :ar_transaction_changes_readonly : :ar_transaction_changes
+        owner.define_cached_method(temp_method_name, as: "#{as}=", namespace: namespace) do |batch|
+          batch << "def #{temp_method_name}(value)"
+          if readonly
+            batch <<
+              "  unless new_record?" <<
+              "    raise ActiveRecord::ReadonlyAttributeError.new(#{attr_name_expr})" <<
+              "  end"
+          end
+          batch <<
+            "  _store_transaction_changed_attributes(#{attr_name_expr}) do" <<
+            "    @attributes.write_from_user(#{attr_name_expr}, value)" <<
+            "  end" <<
+            "end"
+        end
       end
     end
   end
 
-  if ActiveRecord.version >= Gem::Version.new('8.1.0.alpha')
-    def _run_commit_callbacks!
+  if ActiveRecord.version >= Gem::Version.new('7.1')
+    def run_callbacks(kind, type = nil)
       super
     ensure
-      @transaction_changed_attributes = nil
+      if kind == :commit || kind == :rollback
+        @transaction_changed_attributes = nil
+      end
     end
 
-    def _run_rollback_callbacks!
-      super
-    ensure
-      @transaction_changed_attributes = nil
+    if ActiveRecord.version >= Gem::Version.new('8.1.0.alpha')
+      # We should reset @transaction_changed_attributes in the no-op version of the method.
+      # Even if there are no callbacks registered, attributes should be reset on commit/rollback.
+      def _run_commit_callbacks
+        super
+      ensure
+        @transaction_changed_attributes = nil
+      end
+
+      def _run_rollback_callbacks
+        super
+      ensure
+        @transaction_changed_attributes = nil
+      end
     end
   else
-    def _run_commit_callbacks
+    def run_callbacks(kind)
       super
     ensure
-      @transaction_changed_attributes = nil
-    end
-
-    def _run_rollback_callbacks
-      super
-    ensure
-      @transaction_changed_attributes = nil
+      if kind == :commit || kind == :rollback
+        @transaction_changed_attributes = nil
+      end
     end
   end
 
@@ -113,3 +163,10 @@ module ArTransactionChanges
     end
   end
 end
+
+# Install on ActiveRecord::Base rather than from an `included` hook, so models that get
+# ArTransactionChanges through a concern are covered too. The writers are generated on
+# first use, after the model's modules are included.
+ActiveSupport.on_load(:active_record) do
+  singleton_class.prepend(ArTransactionChanges::GeneratedWriters) if ArTransactionChanges::GeneratedWriters.needed?
+end

data/test/models/account.rb

@@ -0,0 +1,13 @@
+class Account < ActiveRecord::Base
+  include ArTransactionChanges
+
+  attr_readonly :handle
+
+  attr_accessor :stored_transaction_changes
+
+  after_commit :store_transaction_changes_for_tests
+
+  def store_transaction_changes_for_tests
+    @stored_transaction_changes = transaction_changed_attributes.to_h
+  end
+end

data/test/models/plan_change.rb

@@ -0,0 +1,16 @@
+module TracksTransactionChanges
+  extend ActiveSupport::Concern
+  include ArTransactionChanges
+
+  included do
+    attr_accessor :stored_transaction_changes
+
+    after_commit { @stored_transaction_changes = transaction_changed_attributes.to_h }
+  end
+end
+
+class PlanChange < ActiveRecord::Base
+  self.table_name = "accounts"
+
+  include TracksTransactionChanges
+end

data/test/models/user.rb

@@ -17,6 +17,8 @@ class User < ActiveRecord::Base
     serialize :notes, Array
   end
 
+  alias_attribute :job, :occupation
+
   attr_accessor :stored_transaction_changes
 
   after_commit :store_transaction_changes_for_tests

data/test/test_helper.rb

@@ -25,6 +25,11 @@ ActiveRecord::Base.connection.tap do |db|
     t.text :notes
     t.timestamps null: false
   end
+
+  db.create_table(:accounts) do |t|
+    t.string :handle
+    t.string :plan
+  end
 end
 
 Dir[test_dir.join("models/*.rb")].each{ |file| require file }

data/test/transaction_changes_test.rb

@@ -23,6 +23,43 @@ class TransactionChangesTest < Minitest::Test
     assert_equal ["Dylan", "Dillon"], @user.stored_transaction_changes["name"]
   end
 
+  def test_transaction_changes_for_aliased_attribute_writer
+    @user.job = "Tester"
+    @user.save!
+
+    assert_equal ["Developer", "Tester"], @user.stored_transaction_changes["occupation"]
+  end
+
+  def test_readonly_attribute_writer_still_raises_on_persisted_records
+    account = Account.create!(handle: "dylan", plan: "basic")
+    assert_equal({ "handle" => nil, "plan" => nil }, account.stored_transaction_changes.slice("handle", "plan"))
+
+    raises = if ActiveRecord.respond_to?(:_raise_on_assign_to_attr_readonly)
+      ActiveRecord._raise_on_assign_to_attr_readonly
+    elsif ActiveRecord.respond_to?(:raise_on_assign_to_attr_readonly)
+      ActiveRecord.raise_on_assign_to_attr_readonly
+    end
+    if raises
+      assert_raises(ActiveRecord::ReadonlyAttributeError) { account.handle = "dillon" }
+    end
+
+    account.plan = "pro"
+    account.save!
+    assert_equal({ "plan" => "basic" }, account.stored_transaction_changes)
+  ensure
+    Account.delete_all
+  end
+
+  def test_transaction_changes_when_included_through_a_concern
+    record = PlanChange.create!(handle: "dylan", plan: "basic")
+    record.plan = "pro"
+    record.save!
+
+    assert_equal({ "plan" => "basic" }, record.stored_transaction_changes)
+  ensure
+    PlanChange.delete_all
+  end
+
   def test_transaction_changes_for_updating_attribute
     @user[:name] = "Dillon"
     @user.save!
@@ -174,28 +211,4 @@ class TransactionChangesTest < Minitest::Test
 
     assert_equal [[], ['a', 'b']], @user.stored_transaction_changes['notes']
   end
-
-  def test_do_not_allow_adding_this_gem_to_a_model_after_commit_callbacks_are_defined
-    assert_raises(RuntimeError) do
-      Class.new(ActiveRecord::Base) do
-        after_commit :some_method
-
-        include ArTransactionChanges
-
-        def some_method; end
-      end
-    end
-  end
-
-    def test_do_not_allow_adding_this_gem_to_a_model_after_rollback_callbacks_are_defined
-    assert_raises(RuntimeError) do
-      Class.new(ActiveRecord::Base) do
-        after_rollback :some_method
-
-        include ArTransactionChanges
-
-        def some_method; end
-      end
-    end
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ar_transaction_changes
 version: !ruby/object:Gem::Version
-  version: 1.1.10
+  version: 1.1.12
 platform: ruby
 authors:
 - Dylan Thacker-Smith
@@ -64,13 +64,16 @@ files:
 - lib/ar_transaction_changes.rb
 - lib/ar_transaction_changes/version.rb
 - test/database.yml.default
+- test/models/account.rb
+- test/models/plan_change.rb
 - test/models/user.rb
 - test/test_helper.rb
 - test/transaction_changes_test.rb
 homepage: https://github.com/Shopify/ar_transaction_changes
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
 rdoc_options: []
 require_paths:
 - lib
@@ -85,11 +88,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.23
 specification_version: 4
 summary: Store transaction changes for active record objects
 test_files:
 - test/database.yml.default
+- test/models/account.rb
+- test/models/plan_change.rb
 - test/models/user.rb
 - test/test_helper.rb
 - test/transaction_changes_test.rb