active_model_serializers_pg 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d35fba508c14ac3f2dac43976aa98853847901d1854a60cdfc17e9307d7bc054
-  data.tar.gz: de31287ee80e62dbc4ea06dcef31269d70f1ecdb7611ab6021d56d671057aea7
+  metadata.gz: 709fe0bce48637cbd10e3f8a4cc66d9332da0a36ea2158153711c2f49bcdc82f
+  data.tar.gz: bbc3e6c16daf9b8c28ce8d105d1dc355c35b1188b935051447c6b5fab96acda0
 SHA512:
-  metadata.gz: ef15cf70f75a4d508d963593fc806ab388d9f07b295e5a8a393bdcd2ddb1b95094c47f7229ab4113646454211b1dd4550111dc79902c6baf39ddaaa36a4c16a2
-  data.tar.gz: 6221b9fa05569ad2fdd6dd874d326363ea698c6a7442a253e25d349adc046814edf1c67ec68a9ddb0f9fe0126052006261eee969093b78462a027bdb4fa94245
+  metadata.gz: c323f581ecea8145344d4fe95df91a76d548762de320a43513eb7081842d30b28e81fb33a4adc3cca173964d17ce5ba7c384e27043cf9aca68e0ca161b9b83b9
+  data.tar.gz: 076e6dad498e0d0533fe63f4a396099c61557c7b2a05a17ebe910f2caca61b11d4cf005351570e7a4579447e9c427ff7298b759f35a15bfe27749144bee44292

data/README.md

@@ -59,8 +59,10 @@ Here are some other details we support:
 - `belongs_to`, `has_one`, and `has_many` associations.
 - If you serialize an `enum` you get the string values, not integers.
 - You can serialize an `alias`'d association.
+- You can serialize an `alias_attribute`'d column.
 - We preserve SQL ordering from a model's `default_scope`.
 - We preserve SQL ordering attached to an association.
+- When dasherizing we also dasherize json/jsonb/hstore contents (like standard AMS).
 
 ### Methods in Serializers and Models
 

data/Rakefile

@@ -80,6 +80,9 @@ namespace :db do
       t.json     "options"
       t.jsonb    "prefs"
       t.hstore   "settings"
+      t.json     "selfies", array: true
+      t.jsonb    "portraits", array: true
+      t.hstore   "landscapes", array: true
       t.datetime "created_at"
       t.datetime "updated_at"
     end

data/lib/active_model_serializers/adapter/json_api_pg.rb

@@ -77,7 +77,7 @@ module ActiveModelSerializers
       end
 
       def self.warn_about_collection_serializer
-          msg = "You are using an ordinary AMS CollectionSerializer with the json_api_pg adapter, which probably means Rails is pointlessly loading all your ActiveRecord instances *and* running the build JSON-building query in Postgres."
+          msg = "You are using an ordinary AMS CollectionSerializer with the json_api_pg adapter, which probably means Rails is pointlessly loading all your ActiveRecord instances *and* running the JSON-building query in Postgres."
           if Object.const_defined? 'Rails'
             Rails.logger.warn msg
           else
@@ -105,8 +105,8 @@ end
 # i.e. how you got here, not how you'd leave:
 # "Reflection" seems to be the internal ActiveRecord lingo
 # for a belongs_to or has_many relationship.
-# (The public documentation calls these "associations",
-# I think think older versions of Rails even used that internally,
+# (The public documentation calls these "associations".
+# I think older versions of Rails even used that internally,
 # but nowadays the method names use "reflection".)
 class JsonThing
   attr_reader :ar_class, :full_name, :name, :serializer, :serializer_options, :json_key, :json_type, :reflection, :parent, :cte_name, :jbs_name
@@ -192,7 +192,7 @@ class JsonThing
     end
   end
 
-  # Each thing has bother a `cte_foo` CTE and a `jbs_foo` CTE.
+  # Each thing has both a `cte_foo` CTE and a `jbs_foo` CTE.
   # (jbs stands for "JSONBs" and is meant to take 3 chars like `cte`.)
   # The former is just the relevant records,
   # and the second builds the JSON object for each record.
@@ -447,16 +447,22 @@ class JsonApiPgSql
       # Standard AMS dasherizes json/jsonb/hstore columns,
       # so we have to do the same:
       if ActiveModelSerializers.config.key_transform == :dash
-        case resource.ar_class.attribute_types[field.to_s]
-        when ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Hstore
+        cl = resource.ar_class.attribute_types[field.to_s]
+        if column_is_jsonb? cl
+          %Q{jsonb_dasherize("#{resource.table_name}"."#{field}")}
+        elsif column_is_jsonb_array? cl
+          # TODO: Could be faster:
+          # If we made the jsonb_dasherize function smarter so it could handle jsonb[],
+          # we wouldn't have to build a json object from the array then cast to jsonb[].
+          %Q{jsonb_dasherize(array_to_json("#{resource.table_name}"."#{field}")::jsonb)}
+        elsif column_is_castable_to_jsonb? cl
           # Fortunately we can cast hstore to jsonb,
           # which gives us a solution that works whether or not the hstore extension is installed.
           # Defining an hstore_dasherize function would work only if the extension were present.
           %Q{jsonb_dasherize("#{resource.table_name}"."#{field}"::jsonb)}
-        when ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Jsonb
-          %Q{jsonb_dasherize("#{resource.table_name}"."#{field}")}
-        when self.class.json_column_type
-          %Q{jsonb_dasherize("#{resource.table_name}"."#{field}"::jsonb)}
+        elsif column_is_castable_to_jsonb_array? cl
+          # TODO: Could be faster (see above):
+          %Q{jsonb_dasherize(array_to_json("#{resource.table_name}"."#{field}"::jsonb[])::jsonb)}
         else
           %Q{"#{resource.table_name}"."#{field}"}
         end
@@ -466,6 +472,25 @@ class JsonApiPgSql
     end
   end
 
+  def column_is_jsonb?(column_class)
+    column_class.is_a? ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Jsonb
+  end
+
+  def column_is_jsonb_array?(column_class)
+    column_class.is_a?(ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Array) and
+      column_class.subtype.is_a?(ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Jsonb)
+  end
+
+  def column_is_castable_to_jsonb?(column_class)
+    column_class.is_a?(ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Hstore) or
+      column_class.is_a?(self.class.json_column_type)
+  end
+
+  def column_is_castable_to_jsonb_array?(column_class)
+    column_class.is_a?(ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Array) and
+      column_is_castable_to_jsonb?(column_class.subtype)
+  end
+
   def select_resource_relationship_links(resource, reflection)
     reflection.links.map {|link_name, link_parts|
       <<~EOQ
@@ -603,8 +628,6 @@ class JsonApiPgSql
 
   # See note in _jbs_name method for why we split each thing into two CTEs.
   def include_cte(resource)
-    # Sometimes options[:fields] has plural keys and sometimes singular,
-    # so try both:
     parent = resource.parent
     <<~EOQ
       SELECT  DISTINCT ON ("#{resource.table_name}"."#{resource.primary_key}")

data/lib/active_model_serializers_pg/version.rb

@@ -1,3 +1,3 @@
 module ActiveModelSerializersPg
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end

data/spec/serializer_spec.rb

@@ -215,9 +215,12 @@ describe 'ArraySerializer' do
     let(:person)     {
       Person.create first_name: 'Test',
                     last_name: 'User',
-                    options:  { 'foo_foo': 'baz', bar: [{ 'jar_jar': 'binks' }] },
-                    prefs:    { 'foo_foo': 'baz', bar: [{ 'jar_jar': 'binks' }] },
-                    settings: { 'foo_foo': 'bar' }
+                    options:    { 'foo_foo': 'baz', bar: [{ 'jar_jar': 'binks' }] },
+                    prefs:      { 'foo_foo': 'baz', bar: [{ 'jar_jar': 'binks' }] },
+                    settings:   { 'foo_foo': 'bar' },
+                    selfies:    [ { 'photo_resolution': '200x200' } ],
+                    portraits:  [ { 'photo_resolution': '150x200' } ],
+                    landscapes: [ { 'photo_resolution': '200x150' } ]
     }
     let(:options)    { { each_serializer: PersonWithJsonSerializer } }
 
@@ -245,9 +248,18 @@ describe 'ArraySerializer' do
                 bar: [{ 'jar-jar' => 'binks'}],
                 'foo-foo' => 'baz',
               },
+              selfies: [
+                { 'photo-resolution' => '200x200' },
+              ],
               settings: {
                 'foo-foo' => 'bar'
               },
+              portraits: [
+                { 'photo-resolution' => '150x200' },
+              ],
+              landscapes: [
+                { 'photo-resolution' => '200x150' },
+              ],
             },
           }
         ]

data/spec/spec_helper.rb

@@ -69,7 +69,13 @@ class PersonSerializer < ActiveModel::Serializer
 end
 
 class PersonWithJsonSerializer < ActiveModel::Serializer
-  attributes :id, :options, :prefs, :settings
+  attributes :id,
+    :options,     # json
+    :prefs,       # jsonb
+    :settings,    # hstore
+    :selfies,     # json[]
+    :portraits,   # jsonb[]
+    :landscapes   # hstore[]
 end
 
 class Note < ActiveRecord::Base

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_model_serializers_pg
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Paul A. Jungwirth
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-25 00:00:00.000000000 Z
+date: 2020-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_model_serializers
@@ -226,7 +226,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Harness the power of PostgreSQL when crafting JSON reponses