active_snapshot 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dcfaf7d239a170431fa82d70ab56b18bfb54a327b46376017357368b38f484b3
-  data.tar.gz: 833d8fb9ca610983f9a9e510cd6fc94776f043bf3d35ec7e052a2ade87cf1e5a
+  metadata.gz: d5fd89751eb3c64739f2a3242edfb4a8f3fd1dfce8047bbd4db51b790039ee39
+  data.tar.gz: 5cf804fd3bb81be067153fa1120b45f5045febf0eb93921950ae51bea17c65a8
 SHA512:
-  metadata.gz: a412ace11cbeee26528d5e3b58116a1b716f415ab4c1aead7978e6c5f2ccd1db49ee7c08ea0120226d1f66d1d099384cd6cadec5353a3f2fa5aee28d32b825e8
-  data.tar.gz: 5290672baca7ed50d67e9654acb85851e997f9c601d6fa6aae898cf51ba448686595e30b61c4819eafe6f81608850777a9b75ca5a995c18f9f6b6d8047542bf8
+  metadata.gz: c079cdc615a35293cecbe0ab3c86df6a0b96e6bc0a1a92beb5b8580735d4a61209aa97623a18d9e06aeffeb109f94bbc742cea119e96421ba725ed9a22aae1eb
+  data.tar.gz: dad4d76b90fd8caa0dbd09a2c20d618bd6b8060de77eacbbad4eeda7d79cfa13be48fed5888f80122c607f8ce69acdf67eb7ce48707f54bd08dc3e8f9922604b

data/CHANGELOG.md

@@ -2,9 +2,14 @@ CHANGELOG
 ---------
 
 - **Unreleased**
-  * [View Diff](https://github.com/westonganger/active_snapshot/compare/v0.5.0...master)
+  * [View Diff](https://github.com/westonganger/active_snapshot/compare/v0.5.1...master)
   * Nothing yet
 
+- **v0.5.1** - Nov 11, 2024
+  * [View Diff](https://github.com/westonganger/active_snapshot/compare/v0.5.0...v0.5.1)
+  * [#66](https://github.com/westonganger/active_snapshot/pull/66) - Ensure `SnapshotItem#restore_item!` and `Snapshot#fetch_reified_items` bypass assignment for snapshot object data where the associated column no longer exists.
+  * [#63](https://github.com/westonganger/active_snapshot/pull/63) - Fix bug when enum value is nil
+
 - **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?`

data/README.md

@@ -131,9 +131,11 @@ end
 
 Now when you run `create_snapshot!` the associations will be tracked accordingly
 
-# Reifying Snapshot Items
+# Reifying Snapshots
 
-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.
+A reified record refers to an ActiveRecord instance where the local objects data is set to match the snaphotted data, but the database remains changed.
+
+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
@@ -149,6 +151,49 @@ reified_parent, reified_children_hash = snapshot.fetch_reified_items
 reified_children_hash.first.instance_variable_set("@readonly", false)
 ```
 
+# Diffing Versions
+
+You can use the following example code to generate your own diffs.
+
+```ruby
+snapshot = post.snapshots.find_by!(identifier: "some-identifier")
+
+snapshot_item = snapshot.snapshot_items.find_by!(item_type: "Post")
+
+old_attrs = snapshot_item.object
+new_attrs = post.attributes # or could be another snapshot object
+
+attrs_not_changed = old_attrs.to_a.intersection(new_attrs.to_a).to_h
+
+attrs_changed = new_attrs.to_a - attrs_not_changed.to_a
+```
+
+# Important Data Considerations / Warnings
+
+### Dropping columns
+
+If you plan to use the snapshot restore capabilities please be aware:
+
+Whenever you drop a database column and there already exists snapshots of that model then you are kind of silently breaking your restore mechanism. Because now the application will not be able to assign data to columns that dont exist on the model. We work around this by bypassing the attribute assignment for snapshot item object entries that does not correlate to a current database column.
+
+I recommend that you add an entry to this in your applications safe-migrations guidelines.
+
+If you would like to detect if this situation has already ocurred you can use the following script:
+
+```ruby
+SnapshotItem.all.each do |snapshot_item|
+  snapshot_item.object.keys.each do |key|
+    klass = Class.const_get(snapshot_item.item_type)
+
+    if !klass.column_names.include?(key)
+      invalid_data = snapshot_item.object.slice(*klass.column_names)
+
+      raise "invalid data found - #{invalid_data}"
+    end
+  end
+end
+```
+
 # Key Models Provided & Additional Customizations
 
 A key aspect of this library is its simplicity and small API. For major functionality customizations we encourage you to first delete this gem and then copy this gems code directly into your repository.

data/lib/active_snapshot/models/snapshot.rb

@@ -46,15 +46,18 @@ 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)
+      attrs = instance.attributes
+
+      if instance.class.defined_enums.any?
+        instance.class.defined_enums.slice(*attrs.keys).each do |enum_col_name, enum_mapping|
+          val = attrs.fetch(enum_col_name)
+          next if val.nil?
+          attrs[enum_col_name] = enum_mapping.fetch(val)
         end
       end
 
       self.snapshot_items.new({
-        object: attributes,
+        object: attrs,
         item_id: instance.id,
         item_type: instance.class.name,
         child_group_name: child_group_name,
@@ -109,7 +112,15 @@ module ActiveSnapshot
       reified_parent = nil
 
       snapshot_items.each do |si|
-        reified_item = si.item_type.constantize.new(si.object)
+        reified_item = si.item_type.constantize.new
+
+        si.object.each do |k,v|
+          if reified_item.respond_to?("#{k}=")
+            reified_item[k] = v
+          else
+            # database column was likely dropped since the snapshot was created
+          end
+        end
 
         if readonly
           reified_item.readonly!

data/lib/active_snapshot/models/snapshot_item.rb

@@ -51,7 +51,13 @@ module ActiveSnapshot
         self.item = item_klass.new
       end
 
-      item.assign_attributes(object)
+      object.each do |k,v|
+        if item.respond_to?("#{k}=")
+          item[k] = v
+        else
+          # database column was likely dropped since the snapshot was created
+        end
+      end
 
       item.save!(validate: false, touch: false)
     end

data/lib/active_snapshot/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_snapshot
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Weston Ganger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-08 00:00:00.000000000 Z
+date: 2024-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord