activerecord-temporal 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87a493283c2b5a1746266fdedb4978b7ad768be307b73b40b2aa404b460a198c
-  data.tar.gz: ea10fd65c8c61878d1a92ae098a558094e7090e4ae09692ac15c1bd61b94a406
+  metadata.gz: 230f188aed78df98d3121bf21436905bb21cb314b6626c7f741eaf40f250e43c
+  data.tar.gz: 7c8822ad52d0d529222c0a619f2fdfae3436485ce6c479b61095e3d0bdc5b9e5
 SHA512:
-  metadata.gz: 1ffaf0ec3fdc39fb9c4239dcde8f10f27921726be199a4969125c6873d75f29c30f62c60627d229edd45bd4db532eabbbca3e64c760878599f2bd7b4bec0f6e8
-  data.tar.gz: 4cecd795b83076371ad73ac26014a77a7791202269c6fb6903bfef358d9226e445d1e40a0dc8fe433a668562d82c57463809dedab4892dfa9303a12d9154bd44
+  metadata.gz: 4db33aa953f22cba846b1742b263f4051fea0b58cdbe92332a6d3b54f3fab4b64ffdb3edb2c3bd8de4dd4a84724a312d7cff589619495f54594c123ed152948f
+  data.tar.gz: 0636ff55084af4222059a8d5235df0eb538bee8132fb5a80c9f7bc58579c6b05f790d5150b5f8a1e3d8f39fecb80404acf679587b4ed1056169fa6cb9fa7f852

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.4.0] - 2025-12-02
+
+- Nest `HistoryModelNamespace` directly in `ActiveRecord::Temporal` as per the README
+- Fixed issue where including `ActiveRecord::Temporal` would not extend the base module properly
+
 ## [0.3.0] - 2025-11-20
 
 - Application versioning: Raise `ClosedRevisionError` when trying to revise or inactive closed versions.

data/README.md

@@ -10,7 +10,7 @@ As applications mature, changing business requirements become increasingly compl
 
 - Know the price of a product at the time it was added to a cart
 - Allow users to see content as it was before their subscription ended
-- Track the lifetime of long-lived, slowly change entities like projects or customers 
+- Track the lifetime of long-lived, slowly changing entities like projects or customers 
 - Generate reports based on the data as it was known at some time in the past
 
 Many Rails applications use a patchwork of approaches:
@@ -20,7 +20,7 @@ Many Rails applications use a patchwork of approaches:
 - **Event systems** that are used to fill gaps in the data model and gradually take on responsibilities that are implementation details with no business relevance.
 - **Ad-hoc snapshot columns** that result in important business entities having their historical data duplicated across many different and incohesive tables.
 
-Temporal databases solve these problems by providing a simple and coherent data model to reach for whenever historical data is needed.
+Temporal tables address these problems by providing a simple and coherent data model to reach for whenever historical data is needed.
 
 This can be a versioning strategy that operates automatically at the database level or one where versioning is used up front as the default method for all CRUD operations on a table.
 
@@ -29,6 +29,10 @@ This can be a versioning strategy that operates automatically at the database le
 - Active Record >= 8
 - PostgreSQL >= 13
 
+## Stability
+
+⚠️ Currently a beta release. Breaking changes will bump the minor version until the 1.x.x release.
+
 ## Quick Start
 
 ```ruby
@@ -36,8 +40,13 @@ This can be a versioning strategy that operates automatically at the database le
 
 gem "activerecord-temporal"
 ```
+### Versioning Strategies
+
+This gem supports two versioning strategies:
+1. **System versioning**, where database triggers automatically maintain a separate history table that records transaction time.
+2. **Application versioning**, where versioning is managed by the application using a single table whose time dimension can represent validity or any other temporal business concept.
 
-### Create a System Versioned Table
+### Creating a System Versioned Table
 
 Make sure you're using the `:sql` schema dumper.
 
@@ -121,7 +130,7 @@ Employee.history.as_of(Time.parse("2000-01-10"))
  - [System Versioning](#system-versioning)
  - [History Model Namespace](#history-model-namespace)
 
-### Create an Application Versioned Table
+### Creating an Application Versioned Table
 
 Create an `employees` table with a `version` column in the primary key and a `tstzrange` column to be the time dimension.
 
@@ -192,7 +201,7 @@ Employee.as_of(Time.parse("2000-02-15"))
  - [Application Versioning](#application-versioning)
  - [Foreign Key Constraints](#foreign-key-constraints)
 
-### Make Time-travel Queries
+### Making Time-travel Queries
 
 This interface works the same with system versioning and application. But this example assumes at least the `Product` and `Order` models are system versioned:
 
@@ -510,7 +519,7 @@ class Product < ApplicationRecord
 end
 ```
 
-The only strict requirements for a application versioned table are:
+The only strict requirements for an application versioned table are:
 1. It must have a `tstzrange` column (name doesn't matter)
 2. It must have a numeric `version` column with a default value
 

data/lib/activerecord/temporal/version.rb

@@ -1,3 +1,3 @@
 module ActiveRecord::Temporal
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/activerecord/temporal.rb

@@ -29,16 +29,24 @@ require_relative "temporal/system_versioning"
 require_relative "temporal/version"
 
 module ActiveRecord::Temporal
-  def system_versioning
-    include SystemVersioning
+  def self.included(base)
+    base.extend ClassMethods
   end
 
-  def application_versioning(**options)
-    include Querying
-    include ApplicationVersioning
+  module ClassMethods
+    def system_versioning
+      include SystemVersioning
+    end
 
-    self.time_dimensions = options[:dimensions] if options[:dimensions]
+    def application_versioning(**options)
+      include Querying
+      include ApplicationVersioning
+
+      self.time_dimensions = options[:dimensions] if options[:dimensions]
+    end
   end
+
+  HistoryModelNamespace = SystemVersioning::HistoryModelNamespace
 end
 
 ActiveSupport.on_load(:active_record) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-temporal
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Martin-Alexander
@@ -29,26 +29,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '9.0'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '8'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '9.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '8'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement