activerecord_defer_persist 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7db83dbd1d88f1c7f7056bc9b459eb1e212712abc09d868fc0d914c0afbaf8d1
+  data.tar.gz: cb352fcb2375e5f018a4299efb3f56557ff2cfa4c257c9ae80a512225dba14a1
+SHA512:
+  metadata.gz: dce63024a78abeefe8851095c72daceac3236f3a466dccf1853ccacc1b70317ff7fdb5e002ca361d031574ef48acc08f10a7006d45edfd2564dc421210c292f7
+  data.tar.gz: bb8d7a68d2acb158c471e7cfee9749c3432aa67f6fecddc2faea263c76740345c63fc92a93ff00d86abbee76471c9792a8faee021cb559e778cf24be7bef90d0

data/README.md

@@ -0,0 +1,58 @@
+# ActiverecordDeferPersist
+
+[![Gem Version](https://badge.fury.io/rb/activerecord_defer_persist.svg)](https://badge.fury.io/rb/activerecord_defer_persist)
+[![Build Status](https://github.com/betagouv/activerecord_defer_persist/actions/workflows/ci.yml/badge.svg)](https://github.com/betagouv/activerecord_defer_persist/actions)
+
+> [!IMPORTANT]
+> This gem is still experimental. Please use it with caution and make sure you understand its implications.
+
+## TODO
+
+- [ ] Add tests for a simple `has_many` association
+- [ ] Support `ActiveModel::Dirty` so we can track changes association with `team.user_ids_changed?`
+- [ ] wrap changes in a transaction
+
+## Description
+
+The default behavior of ActiveRecord is to persist the associated records immediately when you assign them, which can be surprising/dangerous.
+For example calling `team.user_ids = [1, 2]`, or `team.assign_attributes(params.permit(:user_ids))` will persist immediately.
+
+This gem allows you to defer persisting to the database until the `save` method is called.
+
+## Context
+
+Inspiration for this gem goes to [this gist by @sudoremo](https://gist.github.com/sudoremo/4204e399e547ff7e3afdd0d89a5aaf3e), thank you!
+There is an ongoing (may 2025) PR in Rails to add a `defer` option to `has_many` associations: https://github.com/rails/rails/pull/55041
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add activerecord_defer_persist
+```
+
+## Usage
+
+```ruby
+  class Team < ApplicationRecord
+    include ActiverecordDeferPersist
+
+    has_many :users
+    defer_persist :users
+  end
+
+  team = Team.new(user_ids: [])
+  team.user_ids = [1, 2] # thid does not persist anymore !
+  team.save # this will now persist
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/betagouv/activerecord_defer_persist.

data/lib/activerecord_defer_persist/defer_persist.rb

@@ -0,0 +1,81 @@
+require "bundler/setup"
+require "logger"
+require "active_support/concern"
+
+module ActiverecordDeferPersist
+  module Concern
+    extend ActiveSupport::Concern
+
+    included do
+      after_save :persist_deferred
+    end
+
+    def persist_deferred
+      return if !@_defer_persist_ids && !@_defer_persist_records
+
+      @_defer_persist_ids&.each do |association, new_ids|
+        singular = association.to_s.singularize
+        send(:"original_#{singular}_ids=", new_ids)
+      end
+      @_defer_persist_ids = {}
+
+      @_defer_persist_records&.each do |association, new_records|
+        singular = association.to_s.singularize
+        send(:"original_#{singular}s=", new_records)
+      end
+      @_defer_persist_records = {}
+    end
+
+    def reload
+      @_defer_persist_ids = {}
+      super
+    end
+
+    class_methods do
+      def defer_persist(association)
+        singular = association.to_s.singularize
+
+        alias_method :"original_#{singular}_ids=", :"#{singular}_ids="
+        alias_method :"original_#{singular}s=", :"#{singular}s="
+        alias_method :"original_#{singular}_ids", :"#{singular}_ids"
+
+        define_method "#{singular}_ids=" do |ids|
+          @_defer_persist_ids ||= {}
+          @_defer_persist_ids[association] = ids
+        end
+
+        define_method "#{singular}s=" do |records|
+          @_defer_persist_records ||= {}
+          @_defer_persist_records[association] = records
+          # if something was stored in _defer_persist_ids, clear it now
+          @_defer_persist_ids.delete(association) if @_defer_persist_ids&.key?(association)
+        end
+
+        define_method "#{singular}_ids" do
+          @_defer_persist_ids ||= {}
+          @_defer_persist_records ||= {}
+          if @_defer_persist_ids.key?(association)
+            @_defer_persist_ids[association]
+          elsif @_defer_persist_records.key?(association)
+            @_defer_persist_records[association].map(&:id)
+          else
+            super()
+          end
+        end
+
+        define_method association.to_s do
+          @_defer_persist_ids ||= {}
+          @_defer_persist_records ||= {}
+          if @_defer_persist_ids.key?(association)
+            self.class.reflect_on_association(association).klass.where(id: @_defer_persist_ids[association])
+          elsif @_defer_persist_records.key?(association)
+            @_defer_persist_records[association]
+          else
+            super()
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/activerecord_defer_persist/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActiverecordDeferPersist
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: activerecord_defer_persist
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- BetaGouv developers
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: logger
+  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'
+- !ruby/object:Gem::Dependency
+  name: mutex_m
+  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'
+- !ruby/object:Gem::Dependency
+  name: base64
+  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'
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+description: ActiveRecord defaults to immediately persisting changes to the database
+  on assignments like user.session_ids = [1, 2]. This is a surprising behaviour that
+  this gem aims to fix to be more coherent with regular assignments.
+email:
+- adrien.di_pasquale@beta.gouv.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/activerecord_defer_persist/defer_persist.rb
+- lib/activerecord_defer_persist/version.rb
+homepage: https://github.com/betagouv/activerecord_defer_persist
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Defer persisting changes to the database on ActiveRecord has_many associations
+  assignments
+test_files: []