active_version 1.0.0

data/sig/active_version/audits.rbs

@@ -0,0 +1,128 @@
+module ActiveVersion
+  module Audits
+    module HasAudits
+      REDACTED: String
+
+      module ClassMethods
+        def audit_record?: () -> bool
+        def audit_class: () -> Class?
+        def has_audits: (?Hash[Symbol, untyped] options) -> untyped
+        def audited?: () -> bool
+        def without_auditing: () { () -> untyped } -> untyped
+        def with_auditing: () { () -> untyped } -> untyped
+        def revisions: (?Integer from_version) -> Array[untyped]
+        def revision_at: (untyped date_or_time) -> untyped
+        def with_audited_options: (?Hash[Symbol, untyped] options) { () -> untyped } -> untyped
+        def class_auditing_enabled?: () -> bool
+        def audit_on_create: () -> untyped
+        def audit_on_update: () -> untyped
+        def audit_on_destroy: () -> untyped
+        def audit_on_touch: () -> untyped
+        def revision_with: (Hash[untyped, untyped] attributes, ?id: untyped) -> untyped
+      end
+
+      attr_accessor audit_version: Integer?
+      attr_accessor audit_comment: String?
+      attr_accessor audit_context: Hash[untyped, untyped]?
+
+      def audit_revision: (?version: Integer?) -> untyped
+      def audit_revision_at: (untyped date_or_time) -> untyped
+      def audit_sql: (?destroy: bool) -> String
+      def own_and_associated_audits: () -> untyped
+      def without_auditing: () { () -> untyped } -> untyped
+      def with_auditing: () { () -> untyped } -> untyped
+      def should_audit?: () -> bool
+      def auditing_enabled: () -> bool
+      def audits: () -> untyped
+      def active_audits: () -> Array[untyped]
+      def audited_changes: (?for_touch: bool, ?exclude_readonly_attrs: bool) -> Hash[String, untyped]
+    end
+
+    module AuditRecord
+      module ClassMethods
+        def audit_record?: () -> bool
+        def dangerous_attribute_method?: (Symbol | String name) -> bool
+        def configure_audit: (
+          ?storage: Symbol | String?,
+          ?action_column: Symbol | String?,
+          ?changes_column: Symbol | String?,
+          ?context_column: Symbol | String?,
+          ?comment_column: Symbol | String?,
+          ?version_column: Symbol | String?,
+          ?user_column: Symbol | String?,
+          ?auditable_column: Symbol | String?,
+          ?associated_column: Symbol | String?,
+          ?remote_address_column: Symbol | String?,
+          ?request_uuid_column: Symbol | String?
+        ) -> Hash[Symbol, untyped]
+        def audit_storage: (?Symbol | String value) -> Symbol?
+        def register_storage_provider: (Symbol | String name, ?untyped provider) { (Class audit_class, String column_name) -> untyped } -> untyped
+        def register_audit_storage_provider: (Symbol | String name, ?untyped provider) { (Class audit_class, String column_name) -> untyped } -> untyped
+        def storage_provider_registry: () -> Hash[Symbol, untyped]
+        def storage_provider_for_column: (Symbol | String column_name) -> untyped
+        def audit_action_column: (?Symbol | String value) -> Symbol?
+        def audit_changes_column: (?Symbol | String value) -> Symbol?
+        def audit_context_column: (?Symbol | String value) -> Symbol?
+        def audit_comment_column: (?Symbol | String value) -> Symbol?
+        def audit_version_column: (?Symbol | String value) -> Symbol?
+        def audit_user_column: (?Symbol | String value) -> Symbol?
+        def audit_auditable_column: (?Symbol | String value) -> Symbol?
+        def audit_associated_column: (?Symbol | String value) -> Symbol?
+        def audit_remote_address_column: (?Symbol | String value) -> Symbol?
+        def audit_request_uuid_column: (?Symbol | String value) -> Symbol?
+        def audit_storage_mode: () -> Symbol?
+        def audit_column_for: (Symbol concept) -> Symbol?
+        def source_name: () -> Symbol?
+        def source_class: () -> Class
+        def source_identity_columns: () -> Array[String]
+        def setup_associations: () -> untyped
+        def setup_serializers: () -> untyped
+        def add_audited_class: (Class audited_class) -> Set[Class]
+        def audited_classes: () -> Set[Class]
+        def initialize_serializers: () -> untyped
+        def reconstruct_attributes: (Array[untyped] audits) -> Hash[Symbol | String, untyped]
+      end
+
+      attr_accessor _allow_update_for_readonly_check: bool?
+
+      def audited_changes: () -> Hash[untyped, untyped] | Array[untyped] | String | nil
+      def audited_changes=: (untyped value) -> untyped
+      def audited_context: () -> Hash[untyped, untyped] | Array[untyped] | String | nil
+      def audited_context=: (untyped value) -> untyped
+      def readonly?: () -> bool
+      def save: (*untyped args, **untyped kwargs) -> bool
+      def save!: (*untyped args, **untyped kwargs) -> bool
+      def destroy: (*untyped args, **untyped kwargs) -> untyped
+      def new_attributes: () -> Hash[untyped, untyped]
+      def old_attributes: () -> Hash[untyped, untyped]
+      def ancestors: () -> untyped
+      def revision: () -> untyped
+    end
+
+    module ChangeFilters
+      def audited_changes: (?for_touch: bool, ?exclude_readonly_attrs: bool) -> Hash[String, untyped]
+      def audited_attributes: () -> Hash[String, untyped]
+      def non_audited_columns: () -> Array[String]
+      def normalize_enum_changes: (Hash[String, untyped] changes) -> Hash[String, untyped]
+      def redact_values: (Hash[String, untyped] filtered_changes) -> Hash[String, untyped]
+      def filter_encrypted_attrs: (Hash[String, untyped] filtered_changes) -> Hash[String, untyped]
+      def filter_attr_values: (?audited_changes: Hash[String, untyped], ?attrs: Array[Symbol | String], ?placeholder: String) -> Hash[String, untyped]
+      def prepare_sql_values: (Hash[untyped, untyped] changes) -> Hash[untyped, untyped]
+    end
+
+    module AuditCallbacks
+      def audit_create: () -> untyped
+      def audit_update: () -> untyped
+      def audit_touch: () -> untyped
+      def audit_destroy: () -> untyped
+    end
+
+    module AuditWriter
+      def write_audit: (Hash[untyped, untyped] attrs) -> untyped
+    end
+
+    module AuditCombiner
+      def combine_audits_if_needed: () -> untyped
+    end
+  end
+end

data/sig/active_version/configuration.rbs

@@ -0,0 +1,38 @@
+module ActiveVersion
+  class Configuration
+    attr_accessor auditing_enabled: bool
+    attr_accessor current_user_method: Symbol | String
+    attr_accessor ignored_attributes: Array[String]
+    attr_accessor ignored_default_callbacks: Array[Symbol | String]
+    attr_accessor store_synthesized_enums: bool
+    attr_accessor execution_scope: :fiber | :thread
+
+    attr_accessor translation_locale_column: Symbol | String
+    attr_accessor translation_default_locale: Symbol | String
+
+    attr_accessor revision_version_column: Symbol | String
+    attr_accessor revision_foreign_key_suffix: String
+
+    attr_accessor audit_storage: :json_column | :yaml_column | :mirror_columns
+    attr_accessor audit_action_column: Symbol | String
+    attr_accessor audit_changes_column: Symbol | String
+    attr_accessor audit_context_column: Symbol | String
+    attr_accessor audit_comment_column: Symbol | String
+    attr_accessor audit_version_column: Symbol | String
+    attr_accessor audit_user_column: Symbol | String
+    attr_accessor audit_auditable_column: Symbol | String
+    attr_accessor audit_associated_column: Symbol | String
+    attr_accessor audit_remote_address_column: Symbol | String
+    attr_accessor audit_request_uuid_column: Symbol | String
+    attr_accessor max_audits: Integer?
+    attr_accessor max_revisions: Integer?
+    attr_accessor return_self_if_no_revisions: bool
+    attr_accessor return_self_if_no_audits: bool
+    attr_accessor audit_error_behavior: Symbol
+    attr_accessor revision_error_behavior: Symbol
+    attr_accessor debounce_time: Numeric?
+    attr_accessor partition_schema_guards_enabled: bool
+
+    def validate!: () -> void
+  end
+end

data/sig/active_version/core.rbs

@@ -0,0 +1,53 @@
+module ActiveVersion
+  class Error < StandardError
+  end
+
+  class ConfigurationError < Error
+  end
+
+  class VersionNotFoundError < Error
+  end
+
+  class ReadonlyVersionError < Error
+  end
+
+  class FutureTimeError < Error
+  end
+
+  class DeletedColumnError < Error
+  end
+
+  class RequestStore < ActiveSupport::CurrentAttributes
+    attr_accessor version_context: Hash[untyped, untyped]?
+    attr_accessor audited_user: untyped
+    attr_accessor request_uuid: String?
+    attr_accessor remote_address: String?
+  end
+
+  def self.config: () -> Configuration
+  def self.configure: () { (Configuration) -> void } -> Configuration
+  def self.auditing_enabled: () -> bool
+  def self.auditing_enabled=: (bool value) -> bool
+  def self.runtime_adapter: () -> untyped
+  def self.runtime_adapter=: (untyped adapter) -> untyped
+  def self.reset_runtime_adapter!: () -> untyped
+  def self.context: () -> Hash[untyped, untyped]
+  def self.context=: (Hash[untyped, untyped] value) -> Hash[untyped, untyped]
+  def self.with_context: (?Hash[untyped, untyped] context, ?transactional: bool, **untyped kwargs) { () -> untyped } -> untyped
+  def self.with_context!: (Hash[untyped, untyped] context) -> nil
+  def self.clear_context!: () -> nil
+  def self.without_auditing: () { () -> untyped } -> untyped
+  def self.disable_auditing: () -> bool
+  def self.enable_auditing: () -> bool
+  def self.registry: () -> VersionRegistry
+  def self.column_mapper: () -> ColumnMapper
+  def self.parse_time: (Numeric | String | Date | Time | untyped time) -> Time
+  def self.parse_time_to_time: (Numeric | String | Date | Time | untyped time) -> Time
+  def self.connection_for: (Class model_class, Symbol | String version_type) -> untyped
+  def self.adapter_for: (Class model_class, Symbol | String version_type) -> untyped
+  def self.with_connection: (Class model_class, Symbol | String version_type) { (untyped) -> untyped } -> untyped
+  def self.store_get: (Symbol key) -> untyped
+  def self.store_set: (Symbol key, untyped value) -> untyped
+  def self.store_delete: (Symbol key) -> untyped
+  def self.clear_scoped_keys!: (Regexp pattern) -> void
+end

data/sig/active_version/instrumentation.rbs

@@ -0,0 +1,17 @@
+module ActiveVersion
+  module Instrumentation
+    EVENTS: Hash[Symbol, String]
+
+    def self.instrument_translation_created: (untyped translation, untyped source) -> untyped
+    def self.instrument_translation_updated: (untyped translation, untyped source) -> untyped
+    def self.instrument_translation_destroyed: (untyped translation, untyped source) -> untyped
+    def self.instrument_translation_fallback_used: (untyped source, attr: untyped, requested_locale: untyped, resolved_locale: untyped) -> untyped
+    def self.instrument_revision_created: (untyped revision, untyped source) -> untyped
+    def self.instrument_revision_reverted: (untyped source, from_version: untyped, to_version: untyped, ?strategy: Symbol) -> untyped
+    def self.instrument_revision_switch_applied: (untyped source, from_version: untyped, to_version: untyped, append: bool) -> untyped
+    def self.instrument_revision_write_failed: (untyped source, error: Exception?) -> untyped
+    def self.instrument_audit_created: (untyped audit, untyped auditable) -> untyped
+    def self.instrument_audit_write_failed: (untyped source, error: Exception?, action: untyped) -> untyped
+    def self.instrument_audit_sql_generated: (untyped model, String sql) -> untyped
+  end
+end

data/sig/active_version/registry_and_mapping.rbs

@@ -0,0 +1,18 @@
+module ActiveVersion
+  class ColumnMapper
+    def register: (Class model_class, Symbol version_type, Symbol concept, Symbol | String column_name) -> Symbol
+    def column_for: (Class model_class, Symbol version_type, Symbol concept) -> Symbol | String
+    def mappings_for: (Class model_class, Symbol version_type) -> Hash[Symbol, Symbol]
+  end
+
+  class VersionRegistry
+    def register: (Class model_class, Symbol version_type, ?Hash[Symbol, untyped] options) -> Hash[Symbol, untyped]
+    def version_class_for: (Class model_class, Symbol version_type) -> Class?
+    def register_version_class: (Class model_class, Symbol version_type, Class version_class) -> Class
+    def registered?: (Class model_class, Symbol version_type) -> bool
+    def models_for_version_type: (Symbol version_type) -> Array[Class]
+    def config_for: (Class model_class, Symbol version_type) -> Hash[Symbol, untyped]?
+    def config_for_model_name: (String model_name, Symbol version_type) -> Hash[Symbol, untyped]?
+    def clear!: () -> void
+  end
+end

data/sig/active_version/revisions.rbs

@@ -0,0 +1,70 @@
+module ActiveVersion
+  module Revisions
+    module HasRevisions
+      module ClassMethods
+        def revision_record?: () -> bool
+        def revision_class: () -> Class
+        def revision_class_name: () -> String
+        def setup_revision_associations: () -> untyped
+        def has_revisions: (?Hash[Symbol, untyped] options) -> Hash[Symbol, untyped]
+        def has_revisions?: () -> bool
+        def normalize_revision_options: (Hash[Symbol, untyped] options) -> Hash[Symbol, untyped]
+        def setup_revision_callbacks: (Hash[Symbol, untyped] options) -> untyped
+        def revision_on_update: () -> untyped
+        def create_snapshots: (?Hash[Symbol, untyped] opts) -> untyped
+        def without_revisions: () { () -> untyped } -> untyped
+        def with_revisions: () { () -> untyped } -> untyped
+        def class_revision_enabled?: () -> bool
+      end
+
+      module RevisionQueries
+        def revision: (?version: Integer?) -> untyped
+        def revision_at: (?time: untyped) -> untyped
+        def at: (?time: untyped, ?version: Integer?) -> untyped
+        def at!: (?time: untyped, ?version: Integer?) -> untyped
+        def at_version!: (Integer version) -> untyped
+        def current_version: () -> Integer
+        def at_version: (Integer version) -> untyped
+        def versions: (?reverse: bool, ?include_self: bool) -> Enumerator[untyped]
+      end
+
+      module RevisionManipulation
+        def create_snapshot!: (?Hash[Symbol, untyped] opts) -> untyped
+        def revert_to: (version: Integer) -> bool
+        def undo!: (?append: bool) -> bool
+        def redo!: () -> bool
+        def switch_to!: (Integer version, ?append: bool) -> bool
+        def diff_from: (?time: untyped, ?version: Integer?) -> Hash[String, untyped]
+      end
+    end
+
+    module RevisionRecord
+      module ClassMethods
+        def revision_record?: () -> bool
+        def configure_revision: (
+          ?version_column: Symbol | String?,
+          ?foreign_key: Symbol | String | Array[Symbol | String]?,
+          ?identity_resolver: Symbol | String | Array[Symbol | String]?
+        ) { () -> untyped } -> Hash[Symbol, untyped]
+        def revision_version_column: (?Symbol | String value) -> Symbol?
+        def revision_foreign_key: (?Symbol | String | Array[Symbol | String] value) -> String | Array[String]?
+        def revision_identity_resolver: (?Symbol | String | Array[Symbol | String] value) -> String | Array[String]?
+        def revision_column_for: (Symbol concept) -> Symbol?
+        def source_name: () -> Symbol?
+        def source_class: () -> Class
+        def source_foreign_key: () -> String | Array[String]
+        def source_primary_key: () -> String | Array[String]?
+        def setup_associations: () -> untyped
+      end
+
+      attr_accessor _allow_update_for_readonly_check: bool?
+
+      def readonly?: () -> bool
+      def save: (*untyped args, **untyped kwargs) -> bool
+      def save!: (*untyped args, **untyped kwargs) -> bool
+      def destroy: (*untyped args, **untyped kwargs) -> untyped
+      def source: () -> untyped
+      def attributes: () -> Hash[String, untyped]
+    end
+  end
+end

data/sig/active_version/runtime.rbs

@@ -0,0 +1,29 @@
+module ActiveVersion
+  module Runtime
+    class NullAdapter
+      def base_connection: () -> untyped
+      def connection_for: (Class model_class, Symbol | String version_type) -> untyped
+      def supports_transactional_context?: (untyped connection) -> bool
+      def supports_current_transaction_id?: (untyped connection) -> bool
+      def supports_partition_catalog_checks?: (untyped connection) -> bool
+    end
+
+    class ActiveRecordAdapter
+      def base_connection: () -> untyped
+      def connection_for: (Class model_class, Symbol | String version_type) -> untyped
+      def supports_transactional_context?: (untyped connection) -> bool
+      def supports_current_transaction_id?: (untyped connection) -> bool
+      def supports_partition_catalog_checks?: (untyped connection) -> bool
+    end
+
+    def self.adapter: () -> untyped
+    def self.adapter=: (untyped runtime_adapter) -> untyped
+    def self.reset_adapter!: () -> untyped
+    def self.required_adapter_methods: () -> Array[Symbol]
+    def self.valid_adapter?: (untyped runtime_adapter) -> bool
+    def self.supports_transactional_context?: (untyped connection) -> bool
+    def self.supports_current_transaction_id?: (untyped connection) -> bool
+    def self.supports_partition_catalog_checks?: (untyped connection) -> bool
+    def self.active_record_connection_errors: () -> Array[untyped]
+  end
+end

data/sig/active_version/translations.rbs

@@ -0,0 +1,43 @@
+module ActiveVersion
+  module Translations
+    module HasTranslations
+      module ClassMethods
+        def translation_record?: () -> bool
+        def translation_class: () -> Class
+        def translation_class_name: () -> String
+        def setup_translation_associations: () -> untyped
+        def scope_for_translated_attribute: (Symbol | String attribute_name, untyped value, ?locale: Symbol | String) -> untyped
+        def translated_scopes: (*untyped attribute_names) -> untyped
+        def translated_copies: (*untyped attribute_names) -> untyped
+      end
+
+      def translate: (Symbol | String attr_name, ?locale: Symbol | String | nil, ?presence_check: Symbol | String | nil, ?fallback: bool) -> untyped
+      def translation: (?locale: Symbol | String | nil) -> untyped
+      def update_default_translation: () -> untyped
+    end
+
+    module TranslationRecord
+      module ClassMethods
+        def translation_record?: () -> bool
+        def configure_translation: (
+          ?locale_column: Symbol | String?,
+          ?foreign_key: Symbol | String | Array[Symbol | String]?,
+          ?identity_resolver: Symbol | String | Array[Symbol | String]?
+        ) { () -> untyped } -> Hash[Symbol, untyped]
+        def translation_locale_column: (?Symbol | String value) -> Symbol?
+        def translation_foreign_key: (?Symbol | String | Array[Symbol | String] value) -> String | Array[String]?
+        def translation_identity_resolver: (?Symbol | String | Array[Symbol | String] value) -> String | Array[String]?
+        def source_name: () -> Symbol?
+        def source_class: () -> Class
+        def source_foreign_key: () -> String | Array[String]
+        def source_primary_key: () -> String | Array[String]?
+        def locale_column_name: () -> Symbol | String
+        def setup_associations: () -> untyped
+        def setup_locale_enum: () -> untyped
+      end
+
+      def attr_present_for_locale?: (Symbol | String locale, Symbol | String attr_name, ?untyped presence_check) -> bool
+      def source_version: () -> untyped
+    end
+  end
+end

data/sig/active_version.rbs

@@ -0,0 +1,3 @@
+module ActiveVersion
+  VERSION: String
+end