historiographer 4.1.8 → 4.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28891ab31232a7eae8efccd015269069d992eb775259c6a6b9e738da1df69aed
-  data.tar.gz: 7a794f1a26351b47d194a0b8d18eb0222d49e9dd7d2b6cdcf90467d94cea62b0
+  metadata.gz: e0a2f100a48aa0554022b2b53d7dd09cb296b298b6c6d92e6dae5b824cccd600
+  data.tar.gz: 6472d913b3d16ae9b5adc2414d1bbc0eaab9d62f632d497e475fd35291b90999
 SHA512:
-  metadata.gz: 16ee4305c1aa8c6f09a13b042185afceea10fd18c0a19f7dba360bcab65a7f1a270dce78e24f15f2a30806fa4f4bcdf5ea6c10ecb81060b3dca02724918d7f5e
-  data.tar.gz: e66e7f2a31b5f65689f112ae6b43adeff5e286c42aeb6ed2ffc8931e1a75426dac3f4cb615b2fc06a537c74f070f4f2a245fe4668be8814b8382bd5084336651
+  metadata.gz: c4dcc56d605f9c67ff7e00de652a9d180034e7c41c911d44e4c697a8843903a0da8669a7bf02a72877566835c5acc937f3a61c674dc206fc51e826720b9ff689
+  data.tar.gz: c16605025d81e61edd43476e8c8b0e85035aacd496b071ab13cec7eeabc5469297b1342df7b3e352dfc8eee4999ee871361aebf6e16e324b0020733f02bf5cbc

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
@@ -96,6 +85,20 @@ module Historiographer
       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
         # Keep track of original method_added if it exists
@@ -244,9 +247,17 @@ module Historiographer
         raise "Cannot snapshot a history model!"
       end
 
+      def is_history_class?
+        true
+      end
+
     end
 
     class_methods do
+      def is_history_class?
+        true
+      end
+
       def method_added(method_name)
         set_method_map(method_name, true)
       end
@@ -311,6 +322,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 +355,32 @@ 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
+
+      # Create instance with all attributes except history-specific ones
+      instance = original_class.instantiate(attrs.except(*cannot_keep_cols))
+
+      if instance.valid?
+        if instance.send(original_class.primary_key).present?
+          instance.run_callbacks(:find)
+        end
+        instance.run_callbacks(:initialize)
+      end
 
       # 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

data/lib/historiographer/version.rb

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

data/lib/historiographer.rb

@@ -375,9 +375,10 @@ 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
+        instance = history_class.new(attrs)
+        instance.save(validate: false)
+        current_history.update!(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.9
 platform: ruby
 authors:
 - brettshollenberger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-30 00:00:00.000000000 Z
+date: 2024-12-03 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