active_snapshot 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 214cb14c7afa97c56711b7aaf4d0ed4c3001ba995578de0187432a6951ee8a80
-  data.tar.gz: 72798e3577020e343768f3ba79cb93adb9c97f8636e3dd869eb6443683e2d2b0
+  metadata.gz: 166c7d2f5b7e2595314eab22bd3fc4e8de2b28c7f5c6deb8b7a909e45e3061bb
+  data.tar.gz: daad374af6af17a0c14f0726418a72eb22af6d8366429572f70a3658c7a2168a
 SHA512:
-  metadata.gz: 330a15dd3e253a01b366445442d4b3164b24bb2e557a7a3ed660459314deec0f847fdfdde0fc945ea9b6093943baf73b757e7faf8848f6b8695846a598b322f4
-  data.tar.gz: f75841865ec536b0f9aaf2ead65260a8efefd7ffe6062928b8de1095e9d35ce2be97bff4f52e2f0fa52aa764d515ac2b12f33659e6c4089f6f1cf21c231f7e12
+  metadata.gz: 6c648c31574aca219686d0ba73ceb44c074fc6787dfe0f3df3197bdf047604cee57938eecc3599168f35676d3f4230582114857a7d0d5c6db7e962afbf57b499
+  data.tar.gz: e4904b1ed1f105cda6a60cb2cc243f35c03509e04b399b4412f05228c122f04aa94e32500c7af8eb68d76263bf0f41b1e49273af6d497b4ccc26f1c093cb8f05

data/CHANGELOG.md

@@ -2,9 +2,17 @@ CHANGELOG
 ---------
 
 - **Unreleased**
-  * [View Diff](https://github.com/westonganger/active_snapshot/compare/v1.0.0...master)
+  * [View Diff](https://github.com/westonganger/active_snapshot/compare/v1.1.0...master)
   * Nothing yet
 
+- **v1.1.0** - Dec 28 2025
+  * [View Diff](https://github.com/westonganger/active_snapshot/compare/v1.0.0...v1.1.0)
+  * [#77](https://github.com/westonganger/active_snapshot/pull/77) - Remove uniqueness constraint from `snapshot_items` table migration
+    - Upgrade Instructions: Create a DB migration with `remove_index :snapshot_items, [:snapshot_id, :item_id, :item_type], unique: true`
+  * [#76](https://github.com/westonganger/active_snapshot/pull/76) - Add full STI support (inherit snapshot children definition from base class, and allow overriding in STI child classes)
+  * [#74](https://github.com/westonganger/active_snapshot/pull/74) - Ensure no exception is raised when class does not have method defined_enums
+  * [#72](https://github.com/westonganger/active_snapshot/pull/72) - Adds `ActiveSnapshot::Snapshot.diff(from, to)` to get the difference between two snapshots or a snapshot and the current record.
+
 - **v1.0.0** - Jan 17 2025
   * [View Diff](https://github.com/westonganger/active_snapshot/compare/v0.5.2...v1.0.0)
   * There are no functional changes. This release v1.0.0 is to signal that its stable and ready for widespread usage.

data/README.md

@@ -134,19 +134,24 @@ reified_children_hash.first.instance_variable_set("@readonly", false)
 
 # Diffing Versions
 
-You can use the following example code to generate your own diffs.
-
+You can obtain the diff between two snapshots like this:
 ```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
+from = post.snapshots.first
+to = post.snapshots.second
+
+ActiveSnapshot::Snapshot.diff(from, to)
+# [
+#   {action: :update, item_type: "Post", item_id: 1, changes: {name: ["Old Name", "New Name"]}},
+#   {action: :destroy, item_type: "Comment", item_id: 1, changes: {id: [1, nil], content: ["Some Content", nil]}},
+#   {action: :create, item_type: "Comment", item_id: 2, changes: {id: [nil, 1], content: [nil, "New  Content"]}}
+# ]
+```
 
-attrs_not_changed = old_attrs.to_a.intersection(new_attrs.to_a).to_h
+You can also obtain the diff between a snapshot and the current record:
+```ruby
+from = post.snapshots.last
 
-attrs_changed = new_attrs.to_a - attrs_not_changed.to_a
+ActiveSnapshot::Snapshot.diff(from, post)
 ```
 
 # Important Data Considerations / Warnings

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

@@ -6,35 +6,19 @@ module ActiveSnapshot
       ### We do NOT mark these as dependent: :destroy, the developer must manually destroy the snapshots or individual snapshot items
       has_many :snapshots, as: :item, class_name: 'ActiveSnapshot::Snapshot'
       has_many :snapshot_items, as: :item, class_name: 'ActiveSnapshot::SnapshotItem'
+
+      class_attribute :snapshot_children_proc
     end
 
     def create_snapshot!(identifier: nil, user: nil, metadata: nil)
-      snapshot = snapshots.create!({
-        identifier: identifier,
-        user_id: (user.id if user),
-        user_type: (user.class.name if user),
-        metadata: (metadata || {}),
-      })
-
-      new_entries = []
-
-      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|
-            new_entries << snapshot.build_snapshot_item(child_item, child_group_name: child_group_name).attributes.merge(created_at: current_time)
-          end
-        end
-      end
+      snapshot = Snapshot.build_snapshot(self, identifier: identifier, user: user, metadata: metadata)
+      new_entries = snapshot.snapshot_items.map(&:attributes)
+      snapshot.snapshot_items.reset # clear the association cache otherwise snapshot.valid? returns false
+      snapshot.save!
 
-      SnapshotItem.upsert_all(new_entries.map{|x| x.delete("id"); x }, returning: false)
+      new_entries = new_entries.map { |item| item.except("id").merge(created_at: snapshot.created_at, snapshot_id: snapshot.id) }
 
-      snapshot.snapshot_items.reset # clear the association cache otherwise snapshot.valid? returns false
+      SnapshotItem.upsert_all(new_entries, returning: false)
 
       snapshot
     end
@@ -43,9 +27,9 @@ module ActiveSnapshot
 
       def has_snapshot_children(&block)
         if block_given?
-          @snapshot_children_proc = block
+          self.snapshot_children_proc = block
         else
-          @snapshot_children_proc
+          self.snapshot_children_proc
         end
       end
 
@@ -122,6 +106,5 @@ module ActiveSnapshot
         return snapshot_children
       end
     end
-
   end
 end

data/lib/active_snapshot/models/snapshot.rb

@@ -15,6 +15,118 @@ module ActiveSnapshot
     validates :identifier, uniqueness: { scope: [:item_id, :item_type], allow_nil: true}
     validates :user_type, presence: true, if: :user_id
 
+    class << self
+      def build_snapshot(resource, identifier: nil, user: nil, metadata: nil)
+        snapshot = resource.snapshots.build({
+          identifier: identifier,
+          user_id: (user.id if user),
+          user_type: (user.class.name if user),
+          metadata: (metadata || {}),
+        })
+
+        snapshot.build_snapshot_item(resource)
+
+        snapshot_children = resource.children_to_snapshot
+
+        snapshot_children&.each do |child_group_name, h|
+          h[:records].each do |child_item|
+            snapshot.build_snapshot_item(child_item, child_group_name: child_group_name)
+          end
+        end
+
+        snapshot
+      end
+
+      def diff(from, to)
+        if !from.is_a?(Snapshot)
+          raise ArgumentError.new("'from' must be an ActiveSnapshot::Snapshot")
+        end
+
+        to_item_id, to_item_type = to.is_a?(Snapshot) ? [to.item_id, to.item_type] : [to.id, to.class.polymorphic_name]
+
+        if from.item_id != to_item_id || from.item_type != to_item_type
+          raise ArgumentError.new("Both records must reference the same item")
+        end
+
+        if to.is_a?(Snapshot) && from.created_at > to.created_at
+          raise ArgumentError.new("'to' must be a newer snapshot than 'from'")
+        end
+
+        from_snapshot = from
+        to_snapshot = to.is_a?(Snapshot) ? to : build_snapshot(to)
+
+        from_snapshot_items = from_snapshot.snapshot_items
+        to_snapshot_items = to_snapshot.snapshot_items
+
+        diffs = []
+
+        from_snapshot_items.each do |from_snapshot_item|
+          to_snapshot_item = to_snapshot_items.find do |item|
+            item.item_id == from_snapshot_item.item_id && item.item_type == from_snapshot_item.item_type
+          end
+
+          if to_snapshot_item.nil?
+            diffs << {
+              action: :destroy,
+              item_id: from_snapshot_item.item_id,
+              item_type: from_snapshot_item.item_type,
+              changes: snapshot_item_changes(from_snapshot_item, nil)
+            }
+          else
+            changes = snapshot_item_changes(from_snapshot_item, to_snapshot_item)
+
+            next if changes.empty?
+
+            diffs << {
+              action: :update,
+              item_id: from_snapshot_item.item_id,
+              item_type: from_snapshot_item.item_type,
+              changes: changes
+            }
+          end
+        end
+
+        to_snapshot_items.each do |to_snapshot_item|
+          from_snapshot_item = from_snapshot_items.find do |item|
+            item.item_id == to_snapshot_item.item_id && item.item_type == to_snapshot_item.item_type
+          end
+
+          next if from_snapshot_item.present?
+
+          diffs << {
+            action: :create,
+            item_id: to_snapshot_item.item_id,
+            item_type: to_snapshot_item.item_type,
+            changes: snapshot_item_changes(nil, to_snapshot_item)
+          }
+        end
+
+        diffs
+      end
+
+      private
+
+      def snapshot_item_changes(from, to)
+        from_object = from ? from.object : {}
+        to_object = to ? to.object : {}
+
+        keys = (from_object.keys + to_object.keys).uniq
+
+        changes = {}
+
+        keys.each do |key|
+          from_value = from_object[key]
+          to_value = to_object[key]
+
+          next if to_value == from_value
+
+          changes[key.to_sym] = [from_value, to_value]
+        end
+
+        changes
+      end
+    end
+
     def metadata
       return @metadata if @metadata
 
@@ -52,7 +164,7 @@ module ActiveSnapshot
     def build_snapshot_item(instance, child_group_name: nil)
       attrs = instance.attributes
 
-      if instance.class.defined_enums.any?
+      if instance.class.respond_to?(:defined_enums) && 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?

data/lib/active_snapshot/version.rb

@@ -1,3 +1,3 @@
 module ActiveSnapshot
-  VERSION = "1.0.0".freeze
+  VERSION = "1.1.0".freeze
 end

data/lib/generators/active_snapshot/install/templates/create_snapshots_tables.rb.erb

@@ -16,7 +16,7 @@ class <%= migration_name %> < ActiveRecord::Migration::Current
     create_table :snapshot_items<%= table_options %> do |t|
       t.belongs_to :snapshot, null: false, index: true
       t.belongs_to :item, polymorphic: true, null: false, index: true
-      t.index [:snapshot_id, :item_id, :item_type], unique: true
+      t.index [:snapshot_id, :item_id, :item_type]
 
       t.json :object, null: false
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_snapshot
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Weston Ganger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-17 00:00:00.000000000 Z
+date: 2025-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -56,16 +56,16 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement