active_snapshot 0.2.4 → 0.3.0

data/test/models/snapshot_item_test.rb

@@ -57,7 +57,7 @@ class SnapshotItemTest < ActiveSupport::TestCase
 
     @snapshot_item = @snapshot.snapshot_items.first
 
-    assert @snapshot_item.object.is_a?(HashWithIndifferentAccess)
+    assert @snapshot_item.object.is_a?(Hash)
 
     @snapshot_item.object = {foo: :bar}
 

data/test/models/snapshot_test.rb

@@ -45,7 +45,7 @@ class SnapshotTest < ActiveSupport::TestCase
       
     instance.valid?
 
-    [:item_id, :item_type, :identifier].each do |attr|
+    [:item_id, :item_type].each do |attr|
       assert instance.errors[attr].present? ### presence error
     end
 
@@ -63,11 +63,11 @@ class SnapshotTest < ActiveSupport::TestCase
   def test_metadata
     @snapshot = @snapshot_klass.first
 
-    assert @snapshot.metadata.is_a?(HashWithIndifferentAccess)
+    assert @snapshot.metadata.is_a?(Hash)
 
     @snapshot.metadata = {foo: :bar}
 
-    assert_equal :bar, @snapshot.metadata['foo']
+    assert_equal "bar", @snapshot.metadata['foo']
   end
 
   def test_build_snapshot_item
@@ -101,7 +101,7 @@ class SnapshotTest < ActiveSupport::TestCase
 
     children_hash = reified_items.last
 
-    assert children_hash.is_a?(HashWithIndifferentAccess)
+    assert children_hash.is_a?(Hash)
 
     assert children_hash.all?{|k,v| v.all?{|x| x.readonly?} }
   end
@@ -110,7 +110,7 @@ class SnapshotTest < ActiveSupport::TestCase
     post = SubPost.create!(a: 1, b: 2)
     comment_content = 'Example comment'
     post.comments.create!(content: comment_content)
-    post.create_snapshot!('v1')
+    post.create_snapshot!(identifier: 'v1')
     snapshot = post.snapshots.first
     reified_items = snapshot.fetch_reified_items
 
@@ -122,9 +122,9 @@ class SnapshotTest < ActiveSupport::TestCase
   def test_single_model_snapshots_without_children
     instance = ParentWithoutChildren.create!({a: 1, b: 2})
 
-    previous_attributes = instance.attributes
+    prev_attrs = instance.attributes
 
-    instance.create_snapshot!('v1')
+    instance.create_snapshot!(identifier: 'v1')
 
     instance.update!(a: 9, b: 9)
 
@@ -134,7 +134,15 @@ class SnapshotTest < ActiveSupport::TestCase
 
     assert_equal [instance, {}], reified_items
 
-    assert_equal previous_attributes, reified_items.first.attributes
+    new_attrs = reified_items.first.attributes
+
+    prev_time_attrs = prev_attrs.extract!("created_at","updated_at")
+    new_time_attrs = new_attrs.extract!("created_at","updated_at")
+
+    assert_equal new_time_attrs.values.map{|x| x.round(3)}, new_time_attrs.values
+
+    ### rounding to 3 sometimes fails due to millisecond precision so we just test for 2 decimal places here
+    assert_equal prev_time_attrs.values.map{|x| x.round(2)}, new_time_attrs.values.map{|x| x.round(2)}
   end
 
 end

data/test/models/snapshots_concern_test.rb

@@ -35,17 +35,17 @@ class SnapshotsConcernTest < ActiveSupport::TestCase
 
     #@user = User.first
 
-    snapshot = @post.create_snapshot!("foobar 1", user: @user, metadata: {foo: :bar})
+    snapshot = @post.create_snapshot!(identifier: "foobar 1", user: @user, metadata: {foo: :bar})
     assert_not snapshot.new_record?
 
-    snapshot = @post.create_snapshot!("foobar 2", user: @user)
+    snapshot = @post.create_snapshot!(identifier: "foobar 2", user: @user)
     assert_not snapshot.new_record?
 
-    snapshot = @post.create_snapshot!("foobar 3")
+    snapshot = @post.create_snapshot!(identifier: "foobar 3")
     assert_not snapshot.new_record?
 
     assert_raise do
-      @post.create_snapshot!("foobar 3")
+      @post.create_snapshot!(identifier: "foobar 3")
     end
   end
 
@@ -115,4 +115,29 @@ class SnapshotsConcernTest < ActiveSupport::TestCase
     assert klass.new.children_to_snapshot.count == 2
   end
 
+  def test_legacy_positional_identifier_argument
+    call_count = 0
+
+    allow_any_instance_of(ActiveSupport::Deprecation).to receive(:warn).and_wrap_original do |m, *args|
+      if args.first == ActiveSnapshot::SnapshotsConcern::LEGACY_POSITIONAL_ARGUMENT_WARNING
+        call_count += 1
+      end
+    end
+
+    assert_difference ->{ ActiveSnapshot::Snapshot.count }, 1 do
+      @snapshot = Post.first.create_snapshot!("snapshot-1")
+    end
+
+    assert_equal call_count, 1
+  end
+
+  def test_optional_identifier
+    post = Post.first
+
+    assert_difference ->{ ActiveSnapshot::Snapshot.count }, 2 do
+      post.create_snapshot!
+      post.create_snapshot!
+    end
+  end
+
 end

data/test/test_helper.rb

@@ -3,6 +3,10 @@ ENV["RAILS_ENV"] = "test"
 
 require "active_snapshot"
 
+if ENV["ACTIVE_SNAPSHOT_STORAGE_METHOD"].present?
+  ActiveSnapshot.config.storage_method = ENV["ACTIVE_SNAPSHOT_STORAGE_METHOD"]
+end
+
 begin
   require 'warning'
 
@@ -25,6 +29,8 @@ end
 
 Rails.backtrace_cleaner.remove_silencers!
 
+require 'minitest-spec-rails' ### for describe blocks
+
 require 'minitest/reporters'
 Minitest::Reporters.use!(
   Minitest::Reporters::DefaultReporter.new,
@@ -43,6 +49,24 @@ else
   ActiveRecord::Migrator.migrate File.expand_path("dummy_app/db/migrate/", __dir__)
 end
 
+require 'rspec/mocks'
+module MinitestRSpecMocksIntegration
+  include RSpec::Mocks::ExampleMethods
+
+  def before_setup
+    RSpec::Mocks.setup
+    super
+  end
+
+  def after_teardown
+    super
+    RSpec::Mocks.verify
+  ensure
+    RSpec::Mocks.teardown
+  end
+end
+Minitest::Test.send(:include, MinitestRSpecMocksIntegration)
+
 klasses = [
   Post,
   ActiveSnapshot::Snapshot,
@@ -61,9 +85,9 @@ end
 DATA = {}.with_indifferent_access
 
 DATA[:shared_post] = Post.find_or_create_by!(a: 1, b: 3)
-DATA[:shared_post].create_snapshot!('v1')
+DATA[:shared_post].create_snapshot!(identifier: 'v1')
 DATA[:shared_post].update_columns(a: 2, b: 4)
-DATA[:shared_post].create_snapshot!('v2')
+DATA[:shared_post].create_snapshot!(identifier: 'v2')
 
 def assert_time_match(a, b)
   format = "%d-%m-%Y %h:%M:%S.%L" ### MUST LIMIT THE MILLISECONDS TO 3 decimal places of accuracy, the rest are dropped

data/test/unit/active_snapshot_test.rb

@@ -24,7 +24,7 @@ class ActiveSnapshotTest < ActiveSupport::TestCase
 
     assert_difference ->{ ActiveSnapshot::Snapshot.count }, 1 do
       assert_difference ->{ ActiveSnapshot::SnapshotItem.count }, 2 do
-        @snapshot = parent.create_snapshot!(identifier)
+        @snapshot = parent.create_snapshot!(identifier: identifier)
       end
     end
 
@@ -53,4 +53,5 @@ class ActiveSnapshotTest < ActiveSupport::TestCase
     assert_time_match original_parent_updated_at, parent.updated_at
     assert_time_match original_child_updated_at, parent.children_to_snapshot[:comments][:records].first.updated_at
   end
+
 end

data/test/unit/config_test.rb

@@ -0,0 +1,66 @@
+require "test_helper"
+
+class ActiveSnapshot::ConfigTest < ActiveSupport::TestCase
+
+  describe "storage_method" do
+    def setup
+      @orig_storage_method = ActiveSnapshot.config.storage_method
+    end
+
+    def teardown
+      ActiveSnapshot.config.storage_method = @orig_storage_method
+    end
+
+    def test_defaults_to_serialized_json
+      assert_equal 'serialized_json', ActiveSnapshot.config.storage_method
+
+      assert_equal false, ActiveSnapshot.config.storage_method_yaml?
+      assert_equal true, ActiveSnapshot.config.storage_method_json?
+      assert_equal false, ActiveSnapshot.config.storage_method_native_json?
+    end
+
+    def test_accepts_to_serialized_json
+      ActiveSnapshot.config.storage_method = 'serialized_json'
+
+      assert_equal 'serialized_json', ActiveSnapshot.config.storage_method
+
+      assert_equal false, ActiveSnapshot.config.storage_method_yaml?
+      assert_equal true, ActiveSnapshot.config.storage_method_json?
+      assert_equal false, ActiveSnapshot.config.storage_method_native_json?
+    end
+
+
+    def test_accepts_serialized_yaml
+      ActiveSnapshot.config.storage_method = 'serialized_yaml'
+
+      assert_equal 'serialized_yaml', ActiveSnapshot.config.storage_method
+
+      assert_equal true, ActiveSnapshot.config.storage_method_yaml?
+      assert_equal false, ActiveSnapshot.config.storage_method_json?
+      assert_equal false, ActiveSnapshot.config.storage_method_native_json?
+    end
+
+    def test_accepts_native_json
+      ActiveSnapshot.config.storage_method = "native_json"
+
+      assert_equal "native_json", ActiveSnapshot.config.storage_method, "native_json"
+
+      assert_equal false, ActiveSnapshot.config.storage_method_yaml?
+      assert_equal false, ActiveSnapshot.config.storage_method_json?
+      assert_equal true, ActiveSnapshot.config.storage_method_native_json?
+    end
+
+    def test_config_doesnt_accept_not_specified_storage_methods
+      assert_raise do
+        ActiveSnapshot.config.storage_method = 'foobar'
+      end
+      assert_equal "serialized_json", ActiveSnapshot.config.storage_method
+    end
+
+    def test_converts_symbol_to_string
+      ActiveSnapshot.config.storage_method = "serialized_yaml"
+      assert_equal "serialized_yaml", ActiveSnapshot.config.storage_method
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_snapshot
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Weston Ganger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-25 00:00:00.000000000 Z
+date: 2022-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -95,7 +95,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: appraisal
+  name: minitest-spec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -134,6 +148,7 @@ files:
 - README.md
 - Rakefile
 - lib/active_snapshot.rb
+- lib/active_snapshot/config.rb
 - lib/active_snapshot/models/concerns/snapshots_concern.rb
 - lib/active_snapshot/models/snapshot.rb
 - lib/active_snapshot/models/snapshot_item.rb
@@ -179,6 +194,7 @@ files:
 - test/models/snapshots_concern_test.rb
 - test/test_helper.rb
 - test/unit/active_snapshot_test.rb
+- test/unit/config_test.rb
 - test/unit/errors_test.rb
 homepage: https://github.com/westonganger/active_snapshot
 licenses:
@@ -201,7 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Dead simple snapshot versioning for ActiveRecord models and associations.
@@ -244,4 +260,5 @@ test_files:
 - test/models/snapshots_concern_test.rb
 - test/test_helper.rb
 - test/unit/active_snapshot_test.rb
+- test/unit/config_test.rb
 - test/unit/errors_test.rb