active_snapshot 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 204744938dec9e53545cc73a6497d47b9463b76b0622491d442b5ed4169b7c83
-  data.tar.gz: dee647e71ff99f91e79764f6094e9253fa74b9641e6f2e611ea10485e3d1d570
+  metadata.gz: 89b0b688c46d6f42572e718276d0bb406beedf4aa3fcca78329ebd598d7a53f2
+  data.tar.gz: 210d3f36e4a8c12d4e85665e6d0324a0054333771ab0d7cb6b104f28be7b5b46
 SHA512:
-  metadata.gz: fe9542a0beecba0f52d3d25f0dfbd1197f31eb4ab9758f7ccfaf0e5455dfd150ef6ee1ba81fc138383ff8004a9e26a037a6ad72c004766bac1f0a3bf68edb4e6
-  data.tar.gz: eeab5ae90f2dc09f34ece44aa51992df834cf552693849d4595554e08448d4d8fceac954cb5ccbbe47089b1a868eeb089b5391ed3cf8a410aad6d436e6a3ef6a
+  metadata.gz: 4ff8613e2c3eaf100e8234b7da297ffc82d47cc387c3b7d22511f947b6e934382261751fb8c8518f5c06e8274341432416b9bcd42e9ab07b513717de9bfa5116
+  data.tar.gz: a9d43b41f96ace17d9a9320bbe231dabc326effc049ea1d82f44cc0cae920a61aeecc0d6a43c412e1680740a944bee56a253bdd0b8cf7b2770ea24fa71da0fde

data/CHANGELOG.md

@@ -1,9 +1,22 @@
 CHANGELOG
 ---------
 
-- **UNRELEASED**
-  * [View Diff](https://github.com/westonganger/active_snapshot/compare/v0.2.4...master)
-  * Nothing yet
+- **Unreleased**
+  * [View Diff](https://github.com/westonganger/active_snapshot/compare/v0.3.0...master)
+  - Nothing yet
+
+- **v0.3.0** - November 14, 2022
+  * [View Diff](https://github.com/westonganger/active_snapshot/compare/v0.2.4...v0.3.0)
+  * [PR #24](https://github.com/westonganger/active_snapshot/pull/24) - Fix arguments for db migration for mysql
+  * [PR #29](https://github.com/westonganger/active_snapshot/pull/29) - Deprecate :identifier argument as a positional argument
+  * [PR #30](https://github.com/westonganger/active_snapshot/pull/30) - Make snapshot identifier optional
+  * [PR #32](https://github.com/westonganger/active_snapshot/pull/26) - Add configuration option `ActiveSnapshot.config.storage_method = 'serialized_json'` with support for `serialized_json`, `serialized_yaml`, `native_json`
+  * [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"`
+    * 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"`
 
 - **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,6 +53,25 @@ 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:
@@ -60,9 +79,9 @@ You now have access to the following methods:
 ```ruby
 post = Post.first
 
-# Create snapshot grouped by identifier, only :identifier argument is required, all others are optional
+# Create snapshot, all fields are optional
 snapshot = post.create_snapshot!(
-  "snapshot_1", # Required
+  identifier: "snapshot_1",
   user: current_user,
   metadata: {
     foo: :bar
@@ -117,15 +136,15 @@ Now when you run `create_snapshot!` the associations will be tracked accordingly
 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_items = snapshot.fetch_reified_items
+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`.
 
 ```ruby
-writable_reified_items = snapshot.fetch_reified_items.transform_values do |array| 
-  array.map{|x| x.instance_variable_set("@readonly", false); x}
-end
+reified_parent, reified_children_hash = snapshot.fetch_reified_items
+
+reified_parent.instance_variable_set("@readonly", false)
 ```
 
 # Key Models Provided & Additional Customizations
@@ -138,10 +157,10 @@ I strongly encourage you to read the code for this library to understand how it
   * Defines `snapshots` and `snapshot_items` has_many associations
   * Defines `create_snapshot!` and `has_snapshot_children` methods
 - [Snapshot](./lib/active_snapshot/models/snapshot.rb)
-  * Contains a unique `identifier` column
+  * Contains a unique `identifier` column (optional, but available for custom identification purposes)
   * `has_many :item_snapshots`
 - [SnapshotItem](./lib/active_snapshot/models/snapshot_item.rb)
-  * Contains `object` column with yaml encoded model instance `attributes`
+  * Contains `object` column which contains an encoded database row
   * `belongs_to :snapshot`
 
 

data/lib/active_snapshot/config.rb

@@ -0,0 +1,31 @@
+module ActiveSnapshot
+  class Config
+    attr_reader :storage_method
+
+    def initialize
+      @storage_method = 'serialized_json'
+    end
+
+    def storage_method=(value)
+      value_str = value.to_s
+
+      if ['serialized_yaml', 'serialized_json', 'native_json'].include?(value_str)
+        @storage_method = value_str
+      else
+        raise ArgumentError.new("Invalid storage_method provided")
+      end
+    end
+
+    def storage_method_yaml?
+      @storage_method == 'serialized_yaml'
+    end
+
+    def storage_method_json?
+      @storage_method == 'serialized_json'
+    end
+
+    def storage_method_native_json?
+      @storage_method == 'native_json'
+    end
+  end
+end

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

@@ -8,7 +8,13 @@ module ActiveSnapshot
       has_many :snapshot_items, as: :item, class_name: 'ActiveSnapshot::SnapshotItem'
     end
 
-    def create_snapshot!(identifier, user: nil, metadata: nil)
+    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
+
       snapshot = snapshots.create!({
         identifier: identifier,
         user_id: (user.id if user),
@@ -119,5 +125,7 @@ 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

@@ -12,27 +12,42 @@ module ActiveSnapshot
 
     validates :item_id, presence: true
     validates :item_type, presence: true
-    validates :identifier, presence: true, uniqueness: { scope: [:item_id, :item_type] }
+    validates :identifier, uniqueness: { scope: [:item_id, :item_type], allow_nil: true}
     validates :user_type, presence: true, if: :user_id
 
     def metadata
-      yaml_method = "unsafe_load"
+      return @metadata if @metadata
 
-      if !YAML.respond_to?("unsafe_load")
-        yaml_method = "load"
-      end
+      if ActiveSnapshot.config.storage_method_json?
+        @metadata = JSON.parse(self[:metadata])
+      elsif ActiveSnapshot.config.storage_method_yaml?
+        yaml_method = "unsafe_load"
+
+        if !YAML.respond_to?("unsafe_load")
+          yaml_method = "load"
+        end
 
-      @metadata ||= YAML.send(yaml_method, self[:metadata]).with_indifferent_access
+        @metadata = YAML.send(yaml_method, self[:metadata])
+      elsif ActiveSnapshot.config.storage_method_native_json?
+        @metadata = self[:metadata]
+      end
     end
 
     def metadata=(h)
       @metadata = nil
-      self[:metadata] = YAML.dump(h)
+
+      if ActiveSnapshot.config.storage_method_json?
+        self[:metadata] = h.to_json
+      elsif ActiveSnapshot.config.storage_method_yaml?
+        self[:metadata] = YAML.dump(h)
+      elsif ActiveSnapshot.config.storage_method_native_json?
+        self[:metadata] = h
+      end
     end
 
     def build_snapshot_item(instance, child_group_name: nil)
       self.snapshot_items.new({
-        object: instance.attributes, 
+        object: instance.attributes,
         item_id: instance.id,
         item_type: instance.class.name,
         child_group_name: child_group_name,
@@ -86,7 +101,7 @@ module ActiveSnapshot
 
       reified_parent = nil
 
-      snapshot_items.each do |si| 
+      snapshot_items.each do |si|
         reified_item = si.item_type.constantize.new(si.object)
 
         reified_item.readonly!

data/lib/active_snapshot/models/snapshot_item.rb

@@ -14,23 +14,38 @@ module ActiveSnapshot
     validates :item_type, presence: true, uniqueness: { scope: [:snapshot_id, :item_id] }
 
     def object
-      yaml_method = "unsafe_load"
+      return @object if @object
 
-      if !YAML.respond_to?("unsafe_load")
-        yaml_method = "load"
-      end
+      if ActiveSnapshot.config.storage_method_json?
+        @object = JSON.parse(self[:object])
+      elsif ActiveSnapshot.config.storage_method_yaml?
+        yaml_method = "unsafe_load"
+
+        if !YAML.respond_to?("unsafe_load")
+          yaml_method = "load"
+        end
 
-      @metadata ||= YAML.send(yaml_method, self[:object]).with_indifferent_access
+        @object = YAML.send(yaml_method, self[:object])
+      elsif ActiveSnapshot.config.storage_method_native_json?
+        @object = self[:object]
+      end
     end
 
     def object=(h)
       @object = nil
-      self[:object] = YAML.dump(h)
+
+      if ActiveSnapshot.config.storage_method_json?
+        self[:object] = h.to_json
+      elsif ActiveSnapshot.config.storage_method_yaml?
+        self[:object] = YAML.dump(h)
+      elsif ActiveSnapshot.config.storage_method_native_json?
+        self[:object] = h
+      end
     end
 
     def restore_item!
       ### Add any custom logic here
-      
+
       if !item
         item_klass = item_type.constantize
 

data/lib/active_snapshot/version.rb

@@ -1,3 +1,3 @@
 module ActiveSnapshot
-  VERSION = "0.2.4".freeze
+  VERSION = "0.3.0".freeze
 end

data/lib/active_snapshot.rb

@@ -2,6 +2,7 @@ require "active_record"
 require "activerecord-import"
 
 require "active_snapshot/version"
+require "active_snapshot/config"
 
 require "active_snapshot/models/snapshot"
 require "active_snapshot/models/snapshot_item"
@@ -14,4 +15,14 @@ module ActiveSnapshot
   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

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

@@ -3,16 +3,16 @@ class <%= migration_name %> < ActiveRecord::Migration::Current
   def change
     create_table :snapshots<%= table_options %> do |t|
       t.belongs_to :item, polymorphic: true, null: false, index: true
-      t.string :identifier, null: false, unique: [:item_id, :item_type], index: true
+      t.string :identifier, unique: [:item_id, :item_type], index: true
       t.belongs_to :user, polymorphic: true
-      t.text :metadata
+      t.<%= ActiveSnapshot.config.storage_method == 'native_json' ? 'json' : 'text' %> :metadata
       t.datetime :created_at, null: false
     end
 
     create_table :snapshot_items<%= table_options %> do |t|
       t.belongs_to :snapshot, null: false, index: true
       t.belongs_to :item, polymorphic: true, null: false, unique: [:snapshot_id], index: true
-      t.text :object, null: false
+      t.<%= ActiveSnapshot.config.storage_method == 'native_json' ? 'json' : 'text' %> :object, null: false
       t.datetime :created_at, null: false
       t.string :child_group_name
     end

data/lib/generators/active_snapshot/migration_generator.rb

@@ -66,7 +66,7 @@ module ActiveSnapshot
     #
     def table_options
       if mysql?
-        ', { options: "ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci" }'
+        ', options: "ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci"'
       else
         ""
       end

data/test/dummy_app/config/application.rb

@@ -6,6 +6,10 @@ Bundler.require
 
 module Dummy
   class Application < Rails::Application
+    if Rails::VERSION::STRING.to_f >= 5.1
+      config.load_defaults Rails::VERSION::STRING.to_f
+    end
+
     # Settings in config/environments/* take precedence over those specified here.
     # Application configuration should go into files in config/initializers
     # -- all .rb files in that directory are automatically loaded.
@@ -42,12 +46,5 @@ module Dummy
     config.after_initialize do
       ActiveRecord::Migration.migrate(Rails.root.join("db/migrate/*").to_s)
     end
-
-    if ActiveRecord.respond_to?(:gem_version)
-      gem_version = ActiveRecord.gem_version
-      if gem_version.to_s.start_with?("5.2.")
-        config.active_record.sqlite3.represent_boolean_as_integer = true
-      end
-    end
   end
 end

data/test/dummy_app/db/migrate/20210306100122_create_snapshots_tables.rb

@@ -3,16 +3,28 @@ class CreateSnapshotsTables < ActiveRecord::Migration::Current
   def change
     create_table :snapshots do |t|
       t.belongs_to :item, polymorphic: true, null: false, index: true
-      t.string :identifier, null: false, unique: true, index: true
+      t.string :identifier, unique: true, index: true
       t.belongs_to :user, polymorphic: true
-      t.text :metadata
+
+      if ActiveSnapshot.config.storage_method_native_json?
+        t.json :metadata
+      else
+        t.text :metadata
+      end
+
       t.datetime :created_at, null: false
     end
 
     create_table :snapshot_items do |t|
       t.belongs_to :snapshot, null: false, index: true
       t.belongs_to :item, polymorphic: true, null: false, unique: [:snapshot_id], index: true
-      t.text :object, null: false
+
+      if ActiveSnapshot.config.storage_method_native_json?
+        t.json :object, null: false
+      else
+        t.text :object, null: false
+      end
+
       t.datetime :created_at, null: false
       t.string :child_group_name
     end