historiographer 4.1.7 → 4.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdfddfba56fcb69bb91c73edcf7c1ddff76adc25f517d4b225bcf87bdd356540
-  data.tar.gz: 01e398edc375e2bcf17f22a81c4eb06ab2d507483b05db80b8014ea291f2ac82
+  metadata.gz: e0a2f100a48aa0554022b2b53d7dd09cb296b298b6c6d92e6dae5b824cccd600
+  data.tar.gz: 6472d913b3d16ae9b5adc2414d1bbc0eaab9d62f632d497e475fd35291b90999
 SHA512:
-  metadata.gz: 64b288645843cad4862b06724619ec8c98405745b4d6ba572d00baabbc1ce0d4f706cbf95b42c7e1e6214c870ac0c335fb37ea760f599830037f11a94cf5443e
-  data.tar.gz: '09663a6452efd27ce2f566b3764e7dd9f29499a61cb5eecc7b488e8fe31270d57a6ceb84489de983cbd4851ac8906cf6140127113ef06751fc6cb19839821906'
+  metadata.gz: c4dcc56d605f9c67ff7e00de652a9d180034e7c41c911d44e4c697a8843903a0da8669a7bf02a72877566835c5acc937f3a61c674dc206fc51e826720b9ff689
+  data.tar.gz: c16605025d81e61edd43476e8c8b0e85035aacd496b071ab13cec7eeabc5469297b1342df7b3e352dfc8eee4999ee871361aebf6e16e324b0020733f02bf5cbc

data/lib/historiographer/history.rb

@@ -61,7 +61,7 @@ module Historiographer
     extend ActiveSupport::Concern
 
     included do |base|
-      clear_validators!
+      clear_validators! if respond_to?(:clear_validators!)
       #
       # A History class (e.g. RetailerProductHistory) will gain
       # access to a current scope, returning
@@ -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,6 +83,21 @@ 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
@@ -102,7 +106,6 @@ module Historiographer
           alias_method :original_method_added, :method_added
         end
 
-        method_map = Hash.new(0)
         define_method(:method_added) do |method_name|
           # Skip if we're already in the process of defining a method
           return if Thread.current[:defining_historiographer_method]
@@ -121,6 +124,7 @@ module Historiographer
             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)
@@ -239,9 +243,38 @@ module Historiographer
         define_history_association(association)
       end
 
+      def snapshot
+        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
+
+      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
+
+      def method_map
+        unless class_variable_defined?(:@@method_map)
+          class_variable_set(:@@method_map, {})
+        end
+        class_variable_get(:@@method_map) || {}
+      end
+
       def original_class
         unless class_variable_defined?(:@@original_class)
           class_variable_set(:@@original_class, self.name.gsub(/History$/, '').constantize)
@@ -255,40 +288,41 @@ module Historiographer
           association = original_class.reflect_on_association(association)
         end
         assoc_name = association.name
+        assoc_module = association.active_record.module_parent
         assoc_history_class_name = "#{association.class_name}History"
-        assoc_foreign_key = association.foreign_key
 
-        # Skip if the association is already defined
-        return if method_defined?(assoc_name)
+        begin
+          assoc_module.const_get(assoc_history_class_name)
+          assoc_history_class_name = "#{assoc_module}::#{assoc_history_class_name}" unless assoc_history_class_name.match?(Regexp.new("#{assoc_module}::"))
+        rescue
+        end
+
+        assoc_foreign_key = association.foreign_key
 
         # Skip through associations to history classes to avoid infinite loops
         return if association.class_name.end_with?('History')
 
-        # We're writing a belongs_to
-        # The dataset belongs_to the datasource
-        # dataset#datasource_id => datasource.id
-        # 
-        # For the history class, we're writing a belongs_to
-        # the DatasetHistory belongs_to the DatasourceHistory
-        # dataset_history#datasource_id => datasource_history.easy_ml_datasource_id
-        #
-        # The missing piece for us here is whatever DatasourceHistory would call easy_ml_datasource_id (history foreign key?)
+        # Always use the history class if it exists
+        assoc_class = assoc_history_class_name.safe_constantize || OpenStruct.new(name: association.class_name)
+        assoc_class_name = assoc_class.name
+
+        # Define the scope to filter by snapshot_id for history associations
+        scope = if assoc_class_name.match?(/History/)
+                  ->(history_instance) { where(snapshot_id: history_instance.snapshot_id) }
+                else
+                  ->(history_instance) { all }
+                end
 
         case association.macro
         when :belongs_to
-          belongs_to assoc_name, ->(history_instance) {
-            where(snapshot_id: history_instance.snapshot_id)
-          }, class_name: assoc_history_class_name, foreign_key: assoc_foreign_key, primary_key: assoc_foreign_key
+          belongs_to assoc_name, scope, class_name: assoc_class_name, foreign_key: assoc_foreign_key, primary_key: assoc_foreign_key
         when :has_one
-          has_one assoc_name, ->(history_instance) {
-            where(snapshot_id: history_instance.snapshot_id)
-          }, class_name: assoc_history_class_name, foreign_key: assoc_foreign_key, primary_key: history_foreign_key
+          has_one assoc_name, scope, class_name: assoc_class_name, foreign_key: assoc_foreign_key, primary_key: history_foreign_key
         when :has_many
-          has_many assoc_name, ->(history_instance) {
-            where(snapshot_id: history_instance.snapshot_id)
-          }, class_name: assoc_history_class_name, foreign_key: assoc_foreign_key, primary_key: history_foreign_key
+          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.
       #
@@ -321,21 +355,74 @@ 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_methods.select! do |method| 
+        self.class.instance_method(method).source_location.first == history_class_location
+      end
+
+      history_methods.each do |method_name|
+        instance.singleton_class.class_eval do 
+          define_method(method_name) do |*args, &block|
+            history_instance = instance.instance_variable_get(:@_history_instance)
+            history_instance.send(method_name, *args, &block)
+          end
+        end
+      end
+
+      # For each association in the history class
+      self.class.reflect_on_all_associations.each do |reflection|
+        # Define a method that forwards to the history association
+        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
+
+      # 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
+      end
+
+      instance.instance_variable_set(:@_history_instance, self)
       @dummy_instance = instance
     end
 
     def forward_method(method_name, *args, &block)
-      dummy_instance.send(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

data/lib/historiographer/version.rb

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

data/lib/historiographer.rb

@@ -216,21 +216,25 @@ module Historiographer
     base.singleton_class.prepend(Module.new do
       def belongs_to(name, scope = nil, **options, &extension)
         super
+        return if is_history_class?
         history_class.define_history_association(name)
       end
 
       def has_one(name, scope = nil, **options, &extension)
         super
+        return if is_history_class?
         history_class.define_history_association(name)
       end
 
       def has_many(name, scope = nil, **options, &extension)
         super
+        return if is_history_class?
         history_class.define_history_association(name)
       end
 
       def has_and_belongs_to_many(name, scope = nil, **options, &extension)
         super
+        return if is_history_class?
         history_class.define_history_association(name)
       end
     end)
@@ -371,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.7
+  version: 4.1.9
 platform: ruby
 authors:
 - brettshollenberger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-20 00:00:00.000000000 Z
+date: 2024-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -220,6 +220,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  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: Append-only histories + chained snapshots of your ActiveRecord tables
 email: brett.shollenberger@gmail.com
 executables: []