hoardable 0.17.0 → 0.18.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 888659d9c6655e69c72fd8cf5b10b3697d5a81f432a44c8fa39984a05f4b23d9
-  data.tar.gz: ba850c1bf2363dd965a6e7780435d4feaf2ad417f2712f5f4635398ad5e9913d
+  metadata.gz: fa8fcbadc193fbfcbdb4efa5f1030c2ff5a6be1da19b672136ca0ce5a4bfd846
+  data.tar.gz: 57b7f6fcbe331e181be56a4e8d284bed7ba322c9cb42280917a684e99ae53c0f
 SHA512:
-  metadata.gz: 851d039e113df11834b18bb69edf786ba1d91598e408a45fab6ae7bb65efbc37264e4b803b8c8335f6839784f964f20d29c4c94b02aa6b994a21f3fd346ec162
-  data.tar.gz: 022a7ada38d996f8116a7ab8ed3d671e29055a8c75cc4155789ea3be135d87f24625ab67311c22f3b89b172320a973cbf203586407c6788750443bec90b461be
+  metadata.gz: f4adc32f25af165fc80a53b0982b392dc4878ff3b6afcf1f9f892d75acac859c3b8bf1d9a292e9578da25926b349e380e92dd2d06e8bcb683239e0a7b4ddb95e
+  data.tar.gz: a076911d80e94a764992716188f35dfe5893662e908d40d7f2b7c48305d3188554a494f5c0fd6d598161a16b52abd53a392cf85e29d927535624d25de3ae3b2a

data/README.md

@@ -41,7 +41,6 @@ Include `Hoardable::Model` into an ActiveRecord model you would like to hoard ve
 ```ruby
 class Post < ActiveRecord::Base
   include Hoardable::Model
-  ...
 end
 ```
 
@@ -328,6 +327,14 @@ end
 
 Model-level configuration overrides global configuration.
 
+### Single Table Inheritance
+
+Hoardable works for [Single Table
+Inheritance](https://guides.rubyonrails.org/association_basics.html#single-table-inheritance-sti). You
+will need to include `Hoardable::Model` in each child model you'd like to version, as that is what
+generates the model's version class. The migration generator only needs to be run for the parent
+model, as the versions will similarly be stored in a single table.
+
 ## Relationships
 
 ### `belongs_to`

data/lib/generators/hoardable/migration_generator.rb

@@ -45,21 +45,24 @@ module Hoardable
         "hoardable_set_hoardable_id_from_#{primary_key}"
       end
 
+      def klass
+        @klass ||= class_name.singularize.constantize
+      end
+
       def table_name
-        class_name.singularize.constantize.table_name
+        klass.table_name
       rescue StandardError
         super
       end
 
       def foreign_key_type
-        options[:foreign_key_type] ||
-          class_name.singularize.constantize.columns.find { |col| col.name == primary_key }.sql_type
+        options[:foreign_key_type] || klass.columns.find { |col| col.name == primary_key }.sql_type
       rescue StandardError
         "bigint"
       end
 
       def primary_key
-        options[:primary_key] || class_name.singularize.constantize.primary_key
+        options[:primary_key] || klass.primary_key
       rescue StandardError
         "id"
       end

data/lib/generators/hoardable/templates/migration.rb.erb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class Create<%= class_name.singularize.delete(':') %>Versions < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+class Create<%= singularized_table_name.classify %>Versions < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
   def change
     add_column :<%= table_name %>, :hoardable_id, :<%= foreign_key_type %>
     add_index :<%= table_name %>, :hoardable_id

data/lib/hoardable/arel_crud.rb

@@ -0,0 +1,17 @@
+module Hoardable
+  # Monkey-patches an internal Arel method to ensure that bulk UPDATE's always operate
+  # directly on the root table by injecting the ONLY keyword.
+  module ArelCrud
+    def compile_update(*args)
+      um = super(*args)
+
+      if source.left.instance_variable_get(:@klass).in?(Hoardable::REGISTRY)
+        return um.table(Arel.sql("ONLY #{source.left.name}"))
+      end
+
+      um
+    end
+  end
+end
+
+Arel::SelectManager.prepend Hoardable::ArelCrud

data/lib/hoardable/has_many.rb

@@ -26,16 +26,21 @@ module Hoardable
     class_methods do
       def has_many(*args, &block)
         options = args.extract_options!
-        options[:extend] = Array(options[:extend]).push(HasManyExtension) if options.delete(
-          :hoardable
-        )
+        hoardable_option = options.delete(:hoardable)
+        options[:extend] = Array(options[:extend]).push(HasManyExtension) if hoardable_option
+
         super(*args, **options, &block)
+        return unless hoardable_option
 
         # This hack is needed to force Rails to not use any existing method cache so that the
-        # {HasManyExtension} scope is always used.
+        # {HasManyExtension} scope is always used when using {Hoardable.at}.
         class_eval <<-RUBY, __FILE__, __LINE__ + 1
           def #{args.first}
-            super.extending
+            if Hoardable.instance_variable_get("@at")
+              super.extending
+            else
+              super
+            end
           end
         RUBY
       end

data/lib/hoardable/model.rb

@@ -50,12 +50,14 @@ module Hoardable
       define_model_callbacks :versioned, only: :after
       define_model_callbacks :reverted, only: :after
       define_model_callbacks :untrashed, only: :after
+    end
 
+    def self.included(base)
       TracePoint
         .new(:end) do |trace|
-          next unless self == trace.self
+          next unless base == trace.self
 
-          full_version_class_name = "#{name}#{VERSION_CLASS_SUFFIX}"
+          full_version_class_name = "#{base.name}#{VERSION_CLASS_SUFFIX}"
           if (namespace_match = full_version_class_name.match(/(.*)::(.*)/))
             object_namespace = namespace_match[1].constantize
             version_class_name = namespace_match[2]
@@ -64,10 +66,10 @@ module Hoardable
             version_class_name = full_version_class_name
           end
           unless Object.const_defined?(full_version_class_name)
-            object_namespace.const_set(version_class_name, Class.new(self) { include VersionModel })
+            object_namespace.const_set(version_class_name, Class.new(base) { include VersionModel })
           end
-          include SourceModel
-          REGISTRY.add(self)
+          base.class_eval { include SourceModel }
+          REGISTRY.add(base)
 
           trace.disable
         end

data/lib/hoardable/scopes.rb

@@ -9,13 +9,20 @@ module Hoardable
     included do
       # 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.
+      # the code in a `Hoardable.at(datetime)` block. When this is a version class that is an STI
+      # model, also scope to them.
       default_scope do
-        if (hoardable_at = Hoardable.instance_variable_get("@at"))
-          at(hoardable_at)
-        else
-          exclude_versions
-        end
+        scope =
+          (
+            if (hoardable_at = Hoardable.instance_variable_get("@at"))
+              at(hoardable_at)
+            else
+              exclude_versions
+            end
+          )
+        next scope unless klass == version_class && "type".in?(column_names)
+
+        scope.where(type: superclass.sti_name)
       end
 
       # @!scope class

data/lib/hoardable/source_model.rb

@@ -40,20 +40,24 @@ module Hoardable
       end
 
       before_destroy(if: HOARDABLE_CALLBACKS_ENABLED, unless: HOARDABLE_SAVE_TRASH) do
-        versions.delete_all
+        versions.extending.delete_all
       end
 
       after_commit { hoardable_client.unset_hoardable_version_and_event_uuid }
+    end
 
-      # Returns all +versions+ in ascending order of their temporal timeframes.
-      has_many(
-        :versions,
-        -> { order("UPPER(_during) ASC") },
-        dependent: nil,
-        class_name: version_class.to_s,
-        inverse_of: :hoardable_source,
-        foreign_key: :hoardable_id
-      )
+    def self.included(base)
+      base.class_eval do
+        # Returns all +versions+ in ascending order of their temporal timeframes.
+        has_many(
+          :versions,
+          -> { order("UPPER(_during) ASC") },
+          dependent: nil,
+          class_name: version_class.to_s,
+          inverse_of: :hoardable_source,
+          foreign_key: :hoardable_id
+        )
+      end
     end
 
     # Returns a boolean of whether the record is actually a trashed +version+ cast as an instance of the

data/lib/hoardable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Hoardable
-  VERSION = "0.17.0"
+  VERSION = "0.18.2"
 end

data/lib/hoardable/version_model.rb

@@ -24,6 +24,9 @@ module Hoardable
         class_name: superclass.model_name
       )
 
+      # disable STI on versions tables
+      self.inheritance_column = :_
+
       self.table_name = "#{table_name.singularize}#{VERSION_TABLE_SUFFIX}"
 
       alias_method :readonly?, :persisted?

data/lib/hoardable.rb

@@ -4,6 +4,7 @@ require "active_record"
 require "fx"
 require_relative "hoardable/version"
 require_relative "hoardable/arel_visitors"
+require_relative "hoardable/arel_crud"
 require_relative "hoardable/schema_statements"
 require_relative "hoardable/schema_dumper"
 require_relative "hoardable/engine"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hoardable
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.18.2
 platform: ruby
 authors:
 - justin talbott
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-19 00:00:00.000000000 Z
+date: 2025-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -17,6 +17,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -31,6 +37,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -38,6 +47,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -45,6 +57,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -52,6 +67,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: fx
   requirement: !ruby/object:Gem::Requirement
@@ -100,7 +118,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".streerc"
-- ".tool-versions"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -117,6 +134,7 @@ files:
 - lib/generators/hoardable/triggers/set_hoardable_id.sql
 - lib/generators/hoardable/triggers/versions_prevent_update.sql
 - lib/hoardable.rb
+- lib/hoardable/arel_crud.rb
 - lib/hoardable/arel_visitors.rb
 - lib/hoardable/associations.rb
 - lib/hoardable/belongs_to.rb
@@ -159,7 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: An ActiveRecord extension for versioning and soft-deletion of records in

data/.tool-versions

@@ -1,2 +0,0 @@
-ruby 3.3.0
-postgres 16.1