activerecord-temporal 0.1.0 → 0.2.0

data/lib/activerecord/temporal.rb

@@ -1,63 +1,108 @@
 require "active_support"
 
-require_relative "temporal/application_versioning"
-require_relative "temporal/as_of_query"
-require_relative "temporal/as_of_query/association_macros"
-require_relative "temporal/as_of_query/association_scope"
-require_relative "temporal/as_of_query/association_walker"
-require_relative "temporal/as_of_query/query_methods"
-require_relative "temporal/as_of_query/scope_registry"
-require_relative "temporal/as_of_query/time_dimensions"
+require_relative "temporal/application_versioning/application_versioned"
+require_relative "temporal/application_versioning/command_recorder"
+require_relative "temporal/application_versioning/migration"
+require_relative "temporal/application_versioning/schema_statements"
+require_relative "temporal/querying/association_macros"
+require_relative "temporal/querying/association_scope"
+require_relative "temporal/querying/association_walker"
+require_relative "temporal/querying/predicate_builder/handlers"
+require_relative "temporal/querying/query_methods"
+require_relative "temporal/querying/scope_registry"
+require_relative "temporal/querying/scoping"
+require_relative "temporal/querying/time_dimensions"
 require_relative "temporal/patches/association_reflection"
+require_relative "temporal/patches/command_recorder"
 require_relative "temporal/patches/join_dependency"
 require_relative "temporal/patches/merger"
 require_relative "temporal/patches/relation"
 require_relative "temporal/patches/through_association"
-require_relative "temporal/system_versioning"
 require_relative "temporal/system_versioning/command_recorder"
-require_relative "temporal/system_versioning/namespace"
-require_relative "temporal/system_versioning/model"
+require_relative "temporal/system_versioning/history_model_namespace"
+require_relative "temporal/system_versioning/history_model"
+require_relative "temporal/system_versioning/history_models"
+require_relative "temporal/system_versioning/migration"
 require_relative "temporal/system_versioning/schema_creation"
 require_relative "temporal/system_versioning/schema_definitions"
 require_relative "temporal/system_versioning/schema_statements"
+require_relative "temporal/system_versioning/system_versioned"
+require_relative "temporal/application_versioning"
+require_relative "temporal/querying"
+require_relative "temporal/scoping"
+require_relative "temporal/system_versioning"
+
+module ActiveRecord::Temporal
+  def system_versioning
+    include SystemVersioning
+  end
+
+  def application_versioning(**options)
+    include Querying
+    include ApplicationVersioning
+
+    self.time_dimensions = options[:dimensions] if options[:dimensions]
+  end
+end
 
 ActiveSupport.on_load(:active_record) do
   require "active_record/connection_adapters/postgresql_adapter" # TODO: add test
 
-  ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.include(ActiveRecord::Temporal::SystemVersioning::SchemaStatements)
-  ActiveRecord::Migration::CommandRecorder.include(ActiveRecord::Temporal::SystemVersioning::CommandRecorder)
-  ActiveRecord::Relation.include(ActiveRecord::Temporal::AsOfQuery::QueryMethods)
+  ActiveRecord::ConnectionAdapters::PostgreSQLAdapter
+    .include ActiveRecord::Temporal::ApplicationVersioning::SchemaStatements
+
+  ActiveRecord::Migration::CommandRecorder
+    .include ActiveRecord::Temporal::ApplicationVersioning::CommandRecorder
+
+  ActiveRecord::ConnectionAdapters::PostgreSQLAdapter
+    .include ActiveRecord::Temporal::SystemVersioning::SchemaStatements
+
+  ActiveRecord::Migration::CommandRecorder
+    .include ActiveRecord::Temporal::SystemVersioning::CommandRecorder
+
+  ActiveRecord::Relation
+    .include ActiveRecord::Temporal::Querying::QueryMethods
 
   # Patches
 
-  # Patches the `build_arel` method wrap itself in the as-of query scope registry.
+  # Patches `#invert_drop` to remove the `system_versioning` option. The original
+  # method determines reversibility by looking for the presence of arguments
+  ActiveRecord::Migration::CommandRecorder
+    .prepend ActiveRecord::Temporal::Patches::CommandRecorder
+
+  # Patches `#build_arel` to  wrap itself in the as-of query scope registry.
   # This is what allows temporal association scopes to be aware of the time-scope
   # value of the relation that included them.
   #
-  # Patches the `instantiate_records` method to call `initialize_time_scope_from_relation`
+  # Patches `#instantiate_records` method to call `initialize_time_tags_from_relation`
   # on each loaded record.
-  ActiveRecord::Relation.prepend(ActiveRecord::Temporal::Patches::Relation)
+  ActiveRecord::Relation
+    .prepend ActiveRecord::Temporal::Patches::Relation
 
-  # Patches the `merge` method (called by `Relation#merge`) to handle the new
-  # query method `time_scope` that this gem adds.
-  ActiveRecord::Relation::Merger.prepend(ActiveRecord::Temporal::Patches::Merger)
+  # Patches `#merge` (called by `Relation#merge`) to handle the new query method
+  # `time_tags` that this gem adds.
+  ActiveRecord::Relation::Merger
+    .prepend ActiveRecord::Temporal::Patches::Merger
 
-  # Patches the preloader's `through_scope` method to pass along the relation's
-  # time-scope values when it handles has-many-through associations. The handler
-  # for has-many assoication uses `Relation#merge`, but this one doesn't.
-  ActiveRecord::Associations::Preloader::ThroughAssociation.prepend(ActiveRecord::Temporal::Patches::ThroughAssociation)
+  # Patches `#through_scope` to pass along the relation's time tag values when it
+  # handles has-many-through associations. The handler for has-many association
+  # uses `Relation#merge`, but this one doesn't.
+  ActiveRecord::Associations::Preloader::ThroughAssociation
+    .prepend ActiveRecord::Temporal::Patches::ThroughAssociation
 
   # This permits association scopes generated by this gem to be eager-load if they
-  # are "optionally instance-dependent." That is to say, they accept arguments,
-  # but don't require any arguments.
+  # are "optionally instance-dependent." That is to say, they accept but don't
+  # require arguments.
   #
-  # I think permitting eager-loading optionally instance-dependent association
-  # scopes would make sense as a general feature. See this PR for my justification:
+  # I think permitting eager-loading of such scopes would make sense as a
+  # standalone feature for Active Record. See this PR for my justification:
   # https://github.com/rails/rails/pull/56004
-  ActiveRecord::Reflection::AssociationReflection.prepend(ActiveRecord::Temporal::Patches::AssociationReflection)
+  ActiveRecord::Reflection::AssociationReflection
+    .prepend ActiveRecord::Temporal::Patches::AssociationReflection
 
   # This is a copy of a fix from https://github.com/rails/rails/pull/56088 that
   # impacts this gem. I has been backported to supported stable versions of
   # Active Record, but until those patches are released it's included here.
-  ActiveRecord::Associations::JoinDependency.prepend(ActiveRecord::Temporal::Patches::JoinDependency)
+  ActiveRecord::Associations::JoinDependency
+    .prepend ActiveRecord::Temporal::Patches::JoinDependency
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-temporal
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Martin-Alexander
@@ -15,7 +15,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '8'
     - - "<"
       - !ruby/object:Gem::Version
         version: '9.0'
@@ -25,7 +25,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '8'
     - - "<"
       - !ruby/object:Gem::Version
         version: '9.0'
@@ -35,7 +35,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '8'
     - - "<"
       - !ruby/object:Gem::Version
         version: '9.0'
@@ -45,7 +45,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '8'
     - - "<"
       - !ruby/object:Gem::Version
         version: '9.0'
@@ -77,25 +77,38 @@ files:
 - README.md
 - lib/activerecord/temporal.rb
 - lib/activerecord/temporal/application_versioning.rb
-- lib/activerecord/temporal/as_of_query.rb
-- lib/activerecord/temporal/as_of_query/association_macros.rb
-- lib/activerecord/temporal/as_of_query/association_scope.rb
-- lib/activerecord/temporal/as_of_query/association_walker.rb
-- lib/activerecord/temporal/as_of_query/query_methods.rb
-- lib/activerecord/temporal/as_of_query/scope_registry.rb
-- lib/activerecord/temporal/as_of_query/time_dimensions.rb
+- lib/activerecord/temporal/application_versioning/application_versioned.rb
+- lib/activerecord/temporal/application_versioning/command_recorder.rb
+- lib/activerecord/temporal/application_versioning/migration.rb
+- lib/activerecord/temporal/application_versioning/schema_statements.rb
 - lib/activerecord/temporal/patches/association_reflection.rb
+- lib/activerecord/temporal/patches/command_recorder.rb
 - lib/activerecord/temporal/patches/join_dependency.rb
 - lib/activerecord/temporal/patches/merger.rb
 - lib/activerecord/temporal/patches/relation.rb
 - lib/activerecord/temporal/patches/through_association.rb
+- lib/activerecord/temporal/querying.rb
+- lib/activerecord/temporal/querying/association_macros.rb
+- lib/activerecord/temporal/querying/association_scope.rb
+- lib/activerecord/temporal/querying/association_walker.rb
+- lib/activerecord/temporal/querying/predicate_builder/contains_handler.rb
+- lib/activerecord/temporal/querying/predicate_builder/handlers.rb
+- lib/activerecord/temporal/querying/query_methods.rb
+- lib/activerecord/temporal/querying/scope_registry.rb
+- lib/activerecord/temporal/querying/scoping.rb
+- lib/activerecord/temporal/querying/time_dimensions.rb
+- lib/activerecord/temporal/querying/where_clause_refinement.rb
+- lib/activerecord/temporal/scoping.rb
 - lib/activerecord/temporal/system_versioning.rb
 - lib/activerecord/temporal/system_versioning/command_recorder.rb
-- lib/activerecord/temporal/system_versioning/model.rb
-- lib/activerecord/temporal/system_versioning/namespace.rb
+- lib/activerecord/temporal/system_versioning/history_model.rb
+- lib/activerecord/temporal/system_versioning/history_model_namespace.rb
+- lib/activerecord/temporal/system_versioning/history_models.rb
+- lib/activerecord/temporal/system_versioning/migration.rb
 - lib/activerecord/temporal/system_versioning/schema_creation.rb
 - lib/activerecord/temporal/system_versioning/schema_definitions.rb
 - lib/activerecord/temporal/system_versioning/schema_statements.rb
+- lib/activerecord/temporal/system_versioning/system_versioned.rb
 - lib/activerecord/temporal/version.rb
 homepage: https://github.com/Martin-Alexander/activerecord-temporal
 licenses:

data/lib/activerecord/temporal/as_of_query/association_scope.rb

@@ -1,54 +0,0 @@
-module ActiveRecord::Temporal
-  module AsOfQuery
-    class AssociationScope
-      class << self
-        def build(block)
-          scope = build_scope(block || default_base_scope)
-
-          def scope.as_of_scope? = true
-
-          scope
-        end
-
-        private
-
-        def build_scope(block)
-          temporal_scope = build_temporal_scope
-
-          if block.arity != 0
-            return ->(owner) do
-              base = instance_exec(owner, &block)
-              instance_exec(owner, base, &temporal_scope)
-            end
-          end
-
-          ->(owner = nil) do
-            base = instance_exec(owner, &block)
-            instance_exec(owner, base, &temporal_scope)
-          end
-        end
-
-        def build_temporal_scope
-          ->(owner, base) do
-            time_scopes = ScopeRegistry.query_scope_for(time_dimensions)
-            owner_time_scopes = owner&.time_scopes_for(time_dimensions)
-
-            time_scopes.merge!(owner_time_scopes) if owner_time_scopes
-
-            default_time_scopes = time_dimensions.map do |dimension|
-              [dimension, Time.current]
-            end.to_h
-
-            time_scope_constraints = default_time_scopes.merge(time_scopes)
-
-            base.existed_at(time_scope_constraints).time_scope(time_scopes)
-          end
-        end
-
-        def default_base_scope
-          proc { all }
-        end
-      end
-    end
-  end
-end

data/lib/activerecord/temporal/as_of_query/query_methods.rb

@@ -1,24 +0,0 @@
-module ActiveRecord::Temporal
-  module AsOfQuery
-    module QueryMethods
-      def time_scope(scope)
-        spawn.time_scope!(scope)
-      end
-
-      def time_scope!(scope)
-        self.time_scope_values = time_scope_values.merge(scope)
-        self
-      end
-
-      def time_scope_values
-        @values.fetch(:time_scope, ActiveRecord::QueryMethods::FROZEN_EMPTY_HASH)
-      end
-
-      def time_scope_values=(scope)
-        assert_modifiable! # TODO: write test
-
-        @values[:time_scope] = scope
-      end
-    end
-  end
-end

data/lib/activerecord/temporal/as_of_query/scope_registry.rb

@@ -1,38 +0,0 @@
-module ActiveRecord::Temporal
-  module AsOfQuery
-    class ScopeRegistry
-      class << self
-        delegate :default_scopes, :query_scopes, :set_default_scopes, :query_scope_for, :with_query_scope, to: :instance
-
-        def instance
-          ActiveSupport::IsolatedExecutionState[:temporal_as_of_query_registry] ||= new
-        end
-      end
-
-      attr_reader :default_scopes, :query_scopes
-
-      def initialize
-        @default_scopes = {}
-        @query_scopes = {}
-      end
-
-      def set_default_scopes(default_scopes)
-        @default_scopes = default_scopes
-      end
-
-      def query_scope_for(dimensions)
-        query_scopes.slice(*dimensions)
-      end
-
-      def with_query_scope(scope, &block)
-        original = @query_scopes.dup
-
-        @query_scopes = @query_scopes.merge(scope)
-
-        block.call
-      ensure
-        @query_scopes = original
-      end
-    end
-  end
-end

data/lib/activerecord/temporal/as_of_query.rb

@@ -1,109 +0,0 @@
-module ActiveRecord::Temporal
-  module AsOfQuery
-    class RangeError < StandardError; end
-
-    extend ActiveSupport::Concern
-
-    class_methods do
-      def existed_at_constraint(arel_table, time, time_dimension)
-        time_as_tstz = Arel::Nodes::As.new(
-          Arel::Nodes::Quoted.new(time),
-          Arel::Nodes::SqlLiteral.new("timestamptz")
-        )
-
-        cast_value = Arel::Nodes::NamedFunction.new("CAST", [time_as_tstz])
-
-        arel_table[time_dimension].contains(cast_value)
-      end
-
-      def temporal_association_scope(&block)
-        AssociationScope.build(block)
-      end
-
-      def resolve_time_scopes(time_or_time_scopes)
-        return time_or_time_scopes if time_or_time_scopes.is_a?(Hash)
-
-        {default_time_dimension.to_sym => time_or_time_scopes}
-      end
-    end
-
-    included do
-      include AssociationMacros
-      include TimeDimensions
-
-      delegate :resolve_time_scopes, to: :class
-
-      scope :as_of, ->(time) do
-        time_scopes = resolve_time_scopes(time)
-
-        existed_at(time_scopes).time_scope(time_scopes)
-      end
-
-      scope :existed_at, ->(time) do
-        time_scopes = resolve_time_scopes(time)
-
-        rel = all
-
-        time_scopes.each do |time_dimension, time|
-          next unless time_dimension_column?(time_dimension)
-
-          rel = rel.where(existed_at_constraint(table, time, time_dimension))
-        end
-
-        rel
-      end
-    end
-
-    def time_scopes
-      @time_scopes || {}
-    end
-
-    def time_scopes=(value)
-      @time_scopes = value&.slice(*time_dimensions)
-    end
-
-    def time_scope
-      time_scopes[default_time_dimension]
-    end
-
-    def time_scopes_for(time_dimensions)
-      time_scopes.slice(*time_dimensions)
-    end
-
-    def as_of!(time)
-      time_scopes = resolve_time_scopes(time)
-
-      ensure_time_scopes_in_bounds!(time_scopes)
-
-      reload
-
-      self.time_scopes = time_scopes
-    end
-
-    def as_of(time)
-      time_scopes = resolve_time_scopes(time)
-
-      self.class.as_of(time_scopes).find_by(self.class.primary_key => [id])
-    end
-
-    def initialize_time_scope_from_relation(relation)
-      associations = relation.includes_values | relation.eager_load_values
-
-      self.time_scopes = relation.time_scope_values
-
-      AssociationWalker.each_target(self, associations) do |target|
-        target.time_scopes = relation.time_scope_values
-      end
-    end
-
-    private
-
-    def ensure_time_scopes_in_bounds!(time_scopes)
-      time_scopes.each do |dimension, time|
-        if time_dimension_column?(dimension) && !time_dimension(dimension).cover?(time)
-          raise RangeError, "#{time} is outside of '#{dimension}' range"
-        end
-      end
-    end
-  end
-end

data/lib/activerecord/temporal/system_versioning/model.rb

@@ -1,37 +0,0 @@
-module ActiveRecord::Temporal
-  module SystemVersioning
-    module Model
-      extend ActiveSupport::Concern
-
-      included do
-        include AsOfQuery
-
-        set_time_dimensions :system_period
-
-        reflect_on_all_associations.each do |reflection|
-          scope = temporal_association_scope(&reflection.scope)
-
-          send(reflection.macro, reflection.name, scope, **reflection.options)
-        end
-      end
-
-      class_methods do
-        def polymorphic_class_for(name)
-          super.version_model
-        end
-
-        def sti_name
-          superclass.sti_name
-        end
-
-        def find_sti_class(type_name)
-          superclass.send(:find_sti_class, type_name).version_model
-        end
-
-        def finder_needs_type_condition?
-          superclass.finder_needs_type_condition?
-        end
-      end
-    end
-  end
-end

data/lib/activerecord/temporal/system_versioning/namespace.rb

@@ -1,34 +0,0 @@
-module ActiveRecord::Temporal
-  module SystemVersioning
-    module Namespace
-      extend ActiveSupport::Concern
-
-      class_methods do
-        def const_missing(name)
-          model = name.to_s.constantize
-        rescue NameError
-          super
-        else
-          unless model.is_a?(Class) && model < ActiveRecord::Base
-            raise NameError, "#{model} is not a descendent of ActiveRecord::Base"
-          end
-
-          version_model = if (history_table = model.history_table)
-            Class.new(model) do
-              self.table_name = history_table
-              self.primary_key = model.primary_key_from_db + [:system_period]
-
-              include Model
-            end
-          else
-            Class.new(model) do
-              include Model
-            end
-          end
-
-          const_set(name, version_model)
-        end
-      end
-    end
-  end
-end