hoardable 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c73d162f69d7ff2984571b7e0aefa256357a835c2ecb22d1288a362dce38d73
-  data.tar.gz: 4b250ebb2bf536f94d3cd8e65f0bd884579bd6fc5d8fd89f5c9846554c4d0e7a
+  metadata.gz: c960d95a373942d9183464cc50b7c4213c25c7563fa9d920c81d2c325ea71705
+  data.tar.gz: e7e0f289e60acd720538edc15584209ed3d30e08b21758d06884a5486f198ee0
 SHA512:
-  metadata.gz: 4503897e596e1694a49009aa3e964a86a8e317169c590a1079b075345b9116fb4af50abb68b17a4ea73c7bf1570f56906c11f5e57dbaf84044ab8ac11ca942f2
-  data.tar.gz: a8e2780685b3d0a00757c44ca6a38f58571ef617b1543b7ee8b8f3dcef18c9fed5f7c3e10f7d31677afe0fccafeffca4348d70b5afe3706ead0438488bf57166
+  metadata.gz: a83966223151922d24bb009ac50465723388ba91825e27cf933bb5e00370c270a0518ec828358f1109a040e2a9202cee7b37d7ea98e0387b30dc07a74f7eb851
+  data.tar.gz: 6bc246f6664b61c5000ffa71b24c8ddd30c409eda87e790b0ea1bd9d47f46c4e85e0b5eb89736939a75018e272cdd5ac2ce1217c7c7e9272ddc4f96cc8cc33f4

data/Gemfile

@@ -8,5 +8,6 @@ gem 'rake', '~> 13.0'
 gem 'rubocop', '~> 1.21'
 gem 'rubocop-minitest', '~> 0.20'
 gem 'rubocop-rake', '~> 0.6'
+gem 'yard', '~> 0.9'
 
 gemspec

data/README.md

@@ -3,8 +3,6 @@
 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_.
 
-#### 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,
 each database row has a time range that represents the row’s valid time range - hence
@@ -18,8 +16,10 @@ change is reflected on its descendants.
 With these concepts combined, `hoardable` offers a simple and effective model versioning system for
 Rails. Versions of records are stored in separate, inherited tables along with their valid time
 ranges and contextual data. Compared to other Rails-oriented versioning systems, this gem strives to
-be more explicit and obvious on the lower RDBS level while still familiar and convenient within Ruby
-on Rails.
+be more explicit and obvious on the lower RDBS level while still familiar and convenient to use
+within Ruby on Rails.
+
+[👉 Documentation](https://www.rubydoc.info/gems/hoardable)
 
 ## Installation
 
@@ -117,6 +117,10 @@ post.at(1.day.ago) # => #<PostVersion:0x000000010d44fa30>
 PostVersion.at(1.day.ago).find_by(post_id: post.id) # => #<PostVersion:0x000000010d44fa30>
 ```
 
+_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.
+
 By default, `hoardable` will keep copies of records you have destroyed. You can query for them as
 well:
 
@@ -127,7 +131,7 @@ PostVersion.trashed
 _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.
 
-### Tracking contextual data
+### Tracking Contextual Data
 
 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:
@@ -220,19 +224,22 @@ end
 
 ### Configuration
 
-There are two configurable options currently:
+There are three configurable options currently:
 
 ```ruby
 Hoardable.enabled # => default true
+Hoardable.version_updates # => default true
 Hoardable.save_trash # => default true
 ```
 
-`Hoardable.enabled` controls whether versions will be created at all.
+`Hoardable.enabled` controls whether versions will be ever be created.
+
+`Hoardable.version_updates` controls whether versions get created on record updates.
 
 `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.
 
-If you would like to temporarily set a config setting, you can use `Hoardable.with` as well:
+If you would like to temporarily set a config setting, you can use `Hoardable.with`:
 
 ```ruby
 Hoardable.with(enabled: false) do
@@ -240,6 +247,18 @@ Hoardable.with(enabled: false) do
 end
 ```
 
+You can also configure these variables per `ActiveRecord` class as well using `hoardable_options`:
+
+```ruby
+class Comment < ActiveRecord::Base
+  include Hoardable::Model
+  hoardable_options version_updates: false
+end
+```
+
+If either the model-level option or global option for a configuration variable is set to `false`,
+that behavior will be disabled.
+
 ### Relationships
 
 As in life, sometimes relationships can be hard. `hoardable` is still working out best practices and
@@ -269,15 +288,56 @@ class Post < ActiveRecord::Base
     Comment
       .version_class
       .trashed
+      .where(post_id: id)
       .with_hoardable_event_uuid(hoardable_event_uuid)
       .find_each(&:untrash!)
   end
 end
 ```
 
+## Gem Comparison
+
+###  [`paper_trail`](https://github.com/paper-trail-gem/paper_trail) 
+
+`paper_trail` is maybe the most popular and fully featured gem in this space. It works for other
+  database types than PostgeSQL and (by default) stores all versions of all versioned models in a
+  single `versions` table. It stores changes in a `text`, `json`, or `jsonb` column. In order to
+  efficiently query the `versions` table, a `jsonb` column should be used, which takes up a lot of
+  space to index. Unless you customize your configuration, all `versions` for all models types are
+  in the same table which is inefficient if you are only interested in querying versions of a single
+  model. By contrast, `hoardable` stores versions in smaller, isolated and inherited tables with the
+  same database columns as their parents, which are more efficient for querying as well as auditing
+  for truncating and dropping. The concept of a `temporal` time-frame does not exist for a single
+  version since there is only a `created_at` timestamp.
+
+### [`audited`](https://github.com/collectiveidea/audited)
+
+`audited` works in a similar manner as `paper_trail`. It stores all versions for all model types in
+a single table, you must opt into using `jsonb` as the column type to store "changes", in case you
+want to query them, and there is no concept of a `temporal` time-frame for a single version. It
+makes opinionated decisions about contextual data requirements and stores them as top level data
+types on the `audited` table.
+
+### [`discard`](https://github.com/jhawthorn/discard)
+
+`discard` only covers soft-deletion. The act of "soft deleting" a record is only captured through
+the time-stamping of a `discarded_at` column on the records table; there is no other capturing of
+the event that caused the soft deletion unless you implement it yourself. Once the "discarded"
+record is restored, the previous "discarded" awareness is lost. Since "discarded" records exist in
+the same table as "undiscarded" records, you must explicitly omit the discarded records from queries
+across your app to keep them from leaking in.
+
+### [`paranoia`](https://github.com/rubysherpas/paranoia)
+
+`paranoia` also only covers soft-deletion. In their README, they recommend using `discard` instead
+of `paranoia` because of the fact they override ActiveRecord’s `delete` and `destroy` methods.
+`hoardable` employs callbacks to create trashed versions instead of overriding methods. Otherwise,
+`paranoia` works similarly to `discard` in that it keeps deleted records in the same table and tags
+them with a `deleted_at` timestamp. No other information about the soft-deletion event is stored.
+
 ## Contributing
 
-This gem is currently considered alpha and very open to feedback.
+This gem still quite new and very open to feedback.
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/waymondo/hoardable.
 

data/lib/generators/hoardable/migration_generator.rb

@@ -4,7 +4,8 @@ require 'rails/generators'
 require 'rails/generators/active_record/migration/migration_generator'
 
 module Hoardable
-  # Generates a migration for an inherited temporal table of a model including {Hoardable::Model}
+  # Generates a migration to create an inherited uni-temporal table of a model including
+  # {Hoardable::Model}, for the storage of +versions+.
   class MigrationGenerator < ActiveRecord::Generators::Base
     source_root File.expand_path('templates', __dir__)
     include Rails::Generators::Migration

data/lib/hoardable/error.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Hoardable
-  # A subclass of StandardError for general use within Hoardable
+  # A subclass of +StandardError+ for general use within {Hoardable}.
   class Error < StandardError; end
 end

data/lib/hoardable/hoardable.rb

@@ -1,13 +1,21 @@
 # frozen_string_literal: true
 
-# An ActiveRecord extension for keeping versions of records in temporal inherited tables
+# An +ActiveRecord+ extension for keeping versions of records in uni-temporal inherited tables.
 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
-  CONFIG_KEYS = %i[enabled save_trash].freeze
+  # Symbols for use with setting {Hoardable} configuration. See {file:README.md#configuration
+  # README} for more.
+  CONFIG_KEYS = %i[enabled version_updates save_trash].freeze
 
+  # @!visibility private
   VERSION_CLASS_SUFFIX = 'Version'
+
+  # @!visibility private
   VERSION_TABLE_SUFFIX = "_#{VERSION_CLASS_SUFFIX.tableize}"
-  SAVE_TRASH_ENABLED = -> { Hoardable.save_trash }.freeze
+
+  # @!visibility private
   DURING_QUERY = '_during @> ?::timestamp'
 
   @context = {}
@@ -36,6 +44,9 @@ module Hoardable
       end
     end
 
+    # This is a general use method for setting {DATA_KEYS} or {CONFIG_KEYS} around a scoped block.
+    #
+    # @param hash [Hash] Options and contextual data to set within a block
     def with(hash)
       current_config = @config
       current_context = @context

data/lib/hoardable/model.rb

@@ -1,11 +1,36 @@
 # frozen_string_literal: true
 
 module Hoardable
-  # This concern dynamically generates the Version variant of the class module Model and includes
-  # the API methods and relationships on the source model
+  # This concern is the main entrypoint for using {Hoardable}. When included into an +ActiveRecord+
+  # class, it dynamically generates the +Version+ variant of that class (with {VersionModel}) and
+  # includes the {Hoardable} API methods and relationships on the source model class (through
+  # {SourceModel}).
   module Model
     extend ActiveSupport::Concern
 
+    class_methods do
+      # @!visibility private
+      attr_reader :_hoardable_options
+
+      # If called with a hash, this will set the model-level +Hoardable+ configuration variables. If
+      # called without an argument it will return the computed +Hoardable+ configuration considering
+      # both model-level and global values.
+      #
+      # @param hash [Hash] The +Hoardable+ configuration for the model. Keys must be present in
+      #   {CONFIG_KEYS}
+      # @return [Hash]
+      def hoardable_options(hash = nil)
+        if hash
+          @_hoardable_options = hash.slice(*Hoardable::CONFIG_KEYS)
+        else
+          @_hoardable_options ||= {}
+          Hoardable::CONFIG_KEYS.to_h do |key|
+            [key, Hoardable.send(key) != false && @_hoardable_options[key] != false]
+          end
+        end
+      end
+    end
+
     included do
       define_model_callbacks :versioned
       define_model_callbacks :reverted, only: :after

data/lib/hoardable/source_model.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
 module Hoardable
-  # This concern contains the relationships, callbacks, and API methods for a Source model
+  # This concern contains the {Hoardable} relationships, callbacks, and API methods for an
+  # +ActiveRecord+. It is included by {Hoardable::Model} after the dynamic generation of the
+  # +Version+ class variant.
   module SourceModel
     extend ActiveSupport::Concern
 
     class_methods do
+      # The dynamically generated +Version+ class for this model.
       def version_class
         "#{name}#{VERSION_CLASS_SUFFIX}".constantize
       end
@@ -14,15 +17,22 @@ module Hoardable
     included do
       include Tableoid
 
-      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
+      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
 
+      # This will contain 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
 
+      # Returns all +versions+ in ascending order of their temporal timeframes.
       has_many(
         :versions, -> { order(:_during) },
         dependent: nil,
@@ -31,16 +41,27 @@ module Hoardable
       )
     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&.send(:hoardable_source_attributes) == attributes
     end
 
+    # Returns the +version+ at the supplied +datetime+ or +time+. It will return +self+ if there is
+    # none. This will raise an error if you try to find a version in the future.
+    #
+    # @param datetime [DateTime, Time]
     def at(datetime)
       raise(Error, 'Future state cannot be known') if datetime.future?
 
       versions.find_by(DURING_QUERY, datetime) || self
     end
 
+    # If a version is found at the supplied datetime, it will +revert!+ to it and return it. This
+    # will raise an error if you try to revert to a version in the future.
+    #
+    # @param datetime [DateTime, Time]
     def revert_to!(datetime)
       return unless (version = at(datetime))
 
@@ -50,7 +71,15 @@ module Hoardable
     private
 
     def hoardable_callbacks_enabled
-      Hoardable.enabled && !self.class.name.end_with?(VERSION_CLASS_SUFFIX)
+      self.class.hoardable_options[:enabled] && !self.class.name.end_with?(VERSION_CLASS_SUFFIX)
+    end
+
+    def hoardable_save_trash
+      self.class.hoardable_options[:save_trash]
+    end
+
+    def hoardable_version_updates
+      self.class.hoardable_options[:version_updates]
     end
 
     def insert_hoardable_version_on_update(&block)

data/lib/hoardable/tableoid.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
 module Hoardable
-  # This concern provides support for PostgreSQL's tableoid system column
+  # This concern provides support for PostgreSQL’s tableoid system column to {SourceModel}.
   module Tableoid
     extend ActiveSupport::Concern
 
+    # @!visibility private
     TABLEOID_AREL_CONDITIONS = lambda do |arel_table, condition|
       arel_table[:tableoid].send(
         condition,
@@ -13,13 +14,32 @@ module Hoardable
     end.freeze
 
     included do
+      # @!visibility private
       attr_writer :tableoid
 
+      # By default, {Hoardable} only returns instances of the parent table, and not the +versions+
+      # in the inherited table.
       default_scope { where(TABLEOID_AREL_CONDITIONS.call(arel_table, :eq)) }
+
+      # @!scope class
+      # @!method include_versions
+      # @return [ActiveRecord<Object>]
+      #
+      # Returns +versions+ along with instances of the source models, all cast as instances of the
+      # source model’s class.
       scope :include_versions, -> { unscope(where: [:tableoid]) }
+
+      # @!scope class
+      # @!method versions
+      # @return [ActiveRecord<Object>]
+      #
+      # 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)) }
     end
 
+    private
+
     def tableoid
       connection.execute("SELECT oid FROM pg_class WHERE relname = '#{table_name}'")[0]['oid']
     end

data/lib/hoardable/version.rb

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

data/lib/hoardable/version_model.rb

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
 
 module Hoardable
-  # This concern is included into the dynamically generated Version models.
+  # This concern is included into the dynamically generated +Version+ kind of the parent
+  # +ActiveRecord+ class.
   module VersionModel
     extend ActiveSupport::Concern
 
     included do
       hoardable_source_key = superclass.model_name.i18n_key
+
+      # A +version+ belongs to it’s parent +ActiveRecord+ source.
       belongs_to hoardable_source_key, inverse_of: :versions
       alias_method :hoardable_source, hoardable_source_key
 
@@ -19,15 +22,35 @@ module Hoardable
 
       before_create :assign_temporal_tsrange
 
+      # @!scope class
+      # @!method trashed
+      # @return [ActiveRecord<Object>]
+      #
+      # Returns only trashed +versions+ that are orphans.
       scope :trashed, lambda {
         left_outer_joins(hoardable_source_key)
           .where(superclass.table_name => { id: nil })
           .where(_operation: 'delete')
       }
+
+      # @!scope class
+      # @!method at
+      # @return [ActiveRecord<Object>]
+      #
+      # Returns +versions+ that were valid at the supplied +datetime+ or +time+.
       scope :at, ->(datetime) { where(DURING_QUERY, datetime) }
+
+      # @!scope class
+      # @!method with_hoardable_event_uuid
+      # @return [ActiveRecord<Object>]
+      #
+      # 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) }
     end
 
+    # Reverts the parent +ActiveRecord+ instance to the saved attributes of this +version+. Raises
+    # an error if the version is trashed.
     def revert!
       raise(Error, 'Version is trashed, cannot revert') unless hoardable_operation == 'update'
 
@@ -40,6 +63,8 @@ module Hoardable
       end
     end
 
+    # Inserts a trashed +version+ back into its parent +ActiveRecord+ table with its original
+    # primary key. Raises an error if the version is not trashed.
     def untrash!
       raise(Error, 'Version is not trashed, cannot untrash') unless hoardable_operation == 'delete'
 
@@ -59,6 +84,9 @@ module Hoardable
       end
     end
 
+    # Returns the +ActiveRecord+
+    # {https://api.rubyonrails.org/classes/ActiveModel/Dirty.html#method-i-changes changes} that
+    # were present during version creation.
     def changes
       _data&.dig('changes')
     end

data/sig/hoardable.rbs

@@ -1,4 +1,86 @@
 module Hoardable
   VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  DATA_KEYS: [:meta, :whodunit, :note, :event_uuid]
+  CONFIG_KEYS: [:enabled, :version_updates, :save_trash]
+  VERSION_CLASS_SUFFIX: String
+  VERSION_TABLE_SUFFIX: String
+  DURING_QUERY: String
+  self.@context: Hash[untyped, untyped]
+  self.@config: untyped
+
+  def self.with: (untyped hash) -> untyped
+
+  module Tableoid
+    TABLEOID_AREL_CONDITIONS: Proc
+
+    private
+    def tableoid: -> untyped
+
+    public
+    attr_writer tableoid: untyped
+  end
+
+  class Error < StandardError
+  end
+
+  module SourceModel
+    include Tableoid
+
+    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
+
+    public
+    def version_class: -> untyped
+    attr_reader hoardable_version: nil
+  end
+
+  module VersionModel
+    @hoardable_source_attributes: untyped
+    @hoardable_source_foreign_key: String
+    @hoardable_source_foreign_id: untyped
+
+    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
+  end
+
+  module Model
+    include VersionModel
+    include SourceModel
+
+    attr_reader _hoardable_options: Hash[untyped, untyped]
+    def hoardable_options: (?nil hash) -> untyped
+  end
+
+  class MigrationGenerator
+    @singularized_table_name: untyped
+
+    def create_versions_table: -> untyped
+    def foreign_key_type: -> String
+    def migration_template_name: -> String
+    def singularized_table_name: -> untyped
+  end
 end

metadata

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