Merge pull request #639 from gauthier-delacroix/Unsuffixed-default-associations-keys

Allow JSONAPI unsuffixed associations keys

Author: steveklabnik

README.md

@@ -247,6 +247,18 @@ end
 BlogSerializer.new(object, key_format: :lower_camel)
 ```
 
+## Changing the default association key type
+
+You can specify that serializers use unsuffixed names as association keys by default.
+
+`````ruby
+ActiveModel::Serializer.setup do |config|
+  config.default_key_type = :name
+end
+````
+
+This will build association keys like `comments` or `author` instead of `comment_ids` or `author_id`. 
+
 ## Getting the old version
 
 If you find that your project is already relying on the old rails to_json

lib/active_model/serializer/association/has_many.rb

@@ -5,7 +5,11 @@ class HasMany < Association
         def initialize(name, *args)
           super
           @root_key = @embedded_key
-          @key ||= "#{name.to_s.singularize}_ids"
+          @key ||= case CONFIG.default_key_type
+            when :name then name.to_s.pluralize
+            else "#{name.to_s.singularize}_ids"
+          end
+
         end
 
         def serializer_class(object, _)

lib/active_model/serializer/association/has_one.rb

@@ -5,7 +5,10 @@ class HasOne < Association
         def initialize(name, *args)
           super
           @root_key = @embedded_key.to_s.pluralize
-          @key ||= "#{name}_id"
+          @key ||= case CONFIG.default_key_type
+            when :name then name.to_s.singularize
+            else "#{name}_id"
+          end
         end
 
         def serializer_class(object, options = {})

test/fixtures/poro.rb

@@ -148,3 +148,25 @@ module TestNamespace
   class ProfileSerializer < ::ProfileSerializer; end
   class UserSerializer    < ::UserSerializer;    end
 end
+
+ActiveModel::Serializer.setup do |config|
+  config.default_key_type = :name
+end
+
+class NameKeyUserSerializer < ActiveModel::Serializer
+  attributes :name, :email
+
+  has_one :profile
+end
+
+class NameKeyPostSerializer < ActiveModel::Serializer
+  attributes :title, :body
+  
+  has_many :comments
+end
+
+ActiveModel::Serializer.setup do |config|
+  config.default_key_type = nil
+end
+
+

test/unit/active_model/serializer/has_many_test.rb

@@ -242,6 +242,24 @@ def test_associations_embedding_objects_using_embed_namespace
           }
         }, @post_serializer.as_json)
       end
+
+      def test_associations_name_key_embedding_ids_serialization_using_serializable_hash
+        @association = NameKeyPostSerializer._associations[:comments]
+        @association.embed = :ids
+
+        assert_equal({
+          title: 'Title 1', body: 'Body 1', 'comments' => @post.comments.map { |c| c.object_id }
+        }, NameKeyPostSerializer.new(@post).serializable_hash)
+      end
+
+      def test_associations_name_key_embedding_ids_serialization_using_as_json
+        @association = NameKeyPostSerializer._associations[:comments]
+        @association.embed = :ids
+
+        assert_equal({
+          'name_key_post' => { title: 'Title 1', body: 'Body 1', 'comments' => @post.comments.map { |c| c.object_id } }
+        }, NameKeyPostSerializer.new(@post).as_json)
+      end
     end
   end
 end

test/unit/active_model/serializer/has_one_test.rb

@@ -216,6 +216,24 @@ def test_associations_embedding_ids_using_embed_namespace_and_embed_in_root_key
           }
         }, @user_serializer.as_json)
       end
+
+      def test_associations_name_key_embedding_ids_serialization_using_serializable_hash
+        @association = NameKeyUserSerializer._associations[:profile]
+        @association.embed = :ids
+
+        assert_equal({
+          name: 'Name 1', email: '[email protected]', 'profile' => @user.profile.object_id
+        }, NameKeyUserSerializer.new(@user).serializable_hash)
+      end
+
+      def test_associations_name_key_embedding_ids_serialization_using_as_json
+        @association = NameKeyUserSerializer._associations[:profile]
+        @association.embed = :ids
+
+        assert_equal({
+          'name_key_user' => { name: 'Name 1', email: '[email protected]', 'profile' => @user.profile.object_id }
+        }, NameKeyUserSerializer.new(@user).as_json)
+      end
     end
   end
 end