hoardable 0.14.2 → 0.16.0

data/lib/hoardable/schema_dumper.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Hoardable
+  module SchemaDumper
+    def ignored?(table_name)
+      super || @connection.inherited_table?(table_name)
+    end
+
+    def tables(stream)
+      super
+      dump_inherited_tables(stream)
+      empty_line(stream)
+      triggers(stream)
+    end
+
+    private def dump_inherited_tables(stream)
+      sorted_tables = @connection.tables.filter { |table| @connection.inherited_table?(table) }.sort
+      sorted_tables.each do |table_name|
+        table(table_name, stream)
+        foreign_keys(table_name, stream)
+      end
+    end
+  end
+  private_constant :SchemaDumper
+end

data/lib/hoardable/schema_statements.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Hoardable
+  module SchemaStatements
+    def table_options(table_name)
+      options = super || {}
+      if !options[:options] && (inherited_table_names = parent_table_names(table_name))
+        options[:options] = "INHERITS (#{inherited_table_names.join(", ")})"
+      end
+      options
+    end
+
+    private def parent_table_names(table_name)
+      scope = quoted_scope(table_name, type: "BASE TABLE")
+
+      query_values(<<~SQL.presence, "SCHEMA").presence
+        SELECT parent.relname
+        FROM pg_catalog.pg_inherits i
+          JOIN pg_catalog.pg_class child ON i.inhrelid = child.oid
+          JOIN pg_catalog.pg_class parent ON i.inhparent = parent.oid
+          LEFT JOIN pg_namespace n ON n.oid = child.relnamespace
+        WHERE child.relname = #{scope[:name]}
+          AND child.relkind IN (#{scope[:type]})
+          AND n.nspname = #{scope[:schema]}
+      SQL
+    end
+
+    def inherited_table?(table_name)
+      parent_table_names(table_name).present?
+    end
+  end
+  private_constant :SchemaStatements
+end

data/lib/hoardable/scopes.rb

@@ -6,23 +6,12 @@ module Hoardable
   module Scopes
     extend ActiveSupport::Concern
 
-    TABLEOID_AREL_CONDITIONS = lambda do |arel_table, condition|
-      arel_table[:tableoid].send(
-        condition,
-        Arel::Nodes::NamedFunction.new('CAST', [Arel::Nodes::Quoted.new(arel_table.name).as('regclass')])
-      )
-    end.freeze
-    private_constant :TABLEOID_AREL_CONDITIONS
-
     included do
-      # @!visibility private
-      attr_writer :tableoid
-
       # By default {Hoardable} only returns instances of the parent table, and not the +versions+ in
       # the inherited table. This can be bypassed by using the {.include_versions} scope or wrapping
       # the code in a `Hoardable.at(datetime)` block.
       default_scope do
-        if (hoardable_at = Hoardable.instance_variable_get('@at'))
+        if (hoardable_at = Hoardable.instance_variable_get("@at"))
           at(hoardable_at)
         else
           exclude_versions
@@ -35,7 +24,7 @@ module Hoardable
       #
       # Returns +versions+ along with instances of the source models, all cast as instances of the
       # source model’s class.
-      scope :include_versions, -> { unscope(where: [:tableoid]) }
+      scope :include_versions, -> { unscope(:from) }
 
       # @!scope class
       # @!method versions
@@ -43,7 +32,7 @@ module Hoardable
       #
       # Returns only +versions+ of the parent +ActiveRecord+ class, cast as instances of the source
       # model’s class.
-      scope :versions, -> { include_versions.where(TABLEOID_AREL_CONDITIONS.call(arel_table, :not_eq)) }
+      scope :versions, -> { from("ONLY #{version_class.table_name}") }
 
       # @!scope class
       # @!method exclude_versions
@@ -51,7 +40,7 @@ module Hoardable
       #
       # Excludes +versions+ of the parent +ActiveRecord+ class. This is included by default in the
       # source model’s +default_scope+.
-      scope :exclude_versions, -> { where(TABLEOID_AREL_CONDITIONS.call(arel_table, :eq)) }
+      scope :exclude_versions, -> { from("ONLY #{table_name}") }
 
       # @!scope class
       # @!method at
@@ -59,21 +48,25 @@ module Hoardable
       #
       # Returns instances of the source model and versions that were valid at the supplied
       # +datetime+ or +time+, all cast as instances of the source model.
-      scope :at, lambda { |datetime|
-        raise(CreatedAtColumnMissingError, @klass.table_name) unless @klass.column_names.include?('created_at')
+      scope(
+        :at,
+        lambda do |datetime|
+          raise(CreatedAtColumnMissingError, table_name) unless column_names.include?("created_at")
 
-        include_versions.where(id: version_class.at(datetime).select(@klass.primary_key)).or(
-          exclude_versions
-            .where("#{table_name}.created_at < ?", datetime)
-            .where.not(id: version_class.select(:hoardable_id).where(DURING_QUERY, datetime))
-        ).hoardable
-      }
-    end
-
-    private
-
-    def tableoid
-      @tableoid ||= connection.execute("SELECT oid FROM pg_class WHERE relname = '#{table_name}'")[0]['oid']
+          from(
+            Arel::Nodes::As.new(
+              Arel::Nodes::Union.new(
+                include_versions.where(id: version_class.at(datetime).select(primary_key)).arel,
+                exclude_versions
+                  .where(created_at: ..datetime)
+                  .where.not(id: version_class.select(:hoardable_id).where(DURING_QUERY, datetime))
+                  .arel
+              ),
+              arel_table
+            )
+          ).hoardable
+        end
+      )
     end
   end
 end

data/lib/hoardable/source_model.rb

@@ -32,11 +32,11 @@ module Hoardable
       include Scopes
 
       around_update(if: [HOARDABLE_CALLBACKS_ENABLED, HOARDABLE_VERSION_UPDATES]) do |_, block|
-        hoardable_client.insert_hoardable_version('update', &block)
+        hoardable_client.insert_hoardable_version("update", &block)
       end
 
       around_destroy(if: [HOARDABLE_CALLBACKS_ENABLED, HOARDABLE_SAVE_TRASH]) do |_, block|
-        hoardable_client.insert_hoardable_version('delete', &block)
+        hoardable_client.insert_hoardable_version("delete", &block)
       end
 
       before_destroy(if: HOARDABLE_CALLBACKS_ENABLED, unless: HOARDABLE_SAVE_TRASH) do
@@ -47,7 +47,8 @@ module Hoardable
 
       # Returns all +versions+ in ascending order of their temporal timeframes.
       has_many(
-        :versions, -> { order('UPPER(_during) ASC') },
+        :versions,
+        -> { order("UPPER(_during) ASC") },
         dependent: nil,
         class_name: version_class.to_s,
         inverse_of: :hoardable_source,
@@ -85,7 +86,7 @@ module Hoardable
     #
     # @param datetime [DateTime, Time]
     def version_at(datetime)
-      raise(Error, 'Future state cannot be known') if datetime.future?
+      raise(Error, "Future state cannot be known") if datetime.future?
 
       versions.at(datetime).limit(1).first
     end
@@ -101,7 +102,7 @@ module Hoardable
     end
 
     def hoardable_id
-      read_attribute('hoardable_id')
+      read_attribute("hoardable_id")
     end
 
     delegate :version_class, to: :class

data/lib/hoardable/version.rb

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

data/lib/hoardable/version_model.rb

@@ -13,13 +13,6 @@ module Hoardable
       def version_class
         self
       end
-
-      # This is needed to omit the pseudo row of 'tableoid' when using +ActiveRecord+’s +insert+.
-      #
-      # @!visibility private
-      def scope_attributes
-        super.without('tableoid')
-      end
     end
 
     included do
@@ -34,20 +27,26 @@ module Hoardable
       self.table_name = "#{table_name.singularize}#{VERSION_TABLE_SUFFIX}"
 
       alias_method :readonly?, :persisted?
-      alias_attribute :hoardable_operation, :_operation
-      alias_attribute :hoardable_event_uuid, :_event_uuid
-      alias_attribute :hoardable_during, :_during
+
+      %i[operation event_uuid during].each do |symbol|
+        define_method("hoardable_#{symbol}") { public_send("_#{symbol}") }
+      end
 
       # @!scope class
       # @!method trashed
       # @return [ActiveRecord<Object>]
       #
       # Returns only trashed +versions+ that are currently orphans.
-      scope :trashed, lambda {
-        left_outer_joins(:hoardable_source)
-          .where(superclass.table_name => { superclass.primary_key => nil })
-          .where(_operation: 'delete')
-      }
+      scope(
+        :trashed,
+        lambda do
+          left_outer_joins(:hoardable_source).where(
+            superclass.table_name => {
+              superclass.primary_key => nil
+            }
+          ).where(_operation: "delete")
+        end
+      )
 
       # @!scope class
       # @!method at
@@ -61,7 +60,7 @@ module Hoardable
       # @return [ActiveRecord<Object>]
       #
       # Returns +versions+ that were trashed at the supplied +datetime+ or +time+.
-      scope :trashed_at, ->(datetime) { where(_operation: 'insert').where(DURING_QUERY, datetime) }
+      scope :trashed_at, ->(datetime) { where(_operation: "insert").where(DURING_QUERY, datetime) }
 
       # @!scope class
       # @!method with_hoardable_event_uuid
@@ -76,17 +75,19 @@ module Hoardable
       # @return [ActiveRecord<Object>]
       #
       # Returns a limited +ActiveRecord+ scope of only the most recent version.
-      scope :only_most_recent, -> { limit(1).reorder('UPPER(_during) DESC') }
+      scope :only_most_recent, -> { limit(1).reorder("UPPER(_during) DESC") }
     end
 
     # Reverts the parent +ActiveRecord+ instance to the saved attributes of this +version+. Raises
     # an error if the version is trashed.
     def revert!
-      raise(Error, 'Version is trashed, cannot revert') unless hoardable_operation == 'update'
+      raise(Error, "Version is trashed, cannot revert") unless hoardable_operation == "update"
 
       transaction do
         hoardable_source.tap do |reverted|
-          reverted.reload.update!(hoardable_source_attributes.without(self.class.superclass.primary_key))
+          reverted.reload.update!(
+            hoardable_source_attributes.without(self.class.superclass.primary_key, "hoardable_id")
+          )
           reverted.instance_variable_set(:@hoardable_version, self)
           reverted.run_callbacks(:reverted)
         end
@@ -96,29 +97,27 @@ module Hoardable
     # Inserts a trashed +version+ back into its parent +ActiveRecord+ table with its original
     # primary key. Raises an error if the version is not trashed.
     def untrash!
-      raise(Error, 'Version is not trashed, cannot untrash') unless hoardable_operation == 'delete'
+      raise(Error, "Version is not trashed, cannot untrash") unless hoardable_operation == "delete"
 
       transaction do
         insert_untrashed_source.tap do |untrashed|
-          untrashed.send('hoardable_client').insert_hoardable_version('insert') do
-            untrashed.instance_variable_set(:@hoardable_version, self)
-            untrashed.run_callbacks(:untrashed)
-          end
+          untrashed
+            .send("hoardable_client")
+            .insert_hoardable_version("insert") do
+              untrashed.instance_variable_set(:@hoardable_version, self)
+              untrashed.run_callbacks(:untrashed)
+            end
         end
       end
     end
 
-    DATA_KEYS.each do |key|
-      define_method("hoardable_#{key}") do
-        _data&.dig(key.to_s)
-      end
-    end
+    DATA_KEYS.each { |key| define_method("hoardable_#{key}") { _data&.dig(key.to_s) } }
 
     # Returns the +ActiveRecord+
     # {https://api.rubyonrails.org/classes/ActiveModel/Dirty.html#method-i-changes changes} that
     # were present during version creation.
     def changes
-      _data&.dig('changes')
+      _data&.dig("changes")
     end
 
     private
@@ -132,7 +131,7 @@ module Hoardable
     def hoardable_source_attributes
       attributes.without(
         (self.class.column_names - self.class.superclass.column_names) +
-        (SUPPORTS_VIRTUAL_COLUMNS ? self.class.columns.select(&:virtual?).map(&:name) : [])
+          self.class.columns.select(&:virtual?).map(&:name)
       )
     end
   end

data/lib/hoardable.rb

@@ -1,20 +1,23 @@
 # frozen_string_literal: true
 
-require 'active_record'
-require 'fx'
-require_relative 'hoardable/version'
-require_relative 'hoardable/engine'
-require_relative 'hoardable/finder_methods'
-require_relative 'hoardable/scopes'
-require_relative 'hoardable/error'
-require_relative 'hoardable/database_client'
-require_relative 'hoardable/source_model'
-require_relative 'hoardable/version_model'
-require_relative 'hoardable/model'
-require_relative 'hoardable/associations'
-require_relative 'hoardable/has_many'
-require_relative 'hoardable/belongs_to'
-require_relative 'hoardable/has_one'
-require_relative 'hoardable/has_rich_text'
-require_relative 'generators/hoardable/migration_generator'
-require_relative 'generators/hoardable/install_generator'
+require "active_record"
+require "fx"
+require_relative "hoardable/version"
+require_relative "hoardable/arel_visitors"
+require_relative "hoardable/schema_statements"
+require_relative "hoardable/schema_dumper"
+require_relative "hoardable/engine"
+require_relative "hoardable/finder_methods"
+require_relative "hoardable/scopes"
+require_relative "hoardable/error"
+require_relative "hoardable/database_client"
+require_relative "hoardable/source_model"
+require_relative "hoardable/version_model"
+require_relative "hoardable/model"
+require_relative "hoardable/associations"
+require_relative "hoardable/has_many"
+require_relative "hoardable/belongs_to"
+require_relative "hoardable/has_one"
+require_relative "hoardable/has_rich_text"
+require_relative "generators/hoardable/migration_generator"
+require_relative "generators/hoardable/install_generator"

data/sig/hoardable.rbs

@@ -1,3 +1,10 @@
+# TypeProf 0.21.9
+
+# Global variables
+$thor_runner: false
+$trace: false
+
+# Classes
 module Hoardable
   VERSION: String
   DATA_KEYS: [:meta, :whodunit, :event_uuid]
@@ -18,7 +25,7 @@ module Hoardable
   def self.at: (untyped datetime) -> untyped
   def self.logger: -> untyped
 
-  class Engine
+  class Engine < Rails::Engine
   end
 
   module FinderMethods
@@ -30,14 +37,7 @@ module Hoardable
   end
 
   module Scopes
-    TABLEOID_AREL_CONDITIONS: Proc
-    self.@klass: bot
-
-    private
-    def tableoid: -> untyped
-
-    public
-    attr_writer tableoid: untyped
+    extend ActiveSupport::Concern
   end
 
   class Error < StandardError
@@ -47,14 +47,25 @@ module Hoardable
     def initialize: (untyped source_table_name) -> void
   end
 
+  class UpdatedAtColumnMissingError < Error
+    def initialize: (untyped source_table_name) -> void
+  end
+
   class DatabaseClient
+    @generated_column_names: untyped
+    @refreshable_column_names: untyped
+
     attr_reader source_record: SourceModel
     def initialize: (SourceModel source_record) -> void
     def insert_hoardable_version: (untyped operation) -> untyped
     def source_primary_key: -> untyped
     def find_or_initialize_hoardable_event_uuid: -> untyped
     def initialize_version_attributes: (untyped operation) -> untyped
+    def has_one_find_conditions: (untyped reflection) -> Hash[String, nil]
+    def has_one_at_timestamp: -> untyped
     def source_attributes_without_primary_key: -> untyped
+    def generated_column_names: -> Array[untyped]
+    def refreshable_column_names: -> untyped
     def initialize_temporal_range: -> Range
     def initialize_hoardable_data: -> untyped
     def assign_hoardable_context: (:event_uuid | :meta | :whodunit key) -> nil
@@ -64,6 +75,7 @@ module Hoardable
   end
 
   module SourceModel
+    extend ActiveSupport::Concern
     include Scopes
     @hoardable_client: DatabaseClient
 
@@ -84,6 +96,8 @@ module Hoardable
   end
 
   module VersionModel
+    extend ActiveSupport::Concern
+
     def revert!: -> untyped
     def untrash!: -> untyped
     def changes: -> untyped
@@ -94,10 +108,10 @@ module Hoardable
 
     public
     def version_class: -> VersionModel
-    def scope_attributes: -> untyped
   end
 
   module Model
+    extend ActiveSupport::Concern
     include VersionModel
     include SourceModel
     include Associations
@@ -108,6 +122,7 @@ module Hoardable
   end
 
   module Associations
+    extend ActiveSupport::Concern
     include HasRichText
     include BelongsTo
     include HasOne
@@ -115,6 +130,8 @@ module Hoardable
   end
 
   module HasMany
+    extend ActiveSupport::Concern
+
     def has_many: (*untyped args) -> untyped
 
     module HasManyExtension
@@ -129,6 +146,8 @@ module Hoardable
   end
 
   module BelongsTo
+    extend ActiveSupport::Concern
+
     def belongs_to: (*untyped args) -> nil
 
     private
@@ -136,25 +155,31 @@ module Hoardable
   end
 
   module HasOne
+    extend ActiveSupport::Concern
+
     def has_one: (*untyped args) -> nil
   end
 
   module HasRichText
+    extend ActiveSupport::Concern
+
     def has_rich_text: (untyped name, ?encrypted: false, ?hoardable: false) -> nil
   end
 
-  class MigrationGenerator
+  class MigrationGenerator < ActiveRecord::Generators::Base
     @singularized_table_name: untyped
 
     def create_versions_table: -> untyped
+    def create_triggers: -> {versions_prevent_update: untyped, set_hoardable_id: untyped, prevent_update_hoardable_id: untyped}
     def foreign_key_type: -> String
     def primary_key: -> String
     def singularized_table_name: -> untyped
   end
 
-  class InstallGenerator
+  class InstallGenerator < Rails::Generators::Base
     def create_initializer_file: -> untyped
     def create_migration_file: -> untyped
+    def create_functions: -> Array[String]
     def self.next_migration_number: (untyped dir) -> untyped
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hoardable
 version: !ruby/object:Gem::Version
-  version: 0.14.2
+  version: 0.16.0
 platform: ruby
 authors:
 - justin talbott
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-22 00:00:00.000000000 Z
+date: 2024-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,60 +16,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '8'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '8'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '8'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '8'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '8'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '8'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: fx
   requirement: !ruby/object:Gem::Requirement
@@ -117,7 +99,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rubocop.yml"
+- ".streerc"
 - ".tool-versions"
 - CHANGELOG.md
 - Gemfile
@@ -135,6 +117,7 @@ files:
 - lib/generators/hoardable/triggers/set_hoardable_id.sql
 - lib/generators/hoardable/triggers/versions_prevent_update.sql
 - lib/hoardable.rb
+- lib/hoardable/arel_visitors.rb
 - lib/hoardable/associations.rb
 - lib/hoardable/belongs_to.rb
 - lib/hoardable/database_client.rb
@@ -147,6 +130,8 @@ files:
 - lib/hoardable/has_rich_text.rb
 - lib/hoardable/model.rb
 - lib/hoardable/rich_text.rb
+- lib/hoardable/schema_dumper.rb
+- lib/hoardable/schema_statements.rb
 - lib/hoardable/scopes.rb
 - lib/hoardable/source_model.rb
 - lib/hoardable/version.rb
@@ -167,14 +152,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
 summary: An ActiveRecord extension for versioning and soft-deletion of records in

data/.rubocop.yml

@@ -1,21 +0,0 @@
-AllCops:
-  TargetRubyVersion: 2.7
-  NewCops: enable
-  SuggestExtensions: false
-
-Layout/LineLength:
-  Max: 120
-
-Metrics/ClassLength:
-  Exclude:
-    - 'test/**/*.rb'
-
-Metrics/BlockLength:
-  Exclude:
-    - 'test/**/*.rb'
-
-Style/DocumentDynamicEvalDefinition:
-  Enabled: false
-
-Naming/PredicateName:
-  Enabled: false