active_snapshot 0.3.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffb14fbf0391e0fb8c91c363740372b0e9688711ed41e620fd1707c690562cb5
-  data.tar.gz: 60c00ff5bd2266bfebc2411945f4f6b8cb9f1435ef9b012a582fffbf2e10b73c
+  metadata.gz: dcfaf7d239a170431fa82d70ab56b18bfb54a327b46376017357368b38f484b3
+  data.tar.gz: 833d8fb9ca610983f9a9e510cd6fc94776f043bf3d35ec7e052a2ade87cf1e5a
 SHA512:
-  metadata.gz: 729687b8c87777eeb8d2dd923b67917ae9000fe73d604517ecdb2410361d659c437bbe9c491c89927942540edf2fc12cdab8ca51cc7c4e3c9dfd1443e2a2b669
-  data.tar.gz: 25690387b0d2ec4ee5f951579c038e4cddedbd9f5ba3bf3aaafdfe8eeace856004203ffb940fc5581baf0ee31993168a78502774cb36173e85900bb9428e1ff4
+  metadata.gz: a412ace11cbeee26528d5e3b58116a1b716f415ab4c1aead7978e6c5f2ccd1db49ee7c08ea0120226d1f66d1d099384cd6cadec5353a3f2fa5aee28d32b825e8
+  data.tar.gz: 5290672baca7ed50d67e9654acb85851e997f9c601d6fa6aae898cf51ba448686595e30b61c4819eafe6f81608850777a9b75ca5a995c18f9f6b6d8047542bf8

data/CHANGELOG.md

@@ -2,9 +2,22 @@ CHANGELOG
 ---------
 
 - **Unreleased**
-  * [View Diff](https://github.com/westonganger/active_snapshot/compare/v0.3.2...master)
+  * [View Diff](https://github.com/westonganger/active_snapshot/compare/v0.5.0...master)
   * Nothing yet
 
+- **v0.5.0** - Nov 8, 2024
+  * [View Diff](https://github.com/westonganger/active_snapshot/compare/v0.4.0...v0.5.0)
+  * [#61](https://github.com/westonganger/active_snapshot/pull/61) - Ensure snapshot record returned by `create_snapshot!` is `valid?`
+  * [#60](https://github.com/westonganger/active_snapshot/pull/60) - Store enum value as integer
+  * [#56](https://github.com/westonganger/active_snapshot/pull/56) - Add presence validation for object in SnapshotItem model
+  * [#57](https://github.com/westonganger/active_snapshot/pull/57) - Add readonly argument to `Shapshot#fetch_reified_items`
+  * [#53](https://github.com/westonganger/active_snapshot/pull/53) - Allow `ActiveSnapshot.config` to be called before ActiveRecord `on_load` hook has occurred
+  * [#52](https://github.com/westonganger/active_snapshot/pull/52) - Remove deprecated positional argument on `create_snapshot!`
+
+- **v0.4.0** - July 23, 2024
+  * [View Diff](https://github.com/westonganger/active_snapshot/compare/v0.3.2...v0.4.0)
+  * [#44](https://github.com/westonganger/active_snapshot/pull/44) - Remove dependency on `activerecord-import` with vanilla ActiveRecord `upsert_all`
+
 - **v0.3.2** - Oct 17, 2023
   * [View Diff](https://github.com/westonganger/active_snapshot/compare/v0.3.1...v0.3.2)
   * [#43](https://github.com/westonganger/active_snapshot/pull/43) - Fix unique index error in generated DB migration

data/README.md

@@ -1,7 +1,7 @@
 # ActiveSnapshot
 
 <a href="https://badge.fury.io/rb/active_snapshot" target="_blank"><img height="21" style='border:0px;height:21px;' border='0' src="https://badge.fury.io/rb/active_snapshot.svg" alt="Gem Version"></a>
-<a href='https://github.com/westonganger/active_snapshot/actions' target='_blank'><img src="https://github.com/westonganger/active_snapshot/workflows/Tests/badge.svg" style="max-width:100%;" height='21' style='border:0px;height:21px;' border='0' alt="CI Status"></a>
+<a href='https://github.com/westonganger/active_snapshot/actions' target='_blank'><img src="https://github.com/westonganger/active_snapshot/actions/workflows/test.yml/badge.svg?branch=master" style="max-width:100%;" height='21' style='border:0px;height:21px;' border='0' alt="CI Status"></a>
 <a href='https://rubygems.org/gems/active_snapshot' target='_blank'><img height='21' style='border:0px;height:21px;' src='https://img.shields.io/gem/dt/active_snapshot?color=brightgreen&label=Rubygems%20Downloads' border='0' alt='RubyGems Downloads' /></a>
 
 Simplified snapshots and restoration for ActiveRecord models and associations with a transparent white-box implementation.
@@ -9,15 +9,15 @@ Simplified snapshots and restoration for ActiveRecord models and associations wi
 Key Features:
 
 - Create and Restore snapshots of a parent record and any specified child records
-- Predictible and explicit behaviour provides much needed clarity to your restore logic
+- Predictable and explicit behaviour provides much needed clarity to your restore logic
 - Snapshots are created upon request only, we do not use any callbacks
 - Tiny method footprint so its easy to completely override the logic later
 
 Why This Library:
 
-Model Versioning and Restoration require concious thought, design, and understanding. You should understand your versioning and restoration process completely. This gem's small API and fully understandable design fully supports this.
+Model Versioning and Restoration require conscious thought, design, and understanding. You should understand your versioning and restoration process completely. This gem's small API and fully understandable design fully supports this.
 
-I do not recommend using paper_trail-association_tracking because it is mostly a blackbox solution which encourages you to set it up and then assume its Just Working<sup>TM</sup>. This makes for major data problems later. Dont fall into this trap. Instead read this gems brief source code completely before use OR copy the code straight into your codebase. Once you know it, then you are free.
+I do not recommend using [paper_trail-association_tracking](https://github.com/westonganger/paper_trail-association_tracking) because it is mostly a blackbox solution which encourages you to set it up and then assume its Just Working<sup>TM</sup>. This makes for major data problems later. Dont fall into this trap. Instead read this gems brief source code completely before use OR copy the code straight into your codebase. Once you know it, then you are free.
 
 
 
@@ -101,24 +101,24 @@ snapshot.destroy!
 ```ruby
 class Post < ActiveRecord::Base
   include ActiveSnapshot
-  
+
   has_snapshot_children do
     ### Executed in the context of the instance / self
 
     ### Reload record from database to ensure a clean state and eager load the specified associations
     instance = self.class.includes(:tags, :ip_address, comments: [:comment_sub_records]).find(id)
-    
+
     ### Define the associated records that will be restored
     {
       comments: instance.comments,
-      
+
       ### Nested Associations can be handled by simply mapping them into an array
-      comment_sub_records: instance.comments.flat_map{|x| x.comment_sub_records }, 
-      
+      comment_sub_records: instance.comments.flat_map{|x| x.comment_sub_records },
+
       tags: {
         records: instance.tags
       },
-      
+
       ip_address: {
         record: instance.ip_address,
         delete_method: ->(item){ item.release! }
@@ -133,18 +133,20 @@ Now when you run `create_snapshot!` the associations will be tracked accordingly
 
 # Reifying Snapshot Items
 
-You can view all of the reified snapshot items by calling the following method. Its completely up to you on how to use this data. 
+You can view all of the reified snapshot items by calling the following method. Its completely up to you on how to use this data.
 
 ```ruby
 reified_parent, reified_children_hash = snapshot.fetch_reified_items
 ```
 
-As a safety these records have the `@readonly = true` attribute set on them. If you want to perform any write actions on the returned instances you will have to set `@readonly = nil`.
+As a safety these records have the `readonly` attribute set on them.
+If you want to perform any write actions on the returned instances you will have to set the `readonly` attribute to `false`
 
 ```ruby
+reified_parent, reified_children_hash = snapshot.fetch_reified_items(readonly: false)
+# or
 reified_parent, reified_children_hash = snapshot.fetch_reified_items
-
-reified_parent.instance_variable_set("@readonly", false)
+reified_children_hash.first.instance_variable_set("@readonly", false)
 ```
 
 # Key Models Provided & Additional Customizations

data/lib/active_snapshot/models/concerns/snapshots_concern.rb

@@ -8,13 +8,7 @@ module ActiveSnapshot
       has_many :snapshot_items, as: :item, class_name: 'ActiveSnapshot::SnapshotItem'
     end
 
-    def create_snapshot!(legacy_identifier=nil, identifier: nil, user: nil, metadata: nil)
-      if identifier.nil? && legacy_identifier
-        identifier = legacy_identifier
-
-        ActiveSupport::Deprecation.warn(LEGACY_POSITIONAL_ARGUMENT_WARNING)
-      end
-
+    def create_snapshot!(identifier: nil, user: nil, metadata: nil)
       snapshot = snapshots.create!({
         identifier: identifier,
         user_id: (user.id if user),
@@ -22,21 +16,25 @@ module ActiveSnapshot
         metadata: (metadata || {}),
       })
 
-      snapshot_items = []
+      new_entries = []
 
-      snapshot_items << snapshot.build_snapshot_item(self)
+      current_time = Time.now
+
+      new_entries << snapshot.build_snapshot_item(self).attributes.merge(created_at: current_time)
 
       snapshot_children = self.children_to_snapshot
 
       if snapshot_children
         snapshot_children.each do |child_group_name, h|
           h[:records].each do |child_item|
-            snapshot_items << snapshot.build_snapshot_item(child_item, child_group_name: child_group_name)
+            new_entries << snapshot.build_snapshot_item(child_item, child_group_name: child_group_name).attributes.merge(created_at: current_time)
           end
         end
       end
 
-      SnapshotItem.import(snapshot_items, validate: true)
+      SnapshotItem.upsert_all(new_entries.map{|x| x.delete("id"); x }, returning: false)
+
+      snapshot.snapshot_items.reset # clear the association cache otherwise snapshot.valid? returns false
 
       snapshot
     end
@@ -125,7 +123,5 @@ module ActiveSnapshot
       end
     end
 
-    LEGACY_POSITIONAL_ARGUMENT_WARNING = "Supplying the snapshots :identifier as a positional argument is now deprecated and will be removed in upcoming versions. Please supply the snapshot identifier using the :identifier keyword argument instead.".freeze
-
   end
 end

data/lib/active_snapshot/models/snapshot.rb

@@ -46,8 +46,15 @@ module ActiveSnapshot
     end
 
     def build_snapshot_item(instance, child_group_name: nil)
+      attributes = instance.attributes
+      attributes.each do |k, v|
+        if instance.class.defined_enums.key?(k)
+          attributes[k] = instance.class.defined_enums.fetch(k).fetch(v)
+        end
+      end
+
       self.snapshot_items.new({
-        object: instance.attributes,
+        object: attributes,
         item_id: instance.id,
         item_type: instance.class.name,
         child_group_name: child_group_name,
@@ -96,7 +103,7 @@ module ActiveSnapshot
       return true
     end
 
-    def fetch_reified_items
+    def fetch_reified_items(readonly: true)
       reified_children_hash = {}.with_indifferent_access
 
       reified_parent = nil
@@ -104,7 +111,9 @@ module ActiveSnapshot
       snapshot_items.each do |si|
         reified_item = si.item_type.constantize.new(si.object)
 
-        reified_item.readonly!
+        if readonly
+          reified_item.readonly!
+        end
 
         key = si.child_group_name
 

data/lib/active_snapshot/models/snapshot_item.rb

@@ -12,22 +12,21 @@ module ActiveSnapshot
     validates :snapshot_id, presence: true
     validates :item_id, presence: true, uniqueness: { scope: [:snapshot_id, :item_type] }
     validates :item_type, presence: true
+    validates :object, presence: true
 
     def object
       return @object if @object
 
       if ActiveSnapshot.config.storage_method_json?
-        @object = JSON.parse(self[:object])
+        @object = self[:object] ? JSON.parse(self[:object]) : {}
       elsif ActiveSnapshot.config.storage_method_yaml?
-        yaml_method = "unsafe_load"
+        yaml_method = YAML.respond_to?(:unsafe_load) ? :unsafe_load : :load
 
-        if !YAML.respond_to?("unsafe_load")
-          yaml_method = "load"
-        end
-
-        @object = YAML.send(yaml_method, self[:object])
+        @object = self[:object] ? YAML.public_send(yaml_method, self[:object]) : {}
       elsif ActiveSnapshot.config.storage_method_native_json?
         @object = self[:object]
+      else
+        raise StandardError, "Unsupported storage_method: `#{ActiveSnapshot.config.storage_method}`"
       end
     end
 

data/lib/active_snapshot/version.rb

@@ -1,3 +1,3 @@
 module ActiveSnapshot
-  VERSION = "0.3.2".freeze
+  VERSION = "0.5.0".freeze
 end

data/lib/active_snapshot.rb

@@ -3,29 +3,29 @@ require "active_snapshot/config"
 
 require 'active_support/lazy_load_hooks'
 
-ActiveSupport.on_load(:active_record) do
-  require "activerecord-import"
+module ActiveSnapshot
+  @@config = ActiveSnapshot::Config.new
+
+  def self.config(&block)
+    if block_given?
+      block.call(@@config)
+    else
+      return @@config
+    end
+  end
+end
 
+ActiveSupport.on_load(:active_record) do
   require "active_snapshot/models/snapshot"
   require "active_snapshot/models/snapshot_item"
 
   require "active_snapshot/models/concerns/snapshots_concern"
 
-  module ActiveSnapshot
+  ActiveSnapshot.module_eval do
     extend ActiveSupport::Concern
 
     included do
       include ActiveSnapshot::SnapshotsConcern
     end
-
-    @@config = ActiveSnapshot::Config.new
-
-    def self.config(&block)
-      if block_given?
-        block.call(@@config)
-      else
-        return @@config
-      end
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_snapshot
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Weston Ganger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-17 00:00:00.000000000 Z
+date: 2024-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -38,20 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: activerecord-import
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -177,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: Dead simple snapshot versioning for ActiveRecord models and associations.