active_snapshot 0.5.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dcfaf7d239a170431fa82d70ab56b18bfb54a327b46376017357368b38f484b3
-  data.tar.gz: 833d8fb9ca610983f9a9e510cd6fc94776f043bf3d35ec7e052a2ade87cf1e5a
+  metadata.gz: 170e9249f3a190a13d266d247f3d11c96ce3f1a0eedb4660aaf17a16fccb9a55
+  data.tar.gz: c8a233b6eccb33f331fefa0020225f57d99cb2ffe4ec528e3dd0bb7509383816
 SHA512:
-  metadata.gz: a412ace11cbeee26528d5e3b58116a1b716f415ab4c1aead7978e6c5f2ccd1db49ee7c08ea0120226d1f66d1d099384cd6cadec5353a3f2fa5aee28d32b825e8
-  data.tar.gz: 5290672baca7ed50d67e9654acb85851e997f9c601d6fa6aae898cf51ba448686595e30b61c4819eafe6f81608850777a9b75ca5a995c18f9f6b6d8047542bf8
+  metadata.gz: 25dd13a665ef38d7a5fbc9f461e531195753742b2968007616e3ebc5427d31c8e68188153091708f488137bc8de7ac09dbca2cd23c79af03fd6f2c607c5df7c7
+  data.tar.gz: b8277f58992d150915f477160f6e95f4863bea51563403b8c6e8c6d13237796747fb41491509d490be79d51bd0f6c33313c83e93048a6c34da0c1acfa915cea4

data/CHANGELOG.md

@@ -2,9 +2,19 @@ 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.2...master)
   * Nothing yet
 
+- **Unreleased**
+  * [View Diff](https://github.com/westonganger/active_snapshot/compare/v0.5.1...v0.5.2)
+  * [#67](https://github.com/westonganger/active_snapshot/pull/67) - Switch default storage method to native SQL JSON columns. No longer recommend to set `ActiveSnapshot.config.storage_method`, its only retained to support legacy installations
+  * Drop support for Rails 6.0. Rails 6.1 is minimum required version now.
+
+- **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

@@ -53,25 +53,6 @@ It defines an optional extension to your model: `has_snapshot_children`.
 
 It defines one instance method to your model: `create_snapshot!`
 
-# Using a different storage format
-
-By default ActiveSnapshot encodes objects to JSON and stores in the database as plain text. If you prefer to have YAML encoded columns or native JSON DB columns you can configure this as follows:
-
-```ruby
-ActiveSnapshot.config do |config|
-  config.storage_method = "serialized_json" # default, for text column
-  #config.storage_method = "serialized_yaml" # for text column
-  #config.storage_method = "native_json" # for json/jsonb column
-end
-```
-
-If using a native json column, you should configure the `storage_method` before generating the migration. If this step was missed then you would need to create a migration to change the `:object` and `:metadata` columns to json (or jsonb)
-
-```ruby
-change_column :snapshots, :object, :json
-change_column :snapshots, :metadata, :json
-```
-
 # Basic Usage
 
 You now have access to the following methods:
@@ -131,9 +112,11 @@ end
 
 Now when you run `create_snapshot!` the associations will be tracked accordingly
 
-# Reifying Snapshot Items
+# Reifying Snapshots
+
+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.
+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 +132,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/config.rb

@@ -1,12 +1,24 @@
 module ActiveSnapshot
   class Config
-    attr_reader :storage_method
-
     def initialize
-      @storage_method = 'serialized_json'
+    end
+
+    def storage_method
+      if @storage_method.nil?
+        if ActiveSnapshot::SnapshotItem.table_exists? && ActiveSnapshot::SnapshotItem.type_for_attribute(:object).type == :text
+          # for legacy active_snapshot configurations only
+          self.storage_method = 'serialized_json'
+        else
+          self.storage_method = 'native_json'
+        end
+      end
+
+      @storage_method
     end
 
     def storage_method=(value)
+      # for legacy active_snapshot configurations only
+
       value_str = value.to_s
 
       if ['serialized_yaml', 'serialized_json', 'native_json'].include?(value_str)
@@ -17,15 +29,15 @@ module ActiveSnapshot
     end
 
     def storage_method_yaml?
-      @storage_method == 'serialized_yaml'
+      # for legacy active_snapshot configurations only
+      storage_method == 'serialized_yaml'
     end
 
-    def storage_method_json?
-      @storage_method == 'serialized_json'
+    def storage_method_serialized_json?
+      # for legacy active_snapshot configurations only
+      storage_method == 'serialized_json'
     end
+    alias_method :storage_method_json?, :storage_method_serialized_json?
 
-    def storage_method_native_json?
-      @storage_method == 'native_json'
-    end
   end
 end

data/lib/active_snapshot/models/snapshot.rb

@@ -18,9 +18,11 @@ module ActiveSnapshot
     def metadata
       return @metadata if @metadata
 
-      if ActiveSnapshot.config.storage_method_json?
+      if ActiveSnapshot.config.storage_method_serialized_json?
+        # for legacy active_snapshot configurations only
         @metadata = JSON.parse(self[:metadata])
       elsif ActiveSnapshot.config.storage_method_yaml?
+        # for legacy active_snapshot configurations only
         yaml_method = "unsafe_load"
 
         if !YAML.respond_to?("unsafe_load")
@@ -28,7 +30,7 @@ module ActiveSnapshot
         end
 
         @metadata = YAML.send(yaml_method, self[:metadata])
-      elsif ActiveSnapshot.config.storage_method_native_json?
+      else
         @metadata = self[:metadata]
       end
     end
@@ -36,25 +38,30 @@ module ActiveSnapshot
     def metadata=(h)
       @metadata = nil
 
-      if ActiveSnapshot.config.storage_method_json?
+      if ActiveSnapshot.config.storage_method_serialized_json?
+        # for legacy active_snapshot configurations only
         self[:metadata] = h.to_json
       elsif ActiveSnapshot.config.storage_method_yaml?
+        # for legacy active_snapshot configurations only
         self[:metadata] = YAML.dump(h)
-      elsif ActiveSnapshot.config.storage_method_native_json?
+      else
         self[:metadata] = h
       end
     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 +116,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

@@ -17,27 +17,29 @@ module ActiveSnapshot
     def object
       return @object if @object
 
-      if ActiveSnapshot.config.storage_method_json?
+      if ActiveSnapshot.config.storage_method_serialized_json?
+        # for legacy active_snapshot configurations only
         @object = self[:object] ? JSON.parse(self[:object]) : {}
       elsif ActiveSnapshot.config.storage_method_yaml?
+        # for legacy active_snapshot configurations only
         yaml_method = YAML.respond_to?(:unsafe_load) ? :unsafe_load : :load
 
         @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}`"
+        @object = self[:object]
       end
     end
 
     def object=(h)
       @object = nil
 
-      if ActiveSnapshot.config.storage_method_json?
+      if ActiveSnapshot.config.storage_method_serialized_json?
+        # for legacy active_snapshot configurations only
         self[:object] = h.to_json
       elsif ActiveSnapshot.config.storage_method_yaml?
+        # for legacy active_snapshot configurations only
         self[:object] = YAML.dump(h)
-      elsif ActiveSnapshot.config.storage_method_native_json?
+      else
         self[:object] = h
       end
     end
@@ -51,7 +53,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.2".freeze
 end

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

@@ -8,7 +8,7 @@ class <%= migration_name %> < ActiveRecord::Migration::Current
       t.string :identifier, index: true
       t.index [:identifier, :item_id, :item_type], unique: true
 
-      t.<%= ActiveSnapshot.config.storage_method == 'native_json' ? 'json' : 'text' %> :metadata
+      t.json :metadata
 
       t.datetime :created_at, null: false
     end
@@ -18,7 +18,7 @@ class <%= migration_name %> < ActiveRecord::Migration::Current
       t.belongs_to :item, polymorphic: true, null: false, index: true
       t.index [:snapshot_id, :item_id, :item_type], unique: true
 
-      t.<%= ActiveSnapshot.config.storage_method == 'native_json' ? 'json' : 'text' %> :object, null: false
+      t.json :object, null: false
 
       t.datetime :created_at, null: false
       t.string :child_group_name

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_snapshot
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.2
 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
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement