ar_transaction_changes 1.1.2 → 1.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8512832019c33caf8bd9bb39796f2db6b6e8ce74
-  data.tar.gz: 05f8382a08442778dc3a9eb3fc4d9f573c83969d
+SHA256:
+  metadata.gz: 1b75ccc7bc393e60284a26e6077bdfc48e8032b52780770f0b762f292a6a3393
+  data.tar.gz: 2a048448c70283320792559fd7f7ae90d339384fda9fa3b9d437abf2607fd701
 SHA512:
-  metadata.gz: 258b699e07a4dcc3bbce95dce4991f5916569f94764eb3c66fb2627fb12e3f98520eb0663a57986cf868f37eef0703f013a9f6d4c73e9337682d67b8e29b6de3
-  data.tar.gz: e8b2912cc3fd090905493e6d0230da91fe08251cfea9cb1edebe93ab1eaa78619d667947d81689443f6a0d56158da4db545d2583ec632b83e76b65bfeec935f3
+  metadata.gz: f3148c75a2a2bebc626451d1cbfbb7263cb1e39a56571af89761dc1f5b96a3a988de2a97ee2bef546744765f2b3eb569de77ce45fea5e7da1289821231435076
+  data.tar.gz: e21dff998d73c00ee6f6b8b7d92d9814412bf3421b8dc009e41429b7fc33e014cd9cd4f01d05288bc5009fc530749628de7d19c6e97973c53a3ddd37bc8f9cd0

data/.travis.yml

@@ -1,22 +1,17 @@
 language: ruby
 sudo: false
 
-rvm:
-  - 2.2.5
-  - 2.3.1
-
-gemfile:
-  - Gemfile.rails42
-  - Gemfile.rails50
-  - Gemfile.rails51
-
-matrix:
+jobs:
   include:
-    - rvm: 2.1.9
-      gemfile: Gemfile.rails42
+    - 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
-
-before_script:
-  - mysql -e 'create database ar_transaction_changes_test'

data/{Gemfile.rails42 → Gemfile.rails52}

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

data/Gemfile.rails_head

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem 'activerecord', github: 'rails/rails'
+
+gemspec

data/README.md

@@ -44,6 +44,19 @@ class User < ActiveRecord::Base
 end
 ```
 
+## Important Notes
+
+`ar_transaction_changes` may have conflict with another gems who modify
+`active_record#write_attribute` method, e.g. `globalize` gem
+
+the workaround is by requiring this gem first, for example:
+
+```ruby
+gem 'ar_transaction_changes', require: false
+gem 'globalize', require: ['ar_transaction_changes', 'globalize']
+
+```
+
 ## Contributing
 
 1. Fork it

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,4 +1,7 @@
+# frozen_string_literal: true
+
 require "ar_transaction_changes/version"
+require "active_record"
 
 module ArTransactionChanges
   def _run_commit_callbacks
@@ -17,13 +20,52 @@ module ArTransactionChanges
     @transaction_changed_attributes ||= HashWithIndifferentAccess.new
   end
 
-  def write_attribute(attr_name, value) # override
+  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
+
+  private
+
+  def _store_transaction_changed_attributes(attr_name)
     attr_name = attr_name.to_s
-    old_value = attributes[attr_name]
-    ret = super
-    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)
+    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
+      end
+      transaction_changed_attributes
     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.2"
+  VERSION = "1.1.7"
 end

data/test/models/user.rb

@@ -1,6 +1,16 @@
 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
+
   attr_accessor :stored_transaction_changes
 
   after_commit :store_transaction_changes_for_tests

data/test/test_helper.rb

@@ -1,20 +1,25 @@
-ENV["RAILS_ENV"] = "test"
 require 'pathname'
 require 'yaml'
-require 'active_record'
 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")
+
+ActiveRecord::Base.establish_connection(database_config.except("database"))
+ActiveRecord::Base.connection.recreate_database(database_config.fetch("database"))
+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.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,29 @@ 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
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ar_transaction_changes
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.7
 platform: ruby
 authors:
 - Dylan Thacker-Smith
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-06-12 00:00:00.000000000 Z
+date: 2020-07-01 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
@@ -69,9 +63,8 @@ files:
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
-- Gemfile.rails42
-- Gemfile.rails50
-- Gemfile.rails51
+- Gemfile.rails52
+- Gemfile.rails_head
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -83,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
@@ -100,9 +94,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Store transaction changes for active record objects
 test_files:

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