ar_transaction_changes 1.1.3 → 1.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 89f3ff2a1237cc1fab8f9b2bb7b338eacb83ea97
-  data.tar.gz: f05afe6d47540c9bfc5e7c8a80fa1277dfc03d32
+SHA256:
+  metadata.gz: 41a85de7f78cb23d9af300f5279a909db5ecab9b3e02bca9cf2ecd4703062b8b
+  data.tar.gz: cc04e7f4c6e884d4db4fe94c84b8a8ef55871613c0b0d737f9956a5f69d3ebcf
 SHA512:
-  metadata.gz: b5c64f5f5684ac7b3f06653cc6f59e855fefd51ec285fe3e8fd6f357f76201ff3d94440c272a195fcb98f5086006c672eebc743d1eff35d76abee1c6a426e4d9
-  data.tar.gz: d4969d2850dbee065ba0711613968cbe8f4f096d4557da97b3ae82cb688b17804b6fb702dafd64a5ef72f5d625b2f0714de9943d5a6517cb4fd699b1400fc4cf
+  metadata.gz: 4fde634868ccbb2518edbde7841bce8ca6745a41c6ef398d1d20ce55bae6a7eefb9c35689ebecadd3ef8246200a6034bc202960457f42e430a351c56b7ef0742
+  data.tar.gz: d14df655313155febb0c769a2852efc8c1ce4888cfbaa05ea362ecdb3a1219bc98051b5da1b3583dd8add30ff40a6ea52f0a6ac86198cb54a4d7208520daecb4

data/.github/workflows/ci.yml

@@ -0,0 +1,47 @@
+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.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 }}
+
+    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@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.entry.ruby }}
+    - name: Install bundler and gems
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+    - name: Run tests
+      run: bundle exec rake

data/Gemfile

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

data/Gemfile.rails52

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

data/Gemfile.rails_head

@@ -0,0 +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/ar_transaction_changes.gemspec

@@ -11,13 +11,14 @@ Gem::Specification.new do |gem|
   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.license       = "MIT"
 
   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", ">= 4.2.4", "< 6.0"
+  gem.add_dependency "activerecord", ">= 5.2.0"
 
   gem.add_development_dependency("rake")
   gem.add_development_dependency("mysql2")

data/lib/ar_transaction_changes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "ar_transaction_changes/version"
 require "active_record"
 
@@ -18,19 +20,62 @@ module ArTransactionChanges
     @transaction_changed_attributes ||= HashWithIndifferentAccess.new
   end
 
-  method_name = if ActiveRecord.gem_version >= Gem::Version.new("5.2.0.beta1")
-    "_write_attribute"
-  else
-    "write_attribute"
+  def _write_attribute(attr_name, value)
+    _store_transaction_changed_attributes(attr_name) do
+      super(attr_name, value)
+    end
+  end
+
+  if ActiveRecord.version >= Gem::Version.new('6.1.0.alpha')
+    def write_attribute(attr_name, value)
+      _store_transaction_changed_attributes(attr_name) do
+        super(attr_name, value)
+      end
+    end
   end
 
-  define_method(method_name) do |attr_name, value|
+  private
+
+  def _store_transaction_changed_attributes(attr_name)
     attr_name = attr_name.to_s
-    old_value = read_attribute(attr_name)
-    ret = super(attr_name, value)
-    unless transaction_changed_attributes.key?(attr_name) || value == old_value
-      transaction_changed_attributes[attr_name] = old_value
+    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
+    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
+
+      stored_value = transaction_changed_attributes[attr_name]
+
+      if new_value == stored_value
+        transaction_changed_attributes.delete(attr_name)
+      end
     end
     ret
   end
+
+  def _read_attribute_for_transaction(attr_name)
+    attribute = @attributes[attr_name]
+    # Avoid causing an earlier memoized type cast of mutable serialized user values,
+    # since could prevent mutations of that user value from affecting the attribute value
+    # that would affect it without using this library.
+    if attribute.type.is_a?(::ActiveRecord::Type::Serialized)
+      if attribute.came_from_user?
+        attribute.type.serialize(attribute.value_before_type_cast)
+      else
+        attribute.value_before_type_cast
+      end
+    else
+      _read_attribute(attr_name)
+    end
+  end
 end

data/lib/ar_transaction_changes/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ArTransactionChanges
-  VERSION = "1.1.3"
+  VERSION = "1.1.8"
 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

@@ -1,6 +1,17 @@
 class User < ActiveRecord::Base
   include ArTransactionChanges
 
+  class ConnectionDetails
+    attr_accessor :client_ip
+
+    def initialize(client_ip:)
+      @client_ip = client_ip
+    end
+  end
+
+  serialize :connection_details, Array
+  serialize :notes, Array
+
   attr_accessor :stored_transaction_changes
 
   after_commit :store_transaction_changes_for_tests

data/test/test_helper.rb

@@ -1,19 +1,28 @@
-ENV["RAILS_ENV"] = "test"
 require 'pathname'
 require 'yaml'
 require 'ar_transaction_changes'
 require 'minitest/autorun'
 
+ENV["RAILS_ENV"] = "test"
+
 test_dir = Pathname.new(File.dirname(__FILE__))
 config_filename = test_dir.join("database.yml").exist? ? "database.yml" : "database.yml.default"
 database_yml = YAML.load(test_dir.join(config_filename).read)
-ActiveRecord::Base.establish_connection database_yml['test']
+database_config = database_yml.fetch("test")
+
+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|
-  db.drop_table(:users) if db.table_exists?(:users)
   db.create_table(:users) do |t|
     t.string :name
     t.string :occupation
+    t.integer :age
+    t.text :connection_details
+    t.text :notes
     t.timestamps null: false
   end
 end

data/test/transaction_changes_test.rb

@@ -2,7 +2,7 @@ require 'test_helper'
 
 class TransactionChangesTest < MiniTest::Unit::TestCase
   def setup
-    @user = User.new(:name => "Dylan", :occupation => "Developer")
+    @user = User.new(:name => "Dylan", :occupation => "Developer", age: 20)
     @user.save!
     @user.stored_transaction_changes = nil
   end
@@ -23,6 +23,13 @@ class TransactionChangesTest < MiniTest::Unit::TestCase
     assert_equal ["Dylan", "Dillon"], @user.stored_transaction_changes["name"]
   end
 
+  def test_transaction_changes_for_updating_attribute
+    @user[:name] = "Dillon"
+    @user.save!
+
+    assert_equal ["Dylan", "Dillon"], @user.stored_transaction_changes["name"]
+  end
+
   def test_transaction_changes_for_double_save
     @user.transaction do
       @user.name = "Dillon"
@@ -67,7 +74,7 @@ class TransactionChangesTest < MiniTest::Unit::TestCase
   end
 
   def test_transaction_changes_for_changing_updated_at
-    @user.update_attributes!(updated_at: Time.now - 1.second)
+    @user.update!(updated_at: Time.now - 1.second)
     old_updated_at = @user.updated_at
     @user.stored_transaction_changes = nil
 
@@ -78,7 +85,7 @@ class TransactionChangesTest < MiniTest::Unit::TestCase
   end
 
   def test_transaction_changes_for_touch
-    @user.update_attributes!(updated_at: Time.now - 1.second)
+    @user.update!(updated_at: Time.now - 1.second)
     old_updated_at = @user.updated_at
     @user.stored_transaction_changes = nil
 
@@ -94,4 +101,56 @@ class TransactionChangesTest < MiniTest::Unit::TestCase
     end
     refute @user.stored_transaction_changes["name"]
   end
+
+  def test_transaction_changes_type_cast
+    # "20" will be converted to 20 by read_attribute https://apidock.com/rails/ActiveRecord/AttributeMethods/read_attribute
+    @user.transaction do
+      @user.age = "20"
+      @user.save!
+    end
+    assert_empty @user.stored_transaction_changes
+  end
+
+  def test_serialized_attributes_value
+    @user.connection_details = [User::ConnectionDetails.new(client_ip: '1.1.1.1')]
+    @user.save!
+    old_value, new_value = @user.stored_transaction_changes['connection_details']
+    assert_equal([], old_value)
+    assert_equal(['1.1.1.1'], new_value.map(&:client_ip))
+  end
+
+  def test_serialized_attributes_mutation
+    details = User::ConnectionDetails.new(client_ip: '1.1.1.1')
+    @user.connection_details = [details]
+    details.client_ip = '2.2.2.2'
+    @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
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ar_transaction_changes
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.8
 platform: ruby
 authors:
 - Dylan Thacker-Smith
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-02-02 00:00:00.000000000 Z
+date: 2021-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,20 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.4
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 5.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.4
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 5.2.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,13 +60,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
 - Gemfile
-- Gemfile.rails42
-- Gemfile.rails50
-- Gemfile.rails51
 - Gemfile.rails52
+- Gemfile.rails_head
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -84,9 +76,10 @@ files:
 - test/test_helper.rb
 - test/transaction_changes_test.rb
 homepage: https://github.com/dylanahsmith/ar_transaction_changes
-licenses: []
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -101,9 +94,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Store transaction changes for active record objects
 test_files:

data/.travis.yml

@@ -1,23 +0,0 @@
-language: ruby
-sudo: false
-
-rvm:
-  - 2.2.5
-  - 2.3.1
-
-gemfile:
-  - Gemfile.rails42
-  - Gemfile.rails50
-  - Gemfile.rails51
-  - Gemfile.rails52
-
-matrix:
-  include:
-    - rvm: 2.1.9
-      gemfile: Gemfile.rails42
-
-services:
-  - mysql
-
-before_script:
-  - mysql -e 'create database ar_transaction_changes_test'

data/Gemfile.rails42

@@ -1,5 +0,0 @@
-source "https://rubygems.org"
-
-gem "rails", "~> 4.2.0"
-
-gemspec

data/Gemfile.rails50

@@ -1,5 +0,0 @@
-source "https://rubygems.org"
-
-gem "rails", "~> 5.0.0"
-
-gemspec

data/Gemfile.rails51

@@ -1,5 +0,0 @@
-source "https://rubygems.org"
-
-gem "rails", "~> 5.1.0.rc1"
-
-gemspec