attr_json 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 026a86cb550ed91faef1a0aa1eca9dd0fa1985d1d3ac3221da2a165d19145ef9
-  data.tar.gz: be400202cc1016c053ffcdced03d17706601141e402d8998da7c0a3d3cea4815
+  metadata.gz: b2f8a06eaf0058564901292a35bf15fd56c24b0eb8cb784ab1b1e9adc94b87e5
+  data.tar.gz: eb4917f0eb8304b8261536ae75a5abd64dfc29aed52d82c190bb9b48a738ff08
 SHA512:
-  metadata.gz: 98e164f55a903e7babe2a94cfb794d448391bfc75f080d9309f766764e15762f47f524aff7faa5933957302ad36af6f3b0e2ee0e323e0f32f20abbd8eb6e1e2f
-  data.tar.gz: 17e789b630a3a131a57cb8f5805a53641c9802f5e711cad38af73440aa37beb33f1f9a636479fcc63a5b892251c09408a7478746ceeb2df960d207945bea2668
+  metadata.gz: 599a5e752e187a9e511b766efffda2bbf546c6940f42e58c2f0cb883ef835c017e4ec8b9a4fbc2a3236fde733ae6c77c8d27e4728b0fff53dc993b209a3d7882
+  data.tar.gz: 84dac19bcebedf7979ad3299b28ecc175fec59887cc9e6d761d708f0dbb240f8443aba52aca89a434ab8040f5ff64288ce4a428a659c61e8ff11d128399b5974

data/.github/workflows/ci.yml

@@ -53,6 +53,12 @@ jobs:
           - gemfile: rails_6_1
             ruby: 2.7
 
+          - gemfile: rails_6_1
+            ruby: 3.0
+
+          - gemfile: rails_7_0
+            ruby: 3.0
+
     name: ${{ matrix.gemfile }}, ruby ${{ matrix.ruby }}
 
     steps:

data/Appraisals

@@ -35,20 +35,30 @@ end
 appraise "rails-6-1" do
   gem 'combustion', "~> 1.0"
 
-  gem "rails", ">= 6.0.0.rc1", "< 6.2.0.a"
+  gem "rails", "~> 6.1.0"
   gem "pg", "~> 1.0"
 end
 
-appraise "rails-edge-6" do
-  # Edge rails needs unreleased combustion
-  # https://github.com/pat/combustion/issues/92
+appraise "rails-7-0" do
   gem 'combustion', "~> 1.0"
 
-  gem "rails", git: "https://github.com/rails/rails.git", branch: "master"
+  gem "rails", "~> 7.0.0"
   gem "pg", "~> 1.0"
 
-  # We don't actually use coffeescript at all, we need coffee-rails as an explicit
-  # dependency just for transitory edge weirdness using current sprockets release
-  # with rails 6 edge.
-  gem 'coffee-rails'
+  # to make our integration tests using simple_form work as-is,
+  # this works. Don't totally underestand the actual simple_form
+  # setup paths in Rails 7....
+  gem "sprockets-rails"
+end
+
+appraise "rails-edge" do
+  gem 'combustion', "~> 1.0"
+
+  gem "rails", git: "https://github.com/rails/rails.git", branch: "main"
+  gem "pg", "~> 1.0"
+
+  # We do some tests using cocoon, currently via sprockets-rails,
+  # which is not automatically available in Rails 7.  Not sure
+  # the future of cocoon in general. https://github.com/nathanvda/cocoon/issues/555
+  gem "sprockets-rails"
 end

data/CHANGELOG.md

@@ -4,7 +4,24 @@ 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/v1.3.0...HEAD)
+## [Unreleased](https://github.com/jrochkind/attr_json/compare/v1.4.0...HEAD)
+
+
+
+
+## [1.4.0](https://github.com/jrochkind/attr_json/compare/v1.3.0...v1.4.0)
+
+### Changed
+
+* When using store_key feature on an AttrJson::Model, you should not be able to pass in the store_key as a key in initializer or assign_attributes. It was really a bug that this ended up mapped to attribute this way, which could cause a problem in some cases; but calling it out in Changed section because if you were accidentally relying on it, it may appear as a backwards incompat to you. https://github.com/jrochkind/attr_json/pull/125
+
+* Rails 7.0.0 allowed by gemspec and tested in CI
+
+### Fixed
+
+* polymorphic single type can be set to nil https://github.com/jrochkind/attr_json/pull/115
+* polymorphic models can be serialized from hash in container attribute. Thanks @machty. https://github.com/jrochkind/attr_json/pull/123
+* fix bug with deserialization of nested attributes that have types that apply different serialization vs cast logic. Thanks @bradleesand. https://github.com/jrochkind/attr_json/pull/125
 
 ## [1.3.0](https://github.com/jrochkind/attr_json/compare/v1.2.0...v1.3.0)
 

data/Gemfile

@@ -18,17 +18,17 @@ gem 'combustion', '~> 1.1'
 # be the way to do it.
 gem 'rails'
 
-# We should not really need to mention railties, it's already a dependency of
-# rails, but seems to be necessary to get around some mystery bug in bundler
-# dependency resolution.
-gem 'railties'
-
 gem "pg"
 gem "rspec-rails", "~> 4.0"
 gem "simple_form", ">= 4.0"
 gem 'cocoon', ">= 1.2"
 gem 'jquery-rails'
 
+# Even though we don't use coffee-script, when running specs, some part of rails
+# or other part of our stack is still insisting on requiring it, for reasons we
+# don't understand, so we need to depend on it.
+gem "coffee-rails"
+
 gem 'capybara', "~> 3.0"
 gem 'webdrivers', '~> 4.0'
 gem "selenium-webdriver"

data/README.md

@@ -398,27 +398,29 @@ Rails 5.1+ on `attr_json`s on your ActiveRecord classes that include
 `AttrJson::Record`, by including `AttrJson::Record::Dirty`.
 Change-tracking methods are available off the `attr_json_changes` method.
 
-    class MyModel < ActiveRecord::Base
-       include AttrJson::Record
-       include AttrJson::Record::Dirty
-
-       attr_json :str, :string
-    end
-
-    model = MyModel.new
-    model.str = "old"
-    model.save
-    model.str = "new"
+```ruby
+class MyModel < ActiveRecord::Base
+   include AttrJson::Record
+   include AttrJson::Record::Dirty
 
-    # All and only "new" style dirty tracking methods (Raisl 5.1+)
-    # are available:
+   attr_json :str, :string
+end
 
-    model.attr_json_changes.saved_changes
-    model.attr_json_changes.changes_to_save
-    model.attr_json_changes.saved_change_to_str?
-    model.attr_json_changes.saved_change_to_str
-    model.attr_json_changes.will_save_change_to_str?
-    # etc
+model = MyModel.new
+model.str = "old"
+model.save
+model.str = "new"
+
+# All and only "new" style dirty tracking methods (Raisl 5.1+)
+# are available:
+
+model.attr_json_changes.saved_changes
+model.attr_json_changes.changes_to_save
+model.attr_json_changes.saved_change_to_str?
+model.attr_json_changes.saved_change_to_str
+model.attr_json_changes.will_save_change_to_str?
+# etc
+```
 
 More options are available, including merging changes from 'ordinary'
 ActiveRecord attributes in. See docs on [Dirty Tracking](./doc_src/dirty_tracking.md)
@@ -476,11 +478,15 @@ to prevent overwriting other updates from processes.
 
 ## State of Code, and To Be Done
 
-The functionality that is here seems pretty solid, and is being used by jrochkind in a production app.
+This code is solid and stable and is being used in production by at least a handful of people, including the primary maintainer, jrochkind. 
+
+The project is currently getting very little maintainance -- and is still working reliably through Rails releases. It is tested on edge rails and ruby (and has needed very few if any changes with subsequent releases), and I endeavor to keep it working as Rails keeps releasing. 
+
+In order to keep the low-maintenace scenario sustainable, I am *very* cautious accepting new features, especially if they increase code complexity at all. Even if you have a working PR, I may be reluctant to accept it. I'm prioritizing sustainability and stability over new features, and so far this is working out well. However, discussion is always welcome! Especially when paired with code (failing tests for the bugfix or feature you want are super helpful on their own!). 
 
 We are committed to [semantic versioning](https://semver.org/) and will endeavor to release no backwards breaking changes without a major version. We are also serious about minimizing backwards incompat releases altogether (ie minimiing major version releases).
 
-Feedback of any kind of _very welcome_, please feel free to use the issue tracker.
+Feedback of any kind of _very welcome_, please feel free to use the issue tracker. It is hard to get a sense of how many people are actually using this, which is helpful both for my own sense of reward and for anyone to get a sense of the size of the userbase -- feel free to say hi and let us know how you are using it! 
 
 Except for the jsonb_contains stuff using postgres jsonb contains operator, I don't believe any postgres-specific features are used. It ought to work with MySQL, testing and feedback welcome. (Or a PR to test on MySQL?).  My own interest is postgres.
 
@@ -488,26 +494,30 @@ This is still mostly a single-maintainer operation, so has all the sustainabilit
 
 ### Possible future features:
 
-* partial updates for json hashes would be really nice: Using postgres jsonb merge operators to only overwrite what changed. In my initial attempts, AR doesn't make it easy to customize this.
+* Make AttrJson::Model lean more heavily on ActiveModel::Attributes API that did not fully exist in first version of attr_json [hope for a future attr_json 2.0 release]
+
+* Make AttrJson::Record insist on creating rails cover attributes (no longer optional)  and integrating more fully into rails, including rails dirty tricking, eliminating need for custom dirty tracking implementation. Overall decrease in lines of code. Can use jsonb_accessor as guide for some aspects. [hope for inclusion in future attr_json 2.0 release]
+
+* partial updates for json hashes would be really nice: Using postgres jsonb merge operators to only overwrite what changed. In my initial attempts, AR doesn't make it easy to customize this. [update: this is hard, probably not coming soon]
 
-* seamless compatibility with ransack
+* seamless compatibility with ransack [update: not necessarily prioritized]
 
 * Should we give AttrJson::Model a before_serialize hook that you might
   want to use similar to AR before_save?  Should AttrJson::Models
-  raise on trying to serialize an invalid model?
+  raise on trying to serialize an invalid model? [update: eh, hasn't really come up]
 
 * There are limits to what you can do with just jsonb_contains
   queries. We could support operations like `>`, `<`, `<>`
   as [jsonb_accessor](https://github.com/devmynd/jsonb_accessor),
   even accross keypaths. (At present, you could use a
   before_savee to denormalize/renormalize copy your data into
-  ordinary AR columns/associations for searching. Or perhaps a postgres ts_vector for text searching. Needs to be worked out.)
+  ordinary AR columns/associations for searching. Or perhaps a postgres ts_vector for text searching. Needs to be worked out.) [update: interested, but not necessarily prioritized. This one would be interesting for a third-party PR draft!]
 
 * We could/should probably support `jsonb_order` clauses, even
-  accross key paths, like jsonb_accessor.
+  accross key paths, like jsonb_accessor. [update: interested but not necessarily prioritized]
 
 * Could we make these attributes work in ordinary AR where, same
-  as they do in jsonb_contains? Maybe.
+  as they do in jsonb_contains? Maybe. [update: probably not]
 
 ## Development
 

data/attr_json.gemspec

@@ -44,8 +44,8 @@ attributes use as much of the existing ActiveRecord architecture as we can.}
 
   # Only to get CI to work on versions of Rails other than we release with,
   # should never release a gem with RAILS_GEM set!
-  unless ENV['APPRAISAL_INITIALIZED'] || ENV["TRAVIS"]
-    spec.add_runtime_dependency "activerecord", ">= 5.0.0", "< 6.2"
+  unless ENV['APPRAISAL_INITIALIZED'] || ENV["TRAVIS"] || ENV['CI']
+    spec.add_runtime_dependency "activerecord", ">= 5.0.0", "< 7.1"
   end
 
   spec.add_development_dependency "bundler"
@@ -54,4 +54,21 @@ attributes use as much of the existing ActiveRecord architecture as we can.}
   spec.add_development_dependency "database_cleaner", "~> 1.5"
   spec.add_development_dependency "yard-activesupport-concern"
   spec.add_development_dependency "appraisal", "~> 2.2"
+
+  # Working around annoying issue in selenium 3.x with ruby 3.0.
+  # we don't actually use rexml ourselves. selenium 3 is a dependency
+  # of webdrivers, and tries to use rexml without depending on it
+  # as is needed in ruby 3.
+  #
+  # https://github.com/SeleniumHQ/selenium/issues/9001
+  #
+  # if in the future you can remove this dependecy and still have tests pass
+  # under ruby 3.x, you're good.
+  spec.add_development_dependency "rexml"
+
+  # Used only for Capybara.server in our spec_helper.rb.
+  # webrick is no longer included in ruby 3.0, so has to
+  # be expressed as a dependecy, unless we switch
+  # capybara to use alternate webserver.
+  spec.add_development_dependency "webrick", "~> 1.0"
 end

data/gemfiles/rails_5_0.gemfile

@@ -4,12 +4,12 @@ source "https://rubygems.org"
 
 gem "combustion", "~> 0.9.0"
 gem "rails", "~> 5.0.0"
-gem "railties"
 gem "pg", "~> 0.18"
 gem "rspec-rails", "~> 4.0"
 gem "simple_form", ">= 4.0"
 gem "cocoon", ">= 1.2"
 gem "jquery-rails"
+gem "coffee-rails"
 gem "capybara", "~> 3.0"
 gem "webdrivers", "~> 4.0"
 gem "selenium-webdriver"

data/gemfiles/rails_5_1.gemfile

@@ -4,12 +4,12 @@ source "https://rubygems.org"
 
 gem "combustion", "~> 0.9.0"
 gem "rails", "~> 5.1.0"
-gem "railties"
 gem "pg", "~> 1.0"
 gem "rspec-rails", "~> 4.0"
 gem "simple_form", ">= 4.0"
 gem "cocoon", ">= 1.2"
 gem "jquery-rails"
+gem "coffee-rails"
 gem "capybara", "~> 3.0"
 gem "webdrivers", "~> 4.0"
 gem "selenium-webdriver"

data/gemfiles/rails_5_2.gemfile

@@ -4,12 +4,12 @@ source "https://rubygems.org"
 
 gem "combustion", "~> 0.9.0"
 gem "rails", "~> 5.2.0"
-gem "railties"
 gem "pg", "~> 1.0"
 gem "rspec-rails", "~> 4.0"
 gem "simple_form", ">= 4.0"
 gem "cocoon", ">= 1.2"
 gem "jquery-rails"
+gem "coffee-rails"
 gem "capybara", "~> 3.0"
 gem "webdrivers", "~> 4.0"
 gem "selenium-webdriver"

data/gemfiles/rails_6_0.gemfile

@@ -4,12 +4,12 @@ source "https://rubygems.org"
 
 gem "combustion", "~> 1.0"
 gem "rails", ">= 6.0.0", "< 6.1"
-gem "railties"
 gem "pg", "~> 1.0"
 gem "rspec-rails", "~> 4.0"
 gem "simple_form", ">= 4.0"
 gem "cocoon", ">= 1.2"
 gem "jquery-rails"
+gem "coffee-rails"
 gem "capybara", "~> 3.0"
 gem "webdrivers", "~> 4.0"
 gem "selenium-webdriver"

data/gemfiles/rails_6_1.gemfile

@@ -3,13 +3,13 @@
 source "https://rubygems.org"
 
 gem "combustion", "~> 1.0"
-gem "rails", "~> 6.1"
-gem "railties"
+gem "rails", "~> 6.1.0"
 gem "pg", "~> 1.0"
 gem "rspec-rails", "~> 4.0"
 gem "simple_form", ">= 4.0"
 gem "cocoon", ">= 1.2"
 gem "jquery-rails"
+gem "coffee-rails"
 gem "capybara", "~> 3.0"
 gem "webdrivers", "~> 4.0"
 gem "selenium-webdriver"

data/gemfiles/{rails_edge_6.gemfile → rails_7_0.gemfile}

@@ -3,17 +3,17 @@
 source "https://rubygems.org"
 
 gem "combustion", "~> 1.0"
-gem "rails", git: "https://github.com/rails/rails.git", branch: "master"
-gem "railties"
+gem "rails", "~> 7.0.0"
 gem "pg", "~> 1.0"
 gem "rspec-rails", "~> 4.0"
 gem "simple_form", ">= 4.0"
 gem "cocoon", ">= 1.2"
 gem "jquery-rails"
+gem "coffee-rails"
 gem "capybara", "~> 3.0"
 gem "webdrivers", "~> 4.0"
 gem "selenium-webdriver"
 gem "byebug"
-gem "coffee-rails"
+gem "sprockets-rails"
 
 gemspec path: "../"

data/gemfiles/rails_edge.gemfile

@@ -3,17 +3,17 @@
 source "https://rubygems.org"
 
 gem "combustion", "~> 1.0"
-gem "rails", git: "https://github.com/rails/rails.git", branch: "master"
-gem "railties"
+gem "rails", git: "https://github.com/rails/rails.git", branch: "main"
 gem "pg", "~> 1.0"
-gem "rspec-rails", "~> 3.7"
+gem "rspec-rails", "~> 4.0"
 gem "simple_form", ">= 4.0"
 gem "cocoon", ">= 1.2"
 gem "jquery-rails"
+gem "coffee-rails"
 gem "capybara", "~> 3.0"
 gem "webdrivers", "~> 4.0"
 gem "selenium-webdriver"
 gem "byebug"
-gem "coffee-rails"
+gem "sprockets-rails"
 
 gemspec path: "../"

data/lib/attr_json/model.rb

@@ -103,16 +103,27 @@ module AttrJson
       end
 
 
-      # Like `.new`, but translate store keys in hash
+      # The inverse of model#serializable_hash -- re-hydrates a serialized hash to a model.
+      #
+      # Similar to `.new`, but translates things that need to be translated in deserialization,
+      # like store_keys, and properly calling deserialize on the underlying types.
+      #
+      # @example Model.new_from_serializable(hash)
       def new_from_serializable(attributes = {})
-        attributes = attributes.transform_keys do |key|
+        attributes = attributes.collect do |key, value|
           # store keys in arguments get translated to attribute names on initialize.
           if attribute_def = self.attr_json_registry.store_key_lookup("", key.to_s)
-            attribute_def.name.to_s
-          else
-            key
+            key = attribute_def.name.to_s
           end
-        end
+
+          attr_type = self.attr_json_registry.has_attribute?(key) && self.attr_json_registry.type_for_attribute(key)
+          if attr_type
+            value = attr_type.deserialize(value)
+          end
+
+          [key, value]
+        end.to_h
+
         self.new(attributes)
       end
 

data/lib/attr_json/type/model.rb

@@ -32,10 +32,10 @@ module AttrJson
           # to_hash is actually the 'implicit' conversion, it really is a hash
           # even though it isn't is_a?(Hash), try to_hash first before to_h,
           # the explicit conversion.
-          model.new_from_serializable(v.to_hash)
+          model.new(v.to_hash)
         elsif v.respond_to?(:to_h)
           # TODO Maybe we ought not to do this on #to_h?
-          model.new_from_serializable(v.to_h)
+          model.new(v.to_h)
         elsif model.attr_json_config.bad_cast == :as_nil
           # This was originally default behavior, to be like existing ActiveRecord
           # which kind of silently does this for non-castable basic values. That
@@ -58,7 +58,31 @@ module AttrJson
       end
 
       def deserialize(v)
-        cast(v)
+        if v.nil?
+          # important to stay nil instead of empty object, because they
+          # are different things.
+          v
+        elsif v.kind_of? model
+          v
+        elsif v.respond_to?(:to_hash)
+          # to_hash is actually the 'implicit' conversion, it really is a hash
+          # even though it isn't is_a?(Hash), try to_hash first before to_h,
+          # the explicit conversion.
+          model.new_from_serializable(v.to_hash)
+        elsif v.respond_to?(:to_h)
+          # TODO Maybe we ought not to do this on #to_h? especially here in deserialize?
+          model.new_from_serializable(v.to_h)
+        elsif model.attr_json_config.bad_cast == :as_nil
+          # TODO should we have different config value for bad_deserialize vs bad_cast?
+
+          # This was originally default behavior, to be like existing ActiveRecord
+          # which kind of silently does this for non-castable basic values. That
+          # ended up being confusing in the basic case, so now we raise by default,
+          # but this is still configurable.
+          nil
+        else
+          raise BadCast.new("Can not cast from #{v.inspect} to #{self.type}")
+        end
       end
 
       # these guys are definitely mutable, so we need this.

data/lib/attr_json/type/polymorphic_model.rb

@@ -114,6 +114,11 @@ module AttrJson
       end
 
       def serialize(v)
+        return nil if v.nil?
+
+        # if it's not already a model cast it to a model if possible (eg it's a hash)
+        v = cast(v)
+
         model_name = v.class.name
         type = type_for_model_name(model_name)
 

data/lib/attr_json/version.rb

@@ -1,3 +1,3 @@
 module AttrJson
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attr_json
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Jonathan Rochkind
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-13 00:00:00.000000000 Z
+date: 2021-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -19,7 +19,7 @@ dependencies:
         version: 5.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 5.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -114,6 +114,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: rexml
+  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: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: |-
   ActiveRecord attributes stored serialized in a json column, super smooth.
   For Rails 5.0, 5.1, or 5.2. Typed and cast like Active Record. Supporting nested models,
@@ -153,8 +181,8 @@ files:
 - gemfiles/rails_5_2.gemfile
 - gemfiles/rails_6_0.gemfile
 - gemfiles/rails_6_1.gemfile
+- gemfiles/rails_7_0.gemfile
 - gemfiles/rails_edge.gemfile
-- gemfiles/rails_edge_6.gemfile
 - lib/attr_json.rb
 - lib/attr_json/attribute_definition.rb
 - lib/attr_json/attribute_definition/registry.rb
@@ -182,7 +210,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/jrochkind/attr_json
   source_code_uri: https://github.com/jrochkind/attr_json
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -197,8 +225,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: ActiveRecord attributes stored serialized in a json column, super smooth.
 test_files: []