hoardable 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c41a6c69f62f7e2a99fefe00229a7244f5cd0dcb9ed3b0d243db9adf9cabd98
-  data.tar.gz: 30dc9d7a551c29331a7736f7b825c0b5f9db83bf5c5cd537d5d2910908f683ff
+  metadata.gz: 888659d9c6655e69c72fd8cf5b10b3697d5a81f432a44c8fa39984a05f4b23d9
+  data.tar.gz: ba850c1bf2363dd965a6e7780435d4feaf2ad417f2712f5f4635398ad5e9913d
 SHA512:
-  metadata.gz: ad46ae05e3241052089aaf432016b906f648051fae6405e2ce4a90c7f247942a09a011d2fc35e6558695814949ef37a0398d36baaa71500f2c31d33436a7eac7
-  data.tar.gz: b3307392cdff1b14a37192cd1a004099c5d99d7dd0ce3d0f8fe230c1dac4b59697c4708f5859cb7b2b831f45f1a3a6489cdce2eaf464fef2d9e135bd902e4f26
+  metadata.gz: 851d039e113df11834b18bb69edf786ba1d91598e408a45fab6ae7bb65efbc37264e4b803b8c8335f6839784f964f20d29c4c94b02aa6b994a21f3fd346ec162
+  data.tar.gz: 022a7ada38d996f8116a7ab8ed3d671e29055a8c75cc4155789ea3be135d87f24625ab67311c22f3b89b172320a973cbf203586407c6788750443bec90b461be

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.17.0
+
+- Much improved performance of setting `hoardable_id` for versions.
+
 ## 0.16.0
 
 - Rails 8 support introduced

data/README.md

@@ -235,6 +235,21 @@ version.changes # => { "title"=> ["Title", "New Title"] }
 version.hoardable_operation # => "update"
 ```
 
+### Overriding the temporal range
+
+When calculating the temporal range for a given version, the default upper bound is `Time.now.utc`.
+
+You can, however, use the `Hoardable.travel_to` class method to specify a custom upper bound for the time range. This allows
+you to specify the datetime that a particular change should be recorded at by passing a block:
+
+```ruby
+Hoardable.travel_to(2.weeks.ago) do
+  post.destroy!
+end
+```
+
+Note: If the provided datetime pre-dates the calculated lower bound then an `InvalidTemporalUpperBoundError` will be raised.
+
 ### Model Callbacks
 
 Sometimes you might want to do something with a version after it gets inserted to the database. You

data/lib/generators/hoardable/functions/set_hoardable_id.sql

@@ -0,0 +1,7 @@
+CREATE OR REPLACE FUNCTION <%= function_name %>() RETURNS trigger
+  LANGUAGE plpgsql AS
+$$
+BEGIN
+  NEW.hoardable_id = NEW.<%= primary_key %>;
+  RETURN NEW;
+END;$$;

data/lib/generators/hoardable/install_generator.rb

@@ -25,7 +25,7 @@ module Hoardable
 
     def create_functions
       Dir
-        .glob(File.join(__dir__, "functions", "*.sql"))
+        .glob(File.join(__dir__, "install_functions", "*.sql"))
         .each do |file_path|
           file_name = file_path.match(%r{([^/]+)\.sql})[1]
           template file_path, "db/functions/#{file_name}_v01.sql"

data/lib/generators/hoardable/migration_generator.rb

@@ -36,7 +36,15 @@ module Hoardable
       end
     end
 
+    def create_function
+      template("../functions/set_hoardable_id.sql", "db/functions/#{function_name}_v01.sql")
+    end
+
     no_tasks do
+      def function_name
+        "hoardable_set_hoardable_id_from_#{primary_key}"
+      end
+
       def table_name
         class_name.singularize.constantize.table_name
       rescue StandardError

data/lib/generators/hoardable/templates/install.rb.erb

@@ -4,7 +4,6 @@ class InstallHoardable < ActiveRecord::Migration[<%= ActiveRecord::Migration.cur
   def change
     <% if postgres_version < 13 %>enable_extension :pgcrypto
     <% end %>create_function :hoardable_prevent_update_id
-    create_function :hoardable_source_set_id
     create_function :hoardable_version_prevent_update
     create_enum :hoardable_operation, %w[update delete insert]
   end

data/lib/generators/hoardable/templates/migration.rb.erb

@@ -6,7 +6,7 @@ class Create<%= class_name.singularize.delete(':') %>Versions < ActiveRecord::Mi
     add_index :<%= table_name %>, :hoardable_id
     create_table(
       :<%= singularized_table_name %>_versions,
-      id: false, 
+      id: false,
       options: 'INHERITS (<%= table_name %>)',
     ) do |t|
       t.jsonb :_data
@@ -25,6 +25,7 @@ class Create<%= class_name.singularize.delete(':') %>Versions < ActiveRecord::Mi
       :<%= singularized_table_name %>_versions_prevent_update,
       on: :<%= singularized_table_name %>_versions
     )
+    create_function :<%= function_name %>
     create_trigger :<%= table_name %>_set_hoardable_id, on: :<%= table_name %>
     create_trigger :<%= table_name %>_prevent_update_hoardable_id, on: :<%= table_name %>
     change_column_null :<%= table_name %>, :hoardable_id, false

data/lib/generators/hoardable/triggers/set_hoardable_id.sql

@@ -1,3 +1,3 @@
 CREATE TRIGGER <%= table_name %>_set_hoardable_id
   BEFORE INSERT ON <%= table_name %> FOR EACH ROW
-  EXECUTE PROCEDURE hoardable_source_set_id();
+  EXECUTE PROCEDURE <%= function_name %>();

data/lib/hoardable/database_client.rb

@@ -93,7 +93,14 @@ module Hoardable
     end
 
     def initialize_temporal_range
-      ((previous_temporal_tsrange_end || hoardable_source_epoch)..Time.now.utc)
+      upper_bound = Hoardable.instance_variable_get("@travel_to") || Time.now.utc
+      lower_bound = (previous_temporal_tsrange_end || hoardable_source_epoch)
+
+      if upper_bound < lower_bound
+        raise InvalidTemporalUpperBoundError.new(upper_bound, lower_bound)
+      end
+
+      (lower_bound..upper_bound)
     end
 
     def initialize_hoardable_data

data/lib/hoardable/engine.rb

@@ -81,6 +81,16 @@ module Hoardable
       @at = nil
     end
 
+    # Allows calling code to set the upper bound for the temporal range for recorded audits.
+    #
+    # @param datetime [DateTime] the datetime to temporally record versions at
+    def travel_to(datetime)
+      @travel_to = datetime
+      yield
+    ensure
+      @travel_to = nil
+    end
+
     # @!visibility private
     def logger
       @logger ||= ActiveSupport::TaggedLogging.new(Logger.new($stdout))
@@ -101,7 +111,7 @@ module Hoardable
     initializer "hoardable.schema_statements" do
       ActiveSupport.on_load(:active_record_postgresqladapter) do
         # We need to control the table dumping order of tables, so revert these to just +super+
-        Fx::SchemaDumper::Trigger.module_eval("def tables(streams); super; end")
+        Fx::SchemaDumper.module_eval("def tables(streams); super; end")
 
         ActiveRecord::ConnectionAdapters::PostgreSQL::SchemaDumper.prepend(SchemaDumper)
         ActiveRecord::ConnectionAdapters::PostgreSQL::SchemaStatements.prepend(SchemaStatements)

data/lib/hoardable/error.rb

@@ -24,4 +24,14 @@ module Hoardable
         LOG
     end
   end
+
+  # An error to be raised when the provided temporal upper bound is before the calcualated lower bound.
+  class InvalidTemporalUpperBoundError < Error
+    def initialize(upper, lower)
+      super(<<~LOG)
+          'The supplied value to `Hoardable.travel_to` (#{upper}) is before the calculated lower bound (#{lower}).
+          You must provide a datetime > the lower bound.
+        LOG
+    end
+  end
 end

data/lib/hoardable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Hoardable
-  VERSION = "0.16.0"
+  VERSION = "0.17.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hoardable
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - justin talbott
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-11 00:00:00.000000000 Z
+date: 2024-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -58,7 +58,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.9'
     - - "<"
       - !ruby/object:Gem::Version
         version: '1'
@@ -68,7 +68,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.9'
     - - "<"
       - !ruby/object:Gem::Version
         version: '1'
@@ -106,9 +106,9 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/generators/hoardable/functions/hoardable_prevent_update_id.sql
-- lib/generators/hoardable/functions/hoardable_source_set_id.sql
-- lib/generators/hoardable/functions/hoardable_version_prevent_update.sql
+- lib/generators/hoardable/functions/set_hoardable_id.sql
+- lib/generators/hoardable/install_functions/hoardable_prevent_update_id.sql
+- lib/generators/hoardable/install_functions/hoardable_version_prevent_update.sql
 - lib/generators/hoardable/install_generator.rb
 - lib/generators/hoardable/migration_generator.rb
 - lib/generators/hoardable/templates/install.rb.erb

data/lib/generators/hoardable/functions/hoardable_source_set_id.sql

@@ -1,18 +0,0 @@
-CREATE OR REPLACE FUNCTION hoardable_source_set_id() RETURNS trigger
-  LANGUAGE plpgsql AS
-$$
-DECLARE
-  _pk information_schema.constraint_column_usage.column_name%TYPE;
-  _id _pk%TYPE;
-BEGIN
-  SELECT c.column_name
-    FROM information_schema.table_constraints t
-    JOIN information_schema.constraint_column_usage c
-    ON c.constraint_name = t.constraint_name
-    WHERE c.table_name = TG_TABLE_NAME AND t.constraint_type = 'PRIMARY KEY'
-    LIMIT 1
-    INTO _pk;
-  EXECUTE format('SELECT $1.%I', _pk) INTO _id USING NEW;
-  NEW.hoardable_id = _id;
-  RETURN NEW;
-END;$$;