ar_transaction_changes 1.1.8 → 1.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41a85de7f78cb23d9af300f5279a909db5ecab9b3e02bca9cf2ecd4703062b8b
-  data.tar.gz: cc04e7f4c6e884d4db4fe94c84b8a8ef55871613c0b0d737f9956a5f69d3ebcf
+  metadata.gz: 714d24f3fc939b5ab4170bd5863573aea0b5f9f918d3494f51656096579d0cc6
+  data.tar.gz: 62d4814dccd3e3f5623958e1182ba8654eca9d37cc01bf986cfa09527fc5b6b5
 SHA512:
-  metadata.gz: 4fde634868ccbb2518edbde7841bce8ca6745a41c6ef398d1d20ce55bae6a7eefb9c35689ebecadd3ef8246200a6034bc202960457f42e430a351c56b7ef0742
-  data.tar.gz: d14df655313155febb0c769a2852efc8c1ce4888cfbaa05ea362ecdb3a1219bc98051b5da1b3583dd8add30ff40a6ea52f0a6ac86198cb54a4d7208520daecb4
+  metadata.gz: 1a77baf0fd44d182e407c79ae17499933aa0a85aa1a9d2c7be3c4b1df2a0a6bee34a4d18d10bb82a5aea3b45aaa65dfde4d6254bf49b5aa8abb2dd293900b6ac
+  data.tar.gz: ab7fd9f52be45e78f6911159cb7c472ac9d78151891b1968bfcf1629ee97e65a944ef71178c5b5411f935b680d5a460f99f6884c3d8ce08aad6274b882b175f5

data/.devcontainer/devcontainer.json

@@ -0,0 +1,26 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/ruby
+{
+	"name": "Ruby",
+	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+	"image": "ghcr.io/rails/devcontainer/images/ruby:3.4.7",
+	"features": {
+		"ghcr.io/devcontainers/features/github-cli:1": {},
+		"ghcr.io/rails/devcontainer/features/mysql-client:1": {}
+	}
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "ruby --version",
+
+	// Configure tool-specific properties.
+	// "customizations": {},
+
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

data/.github/workflows/ci.yml

@@ -6,42 +6,83 @@ on:
     types: [opened, synchronize]
 
 jobs:
-  build:
-    if: github.event_name == 'push' || github.event.pull_request.head.repo.owner.login != 'dylanahsmith'
-
+  test:
     runs-on: ubuntu-latest
 
     strategy:
+      fail-fast: false
       matrix:
-        entry:
-          - name: 'Minimum supported'
-            ruby: 2.4
-            gemfile: Gemfile.rails52
-          - name: "Latest released versions"
-            ruby: 3.0
-            gemfile: Gemfile
-          - name: "Rails main branch"
-            ruby: 3.0
-            gemfile: Gemfile.rails_head
-
-    name: ${{ matrix.entry.name }}
+        ruby: ['3.2', '3.3', '3.4']
+        rails: ['7.0', '7.1', '7.2', '8.0']
+        exclude:
+          # Rails 7.0 requires Ruby < 3.4
+          - ruby: '3.4'
+            rails: '7.0'
+
+    name: Ruby ${{ matrix.ruby }} / Rails ${{ matrix.rails }}
 
     env:
-      BUNDLE_GEMFILE: ${{ matrix.entry.gemfile }}
+      BUNDLE_GEMFILE: gemfiles/rails_${{ matrix.rails }}.gemfile
 
     steps:
     - name: Install required packages
       run: |
         sudo apt-get update
         sudo apt-get -y install libsqlite3-dev
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: ${{ matrix.entry.ruby }}
-    - name: Install bundler and gems
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake
+
+  test-head:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['3.2', '3.3', '3.4']
+
+    name: Ruby ${{ matrix.ruby }} / Rails head
+
+    env:
+      BUNDLE_GEMFILE: gemfiles/rails_head.gemfile
+
+    steps:
+    - name: Install required packages
       run: |
-        gem install bundler
-        bundle install --jobs 4 --retry 3
+        sudo apt-get update
+        sudo apt-get -y install libsqlite3-dev
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
     - name: Run tests
       run: bundle exec rake
+
+  ci-summary:
+    runs-on: ubuntu-latest
+    needs: [test, test-head]
+    if: always()
+
+    name: CI Summary
+
+    steps:
+    - name: Check test results
+      run: |
+        if [ "${{ needs.test.result }}" != "success" ]; then
+          echo "❌ Required tests failed"
+          exit 1
+        fi
+        echo "✅ All required tests passed"
+        if [ "${{ needs.test-head.result }}" != "success" ]; then
+          echo "⚠️  Rails head tests failed (non-blocking)"
+        else
+          echo "✅ Rails head tests passed"
+        fi

data/.github/workflows/release.yml

@@ -0,0 +1,26 @@
+name: Release Gem
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  release:
+    permissions:
+      contents: write
+      id-token: write
+
+    environment: release
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v5
+      with:
+        persist-credentials: false
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true
+        ruby-version: ruby
+    - uses: rubygems/release-gem@v1

data/Gemfile

@@ -2,4 +2,4 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'sqlite3', '~> 1.4'
+gem 'sqlite3'

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Shopify Inc.
+Copyright (c) 2012-today Shopify Inc.
 
 MIT License
 

data/ar_transaction_changes.gemspec

@@ -6,20 +6,21 @@ require 'ar_transaction_changes/version'
 Gem::Specification.new do |gem|
   gem.name          = "ar_transaction_changes"
   gem.version       = ArTransactionChanges::VERSION
-  gem.authors       = ["Dylan Thacker-Smith"]
-  gem.email         = ["Dylan.Smith@shopify.com"]
+  gem.authors       = ["Dylan Thacker-Smith", "Shopify's Rails Infrastructure Team"]
+  gem.email         = ["Dylan.Smith@shopify.com", "rails@shopify.com"]
   gem.description   = %q{Solves the problem of trying to get all the changes to an object during a transaction in an after_commit callbacks.}
   gem.summary       = %q{Store transaction changes for active record objects}
-  gem.homepage      = "https://github.com/dylanahsmith/ar_transaction_changes"
+  gem.homepage      = "https://github.com/Shopify/ar_transaction_changes"
   gem.license       = "MIT"
 
+  gem.required_ruby_version = ">= 3.2"
+
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency "activerecord", ">= 5.2.0"
+  gem.add_dependency "activerecord", ">= 7.0.0"
 
   gem.add_development_dependency("rake")
-  gem.add_development_dependency("mysql2")
 end

data/gemfiles/rails_7.0.gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gem 'activerecord', github: 'rails/rails', branch: '7-0-stable'
+gem 'sqlite3', '~> 1.4'
+
+gemspec path: ".."

data/{Gemfile.rails_head → gemfiles/rails_7.1.gemfile}

@@ -1,6 +1,6 @@
 source "https://rubygems.org"
 
-gem 'activerecord', github: 'rails/rails'
+gem 'activerecord', '~> 7.1.0'
 gem 'sqlite3', '~> 1.4'
 
-gemspec
+gemspec path: ".."

data/gemfiles/rails_7.2.gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gem 'activerecord', '~> 7.2.0'
+gem 'sqlite3', '~> 1.4'
+
+gemspec path: ".."

data/gemfiles/rails_8.0.gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gem 'activerecord', '~> 8.0.0'
+gem 'sqlite3', '~> 2.1'
+
+gemspec path: ".."

data/gemfiles/rails_head.gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gem 'activerecord', github: 'rails/rails', branch: 'main'
+gem 'sqlite3'
+
+gemspec path: ".."

data/lib/ar_transaction_changes/version.rb

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

data/lib/ar_transaction_changes.rb

@@ -4,16 +4,38 @@ require "ar_transaction_changes/version"
 require "active_record"
 
 module ArTransactionChanges
-  def _run_commit_callbacks
-    super
-  ensure
-    @transaction_changed_attributes = nil
+  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"
+      end
+    end
   end
 
-  def _run_rollback_callbacks
-    super
-  ensure
-    @transaction_changed_attributes = nil
+  if ActiveRecord.version >= Gem::Version.new('8.1.0.alpha')
+    def _run_commit_callbacks!
+      super
+    ensure
+      @transaction_changed_attributes = nil
+    end
+
+    def _run_rollback_callbacks!
+      super
+    ensure
+      @transaction_changed_attributes = nil
+    end
+  else
+    def _run_commit_callbacks
+      super
+    ensure
+      @transaction_changed_attributes = nil
+    end
+
+    def _run_rollback_callbacks
+      super
+    ensure
+      @transaction_changed_attributes = nil
+    end
   end
 
   def transaction_changed_attributes
@@ -34,25 +56,37 @@ module ArTransactionChanges
     end
   end
 
+  def attribute_will_change!(attr_name)
+    unless transaction_changed_attributes.key?(attr_name)
+      value = _read_attribute_for_transaction(attr_name)
+      value = _deserialize_transaction_change_value(attr_name, value)
+      transaction_changed_attributes[attr_name] = value
+    end
+    super
+  end
+
   private
 
+  def init_internals
+    super
+    @transaction_changed_attributes = nil
+  end
+
+  def _deserialize_transaction_change_value(attr_name, value)
+    attribute = @attributes[attr_name]
+    return value unless attribute.type.is_a?(::ActiveRecord::Type::Serialized)
+    attribute.type.deserialize(value)
+  end
+
   def _store_transaction_changed_attributes(attr_name)
     attr_name = attr_name.to_s
     old_value = _read_attribute_for_transaction(attr_name)
     ret = yield
     new_value = _read_attribute_for_transaction(attr_name)
     if !transaction_changed_attributes.key?(attr_name) && new_value != old_value
-      attribute = @attributes[attr_name]
-      transaction_changed_attributes[attr_name] = if attribute.type.is_a?(::ActiveRecord::Type::Serialized)
-        attribute.type.deserialize(old_value)
-      else
-        old_value
-      end
+      transaction_changed_attributes[attr_name] = _deserialize_transaction_change_value(attr_name, old_value)
     elsif transaction_changed_attributes.key?(attr_name)
-      attribute = @attributes[attr_name]
-      if attribute.type.is_a?(::ActiveRecord::Type::Serialized)
-        new_value = attribute.type.deserialize(new_value)
-      end
+      new_value = _deserialize_transaction_change_value(attr_name, new_value)
 
       stored_value = transaction_changed_attributes[attr_name]
 

data/test/models/user.rb

@@ -9,8 +9,13 @@ class User < ActiveRecord::Base
     end
   end
 
-  serialize :connection_details, Array
-  serialize :notes, Array
+  if ActiveRecord.gem_version >= Gem::Version.new('7.1.0')
+    serialize :connection_details, type: Array
+    serialize :notes, type: Array
+  else
+    serialize :connection_details, Array
+    serialize :notes, Array
+  end
 
   attr_accessor :stored_transaction_changes
 

data/test/test_helper.rb

@@ -28,3 +28,10 @@ ActiveRecord::Base.connection.tap do |db|
 end
 
 Dir[test_dir.join("models/*.rb")].each{ |file| require file }
+
+serializable_classes = [User::ConnectionDetails]
+if ActiveRecord::VERSION::MAJOR >= 7
+  ActiveRecord.yaml_column_permitted_classes += serializable_classes
+else
+  ActiveRecord::Base.yaml_column_permitted_classes += serializable_classes
+end

data/test/transaction_changes_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class TransactionChangesTest < MiniTest::Unit::TestCase
+class TransactionChangesTest < Minitest::Test
   def setup
     @user = User.new(:name => "Dylan", :occupation => "Developer", age: 20)
     @user.save!
@@ -153,4 +153,49 @@ class TransactionChangesTest < MiniTest::Unit::TestCase
 
     assert_empty @user.stored_transaction_changes
   end
+
+  def test_mutating_serialized_attribute_in_place_with_attribute_will_change
+    @user.notes_will_change!
+    @user.notes.push('a')
+    @user.save!
+
+    assert_equal [[], ['a']], @user.stored_transaction_changes['notes']
+  end
+
+  def test_double_modification_with_attribute_will_change
+    @user.transaction do
+      @user.notes = ['a']
+      @user.save!
+
+      @user.notes_will_change!
+      @user.notes.push('b')
+      @user.save!
+    end
+
+    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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ar_transaction_changes
 version: !ruby/object:Gem::Version
-  version: 1.1.8
+  version: 1.1.10
 platform: ruby
 authors:
 - Dylan Thacker-Smith
-autorequire:
+- Shopify's Rails Infrastructure Team
 bindir: bin
 cert_chain: []
-date: 2021-02-04 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: 7.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: 7.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -38,48 +38,39 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: mysql2
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Solves the problem of trying to get all the changes to an object during
   a transaction in an after_commit callbacks.
 email:
 - Dylan.Smith@shopify.com
+- rails@shopify.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".devcontainer/devcontainer.json"
 - ".github/workflows/ci.yml"
+- ".github/workflows/release.yml"
 - ".gitignore"
 - Gemfile
-- Gemfile.rails52
-- Gemfile.rails_head
 - LICENSE.txt
 - README.md
 - Rakefile
 - ar_transaction_changes.gemspec
+- gemfiles/rails_7.0.gemfile
+- gemfiles/rails_7.1.gemfile
+- gemfiles/rails_7.2.gemfile
+- gemfiles/rails_8.0.gemfile
+- gemfiles/rails_head.gemfile
 - lib/ar_transaction_changes.rb
 - lib/ar_transaction_changes/version.rb
 - test/database.yml.default
 - test/models/user.rb
 - test/test_helper.rb
 - test/transaction_changes_test.rb
-homepage: https://github.com/dylanahsmith/ar_transaction_changes
+homepage: https://github.com/Shopify/ar_transaction_changes
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -87,15 +78,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Store transaction changes for active record objects
 test_files:

data/Gemfile.rails52

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-gem 'activerecord', '~> 5.2.0'
-gem "sqlite3", "~> 1.3", ">= 1.3.6"
-
-gemspec