attr_json 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd9c25a736bb3b1ce26527c555718efcff2967204d853962048ffc2471af243c
-  data.tar.gz: dc022d69b43b4576d2939bb90f2e172b65b8dd45708b361758554561dc61f44f
+  metadata.gz: 3e3a6009367cdd38597ef94a714897b21dd287f34251a501e54f0081981525e4
+  data.tar.gz: a4b4afb4af34a355eb8df4df1facbd17e03a34df8abb29a8335d4c0d589c4378
 SHA512:
-  metadata.gz: 6457f06b9aed14481b7dd1543929d7010b54d232473f64cde811452083279ab72bbeb92f7a972e903d8994f21f3e263c5163044aa363db4c35a7eadd42710f24
-  data.tar.gz: 8dd0bad4eb89aad50ceb084ecb48a08d0f4b19d67f9421250fb808a2238c159fce891d1e07d37568b6ba6c65c284a9b2b600e1156cf32334a2c7d518d468994d
+  metadata.gz: f2613f3e9e0bfc676ef5ff965e2656780315cd645dc9ddace261ac3f340621ff32e0c1e7029309c379ed79b969aecabed361dd442848504c279753af0452af64
+  data.tar.gz: 5aa56646f724d7426353327f8c396abc0a84f5e462979aa7a92bb0b3563f4cefdfdbb0a0c0c058ba74c9119f2267ff511ca83e1209e13c8d077615fd5971ac38

data/CHANGELOG.md

@@ -22,6 +22,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 *
 
+## [2.1.0](https://github.com/jrochkind/attr_json/compare/v2.0.1...v2.1.0)
+
+### Added
+
+* Support for `store_key` in models used with polymorphic model feature. https://github.com/jrochkind/attr_json/pull/206 . Thanks @rdubya
+
+
 ## [2.0.1](https://github.com/jrochkind/attr_json/compare/v2.0.0...v2.0.1)
 
 

data/README.md

@@ -48,6 +48,9 @@ class MyModel < ActiveRecord::Base
 
    # You can have an _array_ of those things too. It will ordinarily default to empty array.
    attr_json :int_array, :integer, array: true
+   
+   # The empty array default can be disabled with the following setting
+   attr_json :str_array, :string, array: true, default: AttrJson::AttributeDefinition::NO_DEFAULT_PROVIDED
 
    #and/or defaults
    attr_json :str_with_default, :string, default: "default value"
@@ -362,6 +365,9 @@ end
 
 class MyTable < ApplicationRecord
   serialize :some_json_column, MyModel.to_serialization_coder
+
+  # NOTE: In Rails 7.1+, write:
+  # serialize :some_json_column, coder: MyModel.to_serialization_coder
 end
 
 MyTable.create(some_json_column: MyModel.new(some_string: "string"))
@@ -456,7 +462,7 @@ Why might you want this?
 
 * Single-Table Inheritance, with sub-classes that have non-shared
   data fields. You rather not make all those columns, some of which will then also appear
-  to inapplicable sub-classes.
+  to inapplicable sub-classes. (**note** you may have trouble with [ActiveRecord #becomes](https://api.rubyonrails.org/v7.0.4/classes/ActiveRecord/Persistence.html#method-i-becomes) in some versions of Rails due to Rails bug. See https://github.com/jrochkind/attr_json/issues/189 and https://github.com/rails/rails/issues/47538))
 
 * A "content management system" type project, where you need complex
   structured data of various types, maybe needs to be vary depending

data/attr_json.gemspec

@@ -42,8 +42,10 @@ attributes use as much of the existing ActiveRecord architecture as we can.}
 
   spec.required_ruby_version = '>= 2.6.0'
 
-  # Only to get CI to work on versions of Rails other than we release with,
-  # should never release a gem with RAILS_GEM set!
+  # This conditional is only to get CI to work on versions of Rails other than
+  # we release with. The gem should never be released without the activerecord
+  # dependency included just as it is here, should never be released
+  # from an env tht has any of these variables set.
   unless ENV['APPRAISAL_INITIALIZED'] || ENV["TRAVIS"] || ENV['CI']
     spec.add_runtime_dependency "activerecord", ">= 6.0.0", "< 7.1"
   end

data/lib/attr_json/model.rb

@@ -168,6 +168,9 @@ module AttrJson
       #
       #     class MyTable < ApplicationRecord
       #       serialize :some_json_column, MyModel.to_serialization_coder
+      #
+      #       # In Rails 7.1+:
+      #       # serialize :some_json_column, coder: MyModel.to_serialization_coder
       #     end
       #
       def to_serialization_coder

data/lib/attr_json/type/polymorphic_model.rb

@@ -100,17 +100,11 @@ module AttrJson
       end
 
       def cast(v)
-        if v.nil?
-          v
-        elsif model_names.include?(v.class.name)
-          v
-        elsif v.respond_to?(:to_hash)
-          cast_from_hash(v.to_hash)
-        elsif v.respond_to?(:to_h)
-          cast_from_hash(v.to_h)
-        else
-          raise_bad_model_name(v.class, v)
-        end
+        cast_or_deserialize(v, :cast)
+      end
+
+      def deserialize(v)
+        cast_or_deserialize(v, :deserialize)
       end
 
       def serialize(v)
@@ -127,10 +121,6 @@ module AttrJson
         type.serialize(v).merge(type_key => model_name)
       end
 
-      def deserialize(v)
-        cast(v)
-      end
-
       def type_for_model_name(model_name)
         model_type_lookup[model_name]
       end
@@ -153,15 +143,29 @@ module AttrJson
 
       protected
 
-      def raise_missing_type_key(value)
-        raise TypeError, "AttrJson::Type::Polymorphic can't cast without '#{type_key}' key: #{value}"
-      end
-
-      def raise_bad_model_name(name, value)
-        raise TypeError, "This AttrJson::Type::PolymorphicType can only include {#{model_names.join(', ')}}, not '#{name}': #{value.inspect}"
+      # We need to make sure to call the correct operation on
+      # the model type, so that we get the same result as if
+      # we had called the type directly
+      #
+      # @param v [Object, nil] the value to cast or deserialize
+      # @param operation [Symbol] :cast or :deserialize
+      def cast_or_deserialize(v, operation)
+        if v.nil?
+          v
+        elsif model_names.include?(v.class.name)
+          v
+        elsif v.respond_to?(:to_hash)
+          model_from_hash(v.to_hash, operation)
+        elsif v.respond_to?(:to_h)
+          model_from_hash(v.to_h, operation)
+        else
+          raise_bad_model_name(v.class, v)
+        end
       end
 
-      def cast_from_hash(hash)
+      # @param hash [Hash] the value to cast or deserialize
+      # @param operation [Symbol] :cast or :deserialize
+      def model_from_hash(hash, operation)
         new_hash = hash.stringify_keys
         model_name = new_hash.delete(type_key.to_s)
 
@@ -171,7 +175,21 @@ module AttrJson
 
         raise_bad_model_name(model_name, hash) if type.nil?
 
-        type.cast(new_hash)
+        if operation == :deserialize
+          type.deserialize(new_hash)
+        elsif operation == :cast
+          type.cast(new_hash)
+        else
+          raise ArgumentError, "Unknown operation #{operation}"
+        end
+      end
+
+      def raise_missing_type_key(value)
+        raise TypeError, "AttrJson::Type::Polymorphic can't cast without '#{type_key}' key: #{value}"
+      end
+
+      def raise_bad_model_name(name, value)
+        raise TypeError, "This AttrJson::Type::PolymorphicType can only include {#{model_names.join(', ')}}, not '#{name}': #{value.inspect}"
       end
     end
   end

data/lib/attr_json/version.rb

@@ -1,3 +1,3 @@
 module AttrJson
-  VERSION = "2.0.1"
+  VERSION = "2.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attr_json
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Jonathan Rochkind
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-28 00:00:00.000000000 Z
+date: 2023-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord