historiographer 4.0.0 → 4.1.0

data/{lib → Users/brettshollenberger/programming/historiographer/lib}/historiographer.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'active_support/all'
+require 'securerandom'
 require_relative './historiographer/history'
 require_relative './historiographer/postgres_migration'
 require_relative './historiographer/safe'
@@ -83,12 +84,21 @@ module Historiographer
     after_save :record_history, if: :should_record_history?
     validate :validate_history_user_id_present, if: :should_validate_history_user_id_present?
 
+    # Add scope to fetch latest histories
+    scope :latest_snapshot, -> {
+      history_class.latest_snapshot
+    }
+
+    def should_alert_history_user_id_present?
+      !snapshot_mode? && !is_history_class? && Thread.current[:skip_history_user_id_validation] != true
+    end
+
     def should_validate_history_user_id_present?
-      true
+      !snapshot_mode? && !is_history_class? && Thread.current[:skip_history_user_id_validation] != true
     end
 
     def validate_history_user_id_present
-      if @no_history.nil? && (!history_user_id.present? || !history_user_id.is_a?(Integer))
+      if should_validate_history_user_id_present? && (@no_history.nil? && (!history_user_id.present? || !history_user_id.is_a?(Integer)))
         errors.add(:history_user_id, 'must be an integer')
       end
     end
@@ -139,9 +149,9 @@ module Historiographer
     def historiographer_changes?
       case Rails.version.to_f
       when 0..5 then changed? && valid?
-      when 5.1..7 then saved_changes?
-      else
         raise 'Unsupported Rails version'
+      when 5.1..8 then saved_changes?
+      else
       end
     end
 
@@ -151,17 +161,36 @@ module Historiographer
     # then record history after successful save.
     #
     def should_record_history?
+      return false if snapshot_mode?
+      return false if is_history_class?
+
       historiographer_changes? && !@no_history
     end
 
-    attr_accessor :history_user_id
+    def history_user_id=(value)
+      if is_history_class?
+        write_attribute(:history_user_id, value)
+      else
+        @history_user_id = value
+      end
+    end
+
+    def history_user_id
+      if is_history_class?
+        read_attribute(:history_user_id)
+      else
+        @history_user_id
+      end
+    end
 
     class_name = "#{base.name}History"
 
     begin
       class_name.constantize
     rescue StandardError
-      history_class_initializer = Class.new(ActiveRecord::Base) do
+      history_class_initializer = Class.new(base) do
+        self.table_name = "#{base.table_name}_histories"
+        self.inheritance_column = nil
       end
 
       Object.const_set(class_name, history_class_initializer)
@@ -169,6 +198,70 @@ module Historiographer
 
     klass = class_name.constantize
 
+    # Hook into the association building process
+    base.singleton_class.prepend(Module.new do
+      def belongs_to(name, scope = nil, **options, &extension)
+        super
+        define_history_association(name, :belongs_to, options)
+      end
+
+      def has_one(name, scope = nil, **options, &extension)
+        super
+        define_history_association(name, :has_one, options)
+      end
+
+      def has_many(name, scope = nil, **options, &extension)
+        super
+        define_history_association(name, :has_many, options)
+      end
+
+      def has_and_belongs_to_many(name, scope = nil, **options, &extension)
+        super
+        define_history_association(name, :has_and_belongs_to_many, options)
+      end
+
+      private
+
+      def define_history_association(name, type, options)
+        return if is_history_class?
+        return if @defining_association
+        return if %i[histories current_history].include?(name)
+        @defining_association = true
+
+        history_class = "#{self.name}History".constantize
+        history_class_name = "#{name.to_s.singularize.camelize}History"
+
+        # Get the original association's foreign key
+        original_reflection = self.reflect_on_association(name)
+        foreign_key = original_reflection.foreign_key
+
+        if type == :has_many || type == :has_and_belongs_to_many
+          history_class.send(
+            type, 
+            name, 
+            -> (owner) { where("#{name.to_s.singularize}_histories.snapshot_id = ?", owner.snapshot_id) }, 
+            **options.merge(
+              class_name: history_class_name, 
+              foreign_key: foreign_key,
+              primary_key: foreign_key
+            )
+          )
+        else
+          history_class.send(
+            type, 
+            name, 
+            -> (owner) { where("#{name}_histories.snapshot_id = ?", owner.snapshot_id) }, 
+            **options.merge(
+              class_name: history_class_name, 
+              foreign_key: foreign_key,
+              primary_key: foreign_key
+            )
+          )
+        end
+        @defining_association = false
+      end
+    end)
+
     if base.respond_to?(:histories)
       raise "#{base} already has histories. Talk to Brett if this is a legit use case."
     else
@@ -219,6 +312,46 @@ module Historiographer
       @no_history = false
     end
 
+    
+    def snapshot(tree = {}, snapshot_id = nil)
+      return if is_history_class?
+
+      without_history_user_id do
+        # Use SecureRandom.uuid instead of timestamp for snapshot_id
+        snapshot_id ||= SecureRandom.uuid
+        history_class = self.class.history_class
+        primary_key = self.class.primary_key
+        foreign_key = history_class.history_foreign_key
+        attrs = attributes.clone
+        existing_snapshot = history_class.where(foreign_key => attrs[primary_key], snapshot_id: snapshot_id)
+        return if existing_snapshot.present?
+
+        null_snapshot = history_class.where(foreign_key => attrs[primary_key], snapshot_id: nil)
+        if null_snapshot.present?
+          null_snapshot.update(snapshot_id: snapshot_id)
+        else
+          record_history(snapshot_id: snapshot_id)
+        end
+
+        # Recursively snapshot associations, avoiding infinite loops
+        self.class.reflect_on_all_associations.each do |association|
+          associated_records = send(association.name).reload
+          Array(associated_records).each do |record|
+            model_name = record.class.name
+            record_id = record.id
+
+            tree[model_name] ||= {}
+            next if tree[model_name][record_id]
+
+            new_tree = tree.deep_dup
+            new_tree[model_name][record_id] = true
+
+            record.snapshot(new_tree, snapshot_id) if record.respond_to?(:snapshot)
+          end
+        end
+      end
+    end
+
     private
 
     def history_user_absent_action
@@ -231,8 +364,8 @@ module Historiographer
     #
     # Find the most recent history, and update its history_ended_at timestamp
     #
-    def record_history
-      history_user_absent_action if history_user_id.nil?
+    def record_history(snapshot_id: nil)
+      history_user_absent_action if history_user_id.nil? && should_alert_history_user_id_present?
 
       attrs = attributes.clone
       history_class = self.class.history_class
@@ -240,30 +373,62 @@ module Historiographer
 
       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?
 
       attrs = attrs.except('id')
 
       current_history = histories.where(history_ended_at: nil).order('id desc').limit(1).last
 
       if foreign_key.present? && history_class.present?
-        history_class.create!(attrs)
-        current_history.update!(history_ended_at: now) if current_history.present?
+        history_class.create!(attrs).tap do |history|
+          current_history.update!(history_ended_at: now) if current_history.present?
+        end
       else
         raise 'Need foreign key and history class to save history!'
       end
     end
+
+    def without_history_user_id
+      Thread.current[:skip_history_user_id_validation] = true
+      yield
+    ensure
+      Thread.current[:skip_history_user_id_validation] = false
+    end
   end
 
   class_methods do
+    def is_history_class?
+      name.match?(/History$/)
+    end
     #
     # E.g. SponsoredProductCampaign => SponsoredProductCampaignHistory
     #
     def history_class
-      "#{name}History".constantize
+      if is_history_class?
+        nil
+      else
+        "#{name}History".constantize
+      end
     end
 
     def relation
       super.tap { |r| r.extend Historiographer::Relation }
     end
+
+    def historiographer_mode(mode)
+      @historiographer_mode = mode
+    end
+
+    def get_historiographer_mode
+      @historiographer_mode || Historiographer::Configuration.mode
+    end
+  end
+
+  def is_history_class?
+    self.class.is_history_class?
+  end
+
+  def snapshot_mode?
+    (self.class.get_historiographer_mode.to_sym == :snapshot_only)
   end
 end

data/{spec → Users/brettshollenberger/programming/historiographer/spec}/db/database.yml

@@ -1,12 +1,14 @@
 development:
   adapter: postgresql
-  prepared_statements: false
-  url: "postgres://localhost/historiographer_development"
+  encoding: unicode
+  database: historiographer_development
+  pool: 5
 
 test:
   adapter: postgresql
+  encoding: unicode
   database: historiographer_test
-  url: "postgres://localhost/historiographer_test"
+  pool: 5
 
 # mysql_default: &mysql_default
 #   adapter: mysql2

data/Users/brettshollenberger/programming/historiographer/spec/db/migrate/20241109182017_create_comments.rb

@@ -0,0 +1,13 @@
+class CreateComments < ActiveRecord::Migration[7.1]
+  def change
+    create_table :comments do |t|
+      t.bigint :post_id
+      t.bigint :author_id
+      t.text :body
+      t.timestamps
+
+      t.index :post_id
+      t.index :author_id
+    end
+  end
+end

data/Users/brettshollenberger/programming/historiographer/spec/db/migrate/20241109182020_create_comment_histories.rb

@@ -0,0 +1,9 @@
+require 'historiographer/postgres_migration'
+
+class CreateCommentHistories < ActiveRecord::Migration[7.1]
+  def change
+    create_table :comment_histories do |t|
+      t.histories
+    end
+  end
+end

data/{spec → Users/brettshollenberger/programming/historiographer/spec}/db/schema.rb

@@ -10,8 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 2022_10_18_204255) do
-
+ActiveRecord::Schema[7.1].define(version: 2024_11_09_182020) do
   # These are extensions that must be enabled in order to support this database
   enable_extension "plpgsql"
 
@@ -19,26 +18,58 @@ ActiveRecord::Schema.define(version: 2022_10_18_204255) do
     t.integer "author_id", null: false
     t.string "full_name", null: false
     t.text "bio"
-    t.datetime "deleted_at"
-    t.datetime "created_at", null: false
-    t.datetime "updated_at", null: false
-    t.datetime "history_started_at", null: false
-    t.datetime "history_ended_at"
+    t.datetime "deleted_at", precision: nil
+    t.datetime "created_at", precision: nil, null: false
+    t.datetime "updated_at", precision: nil, null: false
+    t.datetime "history_started_at", precision: nil, null: false
+    t.datetime "history_ended_at", precision: nil
     t.integer "history_user_id"
+    t.string "snapshot_id"
     t.index ["author_id"], name: "index_author_histories_on_author_id"
     t.index ["deleted_at"], name: "index_author_histories_on_deleted_at"
     t.index ["history_ended_at"], name: "index_author_histories_on_history_ended_at"
     t.index ["history_started_at"], name: "index_author_histories_on_history_started_at"
     t.index ["history_user_id"], name: "index_author_histories_on_history_user_id"
+    t.index ["snapshot_id"], name: "index_author_histories_on_snapshot_id"
   end
 
   create_table "authors", force: :cascade do |t|
     t.string "full_name", null: false
     t.text "bio"
-    t.datetime "deleted_at"
+    t.datetime "deleted_at", precision: nil
+    t.datetime "created_at", precision: nil, null: false
+    t.datetime "updated_at", precision: nil, null: false
+    t.index ["deleted_at"], name: "index_authors_on_deleted_at"
+  end
+
+  create_table "comment_histories", force: :cascade do |t|
+    t.integer "comment_id", null: false
+    t.integer "post_id"
+    t.integer "author_id"
+    t.text "body"
     t.datetime "created_at", null: false
     t.datetime "updated_at", null: false
-    t.index ["deleted_at"], name: "index_authors_on_deleted_at"
+    t.datetime "history_started_at", null: false
+    t.datetime "history_ended_at"
+    t.integer "history_user_id"
+    t.string "snapshot_id"
+    t.index ["author_id"], name: "index_comment_histories_on_author_id"
+    t.index ["comment_id"], name: "index_comment_histories_on_comment_id"
+    t.index ["history_ended_at"], name: "index_comment_histories_on_history_ended_at"
+    t.index ["history_started_at"], name: "index_comment_histories_on_history_started_at"
+    t.index ["history_user_id"], name: "index_comment_histories_on_history_user_id"
+    t.index ["post_id"], name: "index_comment_histories_on_post_id"
+    t.index ["snapshot_id"], name: "index_comment_histories_on_snapshot_id"
+  end
+
+  create_table "comments", force: :cascade do |t|
+    t.bigint "post_id"
+    t.bigint "author_id"
+    t.text "body"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["author_id"], name: "index_comments_on_author_id"
+    t.index ["post_id"], name: "index_comments_on_post_id"
   end
 
   create_table "post_histories", force: :cascade do |t|
@@ -47,13 +78,14 @@ ActiveRecord::Schema.define(version: 2022_10_18_204255) do
     t.text "body", null: false
     t.integer "author_id", null: false
     t.boolean "enabled", default: false
-    t.datetime "live_at"
-    t.datetime "deleted_at"
-    t.datetime "created_at", null: false
-    t.datetime "updated_at", null: false
-    t.datetime "history_started_at", null: false
-    t.datetime "history_ended_at"
+    t.datetime "live_at", precision: nil
+    t.datetime "deleted_at", precision: nil
+    t.datetime "created_at", precision: nil, null: false
+    t.datetime "updated_at", precision: nil, null: false
+    t.datetime "history_started_at", precision: nil, null: false
+    t.datetime "history_ended_at", precision: nil
     t.integer "history_user_id"
+    t.string "snapshot_id"
     t.index ["author_id"], name: "index_post_histories_on_author_id"
     t.index ["deleted_at"], name: "index_post_histories_on_deleted_at"
     t.index ["enabled"], name: "index_post_histories_on_enabled"
@@ -62,6 +94,7 @@ ActiveRecord::Schema.define(version: 2022_10_18_204255) do
     t.index ["history_user_id"], name: "index_post_histories_on_history_user_id"
     t.index ["live_at"], name: "index_post_histories_on_live_at"
     t.index ["post_id"], name: "index_post_histories_on_post_id"
+    t.index ["snapshot_id"], name: "index_post_histories_on_snapshot_id"
   end
 
   create_table "posts", force: :cascade do |t|
@@ -69,10 +102,10 @@ ActiveRecord::Schema.define(version: 2022_10_18_204255) do
     t.text "body", null: false
     t.integer "author_id", null: false
     t.boolean "enabled", default: false
-    t.datetime "live_at"
-    t.datetime "deleted_at"
-    t.datetime "created_at", null: false
-    t.datetime "updated_at", null: false
+    t.datetime "live_at", precision: nil
+    t.datetime "deleted_at", precision: nil
+    t.datetime "created_at", precision: nil, null: false
+    t.datetime "updated_at", precision: nil, null: false
     t.index ["author_id"], name: "index_posts_on_author_id"
     t.index ["deleted_at"], name: "index_posts_on_deleted_at"
     t.index ["enabled"], name: "index_posts_on_enabled"
@@ -85,13 +118,14 @@ ActiveRecord::Schema.define(version: 2022_10_18_204255) do
     t.text "body", null: false
     t.integer "author_id", null: false
     t.boolean "enabled", default: false
-    t.datetime "live_at"
-    t.datetime "deleted_at"
-    t.datetime "created_at", null: false
-    t.datetime "updated_at", null: false
-    t.datetime "history_started_at", null: false
-    t.datetime "history_ended_at"
+    t.datetime "live_at", precision: nil
+    t.datetime "deleted_at", precision: nil
+    t.datetime "created_at", precision: nil, null: false
+    t.datetime "updated_at", precision: nil, null: false
+    t.datetime "history_started_at", precision: nil, null: false
+    t.datetime "history_ended_at", precision: nil
     t.integer "history_user_id"
+    t.string "snapshot_id"
     t.index ["author_id"], name: "index_safe_post_histories_on_author_id"
     t.index ["deleted_at"], name: "index_safe_post_histories_on_deleted_at"
     t.index ["enabled"], name: "index_safe_post_histories_on_enabled"
@@ -100,6 +134,7 @@ ActiveRecord::Schema.define(version: 2022_10_18_204255) do
     t.index ["history_user_id"], name: "index_safe_post_histories_on_history_user_id"
     t.index ["live_at"], name: "index_safe_post_histories_on_live_at"
     t.index ["safe_post_id"], name: "index_safe_post_histories_on_safe_post_id"
+    t.index ["snapshot_id"], name: "index_safe_post_histories_on_snapshot_id"
   end
 
   create_table "safe_posts", force: :cascade do |t|
@@ -107,10 +142,10 @@ ActiveRecord::Schema.define(version: 2022_10_18_204255) do
     t.text "body", null: false
     t.integer "author_id", null: false
     t.boolean "enabled", default: false
-    t.datetime "live_at"
-    t.datetime "deleted_at"
-    t.datetime "created_at", null: false
-    t.datetime "updated_at", null: false
+    t.datetime "live_at", precision: nil
+    t.datetime "deleted_at", precision: nil
+    t.datetime "created_at", precision: nil, null: false
+    t.datetime "updated_at", precision: nil, null: false
     t.index ["author_id"], name: "index_safe_posts_on_author_id"
     t.index ["deleted_at"], name: "index_safe_posts_on_deleted_at"
     t.index ["enabled"], name: "index_safe_posts_on_enabled"
@@ -123,13 +158,14 @@ ActiveRecord::Schema.define(version: 2022_10_18_204255) do
     t.text "body", null: false
     t.integer "author_id", null: false
     t.boolean "enabled", default: false
-    t.datetime "live_at"
-    t.datetime "deleted_at"
-    t.datetime "created_at", null: false
-    t.datetime "updated_at", null: false
-    t.datetime "history_started_at", null: false
-    t.datetime "history_ended_at"
+    t.datetime "live_at", precision: nil
+    t.datetime "deleted_at", precision: nil
+    t.datetime "created_at", precision: nil, null: false
+    t.datetime "updated_at", precision: nil, null: false
+    t.datetime "history_started_at", precision: nil, null: false
+    t.datetime "history_ended_at", precision: nil
     t.integer "history_user_id"
+    t.string "snapshot_id"
     t.index ["author_id"], name: "index_silent_post_histories_on_author_id"
     t.index ["deleted_at"], name: "index_silent_post_histories_on_deleted_at"
     t.index ["enabled"], name: "index_silent_post_histories_on_enabled"
@@ -138,6 +174,7 @@ ActiveRecord::Schema.define(version: 2022_10_18_204255) do
     t.index ["history_user_id"], name: "index_silent_post_histories_on_history_user_id"
     t.index ["live_at"], name: "index_silent_post_histories_on_live_at"
     t.index ["silent_post_id"], name: "index_silent_post_histories_on_silent_post_id"
+    t.index ["snapshot_id"], name: "index_silent_post_histories_on_snapshot_id"
   end
 
   create_table "silent_posts", force: :cascade do |t|
@@ -145,10 +182,10 @@ ActiveRecord::Schema.define(version: 2022_10_18_204255) do
     t.text "body", null: false
     t.integer "author_id", null: false
     t.boolean "enabled", default: false
-    t.datetime "live_at"
-    t.datetime "deleted_at"
-    t.datetime "created_at", null: false
-    t.datetime "updated_at", null: false
+    t.datetime "live_at", precision: nil
+    t.datetime "deleted_at", precision: nil
+    t.datetime "created_at", precision: nil, null: false
+    t.datetime "updated_at", precision: nil, null: false
     t.index ["author_id"], name: "index_silent_posts_on_author_id"
     t.index ["deleted_at"], name: "index_silent_posts_on_deleted_at"
     t.index ["enabled"], name: "index_silent_posts_on_enabled"
@@ -159,13 +196,15 @@ ActiveRecord::Schema.define(version: 2022_10_18_204255) do
     t.integer "thing_with_compound_index_id", null: false
     t.string "key"
     t.string "value"
-    t.datetime "history_started_at", null: false
-    t.datetime "history_ended_at"
+    t.datetime "history_started_at", precision: nil, null: false
+    t.datetime "history_ended_at", precision: nil
     t.integer "history_user_id"
+    t.string "snapshot_id"
     t.index ["history_ended_at"], name: "index_thing_with_compound_index_histories_on_history_ended_at"
     t.index ["history_started_at"], name: "index_thing_with_compound_index_histories_on_history_started_at"
     t.index ["history_user_id"], name: "index_thing_with_compound_index_histories_on_history_user_id"
     t.index ["key", "value"], name: "idx_history_k_v"
+    t.index ["snapshot_id"], name: "index_thing_with_compound_index_histories_on_snapshot_id"
     t.index ["thing_with_compound_index_id"], name: "idx_k_v_histories"
   end
 

data/Users/brettshollenberger/programming/historiographer/spec/examples.txt

@@ -0,0 +1,40 @@
+example_id                                | status | run_time        |
+----------------------------------------- | ------ | --------------- |
+./spec/historiographer_spec.rb[1:1:1]     | passed | 0.03206 seconds |
+./spec/historiographer_spec.rb[1:1:2]     | passed | 0.03548 seconds |
+./spec/historiographer_spec.rb[1:1:3]     | passed | 0.0394 seconds  |
+./spec/historiographer_spec.rb[1:2:1]     | passed | 0.04024 seconds |
+./spec/historiographer_spec.rb[1:2:2]     | passed | 0.03537 seconds |
+./spec/historiographer_spec.rb[1:2:3:1:1] | passed | 0.05859 seconds |
+./spec/historiographer_spec.rb[1:2:3:1:2] | passed | 0.04457 seconds |
+./spec/historiographer_spec.rb[1:2:3:2:1] | passed | 0.04026 seconds |
+./spec/historiographer_spec.rb[1:2:3:2:2] | passed | 0.04242 seconds |
+./spec/historiographer_spec.rb[1:2:3:2:3] | passed | 0.03368 seconds |
+./spec/historiographer_spec.rb[1:2:3:3:1] | passed | 0.05167 seconds |
+./spec/historiographer_spec.rb[1:2:3:3:2] | passed | 0.04029 seconds |
+./spec/historiographer_spec.rb[1:2:4:1]   | passed | 0.04736 seconds |
+./spec/historiographer_spec.rb[1:2:4:2]   | passed | 0.03779 seconds |
+./spec/historiographer_spec.rb[1:2:4:3]   | passed | 0.03484 seconds |
+./spec/historiographer_spec.rb[1:2:5:1]   | passed | 0.04458 seconds |
+./spec/historiographer_spec.rb[1:2:5:2]   | passed | 0.03644 seconds |
+./spec/historiographer_spec.rb[1:2:5:3]   | passed | 0.03426 seconds |
+./spec/historiographer_spec.rb[1:2:6]     | passed | 0.03251 seconds |
+./spec/historiographer_spec.rb[1:2:7]     | passed | 0.04135 seconds |
+./spec/historiographer_spec.rb[1:2:8]     | passed | 0.03819 seconds |
+./spec/historiographer_spec.rb[1:3:1]     | passed | 0.03542 seconds |
+./spec/historiographer_spec.rb[1:4:1]     | passed | 0.03833 seconds |
+./spec/historiographer_spec.rb[1:5:1]     | passed | 0.03372 seconds |
+./spec/historiographer_spec.rb[1:5:2]     | passed | 0.05387 seconds |
+./spec/historiographer_spec.rb[1:6:1]     | passed | 0.0377 seconds  |
+./spec/historiographer_spec.rb[1:6:2]     | passed | 0.03973 seconds |
+./spec/historiographer_spec.rb[1:7:1]     | passed | 0.03895 seconds |
+./spec/historiographer_spec.rb[1:8:1]     | passed | 0.03733 seconds |
+./spec/historiographer_spec.rb[1:9:1]     | passed | 0.0322 seconds  |
+./spec/historiographer_spec.rb[1:10:1]    | passed | 0.03434 seconds |
+./spec/historiographer_spec.rb[1:10:2]    | passed | 0.0363 seconds  |
+./spec/historiographer_spec.rb[1:10:3]    | passed | 0.03492 seconds |
+./spec/historiographer_spec.rb[1:10:4]    | passed | 0.03702 seconds |
+./spec/historiographer_spec.rb[1:11:1]    | passed | 0.05087 seconds |
+./spec/historiographer_spec.rb[1:11:2]    | passed | 0.06332 seconds |
+./spec/historiographer_spec.rb[1:11:3]    | passed | 0.06558 seconds |
+./spec/historiographer_spec.rb[1:12:1]    | passed | 0.15112 seconds |