after_commit_changes 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 69c7f5e46ca54be22ea0fecc939d4a092681e5183f3f80ef7850a7b4588aa702
+  data.tar.gz: 03c2c226e947acab43f004a8b98bfe6f0b27f3959a1abde8b421715861324442
+SHA512:
+  metadata.gz: c478de53032f858476b399ec9aff94aa46b14f8ccb341a29332f7cbfcd037a6fb7b3d85244172042f88c012550c7c876ee0f664c8c6af875eeb57044720ef40b
+  data.tar.gz: 99e87f8493b2fe465ef4d14866691e4fb6ffffefbd8e8dd5e193ae262961e51a82546a2e0d43480e8bbb0cc383dd52356963489824f8ed467ac235255843fe04

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## 1.0.0
+
+### Added
+- Initial release

data/MIT_LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2023 Brian Durand
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,75 @@
+# AfterCommitChanges
+
+[![Continuous Integration](https://github.com/bdurand/after_commit_changes/actions/workflows/continuous_integration.yml/badge.svg)](https://github.com/bdurand/after_commit_changes/actions/workflows/continuous_integration.yml)
+[![Regression Test](https://github.com/bdurand/after_commit_changes/actions/workflows/regression_test.yml/badge.svg)](https://github.com/bdurand/after_commit_changes/actions/workflows/regression_test.yml)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
+[![Gem Version](https://badge.fury.io/rb/after_commit_changes.svg)](https://badge.fury.io/rb/after_commit_changes)
+
+This gem addresses an [issue in ActiveRecord](https://github.com/rails/rails/pull/50011) with the `saved_changes` value when a record is updated multiple times in a single database transaction.
+
+After a record is saved, you can check the set of changes with the `saved_changes` method using the [ActiveModel::Dirty API](https://api.rubyonrails.org/classes/ActiveModel/Dirty.html). However, when a record is saved multiple times, the list of saved changes is reset with each save operation. This can be an issue inside of an `after_commit` or `before_commit` callback since those callbacks are only called once for the transaction and will only get the last set of changes.
+
+This can be a problem if you have a callback that checks for changes to specific fields. Consider this model where we want to run an asychronous job when a user changes their email address:
+
+```ruby
+class User < ApplicationRecord
+  after_commit :notify_email_changes, if: :email_changed?
+
+  def notify_email_changes
+    NotifyEmailChangesJob.perform_later(id)
+  end
+end
+```
+
+This breaks down if a record is saved twice in a single transaction.
+
+```ruby
+user.transaction do
+  user.update!(email: params[:email])
+  if user.last_visited_at < 1.day.ago
+    user.update!(last_visited_at: Time.now)
+  end
+end
+```
+
+In the case where we update the `last_visited_at` field, the `email_changed?` method will return false since the email address was not changed in the last save operation and `notify_email_changes` method will not be called.
+
+This gem addresses this issue by merging all saved changes together before calling the `after_commit` or `before_commit` callbacks so that `saved_changes` will return the complete list of changes for the transaction.
+
+## Usage
+
+To use the gem, you simply need to mix it into your models. You can include it in all models by including it in your `ApplicationRecord` class:
+
+```ruby
+class ApplicationRecord < ActiveRecord::Base
+  include AfterCommitChanges
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "after_commit_changes"
+```
+
+Then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install gem "after_commit_changes"
+```
+
+## Contributing
+
+Open a pull request on GitHub.
+
+Please use the [standardrb](https://github.com/testdouble/standard) syntax and lint your code with `standardrb --fix` before submitting.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/after_commit_changes.gemspec

@@ -0,0 +1,36 @@
+Gem::Specification.new do |spec|
+  spec.name = "after_commit_changes"
+  spec.version = File.read(File.join(__dir__, "VERSION")).strip
+  spec.authors = ["Brian Durand"]
+  spec.email = ["bbdurand@gmail.com"]
+
+  spec.summary = "Aggregate all changes made to an ActiveRecord model inside a transaction into a single set of changes."
+  spec.homepage = "https://github.com/bdurand/after_commit_changes"
+  spec.license = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  ignore_files = %w[
+    .
+    Appraisals
+    Gemfile
+    Gemfile.lock
+    Rakefile
+    config.ru
+    assets/
+    bin/
+    gemfiles/
+    spec/
+  ]
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject { |f| ignore_files.any? { |path| f.start_with?(path) } }
+  end
+
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", ">= 6.0"
+
+  spec.add_development_dependency "bundler"
+
+  spec.required_ruby_version = ">= 2.5"
+end

data/lib/after_commit_changes.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module AfterCommitChanges
+  VERSION = File.read(File.expand_path("../VERSION", __dir__)).strip
+
+  def self.included(base)
+    base.before_commit do
+      rollup_mutations_for_transaction!
+    end
+
+    base.after_save do
+      @after_commit_saved_changes ||= []
+      @after_commit_saved_changes << saved_changes
+    end
+  end
+
+  private
+
+  def rollup_mutations_for_transaction!
+    return unless @after_commit_saved_changes && @after_commit_saved_changes.size > 1
+
+    attributes = @_start_transaction_state[:attributes].deep_dup
+    mutations = ActiveModel::AttributeMutationTracker.new(attributes)
+
+    @after_commit_saved_changes[1, @after_commit_saved_changes.length].each do |changes|
+      changes.each do |attr_name, value_change|
+        attribute = attributes[attr_name]
+        last_value = value_change.last
+        last_value = last_value.to_h if last_value.is_a?(ActiveSupport::HashWithIndifferentAccess)
+        attributes[attr_name] = ActiveModel::Attribute.from_user(attr_name, last_value, attribute.type, attribute)
+        mutations.force_change(attr_name) unless mutations.changed?(attr_name)
+      end
+    end
+
+    @after_commit_saved_changes = nil
+    @mutations_before_last_save = mutations
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: after_commit_changes
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brian Durand
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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:
+email:
+- bbdurand@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT_LICENSE.txt
+- README.md
+- VERSION
+- after_commit_changes.gemspec
+- lib/after_commit_changes.rb
+homepage: https://github.com/bdurand/after_commit_changes
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.20
+signing_key:
+specification_version: 4
+summary: Aggregate all changes made to an ActiveRecord model inside a transaction
+  into a single set of changes.
+test_files: []