hoardable 0.6.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dff71dd2ebbebaeedfdc9d6fdd8c56c8faaa5505814cfe41c146c4a565375ff1
-  data.tar.gz: 6693f3634541bc8308ed5b4329d69851d971df1cec2b50e842fa9332c62425b6
+  metadata.gz: 5b85dfaf658e447049fcb09281d34dd25188be79f948eda294398f47b19b8244
+  data.tar.gz: 67219612736259e2dbc542230cc1490a156a15bc679340176aca35b76aaf516c
 SHA512:
-  metadata.gz: ec2a9df9254cf3623f4fffb0516e99ec30a46ec6496ad0d5e555d4a3ce8324fa81d1880036f42aeb4bbbee136957479f283ccab4b8fb3f2847122bd597483889
-  data.tar.gz: 25a5040c6dc5b91b0b54020657e436aa775cf2211b56fecf1b277e36c11041b55f5a29861000503d5388a9a3d0280a8ccca99c052a2dc82a45abb8f5c98bb50e
+  metadata.gz: cf3c5edfeac5526e7520dc2584caba8bb5399df43acf1ce6bd320b19f44981c154624b9b80c5b415aaeb840fc5d718f1999b4bbaf82eb3ff76149e09621ab0e5
+  data.tar.gz: 52112fb9bc55bec2009656cce9571887130333b6460d5478c1a0c113895ccb977ffcc80172954911c6e70d2012f136bf68c64b17bc69ffd7deeaa40a56c97646

data/.rubocop.yml

@@ -16,3 +16,6 @@ Metrics/BlockLength:
 
 Style/DocumentDynamicEvalDefinition:
   Enabled: false
+
+Naming/PredicateName:
+  Enabled: false

data/CHANGELOG.md

@@ -1,10 +1,41 @@
 ## [Unreleased]
 
+- Stability is coming.
+
+## [0.9.0] - 2022-10-02
+
+- **Breaking Change** - `Hoardable.return_everything` was removed in favor of the newly added
+  `Hoardable.at`.
+
+## [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

@@ -31,6 +31,12 @@ gem 'hoardable'
 
 And then execute `bundle install`.
 
+If you would like to generate an initializer with the global [configuration](#configuration) options:
+
+```
+rails g hoardable:initializer
+```
+
 ### Model Installation
 
 You must include `Hoardable::Model` into an ActiveRecord model that you would like to hoard versions
@@ -64,6 +70,9 @@ _Note:_ If you are on Rails 6.1, you might want to set `config.active_record.sch
 in `application.rb`, so that the enum type is captured in your schema dump. This is not required in
 Rails 7.
 
+_Note:_ Creating an inherited table does not copy over the indexes from the parent table. If you
+need to query versions often, you should add appropriate indexes to the `_versions` tables.
+
 ## Usage
 
 ### Overview
@@ -76,7 +85,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 +95,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
@@ -99,15 +108,15 @@ Each `PostVersion` has access to the same attributes, relationships, and other m
 
 If you ever need to revert to a specific version, you can call `version.revert!` on it.
 
-``` ruby
+```ruby
 post = Post.create!(title: "Title")
 post.update!(title: "Whoops")
-post.versions.last.revert!
+post.reload.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.
+re-insert the model in the parent class’s table with the original primary key.
 
 ```ruby
 post = Post.create!(title: "Title")
@@ -134,21 +143,20 @@ 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:
 
-``` ruby
+```ruby
 Post.at(1.day.ago) # => [#<Post>, #<Post>]
 ```
 
-This will return an ActiveRecord scoped query of all `Posts` and `PostVersions` that were valid at
-that time, all cast as instances of `Post`.
+This will return an ActiveRecord scoped query of all `Post` and `PostVersion` records that were
+valid at that time, all cast as instances of `Post`.
 
-_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.
+There is also an `at` method on `Hoardable` itself for more complex temporal resource querying. See
+[Relationships](#relationships) for more.
 
 By default, `hoardable` will keep copies of records you have destroyed. You can query them
 specifically with:
@@ -156,10 +164,12 @@ specifically with:
 ```ruby
 PostVersion.trashed
 Post.version_class.trashed # <- same thing as above
+PostVersion.trashed.first.trashed? # <- true
 ```
 
-_Note:_ Creating an inherited table does not copy over the indexes from the parent table. If you
-need to query versions often, you should add appropriate indexes to the `_versions` tables.
+_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.
 
 ### Tracking Contextual Data
 
@@ -182,7 +192,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 +201,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 +235,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 +245,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
@@ -263,7 +273,6 @@ The configurable options are:
 Hoardable.enabled # => default true
 Hoardable.version_updates # => default true
 Hoardable.save_trash # => default true
-Hoardable.return_everything # => default false
 ```
 
 `Hoardable.enabled` controls whether versions will be ever be created.
@@ -273,10 +282,6 @@ Hoardable.return_everything # => default false
 `Hoardable.save_trash` controls whether to create versions upon record deletion. When this is set to
 `false`, all versions of a record will be deleted when the record is destroyed.
 
-`Hoardable.return_everything` controls whether to include versions when doing queries for source
-models. This is typically only useful to set around a block, as explained below in
-[Relationships](#relationships).
-
 If you would like to temporarily set a config setting, you can use `Hoardable.with`:
 
 ```ruby
@@ -323,8 +328,54 @@ class Comment
 end
 ```
 
-Sometimes you’ll trash something that `has_many :children, dependent: :destroy` and both the parent
-and child model classes include `Hoardable::Model`. Whenever a hoardable version is created in a
+Sometimes you'll have a Hoardable record that `has_many` other Hoardable records and you will want
+to know the state of both the parent record and the children at a cetain point in time. You
+accomplish this by establishing a `has_many_hoardable` relationship and using the `Hoardable.at`
+method:
+
+```ruby
+class Post
+  include Hoardable::Model
+  has_many_hoardable :comments
+end
+
+def Comment
+  include Hoardable::Model
+end
+
+post = Post.create!(title: 'Title')
+comment1 = post.comments.create!(body: 'Comment')
+comment2 = post.comments.create!(body: 'Comment')
+datetime = DateTime.current
+comment2.destroy!
+post.update!(title: 'New Title')
+post_id = post.id # 1
+
+Hoardable.at(datetime) do
+  post = Post.hoardable.find(post_id)
+  post.title # => 'Title'
+  post.comments.size # => 2
+  post.id # => 2
+  post.version? # => true
+  post.hoardable_source_id # => 1
+end
+```
+
+There are some additional details to point out above. Firstly, it is important to note that the
+final `post.id` yields a different value than the originally created `Post`. This is because the
+`post` within the `#at` block is actually a temporal version, since it has been subsequently
+updated, but it has been reified as a `Post` for the purposes of your business logic (serialization,
+rendering views, exporting, etc). Don’t fret - you will not be able to commit any updates to the
+version, even though it is masquerading as a `Post`.
+
+If you are ever unsure if a Hoardable record is a "source" or a "version", you can be sure by
+calling `version?` on it. If you want to get the true original source record ID, you can call
+`hoardable_source_id`. Finally, if you prepend `.hoardable` to a `.find` call on the source model
+class, you can always find the relevant source or temporal version record using just the original
+source record’s id.
+
+Sometimes you’ll trash something that `has_many_hoardable :children, dependent: :destroy` and want
+to untrash everything in a similar dependent manner. Whenever a hoardable version is created in a
 database transaction, it will create or re-use a unique event UUID for that transaction and tag all
 versions created with it. That way, when you `untrash!` a record, you can find and `untrash!`
 records that were trashed with it:
@@ -332,35 +383,18 @@ records that were trashed with it:
 ```ruby
 class Post < ActiveRecord::Base
   include Hoardable::Model
-  has_many :comments, dependent: :destroy # `Comment` also includes `Hoardable::Model`
+  has_many_hoardable :comments, dependent: :destroy # `Comment` also includes `Hoardable::Model`
 
   after_untrashed do
     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
-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.
-
-```ruby
-post.destroy!
-
-Hoardable.with(return_everything: true) do
-  post = Post.find(post.id) # returns the trashed post as if it was not
-  post.comments # returns the trashed comments as well
-end
-
-post.reload # raises ActiveRecord::RecordNotFound
-```
-
 ## Gem Comparison
 
 ### [`paper_trail`](https://github.com/paper-trail-gem/paper_trail)

data/lib/generators/hoardable/initializer_generator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module Hoardable
+  # Generates an initializer file for {Hoardable} configuration.
+  class InitializerGenerator < Rails::Generators::Base
+    def create_initializer_file
+      create_file(
+        'config/initializers/hoardable.rb',
+        <<~TEXT
+          # Hoardable configuration defaults are below. Learn more at https://github.com/waymondo/hoardable#configuration
+          #
+          # Hoardable.enabled = true
+          # Hoardable.version_updates = true
+          # Hoardable.save_trash = true
+        TEXT
+      )
+    end
+  end
+end

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

@@ -8,11 +8,26 @@ 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
+    execute(
+      <<~SQL
+        CREATE OR REPLACE FUNCTION hoardable_version_prevent_update() RETURNS trigger
+          LANGUAGE plpgsql AS
+        $$BEGIN
+          RAISE EXCEPTION 'updating a version is not allowed';
+          RETURN NEW;
+        END;$$;
+
+        CREATE TRIGGER <%= singularized_table_name %>_versions_prevent_update
+          BEFORE UPDATE ON <%= singularized_table_name %>_versions FOR EACH ROW
+          EXECUTE PROCEDURE hoardable_version_prevent_update();
+      SQL
+    )
+    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,26 @@ 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
+    execute(
+      <<~SQL
+        CREATE OR REPLACE FUNCTION hoardable_version_prevent_update() RETURNS trigger
+          LANGUAGE plpgsql AS
+        $$BEGIN
+          RAISE EXCEPTION 'updating a version is not allowed';
+          RETURN NEW;
+        END;$$;
+
+        CREATE TRIGGER <%= singularized_table_name %>_versions_prevent_update
+          BEFORE UPDATE ON <%= singularized_table_name %>_versions FOR EACH ROW
+          EXECUTE PROCEDURE hoardable_version_prevent_update();
+      SQL
+    )
+    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

@@ -7,6 +7,26 @@ module Hoardable
   module Associations
     extend ActiveSupport::Concern
 
+    # An +ActiveRecord+ extension that allows looking up {VersionModel}s by +hoardable_source_id+ as
+    # if they were {SourceModel}s.
+    module HasManyScope
+      def scope
+        @scope ||= hoardable_scope
+      end
+
+      private
+
+      def hoardable_scope
+        if Hoardable.instance_variable_get('@at') &&
+           (hoardable_source_id = @association.owner.hoardable_source_id)
+          @association.scope.rewhere(@association.reflection.foreign_key => hoardable_source_id)
+        else
+          @association.scope
+        end
+      end
+    end
+    private_constant :HasManyScope
+
     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.
@@ -17,9 +37,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
 
@@ -29,6 +49,12 @@ module Hoardable
           end
         RUBY
       end
+
+      # A wrapper for +ActiveRecord+’s +has_many+ that allows for finding temporal versions of a
+      # record cast as instances of the {SourceModel}, when doing a {Hoardable#at} query.
+      def has_many_hoardable(name, scope = nil, **options)
+        has_many(name, scope, **options) { include HasManyScope }
+      end
     end
   end
 end

data/lib/hoardable/database_client.rb

@@ -0,0 +1,98 @@
+# 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 hoardable_version_source_id
+      @hoardable_version_source_id ||= query_hoardable_version_source_id
+    end
+
+    def query_hoardable_version_source_id
+      primary_key = source_record.class.primary_key
+      version_class.where(primary_key => source_record.read_attribute(primary_key)).pluck('hoardable_source_id')[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/hoardable.rb

@@ -8,7 +8,7 @@ module Hoardable
 
   # 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 warn_on_missing_created_at_column].freeze
+  CONFIG_KEYS = %i[enabled version_updates save_trash warn_on_missing_created_at_column].freeze
 
   VERSION_CLASS_SUFFIX = 'Version'
   private_constant :VERSION_CLASS_SUFFIX
@@ -36,7 +36,7 @@ module Hoardable
 
   @context = {}
   @config = CONFIG_KEYS.to_h do |key|
-    [key, key != :return_everything]
+    [key, true]
   end
 
   class << self
@@ -75,6 +75,17 @@ module Hoardable
       @context = current_context
     end
 
+    # Allows performing a query for record states at a certain time. Returned {SourceModel}
+    # instances within the block may be {SourceModel} or {VersionModel} records.
+    #
+    # @param datetime [DateTime, Time] the datetime or time to temporally query records at
+    def at(datetime)
+      @at = datetime
+      yield
+    ensure
+      @at = nil
+    end
+
     # @!visibility private
     def logger
       @logger ||= ActiveSupport::TaggedLogging.new(Logger.new($stdout))

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/{tableoid.rb → scopes.rb}

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
 module Hoardable
-  # This concern provides support for PostgreSQL’s tableoid system column to {SourceModel}.
-  module Tableoid
+  # This concern provides support for PostgreSQL’s tableoid system column to {SourceModel} and
+  # temporal +ActiveRecord+ scopes.
+  module Scopes
     extend ActiveSupport::Concern
 
     TABLEOID_AREL_CONDITIONS = lambda do |arel_table, condition|
@@ -19,10 +20,10 @@ module Hoardable
 
       # 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.with(return_everything: true)` block.
+      # the code in a `Hoardable.at(datetime)` block.
       default_scope do
-        if hoardable_config[:return_everything]
-          where(nil)
+        if (hoardable_at = Hoardable.instance_variable_get('@at'))
+          at(hoardable_at)
         else
           exclude_versions
         end
@@ -51,6 +52,18 @@ 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 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(:hoardable_source_id).where(DURING_QUERY, datetime))
+        )
+      }
     end
 
     private

data/lib/hoardable/source_model.rb

@@ -16,56 +16,69 @@ module Hoardable
     #   @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
 
+    # A module for overriding +ActiveRecord#find_one+’ in the case you are doing a temporal query
+    # and the current {SourceModel} record may in fact be a {VersionModel} record.
+    module FinderMethods
+      def find_one(id)
+        conditions = { primary_key => [id, *version_class.where(hoardable_source_id: id).select(primary_key).ids] }
+        find_by(conditions) || where(conditions).raise_record_not_found_exception!
+      end
+    end
+    private_constant :FinderMethods
+
     class_methods do
       # The dynamically generated +Version+ class for this model.
       def version_class
         "#{name}#{VERSION_CLASS_SUFFIX}".constantize
       end
+
+      # Extends the current {SourceModel} scoping to include Hoardable’s {FinderMethods} overrides.
+      def hoardable
+        extending(FinderMethods)
+      end
     end
 
     included do
-      include Tableoid
+      include Scopes
 
       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
-      # @!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+.
+    # Returns a boolean of whether the record is actually a trashed +version+ cast as an instance of the
+    # source model.
     #
     # @return [Boolean]
     def trashed?
-      versions.trashed.only_most_recent.first&.hoardable_source_foreign_id == id
+      versions.trashed.only_most_recent.first&.hoardable_source_id == id
+    end
+
+    # Returns a boolean of whether the record is actually a +version+ cast as an instance of the
+    # source model.
+    #
+    # @return [Boolean]
+    def version?
+      !!hoardable_client.hoardable_version_source_id
     end
 
     # Returns the +version+ at the supplied +datetime+ or +time+. It will return +self+ if there is
@@ -85,68 +98,24 @@ 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)
+    # Returns the +hoardable_source_id+ that represents the original {SourceModel} record’s ID. Will
+    # return nil if the current {SourceModel} record is not an instance of a {VersionModel} cast as
+    # {SourceModel}.
+    #
+    # @return [Integer, nil]
+    def hoardable_source_id
+      hoardable_client.hoardable_version_source_id || id
     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
-
-      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
+    delegate :version_class, to: :class
 
-      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.9.1'
 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
@@ -113,72 +113,24 @@ module Hoardable
       _data&.dig('changes')
     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)
+    # Returns the ID of the {SourceModel} that created this {VersionModel}
+    def hoardable_source_id
+      read_attribute('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_id))
+      superscope.find(hoardable_source_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

@@ -2,10 +2,12 @@
 
 require_relative 'hoardable/version'
 require_relative 'hoardable/hoardable'
-require_relative 'hoardable/tableoid'
+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 'generators/hoardable/migration_generator'
+require_relative 'generators/hoardable/initializer_generator'

data/sig/hoardable.rbs

@@ -1,7 +1,7 @@
 module Hoardable
   VERSION: String
   DATA_KEYS: [:meta, :whodunit, :note, :event_uuid]
-  CONFIG_KEYS: [:enabled, :version_updates, :save_trash, :return_everything, :warn_on_missing_created_at_column]
+  CONFIG_KEYS: [:enabled, :version_updates, :save_trash, :warn_on_missing_created_at_column]
   VERSION_CLASS_SUFFIX: String
   VERSION_TABLE_SUFFIX: String
   DURING_QUERY: String
@@ -10,12 +10,14 @@ module Hoardable
   HOARDABLE_VERSION_UPDATES: ^(untyped) -> untyped
   self.@context: Hash[untyped, untyped]
   self.@config: untyped
+  self.@at: nil
   self.@logger: untyped
 
   def self.with: (untyped hash) -> untyped
+  def self.at: (untyped datetime) -> untyped
   def self.logger: -> untyped
 
-  module Tableoid
+  module Scopes
     TABLEOID_AREL_CONDITIONS: Proc
 
     private
@@ -28,57 +30,62 @@ module Hoardable
   class Error < StandardError
   end
 
+  class DatabaseClient
+    @hoardable_version_source_id: untyped
+
+    attr_reader source_record: SourceModel
+    def initialize: (SourceModel source_record) -> void
+    def insert_hoardable_version: (untyped operation) -> untyped
+    def find_or_initialize_hoardable_event_uuid: -> untyped
+    def hoardable_version_source_id: -> untyped
+    def query_hoardable_version_source_id: -> 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
+    include Scopes
+    @hoardable_client: DatabaseClient
 
-    attr_reader hoardable_version: nil
+    attr_reader hoardable_version: untyped
     def trashed?: -> untyped
+    def version?: -> untyped
     def at: (untyped datetime) -> SourceModel
     def revert_to!: (untyped datetime) -> SourceModel?
+    def hoardable_source_id: -> untyped
 
     private
-    def hoardable_source_service: -> Service
+    def hoardable_client: -> DatabaseClient
 
     public
     def version_class: -> untyped
+    def hoardable: -> 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
+    module FinderMethods
+      def find_one: (untyped id) -> untyped
     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
+    def hoardable_source_id: -> untyped
+
+    private
+    def insert_untrashed_source: -> untyped
+    def hoardable_source_attributes: -> untyped
+
+    public
+    def scope_attributes: -> untyped
   end
 
   module Model
@@ -93,6 +100,17 @@ module Hoardable
 
   module Associations
     def belongs_to_trashable: (untyped name, ?nil scope, **untyped) -> untyped
+    def has_many_hoardable: (untyped name, ?nil scope, **untyped) -> untyped
+
+    module HasManyScope
+      @scope: untyped
+      @association: bot
+
+      def scope: -> untyped
+
+      private
+      def hoardable_scope: -> untyped
+    end
   end
 
   class MigrationGenerator
@@ -103,4 +121,8 @@ module Hoardable
     def migration_template_name: -> String
     def singularized_table_name: -> untyped
   end
+
+  class InitializerGenerator
+    def create_initializer_file: -> untyped
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hoardable
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.9.1
 platform: ruby
 authors:
 - justin talbott
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-28 00:00:00.000000000 Z
+date: 2022-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -104,16 +104,18 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/generators/hoardable/initializer_generator.rb
 - lib/generators/hoardable/migration_generator.rb
 - lib/generators/hoardable/templates/migration.rb.erb
 - 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
+- lib/hoardable/scopes.rb
 - lib/hoardable/source_model.rb
-- lib/hoardable/tableoid.rb
 - lib/hoardable/version.rb
 - lib/hoardable/version_model.rb
 - sig/hoardable.rbs