immosquare-active-record-change-tracker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 299d11653d5c906ae788ed7b915a9b5570c056cdb7e43d16ae7e3bbeafab857e
+  data.tar.gz: 9bc986bd135035ec0e9708a7bef80e678c8b69f764b5781644e9a8c9c98f87b8
+SHA512:
+  metadata.gz: 99002bc0bc01c7d4cafff14310e5942c00298ee8d3781414cd13d6f17fa8a53e8b84c98ca13a78a4c123a7f9a06a7f61396f9337cefea5fa026391b3e5c6721e
+  data.tar.gz: b24bca711330f70cb77f59d6929bdc87de2244f655f9e548e87c993a12dde6b05235b7da115be1acdec940cce11aa46195662531f3c6e8c32a29e5f6e0d912b7

data/lib/generators/immosquare-active-record-change-tracker/install/install_generator.rb

@@ -0,0 +1,36 @@
+require "rails/generators"
+require "rails/generators/migration"
+
+
+module ImmosquareActiveRecordChangeTracker
+  class InstallGenerator < Rails::Generators::Base
+
+    include Rails::Generators::Migration
+
+    source_root File.expand_path("templates", __dir__)
+
+    desc "Generate migration for Table ActiveRecordChangeTracker"
+
+    def copy_migration
+      migration_template("template_1.rb", "db/migrate/#{migration_name.underscore}.rb", :migration_version => migration_version)
+    end
+
+    def self.next_migration_number(dirname)
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    end
+
+    private
+
+
+    def migration_name
+      "CreateActiveRecordChangeTracker"
+    end
+
+    def migration_version
+      return if ActiveRecord::VERSION::MAJOR < 6
+
+      "[#{ActiveRecord::VERSION::STRING.to_f}]"
+    end
+
+  end
+end

data/lib/generators/immosquare-active-record-change-tracker/install/templates/template_1.rb

@@ -0,0 +1,16 @@
+class <%= "#{migration_name} < ActiveRecord::Migration#{migration_version}" %>
+
+  def change
+    create_table(:active_record_change_trackers) do |t|
+      t.references(:recordable, :polymorphic => true, :foreign_key => false, :index => false, :null => false)
+      t.references(:modifier, :polymorphic => true, :foreign_key => false, :index => false, :null => true)
+      t.string(:event, :null => true, :limit => 10)
+      t.text(:data, :null => true, :limit => 4_294_967_295)
+      t.datetime(:created_at, :null => false)
+    end
+
+    add_index(:active_record_change_trackers, [:recordable_type, :recordable_id])
+    add_index(:active_record_change_trackers, [:modifier_type, :modifier_id])
+  end
+
+end

data/lib/immosquare-active-record-change-tracker/models/history_record.rb

@@ -0,0 +1,15 @@
+module ImmosquareActiveRecordChangeTracker
+  ##============================================================##
+  ## On nome le modèle différemment que ApplicationRecordHistory
+  ## pour éviter les conflits avec le nom du module.
+  ##============================================================##
+  class HistoryRecord < ::ActiveRecord::Base
+
+    self.table_name = "active_record_change_trackers"
+
+    belongs_to :recordable, :polymorphic => true
+    belongs_to :modifier,   :polymorphic => true
+    serialize :data, :coder => JSON
+
+  end
+end

data/lib/immosquare-active-record-change-tracker/railtie.rb

@@ -0,0 +1,21 @@
+require "rails"
+
+module ImmosquareActiveRecordChangeTracker
+  class Railtie < Rails::Railtie
+
+    initializer "immosquare_active_record_change_tracker.active_record" do
+      ActiveSupport.on_load(:active_record) do
+        ##============================================================##
+        ## Pour ajouter une gestion de l'historique des modifications
+        ##============================================================##
+        extend ImmosquareActiveRecordChangeTracker::ClassMethods
+
+        ##============================================================##
+        ## Définir la classe HistoryRecord après le chargement d'ActiveRecord
+        ##============================================================##
+        require "immosquare-active-record-change-tracker/models/history_record"
+      end
+    end
+
+  end
+end

data/lib/immosquare-active-record-change-tracker/version.rb

@@ -0,0 +1,3 @@
+module ImmosquareActiveRecordChangeTracker
+  VERSION = "0.1.0".freeze
+end

data/lib/immosquare-active-record-change-tracker.rb

@@ -0,0 +1,136 @@
+##============================================================##
+## Rails
+##============================================================##
+require_relative "immosquare-active-record-change-tracker/railtie"
+require_relative "generators/immosquare-active-record-change-tracker/install/install_generator"
+
+
+module ImmosquareActiveRecordChangeTracker
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def track_active_record_changes(options = {}, &modifier_block)
+      ##============================================================##
+      ## Inclut les méthodes d'instance nécessaires
+      ##============================================================##
+      include(ImmosquareActiveRecordChangeTracker::InstanceMethods)
+
+      ##============================================================##
+      ## Stocker les options dans un attribut de classe
+      ##============================================================##
+      class_attribute(:history_options)
+      self.history_options = options
+
+      ##============================================================##
+      ## Stocker le bloc du modificateur s'il est fourni
+      ##============================================================##
+      history_options[:modifier_block] = modifier_block if block_given?
+
+      ##============================================================##
+      ## Configure le callback after_save
+      ##============================================================##
+      after_save(:save_change_history)
+      after_destroy(:delete_change_history)
+    end
+  end
+
+  module InstanceMethods
+    private
+
+    ##============================================================##
+    ## Stocker les changements après un create ou save ou update
+    ##============================================================##
+    def save_change_history
+      history_options = self.class.history_options
+
+      ##============================================================##
+      ## Récupérer les champs à observer
+      ##============================================================##
+      changes_to_save =
+        if history_options[:only].present?
+          previous_changes.slice(*history_options[:only].map(&:to_s))
+        else
+          excluded_fields = history_options[:except] || []
+          excluded_fields += [:created_at, :updated_at]
+          previous_changes.except(*excluded_fields.uniq.map(&:to_s))
+        end
+
+
+      ##============================================================##
+      ## Gestion de Globalize
+      ##============================================================##
+      if respond_to?(:translated_attribute_names)
+        translated_attribute_names = send(:translated_attribute_names).map(&:to_sym)
+        globalize_changes          = {}
+
+        translations.each do |translation|
+          locale = translation.locale.to_sym
+          translation.previous_changes.each do |attribute, values|
+            attribute = attribute.to_sym
+            next if !attribute.in?(translated_attribute_names)
+
+            old_value, new_value = values
+            ##============================================================##
+            ## On ne sauvegarde pas les changements si les valeurs sont identiques
+            ## ou si on passe de nil à "" ou de "" à nil
+            ##============================================================##
+            next if old_value == new_value || (old_value.blank? && new_value.blank?)
+
+            globalize_changes[attribute] ||= {}
+            globalize_changes[attribute][locale] = [old_value, new_value]
+          end
+        end
+        changes_to_save.merge!(globalize_changes)
+      end
+
+
+      ##============================================================##
+      ## Si aucun changement à sauvegarder, on sort
+      ##============================================================##
+      return if changes_to_save.none?
+
+      ##============================================================##
+      ## Récupéreration du modificateur en exécutant le bloc s'il est défini
+      ##============================================================##
+      modifier = history_options[:modifier_block]&.call
+
+      ##============================================================##
+      ## Gestion de l'event
+      ##============================================================##
+      event = previously_new_record? ? "create" : "update"
+
+      ##============================================================##
+      ## On crée un enregistrement dans la table d'historique
+      ##============================================================##
+      ImmosquareActiveRecordChangeTracker::HistoryRecord.create!(
+        :recordable => self,
+        :modifier   => modifier,
+        :data       => changes_to_save,
+        :event      => event,
+        :created_at => DateTime.now
+      )
+    end
+
+    ##============================================================##
+    ## Stocker l'évenement destroy
+    ## Pas besoin de data, rien n'a changé.
+    ##============================================================##
+    def delete_change_history
+      ##============================================================##
+      ## Récupéreration du modificateur en exécutant le bloc s'il est défini
+      ##============================================================##
+      modifier = history_options[:modifier_block]&.call
+
+      ##============================================================##
+      ## On crée un enregistrement dans la table d'historique
+      ##============================================================##
+      ImmosquareActiveRecordChangeTracker::HistoryRecord.create!(
+        :recordable => self,
+        :modifier   => modifier,
+        :data       => nil,
+        :event      => "destroy",
+        :created_at => DateTime.now
+      )
+    end
+  end
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: immosquare-active-record-change-tracker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- IMMO SQUARE
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-10-01 00:00:00.000000000 Z
+dependencies: []
+description: A gem to track changes on ActiveRecord models
+email:
+- jules@immosquare.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/generators/immosquare-active-record-change-tracker/install/install_generator.rb
+- lib/generators/immosquare-active-record-change-tracker/install/templates/template_1.rb
+- lib/immosquare-active-record-change-tracker.rb
+- lib/immosquare-active-record-change-tracker/models/history_record.rb
+- lib/immosquare-active-record-change-tracker/railtie.rb
+- lib/immosquare-active-record-change-tracker/version.rb
+homepage: https://github.com/IMMOSQUARE/immosquare-active-record-change-tracker
+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.7.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: ActiveRecord Change Tracker
+test_files: []