ifad/chronomodel

View on GitHub
lib/chrono_model.rb

Summary

Maintainability
A
0 mins
Test Coverage
C
78%
# frozen_string_literal: true

require 'active_record'

require 'chrono_model/chrono'
require 'chrono_model/conversions'
require 'chrono_model/patches'
require 'chrono_model/adapter'
require 'chrono_model/time_machine'
require 'chrono_model/time_gate'
require 'chrono_model/version'

require 'chrono_model/railtie' if defined?(Rails::Railtie)
require 'chrono_model/db_console' if defined?(Rails::DBConsole) && Rails.version < '7.1'

module ChronoModel
  class Error < ActiveRecord::ActiveRecordError # :nodoc:
  end

  # Performs structure upgrade.
  #
  def self.upgrade!
    connection = ActiveRecord::Base.connection

    unless connection.is_a?(ChronoModel::Adapter)
      raise ChronoModel::Error, 'This database connection is not a ChronoModel::Adapter'
    end

    connection.chrono_upgrade!
  end

  # Returns an Hash keyed by table name of ChronoModels.
  # Computed upon inclusion of the +TimeMachine+ module.
  #
  def self.history_models
    @history_models ||= {}
  end
end

ActiveSupport.on_load :active_record do
  extend ChronoModel::Chrono

  # Hooks into Association#scope to pass the As-Of time automatically
  # to methods that load associated ChronoModel records.
  ActiveRecord::Associations::Association.prepend ChronoModel::Patches::Association

  # Hooks into Relation#build_arel to use `:joins` on your ChronoModels
  # and join data from associated records As-Of time.
  ActiveRecord::Relation.prepend ChronoModel::Patches::Relation

  # Hooks in two points of the AR Preloader to preload As-Of time records of
  # associated ChronoModels. is used by `.includes`, `.preload`, and `.eager_load`.
  ActiveRecord::Associations::Preloader.prepend ChronoModel::Patches::Preloader

  ActiveRecord::Associations::Preloader::Association.prepend ChronoModel::Patches::Preloader::Association

  ActiveRecord::Associations::Preloader::ThroughAssociation.prepend ChronoModel::Patches::Preloader::ThroughAssociation

  ActiveRecord::Batches.prepend ChronoModel::Patches::Batches
end

ActiveSupport.on_load :after_initialize do
  next if Rails.application.config.active_record.schema_format == :sql

  raise 'In order to use ChronoModel, set `config.active_record.schema_format` to `:sql`'
end

if ActiveRecord::ConnectionAdapters.respond_to?(:register)
  ActiveRecord::ConnectionAdapters.register 'chronomodel', 'ChronoModel::Adapter', 'chrono_model/adapter'
end