historiographer 4.4.3 → 4.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e539c6a610a6dd526ea49199d9d8f773dc8528c5e50960b3fc40615d87d81ffb
-  data.tar.gz: cc44f3a4a98e65763b27b869a36e4b8997e4bd9e3b1f988ee07a267b0b346dd3
+  metadata.gz: 99a33a798a97f440f2d4c0d2d1973303a013e99bb5f8d3f566c51a0d9375961f
+  data.tar.gz: 56b51522b7f4b254b9ba1e4e1813aa449dec80579e9e79c8e4f446e629ce74c7
 SHA512:
-  metadata.gz: fb5d80e2d90f8c5dc2172b1a81f75b646750c3eff34c2921fa3a454d7905d05e59420c86c0b24d08eec96ace5f067e1b91e30c0d944675a84a2c5f2ad63e0fb8
-  data.tar.gz: 2fedc59aa4c1fcb684e43f18a03a686ffdf4137fcef83e086583d064491a9cb16b7b17ca46f4893b1a3d83cdc4bc6a3977de4ae534454895fa0a53e0b7bdcf2d
+  metadata.gz: d27ffa3d2aaca0a91d9283c5f18701e7c576475d2619c569dd7edc21cdc8983c3376e823067ffb233a1f14ec4123823564b486c906da6b7860c285eb555ecc67
+  data.tar.gz: 7b1608e2c572ab02da5e2371679fe5facc463ac4d788e1e9e499a2078be074e3345758e9a9aed97931ade4c15f59fd220d2f8957e7d7101f44290217647a9ac2

data/README.md

@@ -12,7 +12,7 @@ The Audited gem has some serious flaws.
 
 2. It doesn't provide the indexes you need from your primary tables
 
-3. It doesn't provdie out-of-the-box snapshots
+3. It doesn't provide out-of-the-box snapshots
 
 ## How does Historiographer solve these problems?
 
@@ -86,14 +86,17 @@ You can take a snapshot of a record and all its associated records:
 
 ```ruby
 post = Post.find(1)
-post.snapshot(history_user_id: current_user.id)
+post.snapshot
 ```
 
 This will:
 
 1. Create a history record for the post
-2. Create history records for all associated records (comments, author, etc.)
+2. Recursively create history records for all associated records that also include Historiographer (comments, author, etc.)
 3. Link these history records together with a shared `snapshot_id`
+4. Skip any view-backed models (models without a primary key)
+
+**Note:** The snapshot cascades to ALL associations where the associated model includes Historiographer. There is currently no built-in way to limit which associations get snapshotted. If you need finer control, you can either not include Historiographer on models you don't want snapshotted, or override the `snapshot` method.
 
 You can retrieve the latest snapshot using:
 
@@ -130,6 +133,38 @@ This can be useful when:
 - You're versioning training data for machine learning models
 - You need to maintain immutable audit trails at specific checkpoints
 
+## Safe and Silent Modes
+
+Historiographer provides two additional modes for migrating existing models:
+
+### Historiographer::Safe
+
+Use `Historiographer::Safe` when migrating an existing model to Historiographer. Instead of raising an error when `history_user_id` is missing, it logs to Rollbar, allowing you to find all locations that need to be updated:
+
+```ruby
+class Post < ActiveRecord::Base
+  include Historiographer::Safe
+end
+
+# This will create a history record and log to Rollbar (instead of raising an error)
+Post.create(title: "My Post")
+```
+
+### Historiographer::Silent
+
+Use `Historiographer::Silent` when you want to allow missing `history_user_id` without any errors or logging:
+
+```ruby
+class Post < ActiveRecord::Base
+  include Historiographer::Silent
+end
+
+# This will create a history record silently without history_user_id
+Post.create(title: "My Post")
+```
+
+**Note:** Both Safe and Silent modes are intended for migration purposes, not as long-term solutions.
+
 ## Namespaced Models
 
 When using namespaced models, Rails handles foreign key naming differently than with non-namespaced models. For example, if you have a model namespaced like this:
@@ -296,6 +331,7 @@ You should also make a `PostHistory` class if you're going to query `PostHistory
 ```ruby
 class PostHistory < ActiveRecord::Base
   self.table_name = "post_histories"
+  include Historiographer::History
 end
 ```
 
@@ -323,6 +359,21 @@ Post.last.destroy!(history_user_id: current_user.id)
 Post.destroy_all(history_user_id: current_user.id)
 ```
 
+### Skipping History
+
+If you need to save a record without creating a history entry:
+
+```ruby
+post = Post.new(title: "My Post")
+post.save_without_history    # No history_user_id required
+post.save_without_history!   # Bang version
+
+# For bulk operations:
+Post.all.update_all_without_history(title: "New Title")
+Post.all.delete_all_without_history
+Post.all.destroy_all_without_history
+```
+
 The `histories` classes have a `current` method, which only finds current history records. These records will also be the same as the data in the primary table.
 
 ```ruby

data/Rakefile

@@ -22,6 +22,20 @@ Jeweler::Tasks.new do |gem|
   gem.description = %Q{Creates separate tables for each history table}
   gem.email = "brett.shollenberger@gmail.com"
   gem.authors = ["brettshollenberger"]
+  
+  # Use glob patterns to automatically include all relevant files
+  gem.files = `git ls-files`.split("\n").reject { |f| 
+    f.match(/^(test|spec|features)\//) || 
+    f.match(/\.gem$/) ||
+    f.match(/^\./) ||
+    f == 'Gemfile.lock'
+  }
+  
+  # Include spec files for development/testing
+  gem.files += Dir.glob("spec/**/*")
+  
+  # Ensure we have all the executables
+  gem.executables = Dir.glob("bin/*").map { |f| File.basename(f) }
 end
 Jeweler::RubygemsDotOrgTasks.new
 

data/VERSION

@@ -1 +1 @@
-4.4.3
+4.4.5

data/historiographer.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: historiographer 4.4.3 ruby lib
+# stub: historiographer 4.4.5 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "historiographer".freeze
-  s.version = "4.4.3"
+  s.version = "4.4.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["brettshollenberger".freeze]
-  s.date = "2025-08-22"
+  s.date = "2026-01-14"
   s.description = "Creates separate tables for each history table".freeze
   s.email = "brett.shollenberger@gmail.com".freeze
   s.executables = ["console".freeze, "setup".freeze, "test".freeze, "test-all".freeze, "test-rails".freeze]
@@ -20,13 +20,8 @@ Gem::Specification.new do |s|
     "README.md"
   ]
   s.files = [
-    ".document",
-    ".rspec",
-    ".ruby-version",
-    ".standalone_migrations",
     "DEVELOPMENT.md",
     "Gemfile",
-    "Gemfile.lock",
     "Guardfile",
     "LICENSE.txt",
     "README.md",
@@ -37,10 +32,6 @@ Gem::Specification.new do |s|
     "bin/test",
     "bin/test-all",
     "bin/test-rails",
-    "historiographer-4.1.12.gem",
-    "historiographer-4.1.13.gem",
-    "historiographer-4.1.14.gem",
-    "historiographer-4.3.0.gem",
     "historiographer.gemspec",
     "init.rb",
     "instructions/implementation.md",
@@ -83,7 +74,17 @@ Gem::Specification.new do |s|
     "spec/db/migrate/20250826000001_create_test_user_histories.rb",
     "spec/db/migrate/20250826000002_create_test_websites.rb",
     "spec/db/migrate/20250826000003_create_test_website_histories.rb",
+    "spec/db/migrate/20250827000000_create_templates.rb",
+    "spec/db/migrate/20250827000001_create_template_histories.rb",
+    "spec/db/migrate/20250827000002_create_websites.rb",
+    "spec/db/migrate/20250827000003_create_website_histories.rb",
+    "spec/db/migrate/20250827000004_create_template_files.rb",
+    "spec/db/migrate/20250827000005_create_template_file_histories.rb",
+    "spec/db/migrate/20250827000006_create_website_files.rb",
+    "spec/db/migrate/20250827000007_create_website_file_histories.rb",
+    "spec/db/migrate/20250827000008_create_code_files_view.rb",
     "spec/db/schema.rb",
+    "spec/examples.txt",
     "spec/factories/post.rb",
     "spec/historiographer_spec.rb",
     "spec/integration/historiographer_safe_integration_spec.rb",
@@ -95,10 +96,13 @@ Gem::Specification.new do |s|
     "spec/internal/config/database.yml",
     "spec/internal/config/routes.rb",
     "spec/internal/db/schema.rb",
+    "spec/internal/log/development.log",
+    "spec/internal/log/test.log",
     "spec/models/application_record.rb",
     "spec/models/author.rb",
     "spec/models/author_history.rb",
     "spec/models/byline.rb",
+    "spec/models/code_file.rb",
     "spec/models/comment.rb",
     "spec/models/comment_history.rb",
     "spec/models/easy_ml/column.rb",
@@ -113,6 +117,10 @@ Gem::Specification.new do |s|
     "spec/models/safe_post_history.rb",
     "spec/models/silent_post.rb",
     "spec/models/silent_post_history.rb",
+    "spec/models/template.rb",
+    "spec/models/template_file.rb",
+    "spec/models/template_file_history.rb",
+    "spec/models/template_history.rb",
     "spec/models/test_article.rb",
     "spec/models/test_article_history.rb",
     "spec/models/test_category.rb",
@@ -125,8 +133,13 @@ Gem::Specification.new do |s|
     "spec/models/thing_with_compound_index_history.rb",
     "spec/models/thing_without_history.rb",
     "spec/models/user.rb",
+    "spec/models/website.rb",
+    "spec/models/website_file.rb",
+    "spec/models/website_file_history.rb",
+    "spec/models/website_history.rb",
     "spec/rails_integration/historiographer_rails_integration_spec.rb",
-    "spec/spec_helper.rb"
+    "spec/spec_helper.rb",
+    "spec/view_backed_model_spec.rb"
   ]
   s.homepage = "http://github.com/brettshollenberger/historiographer".freeze
   s.licenses = ["MIT".freeze]

data/lib/historiographer/history.rb

@@ -109,8 +109,11 @@ module Historiographer
       #
       # Set up user association unless Silent module is included
       # Defer this check until foreign_class is available
+      # Use optional: true because history_user_id validation is handled separately
+      # by Historiographer's validate_history_user_id_present method, and we need
+      # to allow updates without a user when using without_history_user_id blocks
       unless base.foreign_class && base.foreign_class.ancestors.include?(Historiographer::Silent)
-        belongs_to :user, foreign_key: :history_user_id
+        belongs_to :user, foreign_key: :history_user_id, optional: true
       end
 
       # Add method_added hook to the original class when it's available

data/lib/historiographer.rb

@@ -188,7 +188,7 @@ module Historiographer
     rescue NameError
       # Get the base table name without _histories suffix
       base_table = base.table_name.singularize.sub(/_histories$/, '')
-      
+
       history_class_initializer = Class.new(ActiveRecord::Base) do
         self.table_name = "#{base_table}_histories"
       end
@@ -204,7 +204,7 @@ module Historiographer
 
       # Set the constant in the correct module
       history_class = target_module.const_set(final_class_name, history_class_initializer)
-      
+
       # Now that the class is named, include the History module and extend class methods
       history_class.send(:include, Historiographer::History)
     end
@@ -279,7 +279,7 @@ module Historiographer
       save!(*args, &block)
       @no_history = false
     end
-    
+
     def snapshot(tree = {}, snapshot_id = nil)
       return if is_history_class?
 
@@ -296,7 +296,7 @@ module Historiographer
         null_snapshot = history_class.where(foreign_key => attrs[primary_key], snapshot_id: nil).first
         snapshot = nil
         if null_snapshot.present?
-          null_snapshot.update(snapshot_id: snapshot_id)
+          null_snapshot.update!(snapshot_id: snapshot_id)
           snapshot = null_snapshot
         else
           snapshot = record_history(snapshot_id: snapshot_id)
@@ -304,6 +304,11 @@ module Historiographer
 
         # Recursively snapshot associations, avoiding infinite loops
         self.class.reflect_on_all_associations.each do |association|
+          # Skip associations to models without primary keys (e.g., database views)
+          association_class = association.klass rescue nil
+          next if association_class.nil?
+          next if association_class.primary_key.nil?
+
           associated_records = send(association.name)&.reload
           if associated_records.respond_to?(:order)
             associated_records = associated_records.order(id: :asc)
@@ -378,7 +383,7 @@ module Historiographer
 
       if history_class.history_foreign_key.present? && history_class.present?
         result = history_class.insert_all([attrs])
-        
+
         # Check if the insertion was successful
         if result.rows.empty?
           # insert_all returned empty rows, likely due to a duplicate/conflict
@@ -388,7 +393,7 @@ module Historiographer
             foreign_key => attrs[foreign_key],
             history_started_at: attrs['history_started_at']
           ).first
-          
+
           if existing_history
             # A duplicate history already exists (race condition or retry)
             # This is acceptable - return the existing history
@@ -399,7 +404,7 @@ module Historiographer
             history_class.create!(attrs) # This will raise the correct error since it will fail the unique constraint
           end
         end
-        
+
         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?

data/spec/db/migrate/20250827000000_create_templates.rb

@@ -0,0 +1,9 @@
+class CreateTemplates < ActiveRecord::Migration[7.0]
+  def change
+    create_table :templates do |t|
+      t.string :name, null: false
+      t.text :description
+      t.timestamps
+    end
+  end
+end

data/spec/db/migrate/20250827000001_create_template_histories.rb

@@ -0,0 +1,9 @@
+require 'historiographer/history_migration'
+
+class CreateTemplateHistories < ActiveRecord::Migration[7.0]
+  def change
+    create_table :template_histories do |t|
+      t.histories
+    end
+  end
+end

data/spec/db/migrate/20250827000002_create_websites.rb

@@ -0,0 +1,9 @@
+class CreateWebsites < ActiveRecord::Migration[7.0]
+  def change
+    create_table :websites do |t|
+      t.string :domain, null: false
+      t.references :template, foreign_key: true
+      t.timestamps
+    end
+  end
+end

data/spec/db/migrate/20250827000003_create_website_histories.rb

@@ -0,0 +1,9 @@
+require 'historiographer/history_migration'
+
+class CreateWebsiteHistories < ActiveRecord::Migration[7.0]
+  def change
+    create_table :website_histories do |t|
+      t.histories
+    end
+  end
+end

data/spec/db/migrate/20250827000004_create_template_files.rb

@@ -0,0 +1,15 @@
+class CreateTemplateFiles < ActiveRecord::Migration[7.0]
+  def change
+    create_table :template_files do |t|
+      t.references :template, foreign_key: true, null: false
+      t.string :path, null: false
+      t.text :content
+      t.tsvector :content_tsv
+      t.string :shasum
+      t.integer :file_specification_id
+      t.timestamps
+    end
+
+    add_index :template_files, [:template_id, :path], unique: true
+  end
+end

data/spec/db/migrate/20250827000005_create_template_file_histories.rb

@@ -0,0 +1,9 @@
+require 'historiographer/history_migration'
+
+class CreateTemplateFileHistories < ActiveRecord::Migration[7.0]
+  def change
+    create_table :template_file_histories do |t|
+      t.histories
+    end
+  end
+end

data/spec/db/migrate/20250827000006_create_website_files.rb

@@ -0,0 +1,15 @@
+class CreateWebsiteFiles < ActiveRecord::Migration[7.0]
+  def change
+    create_table :website_files do |t|
+      t.references :website, foreign_key: true, null: false
+      t.string :path, null: false
+      t.text :content
+      t.tsvector :content_tsv
+      t.string :shasum
+      t.integer :file_specification_id
+      t.timestamps
+    end
+
+    add_index :website_files, [:website_id, :path], unique: true
+  end
+end

data/spec/db/migrate/20250827000007_create_website_file_histories.rb

@@ -0,0 +1,9 @@
+require 'historiographer/history_migration'
+
+class CreateWebsiteFileHistories < ActiveRecord::Migration[7.0]
+  def change
+    create_table :website_file_histories do |t|
+      t.histories
+    end
+  end
+end

data/spec/db/migrate/20250827000008_create_code_files_view.rb

@@ -0,0 +1,62 @@
+class CreateCodeFilesView < ActiveRecord::Migration[7.0]
+  def up
+    execute <<-SQL
+      CREATE OR REPLACE VIEW code_files AS
+      WITH merged_files AS (
+        -- Get all website files
+        SELECT 
+          wf.website_id,
+          wf.path,
+          wf.content,
+          wf.content_tsv,
+          wf.shasum,
+          wf.file_specification_id,
+          wf.created_at,
+          wf.updated_at,
+          'WebsiteFile' AS source_type,
+          wf.id AS source_id
+        FROM website_files wf
+        
+        UNION ALL
+        
+        -- Get template files that don't have a matching website file
+        SELECT 
+          w.id AS website_id,
+          tf.path,
+          tf.content,
+          tf.content_tsv,
+          tf.shasum,
+          tf.file_specification_id,
+          tf.created_at,
+          tf.updated_at,
+          'TemplateFile' AS source_type,
+          tf.id AS source_id
+        FROM template_files tf
+        INNER JOIN websites w ON w.template_id = tf.template_id
+        WHERE NOT EXISTS (
+          SELECT 1 
+          FROM website_files wf2 
+          WHERE wf2.website_id = w.id 
+            AND wf2.path = tf.path
+        )
+      )
+      SELECT 
+        website_id,
+        path,
+        content,
+        content_tsv,
+        shasum,
+        file_specification_id,
+        source_type,
+        source_id,
+        created_at,
+        updated_at
+      FROM merged_files
+      ORDER BY website_id, path;
+    SQL
+  end
+
+  def down
+    execute "DROP VIEW IF EXISTS code_files;"
+  end
+end

data/spec/db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema[7.1].define(version: 2025_08_26_000003) do
+ActiveRecord::Schema[7.1].define(version: 2025_08_27_000008) do
   # These are extensions that must be enabled in order to support this database
   enable_extension "plpgsql"
 
@@ -299,6 +299,66 @@ ActiveRecord::Schema[7.1].define(version: 2025_08_26_000003) do
     t.index ["live_at"], name: "index_silent_posts_on_live_at"
   end
 
+  create_table "template_file_histories", force: :cascade do |t|
+    t.integer "template_file_id", null: false
+    t.integer "template_id", null: false
+    t.string "path", null: false
+    t.text "content"
+    t.tsvector "content_tsv"
+    t.string "shasum"
+    t.integer "file_specification_id"
+    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.integer "history_user_id"
+    t.string "snapshot_id"
+    t.index ["history_ended_at"], name: "index_template_file_histories_on_history_ended_at"
+    t.index ["history_started_at"], name: "index_template_file_histories_on_history_started_at"
+    t.index ["history_user_id"], name: "index_template_file_histories_on_history_user_id"
+    t.index ["snapshot_id"], name: "index_template_file_histories_on_snapshot_id"
+    t.index ["template_file_id"], name: "index_template_file_histories_on_template_file_id"
+    t.index ["template_id", "path"], name: "index_template_file_histories_on_template_id_and_path"
+    t.index ["template_id"], name: "index_template_file_histories_on_template_id"
+  end
+
+  create_table "template_files", force: :cascade do |t|
+    t.bigint "template_id", null: false
+    t.string "path", null: false
+    t.text "content"
+    t.tsvector "content_tsv"
+    t.string "shasum"
+    t.integer "file_specification_id"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["template_id", "path"], name: "index_template_files_on_template_id_and_path", unique: true
+    t.index ["template_id"], name: "index_template_files_on_template_id"
+  end
+
+  create_table "template_histories", force: :cascade do |t|
+    t.integer "template_id", null: false
+    t.string "name", null: false
+    t.text "description"
+    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.integer "history_user_id"
+    t.string "snapshot_id"
+    t.index ["history_ended_at"], name: "index_template_histories_on_history_ended_at"
+    t.index ["history_started_at"], name: "index_template_histories_on_history_started_at"
+    t.index ["history_user_id"], name: "index_template_histories_on_history_user_id"
+    t.index ["snapshot_id"], name: "index_template_histories_on_snapshot_id"
+    t.index ["template_id"], name: "index_template_histories_on_template_id"
+  end
+
+  create_table "templates", force: :cascade do |t|
+    t.string "name", null: false
+    t.text "description"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+
   create_table "test_article_histories", force: :cascade do |t|
     t.integer "test_article_id", null: false
     t.string "title"
@@ -419,4 +479,69 @@ ActiveRecord::Schema[7.1].define(version: 2025_08_26_000003) do
     t.string "name"
   end
 
+  create_table "website_file_histories", force: :cascade do |t|
+    t.integer "website_file_id", null: false
+    t.integer "website_id", null: false
+    t.string "path", null: false
+    t.text "content"
+    t.tsvector "content_tsv"
+    t.string "shasum"
+    t.integer "file_specification_id"
+    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.integer "history_user_id"
+    t.string "snapshot_id"
+    t.index ["history_ended_at"], name: "index_website_file_histories_on_history_ended_at"
+    t.index ["history_started_at"], name: "index_website_file_histories_on_history_started_at"
+    t.index ["history_user_id"], name: "index_website_file_histories_on_history_user_id"
+    t.index ["snapshot_id"], name: "index_website_file_histories_on_snapshot_id"
+    t.index ["website_file_id"], name: "index_website_file_histories_on_website_file_id"
+    t.index ["website_id", "path"], name: "index_website_file_histories_on_website_id_and_path"
+    t.index ["website_id"], name: "index_website_file_histories_on_website_id"
+  end
+
+  create_table "website_files", force: :cascade do |t|
+    t.bigint "website_id", null: false
+    t.string "path", null: false
+    t.text "content"
+    t.tsvector "content_tsv"
+    t.string "shasum"
+    t.integer "file_specification_id"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["website_id", "path"], name: "index_website_files_on_website_id_and_path", unique: true
+    t.index ["website_id"], name: "index_website_files_on_website_id"
+  end
+
+  create_table "website_histories", force: :cascade do |t|
+    t.integer "website_id", null: false
+    t.string "domain", null: false
+    t.integer "template_id"
+    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.integer "history_user_id"
+    t.string "snapshot_id"
+    t.index ["history_ended_at"], name: "index_website_histories_on_history_ended_at"
+    t.index ["history_started_at"], name: "index_website_histories_on_history_started_at"
+    t.index ["history_user_id"], name: "index_website_histories_on_history_user_id"
+    t.index ["snapshot_id"], name: "index_website_histories_on_snapshot_id"
+    t.index ["template_id"], name: "index_website_histories_on_template_id"
+    t.index ["website_id"], name: "index_website_histories_on_website_id"
+  end
+
+  create_table "websites", force: :cascade do |t|
+    t.string "domain", null: false
+    t.bigint "template_id"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["template_id"], name: "index_websites_on_template_id"
+  end
+
+  add_foreign_key "template_files", "templates"
+  add_foreign_key "website_files", "websites"
+  add_foreign_key "websites", "templates"
 end