ar_transaction_changes 1.1.7 → 1.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b75ccc7bc393e60284a26e6077bdfc48e8032b52780770f0b762f292a6a3393
-  data.tar.gz: 2a048448c70283320792559fd7f7ae90d339384fda9fa3b9d437abf2607fd701
+  metadata.gz: 5871403ece76d3c6fceb41b1a5aecd240d5460363e0d86a88f4b27ba4fc1d562
+  data.tar.gz: fda845379838e83afc84c11bc23005f4af0ac8e12df804c48c5010d724b52ba3
 SHA512:
-  metadata.gz: f3148c75a2a2bebc626451d1cbfbb7263cb1e39a56571af89761dc1f5b96a3a988de2a97ee2bef546744765f2b3eb569de77ce45fea5e7da1289821231435076
-  data.tar.gz: e21dff998d73c00ee6f6b8b7d92d9814412bf3421b8dc009e41429b7fc33e014cd9cd4f01d05288bc5009fc530749628de7d19c6e97973c53a3ddd37bc8f9cd0
+  metadata.gz: 386cd79e7207afdc17fc9f019183fe14674c5a3af5fe6b35c87433417bfe0ce94573abbe43954f46812e22911051aa3ab80a8d47ddee7a78b6f5801b6d10fef2
+  data.tar.gz: 628f82d89b3c54455dc9c5071e9beb1610deb710bbfa158f616d886b04c9136f446bc25ad04d8f1ba9e6f3096dd5c93f64340a207cc4541f53e6420ab74db115

data/.github/workflows/ci.yml

@@ -0,0 +1,44 @@
+name: CI
+
+on:
+  push: {}
+  pull_request:
+    types: [opened, synchronize]
+
+jobs:
+  build:
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.owner.login != 'dylanahsmith'
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        entry:
+          - name: 'Minimum supported'
+            ruby: 2.7
+            gemfile: Gemfile.rails6
+          - name: "Latest released versions"
+            ruby: 3.2
+            gemfile: Gemfile
+          - name: "Rails main branch"
+            ruby: 3.2
+            gemfile: Gemfile.rails_head
+
+    name: ${{ matrix.entry.name }}
+
+    env:
+      BUNDLE_GEMFILE: ${{ matrix.entry.gemfile }}
+
+    steps:
+    - name: Install required packages
+      run: |
+        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.entry.ruby }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake

data/Gemfile

@@ -1,3 +1,5 @@
 source 'https://rubygems.org'
 
 gemspec
+
+gem 'sqlite3', '~> 1.4'

data/Gemfile.rails6

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

data/Gemfile.rails_head

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

data/README.md

@@ -1,5 +1,5 @@
 # ArTransactionChanges
-[![Build Status](https://travis-ci.org/dylanahsmith/ar_transaction_changes.png?branch=master)](https://travis-ci.org/dylanahsmith/ar_transaction_changes)
+[![Build Status](https://github.com/dylanahsmith/ar_transaction_changes/workflows/CI/badge.svg?branch=main)](https://github.com/dylanahsmith/ar_transaction_changes/actions?query=branch%3Amain)
 
 Store all attribute changes for active record objects during a
 transaction so that they are available in an after_commit callbacks.

data/lib/ar_transaction_changes/version.rb

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

data/lib/ar_transaction_changes.rb

@@ -34,21 +34,43 @@ 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)
-    unless 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
+    if !transaction_changed_attributes.key?(attr_name) && new_value != old_value
+      transaction_changed_attributes[attr_name] = _deserialize_transaction_change_value(attr_name, old_value)
+    elsif transaction_changed_attributes.key?(attr_name)
+      new_value = _deserialize_transaction_change_value(attr_name, new_value)
+
+      stored_value = transaction_changed_attributes[attr_name]
+
+      if new_value == stored_value
+        transaction_changed_attributes.delete(attr_name)
       end
-      transaction_changed_attributes
     end
     ret
   end

data/test/database.yml.default

@@ -1,7 +1,3 @@
 test:
-  adapter: mysql2
-  database: ar_transaction_changes_test
-  host: 127.0.0.1
-  encoding: utf8
-  username: root
-  password:
+  adapter: sqlite3
+  database: ':memory:'

data/test/models/user.rb

@@ -10,6 +10,7 @@ class User < ActiveRecord::Base
   end
 
   serialize :connection_details, Array
+  serialize :notes, Array
 
   attr_accessor :stored_transaction_changes
 

data/test/test_helper.rb

@@ -10,8 +10,10 @@ config_filename = test_dir.join("database.yml").exist? ? "database.yml" : "datab
 database_yml = YAML.load(test_dir.join(config_filename).read)
 database_config = database_yml.fetch("test")
 
-ActiveRecord::Base.establish_connection(database_config.except("database"))
-ActiveRecord::Base.connection.recreate_database(database_config.fetch("database"))
+if database_config.fetch('adapter') != 'sqlite3'
+  ActiveRecord::Base.establish_connection(database_config.except("database"))
+  ActiveRecord::Base.connection.recreate_database(database_config.fetch("database"))
+end
 ActiveRecord::Base.establish_connection(database_config)
 
 ActiveRecord::Base.connection.tap do |db|
@@ -20,8 +22,16 @@ ActiveRecord::Base.connection.tap do |db|
     t.string :occupation
     t.integer :age
     t.text :connection_details
+    t.text :notes
     t.timestamps null: false
   end
 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

@@ -126,4 +126,52 @@ class TransactionChangesTest < MiniTest::Unit::TestCase
     @user.save!
     assert_equal '2.2.2.2', @user.connection_details.first.client_ip
   end
+
+  def test_double_save_back_to_original_value
+    @user.transaction do
+      @user.name = "Dillon"
+      @user.save!(touch: false)
+
+      @user.name = "Dylan"
+      @user.save!(touch: false)
+    end
+
+    assert_empty @user.stored_transaction_changes
+  end
+
+  def test_double_save_back_to_original_value_for_serialized_attribute
+    @user.notes = ['a', 'b']
+    @user.save!
+
+    @user.transaction do
+      @user.notes = ['b', 'c']
+      @user.save!(touch: false)
+
+      @user.notes = ['a', 'b']
+      @user.save!(touch: false)
+    end
+
+    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
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ar_transaction_changes
 version: !ruby/object:Gem::Version
-  version: 1.1.7
+  version: 1.1.9
 platform: ruby
 authors:
 - Dylan Thacker-Smith
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-01 00:00:00.000000000 Z
+date: 2023-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -60,10 +60,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
 - Gemfile
-- Gemfile.rails52
+- Gemfile.rails6
 - Gemfile.rails_head
 - LICENSE.txt
 - README.md
@@ -94,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: Store transaction changes for active record objects

data/.travis.yml

@@ -1,17 +0,0 @@
-language: ruby
-sudo: false
-
-jobs:
-  include:
-    - name: "Minimum supported versions"
-      rvm: 2.4
-      gemfile: Gemfile.rails52
-    - name: "Latest released versions"
-      rvm: 2.7
-      gemfile: Gemfile
-    - name: "Rails master branch"
-      rvm: 2.7
-      gemfile: Gemfile.rails_head
-
-services:
-  - mysql

data/Gemfile.rails52

@@ -1,5 +0,0 @@
-source "https://rubygems.org"
-
-gem 'activerecord', '~> 5.2.0'
-
-gemspec