hoardable 0.3.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50086ef99aac41454b28ab8bff2e8abf94d7870b371da0c706c477e0b296ffc3
-  data.tar.gz: 6e6d4ab40470bbfb93e23e96fdbb2d8b086878d24e55d499ac368523125e5397
+  metadata.gz: dff71dd2ebbebaeedfdc9d6fdd8c56c8faaa5505814cfe41c146c4a565375ff1
+  data.tar.gz: 6693f3634541bc8308ed5b4329d69851d971df1cec2b50e842fa9332c62425b6
 SHA512:
-  metadata.gz: 747ac52845c950eb655cb7b0af22794dda49ed08e2b0f1aee472595fd2c63b1f886d4f516e686807607efe4946ca588792913ea92ec1c3152a44c23f8cd84487
-  data.tar.gz: 3460ccd66ebe6eed7cdb129bca6150696b82ad9f8613965e80b08fb458ac6e2b8b644e662036533f73f95f52b97a10bf50f2782f76d3fd6671f23f9c2b58df08
+  metadata.gz: ec2a9df9254cf3623f4fffb0516e99ec30a46ec6496ad0d5e555d4a3ce8324fa81d1880036f42aeb4bbbee136957479f283ccab4b8fb3f2847122bd597483889
+  data.tar.gz: 25a5040c6dc5b91b0b54020657e436aa775cf2211b56fecf1b277e36c11041b55f5a29861000503d5388a9a3d0280a8ccca99c052a2dc82a45abb8f5c98bb50e

data/.rubocop.yml

@@ -1,6 +1,7 @@
 AllCops:
   TargetRubyVersion: 2.6
   NewCops: enable
+  SuggestExtensions: false
 
 Layout/LineLength:
   Max: 120
@@ -8,3 +9,10 @@ Layout/LineLength:
 Metrics/ClassLength:
   Exclude:
     - 'test/**/*.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'test/**/*.rb'
+
+Style/DocumentDynamicEvalDefinition:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 ## [Unreleased]
 
+## [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.
+
+## [0.5.0] - 2022-09-25
+
+- **Breaking Change** - Untrashing a version will now insert a version for the untrash event with
+  it's own temporal timespan. This simplifies the ability to query versions temporarily for when
+  they were trashed or not. This changes, but corrects, temporal query results using `.at`.
+
+- **Breaking Change** - Because of the above, a new operation enum value of "insert" was added. If
+  you already have the `hoardable_operation` enum in your PostgreSQL schema, you can add it by
+  executing the following SQL in a new migration: `ALTER TYPE hoardable_operation ADD VALUE
+  'insert';`.
+
+## [0.4.0] - 2022-09-24
+
+- **Breaking Change** - Trashed versions now pull from the same postgres sequenced used by the
+  source model’s table.
+
 ## [0.1.0] - 2022-07-23
 
 - Initial release

data/README.md

@@ -69,7 +69,7 @@ Rails 7.
 ### Overview
 
 Once you include `Hoardable::Model` into a model, it will dynamically generate a "Version" subclass
-of that model. As we continue our example above:
+of that model. As we continue our example from above:
 
 ```
 $ irb
@@ -79,8 +79,8 @@ $ irb
 => PostVersion(id: integer, body: text, user_id: integer, created_at: datetime, _data: jsonb, _during: tsrange, post_id: integer)
 ```
 
-A `Post` now `has_many :versions`. Whenever an update and deletion of a `Post` occurs, a version is
-created (by default):
+A `Post` now `has_many :versions`. With the default configuration, whenever an update and deletion
+of a `Post` occurs, a version is created:
 
 ```ruby
 post = Post.create!(title: "Title")
@@ -97,9 +97,29 @@ Post.find(post.id) # raises ActiveRecord::RecordNotFound
 Each `PostVersion` has access to the same attributes, relationships, and other model behavior that
 `Post` has, but as a read-only record.
 
-If you ever need to revert to a specific version, you can call `version.revert!` on it. If you would
-like to untrash a specific version, you can call `version.untrash!` on it. This will re-insert the
-model in the parent class’ table with it’s original primary key.
+If you ever need to revert to a specific version, you can call `version.revert!` on it.
+
+``` ruby
+post = Post.create!(title: "Title")
+post.update!(title: "Whoops")
+post.versions.last.revert!
+post.title # => "Title"
+```
+
+If you would like to untrash a specific version, you can call `version.untrash!` on it. This will
+re-insert the model in the parent class’s table with it’s original primary key.
+
+```ruby
+post = Post.create!(title: "Title")
+post.id # => 1
+post.destroy!
+post.versions.size # => 1
+Post.find(post.id) # raises ActiveRecord::RecordNotFound
+trashed_post = post.versions.trashed.last
+trashed_post.id # => 2
+trashed_post.untrash!
+Post.find(post.id) # #<Post>
+```
 
 ### Querying and Temporal Lookup
 
@@ -112,20 +132,30 @@ post.versions.where(user_id: Current.user.id, body: "Cool!")
 If you want to look-up the version of a record at a specific time, you can use the `.at` method:
 
 ```ruby
-post.at(1.day.ago) # => #<PostVersion:0x000000010d44fa30>
-# or
-PostVersion.at(1.day.ago).find_by(post_id: post.id) # => #<PostVersion:0x000000010d44fa30>
+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>
+```
+
+The source model class also has an `.at` method:
+
+``` ruby
+Post.at(1.day.ago) # => [#<Post>, #<Post>]
 ```
 
-_Note:_ A `Version` is not created upon initial parent model creation. If you would like to
-accurately capture the valid temporal frame of the first version, make sure your model’s table has a
-`created_at` timestamp field.
+This will return an ActiveRecord scoped query of all `Posts` and `PostVersions` that were valid at
+that time, all cast as instances of `Post`.
 
-By default, `hoardable` will keep copies of records you have destroyed. You can query for them as
-well:
+_Note:_ A `Version` is not created upon initial parent model creation. To accurately track the
+beginning of the first temporal period, you will need to ensure the source model table has a
+`created_at` timestamp column.
+
+By default, `hoardable` will keep copies of records you have destroyed. You can query them
+specifically with:
 
 ```ruby
 PostVersion.trashed
+Post.version_class.trashed # <- same thing as above
 ```
 
 _Note:_ Creating an inherited table does not copy over the indexes from the parent table. If you
@@ -146,7 +176,7 @@ choosing.
 One convenient way to assign contextual data to these is by defining a proc in an initializer, i.e.:
 
 ```ruby
-# config/initiailzers/hoardable.rb
+# config/initializers/hoardable.rb
 Hoardable.whodunit = -> { Current.user&.id }
 
 # somewhere in your app code
@@ -177,7 +207,7 @@ class ApplicationController < ActionController::Base
     Hoardable.with(whodunit: current_user.id, meta: { request_uuid: request.uuid }) do
       yield
     end
-    # `Hoardable.whodunit` is back to nil or the previously set value
+    # `Hoardable.whodunit` and `Hoardable.meta` are back to nil or their previously set values
   end
 end
 ```
@@ -227,7 +257,7 @@ end
 
 ### Configuration
 
-There are three configurable options currently:
+The configurable options are:
 
 ```ruby
 Hoardable.enabled # => default true
@@ -278,18 +308,18 @@ If a model-level option exists, it will use that. Otherwise, it will fall back t
 
 ### Relationships
 
-As in life, sometimes relationships can be hard. `hoardable` is still working out best practices and
-features in this area, but here are a couple pointers.
+As in life, sometimes relationships can be hard, but here are some pointers on handling associations
+with `Hoardable` considerations.
 
-Sometimes you’ll have a record that belongs to a record that you’ll trash. Now the child record’s
-foreign key will point to the non-existent trashed version of the parent. If you would like this
-`belongs_to` relationship to always resolve to the parent as if it was not trashed, you can include
-the `include_versions` scope on the relationship definition:
+Sometimes you’ll have a record that belongs to a parent record that you’ll trash. Now the child
+record’s foreign key will point to the non-existent trashed version of the parent. If you would like
+to have `belongs_to` resolve to the trashed parent model in this case, you can use
+`belongs_to_trashable` in place of `belongs_to`:
 
 ```ruby
 class Comment
-  include Hoardable::Model
-  belongs_to :post, -> { include_versions } # `Post` also includes `Hoardable::Model`
+  include Hoardable::Associations # <- This includes is not required if this model already includes `Hoardable::Model`
+  belongs_to_trashable :post, -> { where(status: 'published') }, class_name: 'Article' # <- Accepts normal `belongs_to` arguments
 end
 ```
 
@@ -317,7 +347,8 @@ end
 
 If there are models that might be related to versions that are trashed or otherwise, and/or might
 trashed themselves, you can bypass the inherited tables query handling altogether by using the
-`return_everything` configuration variable in `Hoardable.with`:
+`return_everything` configuration variable in `Hoardable.with`. This will ensure that you always see
+all records, including update and trashed versions.
 
 ```ruby
 post.destroy!

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

@@ -2,7 +2,7 @@
 
 class Create<%= class_name.singularize %>Versions < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
   def change
-    create_enum :hoardable_operation, %w[update delete]
+    create_enum :hoardable_operation, %w[update delete insert]
     create_table :<%= singularized_table_name %>_versions, id: false, options: 'INHERITS (<%= table_name %>)' do |t|
       t.jsonb :_data
       t.tsrange :_during, null: false

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

@@ -11,7 +11,7 @@ class Create<%= class_name.singularize %>Versions < ActiveRecord::Migration[<%=
                 SELECT 1 FROM pg_type t
                 WHERE t.typname = 'hoardable_operation'
               ) THEN
-                CREATE TYPE hoardable_operation AS ENUM ('update', 'delete');
+                CREATE TYPE hoardable_operation AS ENUM ('update', 'delete', 'insert');
               END IF;
           END
           $$;

data/lib/hoardable/associations.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Hoardable
+  # This concern contains +ActiveRecord+ association considerations for {SourceModel}. It is
+  # included by {Model} but can be included on it’s own for models that +belongs_to+ a Hoardable
+  # {Model}.
+  module Associations
+    extend ActiveSupport::Concern
+
+    class_methods do
+      # A wrapper for +ActiveRecord+’s +belongs_to+ that allows for falling back to the most recent
+      # trashed +version+, in the case that the related source has been trashed.
+      def belongs_to_trashable(name, scope = nil, **options)
+        belongs_to(name, scope, **options)
+
+        trashable_relationship_name = "trashable_#{name}"
+
+        define_method(trashable_relationship_name) do
+          source_reflection = self.class.reflections[name.to_s]
+          version_class = source_reflection.klass.version_class
+          version_class.trashed.only_most_recent.find_by(
+            version_class.hoardable_source_foreign_key => source_reflection.foreign_key
+          )
+        end
+
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def #{name}
+            super || #{trashable_relationship_name}
+          end
+        RUBY
+      end
+    end
+  end
+end

data/lib/hoardable/hoardable.rb

@@ -5,18 +5,34 @@ module Hoardable
   # Symbols for use with setting contextual data, when creating versions. See
   # {file:README.md#tracking-contextual-data README} for more.
   DATA_KEYS = %i[meta whodunit note event_uuid].freeze
+
   # Symbols for use with setting {Hoardable} configuration. See {file:README.md#configuration
   # README} for more.
-  CONFIG_KEYS = %i[enabled version_updates save_trash return_everything].freeze
+  CONFIG_KEYS = %i[enabled version_updates save_trash return_everything warn_on_missing_created_at_column].freeze
 
-  # @!visibility private
   VERSION_CLASS_SUFFIX = 'Version'
+  private_constant :VERSION_CLASS_SUFFIX
 
-  # @!visibility private
   VERSION_TABLE_SUFFIX = "_#{VERSION_CLASS_SUFFIX.tableize}"
+  private_constant :VERSION_TABLE_SUFFIX
 
-  # @!visibility private
   DURING_QUERY = '_during @> ?::timestamp'
+  private_constant :DURING_QUERY
+
+  HOARDABLE_CALLBACKS_ENABLED = proc do |source_model|
+    source_model.class.hoardable_config[:enabled] && !source_model.class.name.end_with?(VERSION_CLASS_SUFFIX)
+  end.freeze
+  private_constant :HOARDABLE_CALLBACKS_ENABLED
+
+  HOARDABLE_SAVE_TRASH = proc do |source_model|
+    source_model.class.hoardable_config[:save_trash]
+  end.freeze
+  private_constant :HOARDABLE_SAVE_TRASH
+
+  HOARDABLE_VERSION_UPDATES = proc do |source_model|
+    source_model.class.hoardable_config[:version_updates]
+  end.freeze
+  private_constant :HOARDABLE_VERSION_UPDATES
 
   @context = {}
   @config = CONFIG_KEYS.to_h do |key|
@@ -44,7 +60,8 @@ module Hoardable
       end
     end
 
-    # This is a general use method for setting {DATA_KEYS} or {CONFIG_KEYS} around a scoped block.
+    # This is a general use method for setting {file:README.md#tracking-contextual-data Contextual
+    # Data} or {file:README.md#configuration Configuration} around a block.
     #
     # @param hash [Hash] config and contextual data to set within a block
     def with(hash)
@@ -57,5 +74,10 @@ module Hoardable
       @config = current_config
       @context = current_context
     end
+
+    # @!visibility private
+    def logger
+      @logger ||= ActiveSupport::TaggedLogging.new(Logger.new($stdout))
+    end
   end
 end

data/lib/hoardable/model.rb

@@ -21,10 +21,10 @@ module Hoardable
       # @return [Hash]
       def hoardable_config(hash = nil)
         if hash
-          @_hoardable_config = hash.slice(*Hoardable::CONFIG_KEYS)
+          @_hoardable_config = hash.slice(*CONFIG_KEYS)
         else
           @_hoardable_config ||= {}
-          Hoardable::CONFIG_KEYS.to_h do |key|
+          CONFIG_KEYS.to_h do |key|
             [key, @_hoardable_config.key?(key) ? @_hoardable_config[key] : Hoardable.send(key)]
           end
         end
@@ -37,7 +37,7 @@ module Hoardable
       #   {CONFIG_KEYS}
       def with_hoardable_config(hash)
         current_config = @_hoardable_config
-        @_hoardable_config = hash.slice(*Hoardable::CONFIG_KEYS)
+        @_hoardable_config = hash.slice(*CONFIG_KEYS)
         yield
       ensure
         @_hoardable_config = current_config
@@ -45,6 +45,7 @@ module Hoardable
     end
 
     included do
+      include Associations
       define_model_callbacks :versioned
       define_model_callbacks :reverted, only: :after
       define_model_callbacks :untrashed, only: :after

data/lib/hoardable/source_model.rb

@@ -7,6 +7,15 @@ module Hoardable
   module SourceModel
     extend ActiveSupport::Concern
 
+    # The +Version+ class instance for use within +versioned+, +reverted+, and +untrashed+ callbacks.
+    attr_reader :hoardable_version
+
+    # @!attribute [r] hoardable_event_uuid
+    #   @return [String] A postgres UUID that represents the +version+’s +ActiveRecord+ database transaction
+    # @!attribute [r] hoardable_operation
+    #   @return [String] The database operation that created the +version+ - either +update+ or +delete+.
+    delegate :hoardable_event_uuid, :hoardable_operation, to: :hoardable_version, allow_nil: true
+
     class_methods do
       # The dynamically generated +Version+ class for this model.
       def version_class
@@ -17,35 +26,46 @@ module Hoardable
     included do
       include Tableoid
 
-      around_update :insert_hoardable_version_on_update, if: %i[hoardable_callbacks_enabled hoardable_version_updates]
-      around_destroy :insert_hoardable_version_on_destroy, if: %i[hoardable_callbacks_enabled hoardable_save_trash]
-      before_destroy :delete_hoardable_versions, if: :hoardable_callbacks_enabled, unless: :hoardable_save_trash
-      after_commit :unset_hoardable_version_and_event_uuid
+      around_update(if: [HOARDABLE_CALLBACKS_ENABLED, HOARDABLE_VERSION_UPDATES]) do |_, block|
+        hoardable_source_service.insert_hoardable_version('update', &block)
+      end
 
-      # This will contain the +Version+ class instance for use within +versioned+, +reverted+, and
-      # +untrashed+ callbacks.
-      attr_reader :hoardable_version
+      around_destroy(if: [HOARDABLE_CALLBACKS_ENABLED, HOARDABLE_SAVE_TRASH]) do |_, block|
+        hoardable_source_service.insert_hoardable_version('delete', &block)
+      end
 
-      # @!attribute [r] hoardable_event_uuid
-      #   @return [String] A postgres UUID that represents the +version+’s +ActiveRecord+ database transaction
-      # @!attribute [r] hoardable_operation
-      #   @return [String] The database operation that created the +version+ - either +update+ or +delete+.
-      delegate :hoardable_event_uuid, :hoardable_operation, to: :hoardable_version, allow_nil: true
+      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 }
 
       # Returns all +versions+ in ascending order of their temporal timeframes.
       has_many(
-        :versions, -> { order(:_during) },
+        :versions, -> { order('UPPER(_during) ASC') },
         dependent: nil,
         class_name: version_class.to_s,
-        inverse_of: model_name.i18n_key
+        inverse_of: :hoardable_source
       )
+
+      # @!scope class
+      # @!method at
+      # @return [ActiveRecord<Object>]
+      #
+      # 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|
+        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))
+        )
+      }
     end
 
     # Returns a boolean of whether the record is actually a trashed +version+.
     #
     # @return [Boolean]
     def trashed?
-      versions.trashed.limit(1).order(_during: :desc).first&.id == id
+      versions.trashed.only_most_recent.first&.hoardable_source_foreign_id == id
     end
 
     # Returns the +version+ at the supplied +datetime+ or +time+. It will return +self+ if there is
@@ -55,7 +75,7 @@ module Hoardable
     def at(datetime)
       raise(Error, 'Future state cannot be known') if datetime.future?
 
-      versions.find_by(DURING_QUERY, datetime) || self
+      versions.at(datetime).first || self
     end
 
     # If a version is found at the supplied datetime, it will +revert!+ to it and return it. This
@@ -70,72 +90,63 @@ module Hoardable
 
     private
 
-    def hoardable_callbacks_enabled
-      self.class.hoardable_config[:enabled] && !self.class.name.end_with?(VERSION_CLASS_SUFFIX)
-    end
-
-    def hoardable_save_trash
-      self.class.hoardable_config[:save_trash]
+    def hoardable_source_service
+      @hoardable_source_service ||= Service.new(self)
     end
 
-    def hoardable_version_updates
-      self.class.hoardable_config[:version_updates]
-    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 insert_hoardable_version_on_update(&block)
-      insert_hoardable_version('update', attributes_before_type_cast.without('id'), &block)
-    end
-
-    def insert_hoardable_version_on_destroy(&block)
-      insert_hoardable_version('delete', attributes_before_type_cast, &block)
-    end
+      def initialize(source_model)
+        @source_model = source_model
+      end
 
-    def insert_hoardable_version(operation, attrs)
-      @hoardable_version = initialize_hoardable_version(operation, attrs)
-      run_callbacks(:versioned) do
-        yield
-        hoardable_version.save(validate: false, touch: false)
+      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
-    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 find_or_initialize_hoardable_event_uuid
+        Thread.current[:hoardable_event_uuid] ||= ActiveRecord::Base.connection.query('SELECT gen_random_uuid();')[0][0]
+      end
 
-    def initialize_hoardable_version(operation, attrs)
-      versions.new(
-        attrs.merge(
-          changes.transform_values { |h| h[0] },
-          {
-            _event_uuid: find_or_initialize_hoardable_event_uuid,
-            _operation: operation,
-            _data: initialize_hoardable_data.merge(changes: changes)
-          }
+      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?
+      def initialize_hoardable_data
+        DATA_KEYS.to_h do |key|
+          [key, assign_hoardable_context(key)]
+        end
+      end
 
-      value.is_a?(Proc) ? value.call : value
-    end
+      def assign_hoardable_context(key)
+        return nil if (value = Hoardable.public_send(key)).nil?
 
-    def delete_hoardable_versions
-      versions.delete_all(:delete_all)
-    end
+        value.is_a?(Proc) ? value.call : value
+      end
 
-    def unset_hoardable_version_and_event_uuid
-      @hoardable_version = nil
-      return if ActiveRecord::Base.connection.transaction_open?
+      def unset_hoardable_version_and_event_uuid
+        source_model.instance_variable_set('@hoardable_version', nil)
+        return if source_model.class.connection.transaction_open?
 
-      Thread.current[:hoardable_event_uuid] = nil
+        Thread.current[:hoardable_event_uuid] = nil
+      end
     end
+    private_constant :Service
   end
 end

data/lib/hoardable/tableoid.rb

@@ -5,13 +5,13 @@ module Hoardable
   module Tableoid
     extend ActiveSupport::Concern
 
-    # @!visibility private
     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
@@ -24,7 +24,7 @@ module Hoardable
         if hoardable_config[:return_everything]
           where(nil)
         else
-          where(TABLEOID_AREL_CONDITIONS.call(arel_table, :eq))
+          exclude_versions
         end
       end
 
@@ -43,6 +43,14 @@ 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 class
+      # @!method exclude_versions
+      # @return [ActiveRecord<Object>]
+      #
+      # 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)) }
     end
 
     private

data/lib/hoardable/version.rb

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

data/lib/hoardable/version_model.rb

@@ -6,29 +6,38 @@ module Hoardable
   module VersionModel
     extend ActiveSupport::Concern
 
-    included do
-      hoardable_source_key = superclass.model_name.i18n_key
+    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"
+      end
+    end
 
+    included do
       # A +version+ belongs to it’s parent +ActiveRecord+ source.
-      belongs_to hoardable_source_key, inverse_of: :versions
-      alias_method :hoardable_source, hoardable_source_key
+      belongs_to(
+        :hoardable_source,
+        inverse_of: :versions,
+        class_name: superclass.model_name,
+        foreign_key: hoardable_source_foreign_key
+      )
 
-      self.table_name = "#{table_name.singularize}#{Hoardable::VERSION_TABLE_SUFFIX}"
+      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
 
-      before_create :assign_temporal_tsrange
+      before_create { hoardable_version_service.assign_temporal_tsrange }
 
       # @!scope class
       # @!method trashed
       # @return [ActiveRecord<Object>]
       #
-      # Returns only trashed +versions+ that are orphans.
+      # Returns only trashed +versions+ that are currently orphans.
       scope :trashed, lambda {
-        left_outer_joins(hoardable_source_key)
+        left_outer_joins(:hoardable_source)
           .where(superclass.table_name => { id: nil })
           .where(_operation: 'delete')
       }
@@ -38,7 +47,14 @@ module Hoardable
       # @return [ActiveRecord<Object>]
       #
       # Returns +versions+ that were valid at the supplied +datetime+ or +time+.
-      scope :at, ->(datetime) { where(DURING_QUERY, datetime) }
+      scope :at, ->(datetime) { where(_operation: %w[delete update]).where(DURING_QUERY, datetime) }
+
+      # @!scope class
+      # @!method trashed_at
+      # @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 class
       # @!method with_hoardable_event_uuid
@@ -47,6 +63,13 @@ module Hoardable
       # Returns all +versions+ that were created as part of the same +ActiveRecord+ database
       # transaction of the supplied +event_uuid+. Useful in +reverted+ and +untrashed+ callbacks.
       scope :with_hoardable_event_uuid, ->(event_uuid) { where(_event_uuid: event_uuid) }
+
+      # @!scope class
+      # @!method only_most_recent
+      # @return [ActiveRecord<Object>]
+      #
+      # Returns a limited +ActiveRecord+ scope of only the most recent version.
+      scope :only_most_recent, -> { limit(1).reorder('UPPER(_during) DESC') }
     end
 
     # Reverts the parent +ActiveRecord+ instance to the saved attributes of this +version+. Raises
@@ -56,7 +79,7 @@ module Hoardable
 
       transaction do
         hoardable_source.tap do |reverted|
-          reverted.update!(hoardable_source_attributes.without('id'))
+          reverted.update!(hoardable_version_service.hoardable_source_attributes.without('id'))
           reverted.instance_variable_set(:@hoardable_version, self)
           reverted.run_callbacks(:reverted)
         end
@@ -69,9 +92,8 @@ module Hoardable
       raise(Error, 'Version is not trashed, cannot untrash') unless hoardable_operation == 'delete'
 
       transaction do
-        superscope = self.class.superclass.unscoped
-        superscope.insert(untrashable_hoardable_source_attributes)
-        superscope.find(hoardable_source_foreign_id).tap do |untrashed|
+        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)
         end
@@ -91,43 +113,72 @@ module Hoardable
       _data&.dig('changes')
     end
 
-    private
-
-    def untrashable_hoardable_source_attributes
-      hoardable_source_attributes.merge('id' => hoardable_source_foreign_id).tap do |hash|
-        hash['updated_at'] = Time.now if self.class.column_names.include?('updated_at')
-      end
+    # 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)
     end
 
-    def hoardable_source_attributes
-      @hoardable_source_attributes ||=
-        attributes_before_type_cast
-        .without(hoardable_source_foreign_key)
-        .reject { |k, _v| k.start_with?('_') }
-    end
+    delegate :hoardable_source_foreign_key, to: :class
 
-    def hoardable_source_foreign_key
-      @hoardable_source_foreign_key ||= "#{self.class.superclass.model_name.i18n_key}_id"
+    def hoardable_version_service
+      @hoardable_version_service ||= Service.new(self)
     end
 
-    def hoardable_source_foreign_id
-      @hoardable_source_foreign_id ||= public_send(hoardable_source_foreign_key)
-    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 previous_temporal_tsrange_end
-      hoardable_source.versions.limit(1).order(_during: :desc).pluck('_during').first&.end
-    end
+      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 assign_temporal_tsrange
-      range_start = (
-        previous_temporal_tsrange_end ||
+      def hoardable_source_epoch
         if hoardable_source.class.column_names.include?('created_at')
           hoardable_source.created_at
         else
-          Time.at(0)
+          maybe_warn_about_missing_created_at_column
+          Time.at(0).utc
         end
-      )
-      self._during = (range_start..Time.now)
+      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
     end
+    private_constant :Service
   end
 end

data/lib/hoardable.rb

@@ -7,4 +7,5 @@ require_relative 'hoardable/error'
 require_relative 'hoardable/source_model'
 require_relative 'hoardable/version_model'
 require_relative 'hoardable/model'
+require_relative 'hoardable/associations'
 require_relative 'generators/hoardable/migration_generator'

data/sig/hoardable.rbs

@@ -1,14 +1,19 @@
 module Hoardable
   VERSION: String
   DATA_KEYS: [:meta, :whodunit, :note, :event_uuid]
-  CONFIG_KEYS: [:enabled, :version_updates, :save_trash, :return_everything]
+  CONFIG_KEYS: [:enabled, :version_updates, :save_trash, :return_everything, :warn_on_missing_created_at_column]
   VERSION_CLASS_SUFFIX: String
   VERSION_TABLE_SUFFIX: String
   DURING_QUERY: String
+  HOARDABLE_CALLBACKS_ENABLED: ^(untyped) -> untyped
+  HOARDABLE_SAVE_TRASH: ^(untyped) -> untyped
+  HOARDABLE_VERSION_UPDATES: ^(untyped) -> untyped
   self.@context: Hash[untyped, untyped]
   self.@config: untyped
+  self.@logger: untyped
 
   def self.with: (untyped hash) -> untyped
+  def self.logger: -> untyped
 
   module Tableoid
     TABLEOID_AREL_CONDITIONS: Proc
@@ -25,56 +30,71 @@ module Hoardable
 
   module SourceModel
     include Tableoid
+    @hoardable_source_service: Service
 
+    attr_reader hoardable_version: nil
     def trashed?: -> untyped
     def at: (untyped datetime) -> SourceModel
     def revert_to!: (untyped datetime) -> SourceModel?
 
     private
-    def hoardable_callbacks_enabled: -> untyped
-    def hoardable_save_trash: -> untyped
-    def hoardable_version_updates: -> untyped
-    def insert_hoardable_version_on_update: -> untyped
-    def insert_hoardable_version_on_destroy: -> untyped
-    def insert_hoardable_version: (String operation, untyped attrs) -> untyped
-    def find_or_initialize_hoardable_event_uuid: -> untyped
-    def initialize_hoardable_version: (String operation, untyped attrs) -> untyped
-    def initialize_hoardable_data: -> untyped
-    def assign_hoardable_context: (:event_uuid | :meta | :note | :whodunit key) -> nil
-    def delete_hoardable_versions: -> untyped
-    def unset_hoardable_version_and_event_uuid: -> nil
+    def hoardable_source_service: -> Service
 
     public
     def version_class: -> untyped
-    attr_reader hoardable_version: nil
+
+    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_attributes: untyped
-    @hoardable_source_foreign_key: String
     @hoardable_source_foreign_id: untyped
+    @hoardable_source_foreign_key: String
+    @hoardable_version_service: Service
 
     def revert!: -> untyped
     def untrash!: -> untyped
     def changes: -> untyped
-
-    private
-    def untrashable_hoardable_source_attributes: -> untyped
-    def hoardable_source_attributes: -> untyped
-    def hoardable_source_foreign_key: -> String
     def hoardable_source_foreign_id: -> untyped
-    def previous_temporal_tsrange_end: -> untyped
-    def assign_temporal_tsrange: -> Range
+    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
   end
 
   module Model
     include VersionModel
     include SourceModel
+    include Associations
 
+    attr_reader _hoardable_config: Hash[untyped, untyped]
     def hoardable_config: (?nil hash) -> untyped
     def with_hoardable_config: (untyped hash) -> untyped
   end
 
+  module Associations
+    def belongs_to_trashable: (untyped name, ?nil scope, **untyped) -> untyped
+  end
+
   class MigrationGenerator
     @singularized_table_name: untyped
 

metadata

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