attr_json 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 979ced874e097dcf41e911b60320b8cf05dde0a3fce0256b7127d0ad28de4854
-  data.tar.gz: cfa4e62ba695c5f952adcef69a47453781891f91e854bbe83cf83d4360364773
+  metadata.gz: 3e3a6009367cdd38597ef94a714897b21dd287f34251a501e54f0081981525e4
+  data.tar.gz: a4b4afb4af34a355eb8df4df1facbd17e03a34df8abb29a8335d4c0d589c4378
 SHA512:
-  metadata.gz: 054c84ddcd6d63b3020656ba64a200c43a8994d28be693a61d37dee5a25352b215e375354ca55ea3cd8f3e80b6427639ba279d2075a52aaa9f9b7a4364506d75
-  data.tar.gz: f2fe2af4a190f7e6c7fe18f2fff235158f209929a0ded8d66543833b8d8b2ca55b93dece3363f71b93000e4c174c48ce3516ab291948dad88b109d0d973987a5
+  metadata.gz: f2613f3e9e0bfc676ef5ff965e2656780315cd645dc9ddace261ac3f340621ff32e0c1e7029309c379ed79b969aecabed361dd442848504c279753af0452af64
+  data.tar.gz: 5aa56646f724d7426353327f8c396abc0a84f5e462979aa7a92bb0b3563f4cefdfdbb0a0c0c058ba74c9119f2267ff511ca83e1209e13c8d077615fd5971ac38

data/Appraisals

@@ -37,11 +37,5 @@ appraise "rails-edge" do
   # Edge rails, future Rails 7.1 currently allows rack 3 -- but rails itself
   # and some of our other dependencies may not actually work with rack 3 yet,
   # let's test under rack 2. (Nothing in this gem deals with levels as low as rack)
-  #
-  # Bundler was having trouble resolving unless we specified rackup and rack-session
-  # limits too, I think it was a bundler failure, we actually only care about
-  # rack < 3 here.
   gem "rack", "~> 2.0"
-  gem "rackup", "< 2"
-  gem "rack-session", "< 2"
 end

data/CHANGELOG.md

@@ -4,9 +4,9 @@ Notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased](https://github.com/jrochkind/attr_json/compare/v2.0.0...HEAD)
+## [Unreleased](https://github.com/jrochkind/attr_json/compare/v2.0.1...HEAD)
 
-### Changed
+### Fixed
 
 *
 
@@ -22,6 +22,26 @@ 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)
+
+
+### Fixed
+
+* You can now do a specified ActiveRecord `.select` without your json containers, to fetch an object with other attributes that you can access. https://github.com/jrochkind/attr_json/pull/193
+
+### Changed
+
+* Refactor #attr_json_sync_to_rails_attributes for slightly improved performance. https://github.com/jrochkind/attr_json/pull/192
+
+* Safety guard in sync_to_rails_attributes against unknown edge case where container is nil https://github.com/jrochkind/attr_json/pull/194
+
 
 ## [2.0.0](https://github.com/jrochkind/attr_json/compare/v1.5.0...v2.0.0)
 

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/gemfiles/rails_edge.gemfile

@@ -16,7 +16,5 @@ gem "webdrivers", "~> 5.0"
 gem "selenium-webdriver"
 gem "byebug"
 gem "rack", "~> 2.0"
-gem "rackup", "< 2"
-gem "rack-session", "< 2"
 
 gemspec path: "../"

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/record.rb

@@ -48,23 +48,33 @@ module AttrJson
     # mutation of mutable object will effect both places, for instance for dirty
     # tracking.
     def attr_json_sync_to_rails_attributes
-      self.class.attr_json_registry.attribute_names.each do |attr_name|
+      self.class.attr_json_registry.definitions.group_by(&:container_attribute).each_pair do |container_attribute, definitions|
         begin
-          attribute_def = self.class.attr_json_registry.fetch(attr_name.to_sym)
-          json_value    = public_send(attribute_def.container_attribute)
-          value         = json_value[attribute_def.store_key]
+          # column may have eg been left out of an explicit 'select'
+          next unless has_attribute?(container_attribute)
 
-          if value
-            # TODO, can we just make this use the setter?
-            write_attribute(attr_name, value)
+          container_value    = public_send(container_attribute)
 
-            clear_attribute_change(attr_name) if persisted?
+          # isn't expected to be possible to be nil rather than empty hash, but
+          # if it is from some edge case, well, we don't have values to sync, fine
+          next if container_value.nil?
 
-            # writing and clearning will result in a new object stored in
-            # rails attributes, we want
-            # to make sure the exact same object is in the json attribute,
-            # so in-place mutation changes to it are reflected in both places.
-            json_value[attribute_def.store_key] = read_attribute(attr_name)
+          definitions.each do |attribute_def|
+            attr_name     = attribute_def.name
+            value         = container_value[attribute_def.store_key]
+
+            if value
+              # TODO, can we just make this use the setter?
+              write_attribute(attr_name, value)
+
+              clear_attribute_change(attr_name) if persisted?
+
+              # writing and clearning will result in a new object stored in
+              # rails attributes, we want
+              # to make sure the exact same object is in the json attribute,
+              # so in-place mutation changes to it are reflected in both places.
+              container_value[attribute_def.store_key] = read_attribute(attr_name)
+            end
           end
         rescue AttrJson::Type::Model::BadCast, AttrJson::Type::PolymorphicModel::TypeError => e
           # There was bad data in the DB, we're just going to skip the Rails attribute sync.

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.0"
+  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.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Jonathan Rochkind
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-30 00:00:00.000000000 Z
+date: 2023-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -206,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.5
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: ActiveRecord attributes stored serialized in a json column, super smooth.