active_model_serializers_pg 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fb040d4836aa84e29ba59590ac8bc4373528e31e5186cec1168538d52384fd0
-  data.tar.gz: a2ef8e881e358597aeb30145a73cbfdff5b7ed663d1c614ba5a40cbceba9d772
+  metadata.gz: d35fba508c14ac3f2dac43976aa98853847901d1854a60cdfc17e9307d7bc054
+  data.tar.gz: de31287ee80e62dbc4ea06dcef31269d70f1ecdb7611ab6021d56d671057aea7
 SHA512:
-  metadata.gz: 30889a0c217b98a0a79296379fd7c399b414b223a3568133e796ef605ae938d013957052c939c65bed5a75fed3e64d08025bc83729a92d620d3fdb905aca13dd
-  data.tar.gz: 7ff699ff57696cece4ed3f54a2f3d8583f1d2bd2089f65ab842972d9c22c9a2a86360c20e4bd0e043f2532db8f54c332804e3038c3d65f35c3af6be4f297a56e
+  metadata.gz: ef15cf70f75a4d508d963593fc806ab388d9f07b295e5a8a393bdcd2ddb1b95094c47f7229ab4113646454211b1dd4550111dc79902c6baf39ddaaa36a4c16a2
+  data.tar.gz: 6221b9fa05569ad2fdd6dd874d326363ea698c6a7442a253e25d349adc046814edf1c67ec68a9ddb0f9fe0126052006261eee969093b78462a027bdb4fa94245

data/README.md

@@ -31,6 +31,13 @@ Or install it yourself as:
 
     gem install active_model_serializers_pg
 
+### Migrations
+
+This gem depends on a SQL function to dasherize hstore/json/jsonb columns, so you must add its migration to your project and run it, like this:
+
+    rails g active_model_serializers_pg
+    rake db:migrate
+
 ## Usage
 
 You can enable in-Postgres serialization for everything by putting this in a Rails initializer:

data/Rakefile

@@ -72,9 +72,14 @@ namespace :db do
   task :migrate => :load_db_settings do
     ActiveRecord::Base.establish_connection
 
+    ActiveRecord::Base.connection.execute "CREATE EXTENSION hstore"
+
     ActiveRecord::Base.connection.create_table :people, force: true do |t|
       t.string   "first_name"
       t.string   "last_name"
+      t.json     "options"
+      t.jsonb    "prefs"
+      t.hstore   "settings"
       t.datetime "created_at"
       t.datetime "updated_at"
     end
@@ -131,6 +136,8 @@ namespace :db do
       t.datetime "updated_at"
     end
 
+    ActiveRecord::Base.connection.execute File.read(File.expand_path('../lib/generators/active_record/templates/jsonb_dasherize.sql', __FILE__))
+
     puts 'Database migrated'
   end
 end

data/active_model_serializers_pg.gemspec

@@ -25,6 +25,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'actionpack', '> 4.0'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'generator_spec'
   spec.add_development_dependency 'bourne', '~> 1.3.0'
   spec.add_development_dependency 'database_cleaner'
   spec.add_development_dependency 'dotenv'

data/gemfiles/Gemfile.activerecord-5.0.x

@@ -2,4 +2,4 @@ source "https://rubygems.org"
 
 gemspec :path => '..'
 
-gem "activerecord", "~>5.0.0"
+gem "rails", "~>5.0.0"

data/gemfiles/Gemfile.activerecord-5.1.x

@@ -2,4 +2,4 @@ source "https://rubygems.org"
 
 gemspec :path => '..'
 
-gem "activerecord", "~>5.1.0"
+gem "rails", "~>5.1.0"

data/gemfiles/Gemfile.activerecord-5.2.x

@@ -2,4 +2,4 @@ source "https://rubygems.org"
 
 gemspec :path => '..'
 
-gem "activerecord", "~>5.2.0"
+gem "rails", "~>5.2.0"

data/lib/active_model_serializers/adapter/json_api_pg.rb

@@ -141,28 +141,10 @@ class JsonThing
     JsonThing.new(refl.klass, "#{full_name}.#{reflection_name}", nil, serializer_options, refl, self)
   end
 
-  # Gets the attributes (i.e. scalar fields) on the AR class
-  # as a Set of symbols.
-  # TODO: tests
-	def declared_attributes
-    @declared_attributes ||= Set.new(@ar_class.attribute_types.keys.map(&:to_sym))
-  end
-
   def enum?(field)
     @ar_class.attribute_types[field.to_s].is_a? ActiveRecord::Enum::EnumType
   end
 
-  # Gets the reflections (aka associations) of the AR class
-  # as a Hash from symbol to a subclass of ActiveRecord::Reflection.
-  # TODO: tests
-  def declared_reflections
-    @declared_reflections ||= Hash[
-      @ar_class.reflections.map{|k, v|
-        [k.to_sym, v]
-      }
-    ]
-  end
-
   # Checks for alias_attribute and gets to the real attribute name.
   def unaliased(field_name)
     ret = field_name
@@ -376,6 +358,15 @@ end
 class JsonApiPgSql
   attr_reader :base_serializer, :base_relation
 
+  def self.json_column_type
+    # These classes may not exist, depending on the Rails version:
+    @@json_column_type = if Rails::VERSION::STRING >= '5.2'
+                           'ActiveRecord::Type::Json'
+                         else
+                           'ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Json'
+                         end.constantize
+  end
+
   def initialize(base_serializer, base_relation, instance_options, options)
     @base_relation = base_relation
     @instance_options = instance_options
@@ -452,7 +443,26 @@ class JsonApiPgSql
     elsif resource.has_sql_method?(field)
       resource.sql_method(field)
     else
-      %Q{"#{resource.table_name}"."#{resource.unaliased(field)}"}
+      field = resource.unaliased(field)
+      # 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
+          # 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)}
+        else
+          %Q{"#{resource.table_name}"."#{field}"}
+        end
+      else
+        %Q{"#{resource.table_name}"."#{field}"}
+      end
     end
   end
 

data/lib/active_model_serializers_pg/version.rb

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

data/lib/generators/active_model_serializers_pg/active_model_serializers_pg_generator.rb

@@ -0,0 +1,20 @@
+require 'rails/generators'
+
+module ActiveModelSerializersPg
+  module Generators
+    class ActiveModelSerializersPgGenerator < Rails::Generators::NamedBase
+      Rails::Generators::ResourceHelpers
+
+      # The ORM generator assumes you're passing a name argument,
+      # but we don't need one, so we give it a default value:
+      argument :name, type: :string, default: "ignored"
+      source_root File.expand_path("../templates", __FILE__)
+
+      namespace :active_model_serializers_pg
+      hook_for :orm, required: true, name: "ignored"
+
+      desc "Creates an active_model_serialiers_pg database migration"
+
+    end
+  end
+end

data/lib/generators/active_record/active_model_serializers_pg_generator.rb

@@ -0,0 +1,43 @@
+require 'rails/generators/active_record'
+
+module ActiveRecord
+  module Generators
+    class ActiveModelSerializersPgGenerator < ActiveRecord::Generators::Base
+      argument :name, type: :string, default: "ignored"
+      source_root File.expand_path("../templates", __FILE__)
+
+      def write_migration
+        migration_template "migration.rb", "#{migration_path}/ams_pg_create_dasherize_functions.rb"
+      end
+
+      private
+
+      def read_sql(funcname)
+        File.read(File.join(File.expand_path('../templates', __FILE__), "#{funcname}.sql"))
+      end
+
+      def migration_exists?(table_name)
+        Dir.glob("#{File.join destination_root, migration_path}/[0-9]*_*.rb").grep(/\d+_ams_pg_create_dasherize_functions.rb$/).first
+      end
+
+      def migration_path
+        if Rails.version >= '5.0.3'
+          db_migrate_path
+        else
+          @migration_path ||= File.join "db", "migrate"
+        end
+      end
+
+      def migration_version
+        if Rails.version.start_with? '5'
+          "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+        end
+      end
+
+      def jsonb_dasherize
+        read_sql('jsonb_dasherize')
+      end
+
+    end
+  end
+end

data/lib/generators/active_record/templates/jsonb_dasherize.sql

@@ -0,0 +1,32 @@
+CREATE FUNCTION jsonb_dasherize(j jsonb)
+RETURNS jsonb
+IMMUTABLE
+AS
+$$
+DECLARE
+t text;
+ret jsonb;
+BEGIN
+  t := jsonb_typeof(j);
+  IF t = 'object' THEN
+    SELECT  COALESCE(jsonb_object_agg(REPLACE(k, '_', '-'), jsonb_dasherize(v)), '{}')
+    INTO    ret
+    FROM    jsonb_each(j) AS t(k, v);
+    RETURN ret;
+  ELSIF t = 'array' THEN
+    SELECT  COALESCE(jsonb_agg(jsonb_dasherize(elem)), '[]')
+    INTO    ret
+    FROM    jsonb_array_elements(j) AS t(elem);
+    RETURN ret;
+  ELSIF t IS NULL THEN
+    -- This should never happen internally
+    -- (thankfully, lest jsonb_set return NULL and destroy everything),
+    -- but only from a passed-in NULL.
+    RETURN NULL;
+  ELSE
+    -- string/number/null:
+    RETURN j;
+  END IF;
+END;
+$$
+LANGUAGE plpgsql;

data/lib/generators/active_record/templates/migration.rb

@@ -0,0 +1,11 @@
+class AmsPgCreateDasherizeFunctions < ActiveRecord::Migration<%= migration_version %>
+
+  def up
+    execute %q{<%= jsonb_dasherize %>}
+  end
+
+  def down
+    execute "DROP FUNCTION jsonb_dasherize(jsonb)"
+  end
+
+end

data/spec/generators/main_generator_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+require 'generators/active_model_serializers_pg/active_model_serializers_pg_generator'
+
+describe ActiveModelSerializersPg::Generators::ActiveModelSerializersPgGenerator, type: :generator do
+  destination File.expand_path "../../../tmp", __FILE__
+
+  before :each do
+    prepare_destination
+  end
+
+  it "creates the migration file" do
+    run_generator
+    expect(destination_root).to have_structure {
+      directory "db" do
+        directory "migrate" do
+          migration "ams_pg_create_dasherize_functions" do
+            contains "class AmsPgCreateDasherizeFunctions"
+          end
+        end
+      end
+    }
+  end
+end

data/spec/serializer_spec.rb

@@ -209,6 +209,53 @@ describe 'ArraySerializer' do
     end
   end
 
+  context 'with dasherized json columns' do
+    let(:relation)   { Person.all }
+    let(:controller) { PeopleController.new }
+    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' }
+    }
+    let(:options)    { { each_serializer: PersonWithJsonSerializer } }
+
+    before do
+      @old_key_setting = ActiveModelSerializers.config.key_transform
+      ActiveModelSerializers.config.key_transform = :dash
+    end
+
+    after do
+      ActiveModelSerializers.config.key_transform = @old_key_setting
+    end
+
+    it 'generates the proper json output' do
+      json_expected = {
+        data: [
+          {
+            id: person.id.to_s,
+            type: 'people',
+            attributes: {
+              prefs: {
+                bar: [{ 'jar-jar' => 'binks'}],
+                'foo-foo' => 'baz',
+              },
+              options: {
+                bar: [{ 'jar-jar' => 'binks'}],
+                'foo-foo' => 'baz',
+              },
+              settings: {
+                'foo-foo' => 'bar'
+              },
+            },
+          }
+        ]
+      }.to_json
+      expect(json_data).to eq json_expected
+    end
+  end
+
   context 'with aliased association' do
     let(:relation)   { Tag.first }
     let(:controller) { TagsController.new }

data/spec/spec_helper.rb

@@ -1,11 +1,12 @@
-require 'active_record'
-require 'action_controller'
+require 'rails/all'
 require 'rspec'
+require 'rspec/rails'
 require 'bourne'
 require 'database_cleaner'
 require 'active_model_serializers'
 require 'action_controller/serialization'
 require 'active_model_serializers_pg'
+require 'generator_spec'
 if ENV['TEST_UNPATCHED_AMS']
   ActiveModelSerializers.config.adapter = :json_api
 else
@@ -24,6 +25,17 @@ end
 require 'dotenv'
 Dotenv.load
 
+# Need this or Rails.application is nil just below:
+module TestApp
+  class Application < ::Rails::Application
+    config.root = File.dirname(__FILE__)
+  end
+end
+
+# Need this line or `hook_for` in our generators is ignored,
+# so our migration generator doesn't run:
+Rails.application.load_generators
+
 ActiveRecord::Base.establish_connection(ENV['DATABASE_URL'])
 
 class TestController < ActionController::Base
@@ -56,6 +68,10 @@ class PersonSerializer < ActiveModel::Serializer
   end
 end
 
+class PersonWithJsonSerializer < ActiveModel::Serializer
+  attributes :id, :options, :prefs, :settings
+end
+
 class Note < ActiveRecord::Base
   has_many :tags
   has_many :sorted_tags

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_model_serializers_pg
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Paul A. Jungwirth
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-22 00:00:00.000000000 Z
+date: 2019-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_model_serializers
@@ -94,6 +94,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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: generator_spec
+  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: bourne
   requirement: !ruby/object:Gem::Requirement
@@ -172,6 +200,11 @@ files:
 - lib/active_model_serializers_pg.rb
 - lib/active_model_serializers_pg/collection_serializer.rb
 - lib/active_model_serializers_pg/version.rb
+- lib/generators/active_model_serializers_pg/active_model_serializers_pg_generator.rb
+- lib/generators/active_record/active_model_serializers_pg_generator.rb
+- lib/generators/active_record/templates/jsonb_dasherize.sql
+- lib/generators/active_record/templates/migration.rb
+- spec/generators/main_generator_spec.rb
 - spec/serializer_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/pjungwir/active_model_serializers_pg
@@ -198,5 +231,6 @@ signing_key:
 specification_version: 4
 summary: Harness the power of PostgreSQL when crafting JSON reponses
 test_files:
+- spec/generators/main_generator_spec.rb
 - spec/serializer_spec.rb
 - spec/spec_helper.rb