attr_json 2.0.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd9c25a736bb3b1ce26527c555718efcff2967204d853962048ffc2471af243c
-  data.tar.gz: dc022d69b43b4576d2939bb90f2e172b65b8dd45708b361758554561dc61f44f
+  metadata.gz: dadc04fb081fee0b326eaff03f569f15d745948119959e2a8eb5d91b690dec38
+  data.tar.gz: fb6a28e048e03822432e63a7205d0242d218ddace88dd0566624517c3a5454b5
 SHA512:
-  metadata.gz: 6457f06b9aed14481b7dd1543929d7010b54d232473f64cde811452083279ab72bbeb92f7a972e903d8994f21f3e263c5163044aa363db4c35a7eadd42710f24
-  data.tar.gz: 8dd0bad4eb89aad50ceb084ecb48a08d0f4b19d67f9421250fb808a2238c159fce891d1e07d37568b6ba6c65c284a9b2b600e1156cf32334a2c7d518d468994d
+  metadata.gz: 6048863f54826dc166200400a93cdfdb91055ddba960d6d2b8587077eafda5e3058e49d030f60c3eb05f74ba2ea99512c087c403f8eb0a18e4dd45c4f7929bee
+  data.tar.gz: afafb7cf57637cce5f99c3afacd38bc802aca8c5e60b9c0cd1adebc08a482b064ce5a7398c44507b612f94691fd8362bba9cb00d13f8d14603524e235e93b617

data/.github/workflows/ci.yml

@@ -49,7 +49,15 @@ jobs:
 
           - gemfile: rails_7_0
             ruby: 3.2
+            
+          - gemfile: rails_7_1
+            ruby: '3.0'
+
+          - gemfile: rails_7_1
+            ruby: 3.1
 
+          - gemfile: rails_7_1
+            ruby: 3.2
 
     name: ${{ matrix.gemfile }}, ruby ${{ matrix.ruby }}
 

data/Appraisals

@@ -4,6 +4,11 @@ appraise "rails-6-0" do
   gem "rails", ">= 6.0.0", "< 6.1"
   gem "pg", "~> 1.0"
   gem "rspec-rails", "~> 5.0"
+
+
+  # Ruby 2.7 still needs webdrivers, since it can't use a new enough
+  # version of selenium-webdriver to download drivers itself
+  gem "webdrivers", ">= 5.3.1"
 end
 
 appraise "rails-6-1" do
@@ -25,6 +30,13 @@ appraise "rails-7-0" do
   gem "pg", "~> 1.0"
 end
 
+appraise "rails-7-1" do
+  gem 'combustion', "~> 1.0"
+
+  gem "rails", "~> 7.1.0"
+  gem "pg", "~> 1.0"
+end
+
 appraise "rails-edge" do
   # need combustion edge to work with rails edge, will no longer
   # be true on next combustion release, probably no later than Rails 7.1

data/CHANGELOG.md

@@ -4,7 +4,7 @@ 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.1...HEAD)
+## [Unreleased](https://github.com/jrochkind/attr_json/compare/v2.2.0...HEAD)
 
 ### Fixed
 
@@ -22,6 +22,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 *
 
+## [2.2.0](https://github.com/jrochkind/attr_json/compare/v2.1.0...v2.2.0)
+
+### Added
+
+* Test and allow Rails 7.1 https://github.com/jrochkind/attr_json/pull/208 Thanks @JoeSouthan
+
+
+## [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/Gemfile

@@ -37,7 +37,6 @@ gem "sprockets-rails"
 
 
 gem 'capybara', "~> 3.0"
-gem 'webdrivers', '~> 5.0'
 gem "selenium-webdriver"
 
 gem "byebug"

data/README.md

@@ -49,6 +49,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"
 
@@ -186,10 +189,8 @@ attribute name, it'll actually query on store_key. And properly handles any
 `container_attribute` -- it'll look in the proper jsonb column.
 
 Anything you can do with `jsonb_contains` should be handled
-by a [postgres `USING GIN` index](https://www.postgresql.org/docs/9.5/static/datatype-json.html#JSON-INDEXING)
-(I think! can anyone help confirm/deny?). To be sure, I recommend you
-investigate: Check out `to_sql` on any query to see what jsonb SQL it generates,
-and explore if you have the indexes you need.
+by a [postgres `USING GIN` index](https://www.postgresql.org/docs/9.5/static/datatype-json.html#JSON-INDEXING). Figuring out how to use indexes for jsonb
+queries can be confusing, [here is a good blog post](https://blog.kiprosh.com/postgres-gin-index-in-rails/).
 
 <a name="nested"></a>
 ## Nested models -- Structured/compound data
@@ -362,6 +363,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 +460,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,10 +42,12 @@ 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"
+    spec.add_runtime_dependency "activerecord", ">= 6.0.0", "< 7.2"
   end
 
   spec.add_development_dependency "bundler"

data/gemfiles/rails_6_0.gemfile

@@ -12,8 +12,8 @@ gem "jquery-rails"
 gem "coffee-rails"
 gem "sprockets-rails"
 gem "capybara", "~> 3.0"
-gem "webdrivers", "~> 5.0"
 gem "selenium-webdriver"
 gem "byebug"
+gem "webdrivers", ">= 5.3.1"
 
 gemspec path: "../"

data/gemfiles/rails_6_1.gemfile

@@ -12,7 +12,6 @@ gem "jquery-rails"
 gem "coffee-rails"
 gem "sprockets-rails"
 gem "capybara", "~> 3.0"
-gem "webdrivers", "~> 5.0"
 gem "selenium-webdriver"
 gem "byebug"
 

data/gemfiles/rails_7_0.gemfile

@@ -12,7 +12,6 @@ gem "jquery-rails"
 gem "coffee-rails"
 gem "sprockets-rails"
 gem "capybara", "~> 3.0"
-gem "webdrivers", "~> 5.0"
 gem "selenium-webdriver"
 gem "byebug"
 

data/gemfiles/rails_7_1.gemfile

@@ -0,0 +1,18 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "combustion", "~> 1.0"
+gem "rails", "~> 7.1.0"
+gem "pg", "~> 1.0"
+gem "rspec-rails", "~> 6.0"
+gem "simple_form", ">= 4.0"
+gem "cocoon", ">= 1.2"
+gem "jquery-rails"
+gem "coffee-rails"
+gem "sprockets-rails"
+gem "capybara", "~> 3.0"
+gem "selenium-webdriver"
+gem "byebug"
+
+gemspec path: "../"

data/gemfiles/rails_edge.gemfile

@@ -12,7 +12,6 @@ gem "jquery-rails"
 gem "coffee-rails"
 gem "sprockets-rails"
 gem "capybara", "~> 3.0"
-gem "webdrivers", "~> 5.0"
 gem "selenium-webdriver"
 gem "byebug"
 gem "rack", "~> 2.0"

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.2.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.2.0
 platform: ruby
 authors:
 - Jonathan Rochkind
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-28 00:00:00.000000000 Z
+date: 2023-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -19,7 +19,7 @@ dependencies:
         version: 6.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 6.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +164,7 @@ files:
 - gemfiles/rails_6_0.gemfile
 - gemfiles/rails_6_1.gemfile
 - gemfiles/rails_7_0.gemfile
+- gemfiles/rails_7_1.gemfile
 - gemfiles/rails_edge.gemfile
 - lib/attr_json.rb
 - lib/attr_json/attribute_definition.rb
@@ -206,7 +207,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: ActiveRecord attributes stored serialized in a json column, super smooth.