historiographer 4.1.8 → 4.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28891ab31232a7eae8efccd015269069d992eb775259c6a6b9e738da1df69aed
-  data.tar.gz: 7a794f1a26351b47d194a0b8d18eb0222d49e9dd7d2b6cdcf90467d94cea62b0
+  metadata.gz: e211bf451d7041d58702ebc28a4485eb3a073978aca72ef1933e9b5dcebc49fe
+  data.tar.gz: 20ab524186b29a4c3dd44553a62b8853cf46a82aae4f139d18d3178b045cb35a
 SHA512:
-  metadata.gz: 16ee4305c1aa8c6f09a13b042185afceea10fd18c0a19f7dba360bcab65a7f1a270dce78e24f15f2a30806fa4f4bcdf5ea6c10ecb81060b3dca02724918d7f5e
-  data.tar.gz: e66e7f2a31b5f65689f112ae6b43adeff5e286c42aeb6ed2ffc8931e1a75426dac3f4cb615b2fc06a537c74f070f4f2a245fe4668be8814b8382bd5084336651
+  metadata.gz: 055c01abfa33ab141ef48644ea38fa2a4052a9471d68519f89a659bbf45f83e37f66bb1aa847ba7014de9a46435af3cdced42d45ea122d25b70c409fdc312777
+  data.tar.gz: d7df91b900b2ea61b4e366b67972242d2882feadf8cfebbd8cd0d67875782535d267e084ec9cf044c835b4da757a0602b1ca8e75f6f27310faf4fe7b7bf69931

data/lib/historiographer/history.rb

@@ -69,17 +69,6 @@ module Historiographer
       #
       scope :current, -> { where(history_ended_at: nil).order(id: :desc) }
 
-      #
-      # A History class will be linked to the user
-      # that made the changes.
-      #
-      # E.g.
-      #
-      # RetailerProductHistory.first.user
-      #
-      # To use histories, a user class must be defined.
-      #
-      belongs_to :user, foreign_key: :history_user_id
 
       # 
       # Historiographer is opinionated about how History classes
@@ -94,7 +83,20 @@ module Historiographer
 
       # Store the original class for method delegation
       class_variable_set(:@@original_class, foreign_class)
-      class_variable_set(:@@method_map, {})
+
+      #
+      # A History class will be linked to the user
+      # that made the changes.
+      #
+      # E.g.
+      #
+      # RetailerProductHistory.first.user
+      #
+      # To use histories, a user class must be defined.
+      #
+      unless foreign_class.ancestors.include?(Historiographer::Silent)
+        belongs_to :user, foreign_key: :history_user_id
+      end
 
       # Add method_added hook to the original class
       foreign_class.singleton_class.class_eval do
@@ -120,8 +122,6 @@ module Historiographer
             # Skip if we've already defined this method in the history class
             return if foreign_class.history_class.method_defined?(method_name)
 
-            # Define the method in the history class
-            foreign_class.history_class.set_method_map(method_name, false)
             foreign_class.history_class.class_eval do
               define_method(method_name) do |*args, &block|
                 forward_method(method_name, *args, &block)
@@ -244,24 +244,15 @@ module Historiographer
         raise "Cannot snapshot a history model!"
       end
 
-    end
-
-    class_methods do
-      def method_added(method_name)
-        set_method_map(method_name, true)
+      def is_history_class?
+        true
       end
 
-      def set_method_map(method_name, is_overridden)
-        mm = method_map
-        mm[method_name.to_sym] = is_overridden
-        class_variable_set(:@@method_map, mm)
-      end
+    end
 
-      def method_map
-        unless class_variable_defined?(:@@method_map)
-          class_variable_set(:@@method_map, {})
-        end
-        class_variable_get(:@@method_map) || {}
+    class_methods do
+      def is_history_class?
+        true
       end
 
       def original_class
@@ -311,6 +302,7 @@ module Historiographer
           has_many assoc_name, scope, class_name: assoc_class_name, foreign_key: assoc_foreign_key, primary_key: history_foreign_key
         end
       end
+
       #
       # The foreign key to the primary class.
       #
@@ -343,20 +335,36 @@ module Historiographer
     def dummy_instance
       return @dummy_instance if @dummy_instance
 
+      # Only exclude history-specific columns
       cannot_keep_cols = %w(history_started_at history_ended_at history_user_id snapshot_id)
-      cannot_keep_cols += [self.class.inheritance_column.to_sym] if self.original_class.sti_enabled?
       cannot_keep_cols += [self.class.history_foreign_key] 
       cannot_keep_cols.map!(&:to_s)
 
       attrs = attributes.clone
       attrs[original_class.primary_key] = attrs[self.class.history_foreign_key]
 
-      instance = original_class.find_or_initialize_by(original_class.primary_key => attrs[original_class.primary_key])
-      instance.assign_attributes(attrs.except(*cannot_keep_cols))
+      if original_class.sti_enabled?
+        # Remove History suffix from type if present
+        attrs[original_class.inheritance_column] = attrs[original_class.inheritance_column]&.gsub(/History$/, '')
+      end
+
+      # Manually handle creating instance WITHOUT running find or initialize callbacks
+      # We will manually run callbacks below
+      # See: https://github.com/rails/rails/blob/95deab7b439abba23fdc4bd659116dab5dbe2606/activerecord/lib/active_record/core.rb#L487
+      #
+      attributes = original_class.attributes_builder.build_from_database(attrs.except(*cannot_keep_cols))
+      instance = original_class.allocate
+
+      # Set the internal attributes
+      instance.instance_variable_set(:@attributes, attributes)
+      instance.instance_variable_set(:@new_record, false)
+
+      # Initialize internal variables without triggering callbacks
+      instance.send(:init_internals)
 
       # Filter out any methods that are not overridden on the history class
       history_methods = self.class.instance_methods(false)
-      history_class_location = Module.const_source_location(self.class.name).first
+      history_class_location = Module.const_source_location(self.class.name).first 
       history_methods.select! do |method| 
         self.class.instance_method(method).source_location.first == history_class_location
       end
@@ -381,15 +389,13 @@ module Historiographer
         end
       end
 
-      # Override class method to return history class
-      instance.singleton_class.class_eval do
-        define_method(:class) do
-          history_instance = instance.instance_variable_get(:@_history_instance)
-          history_instance.class
-        end
+      instance.instance_variable_set(:@_history_instance, self)
+
+      if instance.send(original_class.primary_key).present?
+        instance.run_callbacks(:find)
       end
+      instance.run_callbacks(:initialize)
 
-      instance.instance_variable_set(:@_history_instance, self)
       @dummy_instance = instance
     end
 

data/lib/historiographer/version.rb

@@ -1,3 +1,3 @@
 module Historiographer
-  VERSION = "4.1.8"
+  VERSION = "4.1.10"
 end

data/lib/historiographer.rb

@@ -332,6 +332,10 @@ module Historiographer
       history_class = self.class.history_class
       foreign_key = history_class.history_foreign_key
 
+      attrs = attrs.stringify_keys
+      allowed_columns = self.class.columns.map(&:name)
+      attrs.select! { |k,v| allowed_columns.include?(k) }.to_h
+
       now ||= UTC.now
       attrs.merge!(foreign_key => attrs['id'], history_started_at: now, history_user_id: history_user_id)
       attrs.merge!(snapshot_id: snapshot_id) if snapshot_id.present?
@@ -343,6 +347,7 @@ module Historiographer
       end
 
       attrs = attrs.except('id')
+      attrs.stringify_keys!
 
       attrs
     end
@@ -361,6 +366,23 @@ module Historiographer
       raise HistoryUserIdMissingError, 'history_user_id must be passed in order to save record with histories! If you are in a context with no history_user_id, explicitly call #save_without_user'
     end
 
+    def list_callbacks(klass)
+      callbacks = {}
+
+      [:create, :update, :save, :destroy, :validation].each do |callback_type|
+        chain = klass.send("_#{callback_type}_callbacks")
+        callbacks[callback_type] = chain.map do |callback|
+          {
+            name: callback.filter,
+            kind: callback.kind,
+            options: callback.options
+          }
+        end
+      end
+
+      callbacks
+    end
+
     #
     # Save a record of the most recent changes, with the current
     # time as history_started_at, and the provided user as history_user_id.
@@ -375,9 +397,11 @@ module Historiographer
       current_history = histories.where(history_ended_at: nil).order('id desc').limit(1).last
 
       if history_class.history_foreign_key.present? && history_class.present?
-        history_class.create!(attrs).tap do |new_history|
-          current_history.update!(history_ended_at: now) if current_history.present?
-        end
+        result = history_class.insert_all([attrs])
+        inserted_id = result.rows.first.first if history_class.primary_key == 'id'
+        instance = history_class.find(inserted_id)
+        current_history.update_columns(history_ended_at: now) if current_history.present?
+        instance
       else
         raise 'Need foreign key and history class to save history!'
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: historiographer
 version: !ruby/object:Gem::Version
-  version: 4.1.8
+  version: 4.1.10
 platform: ruby
 authors:
 - brettshollenberger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-30 00:00:00.000000000 Z
+date: 2024-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -247,7 +247,6 @@ files:
 - lib/historiographer.rb
 - lib/historiographer/configuration.rb
 - lib/historiographer/history.rb
-- lib/historiographer/history/instance_methods.rb
 - lib/historiographer/history_migration.rb
 - lib/historiographer/history_migration_mysql.rb
 - lib/historiographer/mysql_migration.rb

data/lib/historiographer/history/instance_methods.rb

@@ -1,98 +0,0 @@
-module Historiographer
-  module History
-    module InstanceMethods
-      def destroy
-        false
-      end
-
-      def destroy!
-        false
-      end
-
-      def save(*args, **kwargs)
-        if persisted? && (changes.keys - %w(history_ended_at snapshot_id)).any?
-          false
-        else
-          super(*args, **kwargs)
-        end
-      end
-
-      def save!(*args, **kwargs)
-        if persisted? && (changes.keys - %w(history_ended_at snapshot_id)).any?
-          false
-        else
-          super(*args, **kwargs)
-        end
-      end
-
-      def snapshot
-        raise "Cannot snapshot a history model!"
-      end
-
-      def original_class
-        self.class.original_class
-      end
-
-      private
-
-      def dummy_instance
-        return @dummy_instance if @dummy_instance
-
-        cannot_keep_cols = %w(history_started_at history_ended_at history_user_id snapshot_id)
-        cannot_keep_cols += [self.class.inheritance_column.to_sym] if self.original_class.sti_enabled?
-        cannot_keep_cols += [self.class.history_foreign_key] 
-        cannot_keep_cols.map!(&:to_s)
-
-        attrs = attributes.clone
-        attrs[original_class.primary_key] = attrs[self.class.history_foreign_key]
-
-        instance = original_class.find_or_initialize_by(original_class.primary_key => attrs[original_class.primary_key])
-        instance.assign_attributes(attrs.except(*cannot_keep_cols))
-
-        # Create a module to hold methods from the history class
-        history_methods_module = Module.new
-
-        # Get methods defined directly in the history class, excluding baseline methods
-        history_methods = self.class.instance_methods(false) - baseline_methods
-
-        history_methods.each do |method_name|
-          next if instance.singleton_class.method_defined?(method_name)
-
-          method = self.class.instance_method(method_name)
-          history_methods_module.define_method(method_name) do |*args, &block|
-            method.bind(self.instance_variable_get(:@_history_instance)).call(*args, &block)
-          end
-        end
-
-        instance.singleton_class.prepend(history_methods_module)
-
-        self.class.reflect_on_all_associations.each do |reflection|
-          instance.singleton_class.class_eval do
-            define_method(reflection.name) do |*args, &block|
-              history_instance = instance.instance_variable_get(:@_history_instance)
-              history_instance.send(reflection.name, *args, &block)
-            end
-          end
-        end
-
-        instance.singleton_class.class_eval do
-          define_method(:class) do
-            history_instance = instance.instance_variable_get(:@_history_instance)
-            history_instance.class
-          end
-        end
-
-        instance.instance_variable_set(:@_history_instance, self)
-        @dummy_instance = instance
-      end
-
-      def forward_method(method_name, *args, &block)
-        if method_name == :class || method_name == 'class'
-          self.class
-        else
-          dummy_instance.send(method_name, *args, &block)
-        end
-      end
-    end
-  end
-end