hoardable 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7380fb64f7dd3132bec65fd1cfc0c8317a52e6cb6f26895d0b83d7b78391c193
-  data.tar.gz: 71241a1edc81c57d1bb0549685da47642036fc65ff8d659284c31a9784b0f571
+  metadata.gz: 3c73d162f69d7ff2984571b7e0aefa256357a835c2ecb22d1288a362dce38d73
+  data.tar.gz: 4b250ebb2bf536f94d3cd8e65f0bd884579bd6fc5d8fd89f5c9846554c4d0e7a
 SHA512:
-  metadata.gz: 4f473b92097e223dd535512ec5850a6c00d9c22faba482787ffbf2ae7b0f6130d37b0a3ed34a46701f53ec4958e7293a69626bdc9693f1f7a51c0e35ff62bb2e
-  data.tar.gz: 530e609fd4535b4d37f82fc4a39ce3322209451bdd0fa67079e74ed2ef658bd252d9a87ca7189a9332e0303b20c8cb073765bc1c99fcdb647c346f893a133ecd
+  metadata.gz: 4503897e596e1694a49009aa3e964a86a8e317169c590a1079b075345b9116fb4af50abb68b17a4ea73c7bf1570f56906c11f5e57dbaf84044ab8ac11ca942f2
+  data.tar.gz: a8e2780685b3d0a00757c44ca6a38f58571ef617b1543b7ee8b8f3dcef18c9fed5f7c3e10f7d31677afe0fccafeffca4348d70b5afe3706ead0438488bf57166

data/README.md

@@ -1,9 +1,9 @@
-# Hoardable
+# Hoardable ![gem version](https://img.shields.io/gem/v/hoardable?style=flat-square)
 
 Hoardable is an ActiveRecord extension for Ruby 2.6+, Rails 6.1+, and PostgreSQL that allows for
 versioning and soft-deletion of records through the use of _uni-temporal inherited tables_.
 
-#### nice... huh?
+#### huh?
 
 [Temporal tables](https://en.wikipedia.org/wiki/Temporal_database) are a database design pattern
 where each row of a table contains data along with one or more time ranges. In the case of this gem,
@@ -48,10 +48,18 @@ end
 Then, run the generator command to create a database migration and migrate it:
 
 ```
-bin/rails g hoardable:migration posts
+bin/rails g hoardable:migration Post
 bin/rails db:migrate
 ```
 
+By default, it will try to guess the foreign key type for the `_versions` table based on the primary
+key of the model specified in the migration generator above. If you want/need to specify this
+explicitly, you can do so:
+
+```
+bin/rails g hoardable:migration Post --foreign-key-type uuid
+```
+
 _Note:_ If you are on Rails 6.1, you might want to set `config.active_record.schema_format = :sql`
 in `application.rb`, so that the enum type is captured in your schema dump. This is not required in
 Rails 7.
@@ -75,10 +83,11 @@ A `Post` now `has_many :versions`. Whenever an update and deletion of a `Post` o
 created (by default):
 
 ```ruby
-post = Post.create!(attributes)
+post = Post.create!(title: "Title")
 post.versions.size # => 0
-post.update!(title: "Title")
+post.update!(title: "Revised Title")
 post.versions.size # => 1
+post.versions.first.title # => "Title"
 post.destroy!
 post.trashed? # true
 post.versions.size # => 2
@@ -120,17 +129,12 @@ need to query versions often, you should add appropriate indexes to the `_versio
 
 ### Tracking contextual data
 
-You’ll often want to track contextual data about the creation of a version. `hoardable` will
-automatically capture the ActiveRecord
-[changes](https://api.rubyonrails.org/classes/ActiveModel/Dirty.html#method-i-changes) hash and the
-`operation` that cause the version (`update` or `delete`). It will also tag all versions created in
-the same database transaction with a shared and unique `event_id`.
-
-There 3 other optional keys that are provided for tracking contextual information:
+You’ll often want to track contextual data about the creation of a version. There are 3 optional
+symbol keys that are provided for tracking contextual information:
 
-- `whodunit` - an identifier for who is responsible for creating the version
-- `note` - a string containing a description regarding the versioning
-- `meta` - any other contextual information you’d like to store along with the version
+- `:whodunit` - an identifier for who is responsible for creating the version
+- `:note` - a description regarding the versioning
+- `:meta` - any other contextual information you’d like to store along with the version
 
 This information is stored in a `jsonb` column. Each key’s value can be in the format of your
 choosing.
@@ -171,6 +175,17 @@ class ApplicationController < ActionController::Base
 end
 ```
 
+`hoardable` will also automatically capture the ActiveRecord
+[changes](https://api.rubyonrails.org/classes/ActiveModel/Dirty.html#method-i-changes) hash, the
+`operation` that cause the version (`update` or `delete`), and it will also tag all versions created
+in the same database transaction with a shared and unique `event_uuid`. These are available as:
+
+```ruby
+version.changes
+version.hoardable_operation
+version.hoardable_event_uuid
+```
+
 ### Model Callbacks
 
 Sometimes you might want to do something with a version before or after it gets inserted to the
@@ -225,8 +240,45 @@ Hoardable.with(enabled: false) do
 end
 ```
 
+### 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.
+
+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 scope on the relationship definition:
+
+```ruby
+belongs_to :parent, -> { include_versions }
+```
+
+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
+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 parent object, you can find and `untrash!`
+the children like so:
+
+```ruby
+class Post < ActiveRecord::Base
+  include Hoardable::Model
+  has_many :comments, dependent: :destroy # `Comment` also includes `Hoardable::Model`
+
+  after_untrashed do
+    Comment
+      .version_class
+      .trashed
+      .with_hoardable_event_uuid(hoardable_event_uuid)
+      .find_each(&:untrash!)
+  end
+end
+```
+
 ## Contributing
 
+This gem is currently considered alpha and very open to feedback.
+
 Bug reports and pull requests are welcome on GitHub at https://github.com/waymondo/hoardable.
 
 ## License

data/lib/generators/hoardable/migration_generator.rb

@@ -8,12 +8,20 @@ module Hoardable
   class MigrationGenerator < ActiveRecord::Generators::Base
     source_root File.expand_path('templates', __dir__)
     include Rails::Generators::Migration
+    class_option :foreign_key_type, type: :string
 
     def create_versions_table
       migration_template migration_template_name, "db/migrate/create_#{singularized_table_name}_versions.rb"
     end
 
     no_tasks do
+      def foreign_key_type
+        options[:foreign_key_type] ||
+          class_name.singularize.constantize.columns.find { |col| col.name == 'id' }.sql_type
+      rescue StandardError
+        'bigint'
+      end
+
       def migration_template_name
         if Gem::Version.new(ActiveRecord::Migration.current_version.to_s) < Gem::Version.new('7')
           'migration_6.rb.erb'

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

@@ -6,14 +6,14 @@ class Create<%= class_name.singularize %>Versions < ActiveRecord::Migration[<%=
     create_table :<%= singularized_table_name %>_versions, id: false, options: 'INHERITS (<%= table_name %>)' do |t|
       t.jsonb :_data
       t.tsrange :_during, null: false
-      t.enum :_operation, enum_type: 'hoardable_operation', null: false
-      t.bigint :<%= singularized_table_name %>_id, null: false, index: true
+      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
     end
     add_index(
       :<%= singularized_table_name %>_versions,
       %i[_during <%= singularized_table_name %>_id],
       name: 'idx_<%= singularized_table_name %>_versions_temporally'
     )
-    add_index :<%= singularized_table_name %>_versions, :_operation
   end
 end

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

@@ -21,14 +21,14 @@ class Create<%= class_name.singularize %>Versions < ActiveRecord::Migration[<%=
     create_table :<%= singularized_table_name %>_versions, id: false, options: 'INHERITS (<%= table_name %>)' do |t|
       t.jsonb :_data
       t.tsrange :_during, null: false
-      t.column :_operation, :hoardable_operation, null: false
-      t.bigint :<%= singularized_table_name %>_id, null: false, index: true
+      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
     end
     add_index(
       :<%= singularized_table_name %>_versions,
       %i[_during <%= singularized_table_name %>_id],
       name: 'idx_<%= singularized_table_name %>_versions_temporally'
     )
-    add_index :<%= singularized_table_name %>_versions, :_operation
   end
 end

data/lib/hoardable/hoardable.rb

@@ -2,7 +2,7 @@
 
 # An ActiveRecord extension for keeping versions of records in temporal inherited tables
 module Hoardable
-  DATA_KEYS = %i[meta whodunit note event_id].freeze
+  DATA_KEYS = %i[meta whodunit note event_uuid].freeze
   CONFIG_KEYS = %i[enabled save_trash].freeze
 
   VERSION_CLASS_SUFFIX = 'Version'

data/lib/hoardable/model.rb

@@ -15,9 +15,9 @@ module Hoardable
         next unless self == trace.self
 
         version_class_name = "#{name}#{VERSION_CLASS_SUFFIX}"
-        next if Object.const_defined?(version_class_name)
-
-        Object.const_set(version_class_name, Class.new(self) { include VersionModel })
+        unless Object.const_defined?(version_class_name)
+          Object.const_set(version_class_name, Class.new(self) { include VersionModel })
+        end
 
         include SourceModel
 

data/lib/hoardable/source_model.rb

@@ -17,10 +17,12 @@ module Hoardable
       around_update :insert_hoardable_version_on_update, if: :hoardable_callbacks_enabled
       around_destroy :insert_hoardable_version_on_destroy, if: [:hoardable_callbacks_enabled, SAVE_TRASH_ENABLED]
       before_destroy :delete_hoardable_versions, if: :hoardable_callbacks_enabled, unless: SAVE_TRASH_ENABLED
-      after_commit :unset_hoardable_version_and_event_id
+      after_commit :unset_hoardable_version_and_event_uuid
 
       attr_reader :hoardable_version
 
+      delegate :hoardable_event_uuid, :hoardable_operation, to: :hoardable_version, allow_nil: true
+
       has_many(
         :versions, -> { order(:_during) },
         dependent: nil,
@@ -34,9 +36,17 @@ module Hoardable
     end
 
     def at(datetime)
+      raise(Error, 'Future state cannot be known') if datetime.future?
+
       versions.find_by(DURING_QUERY, datetime) || self
     end
 
+    def revert_to!(datetime)
+      return unless (version = at(datetime))
+
+      version.is_a?(self.class.version_class) ? version.revert! : self
+    end
+
     private
 
     def hoardable_callbacks_enabled
@@ -52,18 +62,15 @@ module Hoardable
     end
 
     def insert_hoardable_version(operation, attrs)
-      event_id = find_or_initialize_hoardable_event_id
-      Hoardable.with(event_id: event_id) do
-        @hoardable_version = initialize_hoardable_version(operation, attrs)
-        run_callbacks(:versioned) do
-          yield
-          hoardable_version.save(validate: false, touch: false)
-        end
+      @hoardable_version = initialize_hoardable_version(operation, attrs)
+      run_callbacks(:versioned) do
+        yield
+        hoardable_version.save(validate: false, touch: false)
       end
     end
 
-    def find_or_initialize_hoardable_event_id
-      Thread.current[:hoardable_event_id] ||= SecureRandom.hex
+    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)
@@ -71,6 +78,7 @@ module Hoardable
         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)
           }
@@ -94,11 +102,11 @@ module Hoardable
       versions.delete_all(:delete_all)
     end
 
-    def unset_hoardable_version_and_event_id
+    def unset_hoardable_version_and_event_uuid
       @hoardable_version = nil
       return if ActiveRecord::Base.connection.transaction_open?
 
-      Thread.current[:hoardable_event_id] = nil
+      Thread.current[:hoardable_event_uuid] = nil
     end
   end
 end

data/lib/hoardable/version.rb

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

data/lib/hoardable/version_model.rb

@@ -13,6 +13,9 @@ module Hoardable
       self.table_name = "#{table_name.singularize}#{Hoardable::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
 
@@ -22,10 +25,11 @@ module Hoardable
           .where(_operation: 'delete')
       }
       scope :at, ->(datetime) { where(DURING_QUERY, datetime) }
+      scope :with_hoardable_event_uuid, ->(event_uuid) { where(_event_uuid: event_uuid) }
     end
 
     def revert!
-      raise(Error, 'Version is trashed, cannot revert') unless _operation == 'update'
+      raise(Error, 'Version is trashed, cannot revert') unless hoardable_operation == 'update'
 
       transaction do
         hoardable_source.tap do |reverted|
@@ -37,7 +41,7 @@ module Hoardable
     end
 
     def untrash!
-      raise(Error, 'Version is not trashed, cannot untrash') unless _operation == 'delete'
+      raise(Error, 'Version is not trashed, cannot untrash') unless hoardable_operation == 'delete'
 
       transaction do
         superscope = self.class.superclass.unscoped

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hoardable
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - justin talbott
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-28 00:00:00.000000000 Z
+date: 2022-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord