active_snapshot 0.5.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5fd89751eb3c64739f2a3242edfb4a8f3fd1dfce8047bbd4db51b790039ee39
-  data.tar.gz: 5cf804fd3bb81be067153fa1120b45f5045febf0eb93921950ae51bea17c65a8
+  metadata.gz: 214cb14c7afa97c56711b7aaf4d0ed4c3001ba995578de0187432a6951ee8a80
+  data.tar.gz: 72798e3577020e343768f3ba79cb93adb9c97f8636e3dd869eb6443683e2d2b0
 SHA512:
-  metadata.gz: c079cdc615a35293cecbe0ab3c86df6a0b96e6bc0a1a92beb5b8580735d4a61209aa97623a18d9e06aeffeb109f94bbc742cea119e96421ba725ed9a22aae1eb
-  data.tar.gz: dad4d76b90fd8caa0dbd09a2c20d618bd6b8060de77eacbbad4eeda7d79cfa13be48fed5888f80122c607f8ce69acdf67eb7ce48707f54bd08dc3e8f9922604b
+  metadata.gz: 330a15dd3e253a01b366445442d4b3164b24bb2e557a7a3ed660459314deec0f847fdfdde0fc945ea9b6093943baf73b757e7faf8848f6b8695846a598b322f4
+  data.tar.gz: f75841865ec536b0f9aaf2ead65260a8efefd7ffe6062928b8de1095e9d35ce2be97bff4f52e2f0fa52aa764d515ac2b12f33659e6c4089f6f1cf21c231f7e12

data/CHANGELOG.md

@@ -2,9 +2,18 @@ CHANGELOG
 ---------
 
 - **Unreleased**
-  * [View Diff](https://github.com/westonganger/active_snapshot/compare/v0.5.1...master)
+  * [View Diff](https://github.com/westonganger/active_snapshot/compare/v1.0.0...master)
   * Nothing yet
 
+- **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.
+
+- **v0.5.2** - Nov 11, 2024
+  * [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`, this configuration option is only retained to support legacy installations which utilize serialized YAML or serialized JSON text columns. The default storage method will fallback gracefully for legacy installations, if there already exists a text column then it defaults to `ActiveSnapshot.config.storage_method = "serialized_json"`
+  * 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.
@@ -42,9 +51,9 @@ CHANGELOG
   * [PR #32](https://github.com/westonganger/active_snapshot/pull/32) - Change default storage method from `serialized_yaml` to `serialized_json`.
   * [PR #32](https://github.com/westonganger/active_snapshot/pull/32) - `snapshot.metadata` and `snapshot_item.object` no longer return a HashWithIndifferentAccess. Now they simply return a regular Hash.
   * **Upgrade Instructions**
-    * Change all instances of `create_snapshot!("my-snapshot-1"` to `create_snapshot!(identifier: "my-snapshot-1"`
+    * Change all instances of `create_snapshot!("my-snapshot-1"` to `create_snapshot!(identifier: "my-snapshot-1")`
     * Create a migration with the following `change_column_null :snapshots, :identifier, true` to remove the null constraint here
-    * If you have existing snapshots from a previous version then please set `ActiveSnapshot.config.storage_method = "serialized_yaml"`
+    * If you have existing snapshots from a previous version then please set `ActiveSnapshot.config.storage_method = "serialized_yaml"` in an initializer
 
 - **v0.2.4** - Feb 25, 2022
   * [View Diff](https://github.com/westonganger/active_snapshot/compare/v0.2.3...v0.2.4)

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:

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,11 +38,13 @@ 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

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

data/lib/active_snapshot/version.rb

@@ -1,3 +1,3 @@
 module ActiveSnapshot
-  VERSION = "0.5.1".freeze
+  VERSION = "1.0.0".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.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Weston Ganger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-12 00:00:00.000000000 Z
+date: 2025-01-17 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