hoardable 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c4bc9bc4cdd73263a6afe5551b59f085cbf7dc3877e472df8abdba62f5fcbd6
-  data.tar.gz: 7aa8ea828b2f6083a80c93e34a1fcc5756508db15f2a317dc95bfea2ae8b1e28
+  metadata.gz: dff71dd2ebbebaeedfdc9d6fdd8c56c8faaa5505814cfe41c146c4a565375ff1
+  data.tar.gz: 6693f3634541bc8308ed5b4329d69851d971df1cec2b50e842fa9332c62425b6
 SHA512:
-  metadata.gz: 915cba36e937b34667b2ad31ae8dd780224a417669a6bb3c1abdfb2c8a19c10525e7d29a0a4f264aa475362f9b823104bd5a40d71bfc01848db2eb6a463f7c1d
-  data.tar.gz: ab0faaab94b03c5b6452b7aad505e16b4bb98538ae8649cfd65e17d397e3d917e6e61c752ed39b820dc30d72503e993ec5d6fbe353391c29025759a4bedeff74
+  metadata.gz: ec2a9df9254cf3623f4fffb0516e99ec30a46ec6496ad0d5e555d4a3ce8324fa81d1880036f42aeb4bbbee136957479f283ccab4b8fb3f2847122bd597483889
+  data.tar.gz: 25a5040c6dc5b91b0b54020657e436aa775cf2211b56fecf1b277e36c11041b55f5a29861000503d5388a9a3d0280a8ccca99c052a2dc82a45abb8f5c98bb50e

data/.rubocop.yml

@@ -10,5 +10,9 @@ Metrics/ClassLength:
   Exclude:
     - 'test/**/*.rb'
 
+Metrics/BlockLength:
+  Exclude:
+    - 'test/**/*.rb'
+
 Style/DocumentDynamicEvalDefinition:
   Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [0.6.0] - 2022-09-28
+
+- **Breaking Change** - Previously, a source model would `has_many :versions` with an inverse
+  relationship of the i18n interpreted name of the source model. Now it simply `has_many :versions,
+  inverse_of :hoardable_source` to not potentially conflict with previously existing relationships.
+
 ## [0.5.0] - 2022-09-25
 
 - **Breaking Change** - Untrashing a version will now insert a version for the untrash event with

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].freeze
+  CONFIG_KEYS = %i[enabled version_updates save_trash return_everything warn_on_missing_created_at_column].freeze
 
   VERSION_CLASS_SUFFIX = 'Version'
   private_constant :VERSION_CLASS_SUFFIX
@@ -19,6 +19,21 @@ module Hoardable
   DURING_QUERY = '_during @> ?::timestamp'
   private_constant :DURING_QUERY
 
+  HOARDABLE_CALLBACKS_ENABLED = proc do |source_model|
+    source_model.class.hoardable_config[:enabled] && !source_model.class.name.end_with?(VERSION_CLASS_SUFFIX)
+  end.freeze
+  private_constant :HOARDABLE_CALLBACKS_ENABLED
+
+  HOARDABLE_SAVE_TRASH = proc do |source_model|
+    source_model.class.hoardable_config[:save_trash]
+  end.freeze
+  private_constant :HOARDABLE_SAVE_TRASH
+
+  HOARDABLE_VERSION_UPDATES = proc do |source_model|
+    source_model.class.hoardable_config[:version_updates]
+  end.freeze
+  private_constant :HOARDABLE_VERSION_UPDATES
+
   @context = {}
   @config = CONFIG_KEYS.to_h do |key|
     [key, key != :return_everything]
@@ -59,5 +74,10 @@ module Hoardable
       @config = current_config
       @context = current_context
     end
+
+    # @!visibility private
+    def logger
+      @logger ||= ActiveSupport::TaggedLogging.new(Logger.new($stdout))
+    end
   end
 end

data/lib/hoardable/source_model.rb

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

data/lib/hoardable/version.rb

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

data/lib/hoardable/version_model.rb

@@ -14,11 +14,13 @@ module Hoardable
     end
 
     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
+      belongs_to(
+        :hoardable_source,
+        inverse_of: :versions,
+        class_name: superclass.model_name,
+        foreign_key: hoardable_source_foreign_key
+      )
 
       self.table_name = "#{table_name.singularize}#{VERSION_TABLE_SUFFIX}"
 
@@ -27,7 +29,7 @@ module Hoardable
       alias_attribute :hoardable_event_uuid, :_event_uuid
       alias_attribute :hoardable_during, :_during
 
-      before_create :assign_temporal_tsrange
+      before_create { hoardable_version_service.assign_temporal_tsrange }
 
       # @!scope class
       # @!method trashed
@@ -35,7 +37,7 @@ module Hoardable
       #
       # Returns only trashed +versions+ that are currently orphans.
       scope :trashed, lambda {
-        left_outer_joins(hoardable_source_key)
+        left_outer_joins(:hoardable_source)
           .where(superclass.table_name => { id: nil })
           .where(_operation: 'delete')
       }
@@ -77,7 +79,7 @@ module Hoardable
 
       transaction do
         hoardable_source.tap do |reverted|
-          reverted.update!(hoardable_source_attributes.without('id'))
+          reverted.update!(hoardable_version_service.hoardable_source_attributes.without('id'))
           reverted.instance_variable_set(:@hoardable_version, self)
           reverted.run_callbacks(:reverted)
         end
@@ -90,10 +92,8 @@ module Hoardable
       raise(Error, 'Version is not trashed, cannot untrash') unless hoardable_operation == 'delete'
 
       transaction do
-        superscope = self.class.superclass.unscoped
-        superscope.insert(hoardable_source_attributes.merge('id' => hoardable_source_foreign_id))
-        superscope.find(hoardable_source_foreign_id).tap do |untrashed|
-          untrashed.send('insert_hoardable_version_on_untrashed')
+        hoardable_version_service.insert_untrashed_source.tap do |untrashed|
+          untrashed.send('hoardable_source_service').insert_hoardable_version('insert')
           untrashed.instance_variable_set(:@hoardable_version, self)
           untrashed.run_callbacks(:untrashed)
         end
@@ -118,31 +118,67 @@ module Hoardable
       @hoardable_source_foreign_id ||= public_send(hoardable_source_foreign_key)
     end
 
-    private
-
     delegate :hoardable_source_foreign_key, to: :class
 
-    def hoardable_source_attributes
-      @hoardable_source_attributes ||=
-        attributes_before_type_cast
-        .without(hoardable_source_foreign_key)
-        .reject { |k, _v| k.start_with?('_') }
+    def hoardable_version_service
+      @hoardable_version_service ||= Service.new(self)
     end
 
-    def previous_temporal_tsrange_end
-      hoardable_source.versions.only_most_recent.pluck('_during').first&.end
-    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 assign_temporal_tsrange
-      range_start = (
-        previous_temporal_tsrange_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
-      )
-      self._during = (range_start..Time.now.utc)
+      end
+
+      def assign_temporal_tsrange
+        version_model._during = ((previous_temporal_tsrange_end || hoardable_source_epoch)..Time.now.utc)
+      end
+
+      def maybe_warn_about_missing_created_at_column
+        return unless hoardable_source.class.hoardable_config[:warn_on_missing_created_at_column]
+
+        source_table_name = hoardable_source.class.table_name
+        Hoardable.logger.info(
+          <<~LOG
+            '#{source_table_name}' does not have a 'created_at' column, so the first version’s temporal period
+            will begin at the unix epoch instead. Add a 'created_at' column to '#{source_table_name}'
+            or set 'Hoardable.warn_on_missing_created_at_column = false' to disable this message.
+          LOG
+        )
+      end
     end
+    private_constant :Service
   end
 end

data/sig/hoardable.rbs

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

metadata

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