hoardable 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c73d162f69d7ff2984571b7e0aefa256357a835c2ecb22d1288a362dce38d73
-  data.tar.gz: 4b250ebb2bf536f94d3cd8e65f0bd884579bd6fc5d8fd89f5c9846554c4d0e7a
+  metadata.gz: 96952d8928266fc5ae03199a91e85428565ff11385a74851fe61fd3a8eafc881
+  data.tar.gz: 1b9117cbf4ea08325d29212c16580e368a857b12f8c2d20bc346d9e8f5268d59
 SHA512:
-  metadata.gz: 4503897e596e1694a49009aa3e964a86a8e317169c590a1079b075345b9116fb4af50abb68b17a4ea73c7bf1570f56906c11f5e57dbaf84044ab8ac11ca942f2
-  data.tar.gz: a8e2780685b3d0a00757c44ca6a38f58571ef617b1543b7ee8b8f3dcef18c9fed5f7c3e10f7d31677afe0fccafeffca4348d70b5afe3706ead0438488bf57166
+  metadata.gz: e533edf9412339fcc90691fa5d10395265914f71f7f7493c9afc226902cf831db87f69661d565630602e2db815549e4209550420abc44f6a7d179ccb23ba7509
+  data.tar.gz: a8c690b0a3399f3853ed6c65ca7d514af9c82d10569483d7d4bed86c6e7a63d1881ecac61e13d6646facdce3370614dc6c86f88599bc6eb955feba38589c398c

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,7 +3,9 @@
 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?
+[👉 Documentation](https://www.rubydoc.info/gems/hoardable)
+
+### 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,
@@ -269,6 +271,7 @@ class Post < ActiveRecord::Base
     Comment
       .version_class
       .trashed
+      .where(post_id: id)
       .with_hoardable_event_uuid(hoardable_event_uuid)
       .find_each(&:untrash!)
   end

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,24 @@
 # 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
+  # Symbols for use with setting {Hoardable} configuration. See {file:README.md#configuration
+  # README} for more.
   CONFIG_KEYS = %i[enabled save_trash].freeze
 
+  # @!visibility private
   VERSION_CLASS_SUFFIX = 'Version'
+
+  # @!visibility private
   VERSION_TABLE_SUFFIX = "_#{VERSION_CLASS_SUFFIX.tableize}"
+
+  # @!visibility private
   SAVE_TRASH_ENABLED = -> { Hoardable.save_trash }.freeze
+
+  # @!visibility private
   DURING_QUERY = '_during @> ?::timestamp'
 
   @context = {}
@@ -36,6 +47,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,8 +1,10 @@
 # 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
 

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
@@ -19,10 +22,17 @@ module Hoardable
       before_destroy :delete_hoardable_versions, if: :hoardable_callbacks_enabled, unless: SAVE_TRASH_ENABLED
       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))
 

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.1.3'
 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

metadata

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