hoardable 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dff71dd2ebbebaeedfdc9d6fdd8c56c8faaa5505814cfe41c146c4a565375ff1
-  data.tar.gz: 6693f3634541bc8308ed5b4329d69851d971df1cec2b50e842fa9332c62425b6
+  metadata.gz: 1cd77fbd3d35df59423ba95f7286703ae0d3b0f78bd9097b3574c713c38aa4c7
+  data.tar.gz: d5971e9daf59a9fa5343c13e389b20fc5b6ff193b398d05c958f34dfd056d0cb
 SHA512:
-  metadata.gz: ec2a9df9254cf3623f4fffb0516e99ec30a46ec6496ad0d5e555d4a3ce8324fa81d1880036f42aeb4bbbee136957479f283ccab4b8fb3f2847122bd597483889
-  data.tar.gz: 25a5040c6dc5b91b0b54020657e436aa775cf2211b56fecf1b277e36c11041b55f5a29861000503d5388a9a3d0280a8ccca99c052a2dc82a45abb8f5c98bb50e
+  metadata.gz: 5de03adf485f38e3ee3a24999bf770d92792404894529a5317f9788d15b784c0bcd9aa28b3d2966340a1244296cdc7b4ebe6fdccd6791172b44ca498c4bf5fca
+  data.tar.gz: a39bd22b66c727ec791e704ec3b24592c068dd2eb29ae0fa7d70a440073bd6d635fd7f24f12d3ba34bf05976b311bab9ec6a5a6fdf9f9069311347d89ae8f8c0

data/CHANGELOG.md

@@ -1,10 +1,36 @@
 ## [Unreleased]
 
+- Stability is coming.
+
+## [0.8.0] - 2022-10-01
+
+- **Breaking Change** - Due to the performance benefit of using `insert` for database injection of
+  versions, and a personal opinion that only an `after_versioned` hook might be needed, the
+  `before_versioned` and `around_versioned` ActiveRecord hooks are removed.
+
+- **Breaking Change** - Another side effect of the performance benefit gained by using `insert` is
+  that a source model will need to be reloaded before a call to `versions` on it can access the
+  latest version after an `update` on the source record.
+
+- **Breaking Change** - Previously the inherited `_versions` tables did not have a unique index on
+  the ID column, though it still pulled from the same sequence as the parent table. Prior to version
+  0.4.0 though, it was possible to have multiple trashed versions with the same ID. Adding unique
+  indexes to version tables prior to version 0.4.0 could result in issues.
+
+## [0.7.0] - 2022-09-29
+
+- **Breaking Change** - Continuing along with the change below, the `foreign_key` on the `_versions`
+  tables is now changed to `hoardable_source_id` instead of the i18n model name dervied foreign key.
+  The intent is to never leave room for conflict of foreign keys for existing relationships. This
+  can be resolved by renaming the foreign key columns from their i18n model name derived column
+  names to `hoardable_source_id`, i.e. `rename_column :post_versions, :post_id, :hoardable_source_id`.
+
 ## [0.6.0] - 2022-09-28
 
 - **Breaking Change** - Previously, a source model would `has_many :versions` with an inverse
-  relationship of the i18n interpreted name of the source model. Now it simply `has_many :versions,
-  inverse_of :hoardable_source` to not potentially conflict with previously existing relationships.
+  relationship based on the i18n interpreted name of the source model. Now it simply `has_many
+  :versions, inverse_of :hoardable_source` to not potentially conflict with previously existing
+  relationships.
 
 ## [0.5.0] - 2022-09-25
 

data/Gemfile

@@ -2,6 +2,7 @@
 
 source 'https://rubygems.org'
 
+gem 'benchmark-ips', '~> 2.10'
 gem 'debug', '~> 1.6'
 gem 'minitest', '~> 5.0'
 gem 'rake', '~> 13.0'

data/README.md

@@ -76,7 +76,7 @@ $ irb
 >> Post
 => Post(id: integer, body: text, user_id: integer, created_at: datetime)
 >> PostVersion
-=> PostVersion(id: integer, body: text, user_id: integer, created_at: datetime, _data: jsonb, _during: tsrange, post_id: integer)
+=> PostVersion(id: integer, body: text, user_id: integer, created_at: datetime, _data: jsonb, _during: tsrange, hoardable_source_id: integer)
 ```
 
 A `Post` now `has_many :versions`. With the default configuration, whenever an update and deletion
@@ -86,7 +86,7 @@ of a `Post` occurs, a version is created:
 post = Post.create!(title: "Title")
 post.versions.size # => 0
 post.update!(title: "Revised Title")
-post.versions.size # => 1
+post.reload.versions.size # => 1
 post.versions.first.title # => "Title"
 post.destroy!
 post.trashed? # true
@@ -102,7 +102,7 @@ If you ever need to revert to a specific version, you can call `version.revert!`
 ``` ruby
 post = Post.create!(title: "Title")
 post.update!(title: "Whoops")
-post.versions.last.revert!
+post.reload.versions.last.revert!
 post.title # => "Title"
 ```
 
@@ -134,7 +134,7 @@ If you want to look-up the version of a record at a specific time, you can use t
 ```ruby
 post.at(1.day.ago) # => #<PostVersion>
 # or you can use the scope on the version model class
-PostVersion.at(1.day.ago).find_by(post_id: post.id) # => #<PostVersion>
+PostVersion.at(1.day.ago).find_by(hoardable_source_id: post.id) # => #<PostVersion>
 ```
 
 The source model class also has an `.at` method:
@@ -182,7 +182,7 @@ Hoardable.whodunit = -> { Current.user&.id }
 # somewhere in your app code
 Current.user = User.find(123)
 post.update!(status: 'live')
-post.versions.last.hoardable_whodunit # => 123
+post.reload.versions.last.hoardable_whodunit # => 123
 ```
 
 You can also set this context manually as well, just remember to clear them afterwards.
@@ -191,7 +191,7 @@ You can also set this context manually as well, just remember to clear them afte
 Hoardable.note = "reverting due to accidental deletion"
 post.update!(title: "We’re back!")
 Hoardable.note = nil
-post.versions.last.hoardable_note # => "reverting due to accidental deletion"
+post.reload.versions.last.hoardable_note # => "reverting due to accidental deletion"
 ```
 
 A more useful pattern is to use `Hoardable.with` to set the context around a block. A good example
@@ -225,9 +225,9 @@ version.hoardable_event_uuid
 
 ### Model Callbacks
 
-Sometimes you might want to do something with a version before or after it gets inserted to the
-database. You can access it in `before/after/around_versioned` callbacks on the source record as
-`hoardable_version`. These happen around `.save`, which is enclosed in an ActiveRecord transaction.
+Sometimes you might want to do something with a version after it gets inserted to the database. You
+can access it in `after_versioned` callbacks on the source record as `hoardable_version`. These
+happen within `ActiveRecord`’s `.save`, which is enclosed in an ActiveRecord transaction.
 
 There are also `after_reverted` and `after_untrashed` callbacks available as well, which are called
 on the source record after a version is reverted or untrashed.
@@ -235,14 +235,14 @@ on the source record after a version is reverted or untrashed.
 ```ruby
 class User
   include Hoardable::Model
-  before_versioned :sanitize_version
+  after_versioned :track_versioned_event
   after_reverted :track_reverted_event
   after_untrashed :track_untrashed_event
 
   private
 
-  def sanitize_version
-    hoardable_version.sanitize_password
+  def track_versioned_event
+    track_event(:user_versioned, hoardable_version)
   end
 
   def track_reverted_event
@@ -338,14 +338,13 @@ class Post < ActiveRecord::Base
     Comment
       .version_class
       .trashed
-      .where(post_id: id)
       .with_hoardable_event_uuid(hoardable_event_uuid)
       .find_each(&:untrash!)
   end
 end
 ```
 
-If there are models that might be related to versions that are trashed or otherwise, and/or might
+If there are models that might be related to versions that are trashed or otherwise, and/or might be
 trashed themselves, you can bypass the inherited tables query handling altogether by using the
 `return_everything` configuration variable in `Hoardable.with`. This will ensure that you always see
 all records, including update and trashed versions.

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

@@ -8,11 +8,12 @@ class Create<%= class_name.singularize %>Versions < ActiveRecord::Migration[<%=
       t.tsrange :_during, null: false
       t.uuid :_event_uuid, null: false, index: true
       t.enum :_operation, enum_type: 'hoardable_operation', null: false, index: true
-      t.<%= foreign_key_type %> :<%= singularized_table_name %>_id, null: false, index: true
+      t.<%= foreign_key_type %> :hoardable_source_id, null: false, index: true
     end
+    add_index(:<%= singularized_table_name %>_versions, :id, unique: true)
     add_index(
       :<%= singularized_table_name %>_versions,
-      %i[_during <%= singularized_table_name %>_id],
+      %i[_during hoardable_source_id],
       name: 'idx_<%= singularized_table_name %>_versions_temporally'
     )
   end

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

@@ -23,11 +23,12 @@ class Create<%= class_name.singularize %>Versions < ActiveRecord::Migration[<%=
       t.tsrange :_during, null: false
       t.uuid :_event_uuid, null: false, index: true
       t.column :_operation, :hoardable_operation, null: false, index: true
-      t.<%= foreign_key_type %> :<%= singularized_table_name %>_id, null: false, index: true
+      t.<%= foreign_key_type %> :hoardable_source_id, null: false, index: true
     end
+    add_index(:<%= singularized_table_name %>_versions, :id, unique: true)
     add_index(
       :<%= singularized_table_name %>_versions,
-      %i[_during <%= singularized_table_name %>_id],
+      %i[_during hoardable_source_id],
       name: 'idx_<%= singularized_table_name %>_versions_temporally'
     )
   end

data/lib/hoardable/associations.rb

@@ -17,9 +17,9 @@ module Hoardable
 
         define_method(trashable_relationship_name) do
           source_reflection = self.class.reflections[name.to_s]
-          version_class = source_reflection.klass.version_class
+          version_class = source_reflection.version_class
           version_class.trashed.only_most_recent.find_by(
-            version_class.hoardable_source_foreign_key => source_reflection.foreign_key
+            hoardable_source_id: source_reflection.foreign_key
           )
         end
 

data/lib/hoardable/database_client.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Hoardable
+  # This is a private service class that manages the insertion of {VersionModel}s into the
+  # PostgreSQL database.
+  class DatabaseClient
+    attr_reader :source_record
+
+    def initialize(source_record)
+      @source_record = source_record
+    end
+
+    delegate :version_class, to: :source_record
+
+    def insert_hoardable_version(operation, &block)
+      version = version_class.insert(initialize_version_attributes(operation), returning: :id)
+      version_id = version[0]['id']
+      source_record.instance_variable_set('@hoardable_version', version_class.find(version_id))
+      source_record.run_callbacks(:versioned, &block)
+    end
+
+    def find_or_initialize_hoardable_event_uuid
+      Thread.current[:hoardable_event_uuid] ||= ActiveRecord::Base.connection.query('SELECT gen_random_uuid();')[0][0]
+    end
+
+    def initialize_version_attributes(operation)
+      source_record.attributes_before_type_cast.without('id').merge(
+        source_record.changes.transform_values { |h| h[0] },
+        {
+          'hoardable_source_id' => source_record.id,
+          '_event_uuid' => find_or_initialize_hoardable_event_uuid,
+          '_operation' => operation,
+          '_data' => initialize_hoardable_data.merge(changes: source_record.changes),
+          '_during' => initialize_temporal_range
+        }
+      )
+    end
+
+    def initialize_temporal_range
+      ((previous_temporal_tsrange_end || hoardable_source_epoch)..Time.now.utc)
+    end
+
+    def initialize_hoardable_data
+      DATA_KEYS.to_h do |key|
+        [key, assign_hoardable_context(key)]
+      end
+    end
+
+    def assign_hoardable_context(key)
+      return nil if (value = Hoardable.public_send(key)).nil?
+
+      value.is_a?(Proc) ? value.call : value
+    end
+
+    def unset_hoardable_version_and_event_uuid
+      source_record.instance_variable_set('@hoardable_version', nil)
+      return if source_record.class.connection.transaction_open?
+
+      Thread.current[:hoardable_event_uuid] = nil
+    end
+
+    def previous_temporal_tsrange_end
+      source_record.versions.only_most_recent.pluck('_during').first&.end
+    end
+
+    def hoardable_source_epoch
+      if source_record.class.column_names.include?('created_at')
+        source_record.created_at
+      else
+        maybe_warn_about_missing_created_at_column
+        Time.at(0).utc
+      end
+    end
+
+    def maybe_warn_about_missing_created_at_column
+      return unless source_record.class.hoardable_config[:warn_on_missing_created_at_column]
+
+      source_table_name = source_record.class.table_name
+      Hoardable.logger.info(
+        <<~LOG
+          '#{source_table_name}' does not have a 'created_at' column, so the first version’s temporal period
+          will begin at the unix epoch instead. Add a 'created_at' column to '#{source_table_name}'
+          or set 'Hoardable.warn_on_missing_created_at_column = false' to disable this message.
+        LOG
+      )
+    end
+  end
+  private_constant :DatabaseClient
+end

data/lib/hoardable/model.rb

@@ -46,7 +46,7 @@ module Hoardable
 
     included do
       include Associations
-      define_model_callbacks :versioned
+      define_model_callbacks :versioned, only: :after
       define_model_callbacks :reverted, only: :after
       define_model_callbacks :untrashed, only: :after
 

data/lib/hoardable/source_model.rb

@@ -27,25 +27,26 @@ module Hoardable
       include Tableoid
 
       around_update(if: [HOARDABLE_CALLBACKS_ENABLED, HOARDABLE_VERSION_UPDATES]) do |_, block|
-        hoardable_source_service.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_source_service.insert_hoardable_version('delete', &block)
+        hoardable_client.insert_hoardable_version('delete', &block)
       end
 
       before_destroy(if: HOARDABLE_CALLBACKS_ENABLED, unless: HOARDABLE_SAVE_TRASH) do
         versions.delete_all(:delete_all)
       end
 
-      after_commit { hoardable_source_service.unset_hoardable_version_and_event_uuid }
+      after_commit { hoardable_client.unset_hoardable_version_and_event_uuid }
 
       # 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
+        inverse_of: :hoardable_source,
+        foreign_key: :hoardable_source_id
       )
 
       # @!scope class
@@ -56,7 +57,7 @@ module Hoardable
       # +datetime+ or +time+, all cast as instances of the source model.
       scope :at, lambda { |datetime|
         include_versions.where(id: version_class.at(datetime).select('id')).or(
-          where.not(id: version_class.select(version_class.hoardable_source_foreign_key).where(DURING_QUERY, datetime))
+          where.not(id: version_class.select(:hoardable_source_id).where(DURING_QUERY, datetime))
         )
       }
     end
@@ -85,68 +86,15 @@ module Hoardable
     def revert_to!(datetime)
       return unless (version = at(datetime))
 
-      version.is_a?(self.class.version_class) ? version.revert! : self
+      version.is_a?(version_class) ? version.revert! : self
     end
 
-    private
-
-    def hoardable_source_service
-      @hoardable_source_service ||= Service.new(self)
-    end
-
-    # This is a private service class that manages the insertion of {VersionModel}s for a
-    # {SourceModel} into the PostgreSQL database.
-    class Service
-      attr_reader :source_model
-
-      def initialize(source_model)
-        @source_model = source_model
-      end
-
-      def insert_hoardable_version(operation)
-        source_model.instance_variable_set('@hoardable_version', initialize_hoardable_version(operation))
-        source_model.run_callbacks(:versioned) do
-          yield if block_given?
-          source_model.hoardable_version.save(validate: false, touch: false)
-        end
-      end
-
-      def find_or_initialize_hoardable_event_uuid
-        Thread.current[:hoardable_event_uuid] ||= ActiveRecord::Base.connection.query('SELECT gen_random_uuid();')[0][0]
-      end
+    delegate :version_class, to: :class
 
-      def initialize_hoardable_version(operation)
-        source_model.versions.new(
-          source_model.attributes_before_type_cast.without('id').merge(
-            source_model.changes.transform_values { |h| h[0] },
-            {
-              _event_uuid: find_or_initialize_hoardable_event_uuid,
-              _operation: operation,
-              _data: initialize_hoardable_data.merge(changes: source_model.changes)
-            }
-          )
-        )
-      end
-
-      def initialize_hoardable_data
-        DATA_KEYS.to_h do |key|
-          [key, assign_hoardable_context(key)]
-        end
-      end
-
-      def assign_hoardable_context(key)
-        return nil if (value = Hoardable.public_send(key)).nil?
-
-        value.is_a?(Proc) ? value.call : value
-      end
-
-      def unset_hoardable_version_and_event_uuid
-        source_model.instance_variable_set('@hoardable_version', nil)
-        return if source_model.class.connection.transaction_open?
+    private
 
-        Thread.current[:hoardable_event_uuid] = nil
-      end
+    def hoardable_client
+      @hoardable_client ||= DatabaseClient.new(self)
     end
-    private_constant :Service
   end
 end

data/lib/hoardable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Hoardable
-  VERSION = '0.6.0'
+  VERSION = '0.8.0'
 end

data/lib/hoardable/version_model.rb

@@ -7,9 +7,11 @@ module Hoardable
     extend ActiveSupport::Concern
 
     class_methods do
-      # Returns the foreign column that holds the reference to the source model of the version.
-      def hoardable_source_foreign_key
-        @hoardable_source_foreign_key ||= "#{superclass.model_name.i18n_key}_id"
+      # 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
 
@@ -18,8 +20,7 @@ module Hoardable
       belongs_to(
         :hoardable_source,
         inverse_of: :versions,
-        class_name: superclass.model_name,
-        foreign_key: hoardable_source_foreign_key
+        class_name: superclass.model_name
       )
 
       self.table_name = "#{table_name.singularize}#{VERSION_TABLE_SUFFIX}"
@@ -29,8 +30,6 @@ module Hoardable
       alias_attribute :hoardable_event_uuid, :_event_uuid
       alias_attribute :hoardable_during, :_during
 
-      before_create { hoardable_version_service.assign_temporal_tsrange }
-
       # @!scope class
       # @!method trashed
       # @return [ActiveRecord<Object>]
@@ -79,7 +78,7 @@ module Hoardable
 
       transaction do
         hoardable_source.tap do |reverted|
-          reverted.update!(hoardable_version_service.hoardable_source_attributes.without('id'))
+          reverted.update!(hoardable_source_attributes.without('id'))
           reverted.instance_variable_set(:@hoardable_version, self)
           reverted.run_callbacks(:reverted)
         end
@@ -92,10 +91,11 @@ module Hoardable
       raise(Error, 'Version is not trashed, cannot untrash') unless hoardable_operation == 'delete'
 
       transaction do
-        hoardable_version_service.insert_untrashed_source.tap do |untrashed|
-          untrashed.send('hoardable_source_service').insert_hoardable_version('insert')
-          untrashed.instance_variable_set(:@hoardable_version, self)
-          untrashed.run_callbacks(:untrashed)
+        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
         end
       end
     end
@@ -115,70 +115,22 @@ module Hoardable
 
     # Returns the foreign reference that represents the source model of the version.
     def hoardable_source_foreign_id
-      @hoardable_source_foreign_id ||= public_send(hoardable_source_foreign_key)
+      @hoardable_source_foreign_id ||= public_send(:hoardable_source_id)
     end
 
-    delegate :hoardable_source_foreign_key, to: :class
+    private
 
-    def hoardable_version_service
-      @hoardable_version_service ||= Service.new(self)
+    def insert_untrashed_source
+      superscope = self.class.superclass.unscoped
+      superscope.insert(hoardable_source_attributes.merge('id' => hoardable_source_foreign_id))
+      superscope.find(hoardable_source_foreign_id)
     end
 
-    # This is a private service class that manages the construction of {VersionModel} attributes and
-    # untrashing / re-insertion into the {SourceModel} table.
-    class Service
-      attr_reader :version_model
-
-      def initialize(version_model)
-        @version_model = version_model
-      end
-
-      delegate :hoardable_source_foreign_id, :hoardable_source_foreign_key, :hoardable_source, to: :version_model
-
-      def insert_untrashed_source
-        superscope = version_model.class.superclass.unscoped
-        superscope.insert(hoardable_source_attributes.merge('id' => hoardable_source_foreign_id))
-        superscope.find(hoardable_source_foreign_id)
-      end
-
-      def hoardable_source_attributes
-        @hoardable_source_attributes ||=
-          version_model
-          .attributes_before_type_cast
-          .without(hoardable_source_foreign_key)
-          .reject { |k, _v| k.start_with?('_') }
-      end
-
-      def previous_temporal_tsrange_end
-        hoardable_source.versions.only_most_recent.pluck('_during').first&.end
-      end
-
-      def hoardable_source_epoch
-        if hoardable_source.class.column_names.include?('created_at')
-          hoardable_source.created_at
-        else
-          maybe_warn_about_missing_created_at_column
-          Time.at(0).utc
-        end
-      end
-
-      def assign_temporal_tsrange
-        version_model._during = ((previous_temporal_tsrange_end || hoardable_source_epoch)..Time.now.utc)
-      end
-
-      def maybe_warn_about_missing_created_at_column
-        return unless hoardable_source.class.hoardable_config[:warn_on_missing_created_at_column]
-
-        source_table_name = hoardable_source.class.table_name
-        Hoardable.logger.info(
-          <<~LOG
-            '#{source_table_name}' does not have a 'created_at' column, so the first version’s temporal period
-            will begin at the unix epoch instead. Add a 'created_at' column to '#{source_table_name}'
-            or set 'Hoardable.warn_on_missing_created_at_column = false' to disable this message.
-          LOG
-        )
-      end
+    def hoardable_source_attributes
+      @hoardable_source_attributes ||=
+        attributes_before_type_cast
+        .without('hoardable_source_id')
+        .reject { |k, _v| k.start_with?('_') }
     end
-    private_constant :Service
   end
 end

data/lib/hoardable.rb

@@ -4,6 +4,7 @@ require_relative 'hoardable/version'
 require_relative 'hoardable/hoardable'
 require_relative 'hoardable/tableoid'
 require_relative 'hoardable/error'
+require_relative 'hoardable/database_client'
 require_relative 'hoardable/source_model'
 require_relative 'hoardable/version_model'
 require_relative 'hoardable/model'

data/sig/hoardable.rbs

@@ -28,57 +28,52 @@ module Hoardable
   class Error < StandardError
   end
 
+  class DatabaseClient
+    attr_reader source_model: SourceModel
+    def initialize: (SourceModel source_model) -> void
+    def insert_hoardable_version: (untyped operation) -> untyped
+    def find_or_initialize_hoardable_event_uuid: -> untyped
+    def initialize_version_attributes: (untyped operation) -> untyped
+    def initialize_temporal_range: -> Range
+    def initialize_hoardable_data: -> untyped
+    def assign_hoardable_context: (:event_uuid | :meta | :note | :whodunit key) -> nil
+    def unset_hoardable_version_and_event_uuid: -> nil
+    def previous_temporal_tsrange_end: -> untyped
+    def hoardable_source_epoch: -> Time
+    def maybe_warn_about_missing_created_at_column: -> nil
+  end
+
   module SourceModel
     include Tableoid
-    @hoardable_source_service: Service
+    @hoardable_client: DatabaseClient
 
-    attr_reader hoardable_version: nil
+    attr_reader hoardable_version: untyped
     def trashed?: -> untyped
     def at: (untyped datetime) -> SourceModel
     def revert_to!: (untyped datetime) -> SourceModel?
 
     private
-    def hoardable_source_service: -> Service
+    def hoardable_client: -> DatabaseClient
 
     public
     def version_class: -> untyped
-
-    class Service
-      attr_reader source_model: SourceModel
-      def initialize: (SourceModel source_model) -> void
-      def insert_hoardable_version: (untyped operation) -> untyped
-      def find_or_initialize_hoardable_event_uuid: -> untyped
-      def initialize_hoardable_version: (untyped operation) -> untyped
-      def initialize_hoardable_data: -> untyped
-      def assign_hoardable_context: (:event_uuid | :meta | :note | :whodunit key) -> nil
-      def unset_hoardable_version_and_event_uuid: -> nil
-    end
   end
 
   module VersionModel
     @hoardable_source_foreign_id: untyped
-    @hoardable_source_foreign_key: String
-    @hoardable_version_service: Service
+    @hoardable_source_attributes: untyped
 
     def revert!: -> untyped
     def untrash!: -> untyped
     def changes: -> untyped
     def hoardable_source_foreign_id: -> untyped
-    def hoardable_version_service: -> Service
-    def hoardable_source_foreign_key: -> String
-
-    class Service
-      @hoardable_source_attributes: untyped
-
-      attr_reader version_model: VersionModel
-      def initialize: (VersionModel version_model) -> void
-      def insert_untrashed_source: -> untyped
-      def hoardable_source_attributes: -> untyped
-      def previous_temporal_tsrange_end: -> untyped
-      def hoardable_source_epoch: -> Time
-      def assign_temporal_tsrange: -> Range
-      def maybe_warn_about_missing_created_at_column: -> nil
-    end
+
+    private
+    def insert_untrashed_source: -> untyped
+    def hoardable_source_attributes: -> untyped
+
+    public
+    def scope_attributes: -> untyped
   end
 
   module Model

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hoardable
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - justin talbott
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-28 00:00:00.000000000 Z
+date: 2022-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -109,6 +109,7 @@ files:
 - lib/generators/hoardable/templates/migration_6.rb.erb
 - lib/hoardable.rb
 - lib/hoardable/associations.rb
+- lib/hoardable/database_client.rb
 - lib/hoardable/error.rb
 - lib/hoardable/hoardable.rb
 - lib/hoardable/model.rb