hoardable 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96952d8928266fc5ae03199a91e85428565ff11385a74851fe61fd3a8eafc881
-  data.tar.gz: 1b9117cbf4ea08325d29212c16580e368a857b12f8c2d20bc346d9e8f5268d59
+  metadata.gz: a5e5c29b0b6d4a24e7b41a9b4846fd1288caabd48158b517a4b9b61e53421d1c
+  data.tar.gz: 1e863147db8e3a39e4ed3d465855d465f14c4c8a444426abce72534e8bae4d9c
 SHA512:
-  metadata.gz: e533edf9412339fcc90691fa5d10395265914f71f7f7493c9afc226902cf831db87f69661d565630602e2db815549e4209550420abc44f6a7d179ccb23ba7509
-  data.tar.gz: a8c690b0a3399f3853ed6c65ca7d514af9c82d10569483d7d4bed86c6e7a63d1881ecac61e13d6646facdce3370614dc6c86f88599bc6eb955feba38589c398c
+  metadata.gz: 4c997b34958fbe6253098778c03bf9226eac02b7fd218af1a1d1bd52527b7b1a0b0406a6ecf0cc8e3ea45d70e5b8823dc23a0e48fcc741c470831b98adb3fd65
+  data.tar.gz: 44b9c1cfe68aa6ab18370b90632d5563dda8ef50b0cde425be3b44eb7f2027fa6e61d609538653cc15adab20f9d79ba3423f614d95c9413f8db4c0ced3a2f4be

data/README.md

@@ -222,19 +222,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
@@ -242,6 +245,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

data/lib/hoardable/hoardable.rb

@@ -7,7 +7,7 @@ module Hoardable
   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
+  CONFIG_KEYS = %i[enabled version_updates save_trash].freeze
 
   # @!visibility private
   VERSION_CLASS_SUFFIX = 'Version'
@@ -15,9 +15,6 @@ module Hoardable
   # @!visibility private
   VERSION_TABLE_SUFFIX = "_#{VERSION_CLASS_SUFFIX.tableize}"
 
-  # @!visibility private
-  SAVE_TRASH_ENABLED = -> { Hoardable.save_trash }.freeze
-
   # @!visibility private
   DURING_QUERY = '_during @> ?::timestamp'
 

data/lib/hoardable/model.rb

@@ -8,6 +8,29 @@ module Hoardable
   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

@@ -17,9 +17,9 @@ 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
@@ -71,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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Hoardable
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 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.3
+  version: 0.1.4
 platform: ruby
 authors:
 - justin talbott
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-02 00:00:00.000000000 Z
+date: 2022-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord