Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add type key when association name is different than object type #709

Merged
merged 1 commit into from
Oct 31, 2014
Merged

Add type key when association name is different than object type #709

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 20 additions & 3 deletions lib/active_model/serializer/adapter/json_api.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,18 @@ def serializable_hash(options = {})
end

def add_links(name, serializers, options)
@hash[@root][:links][name] ||= []
@hash[@root][:links][name] += serializers.map{|serializer| serializer.id.to_s }
if serializers.first
type = serializers.first.object.class.to_s.underscore.pluralize
end
if name.to_s == type || !type
@hash[@root][:links][name] ||= []
@hash[@root][:links][name] += serializers.map{|serializer| serializer.id.to_s }
else
@hash[@root][:links][name] ||= {}
@hash[@root][:links][name][:type] = type
@hash[@root][:links][name][:ids] ||= []
@hash[@root][:links][name][:ids] += serializers.map{|serializer| serializer.id.to_s }
end

unless options[:embed] == :ids
@hash[:linked][name] ||= []
Expand All @@ -45,7 +55,14 @@ def add_links(name, serializers, options)

def add_link(name, serializer, options)
if serializer
@hash[@root][:links][name] = serializer.id.to_s
type = serializer.object.class.to_s.underscore
if name.to_s == type || !type
@hash[@root][:links][name] = serializer.id.to_s
else
@hash[@root][:links][name] ||= {}
@hash[@root][:links][name][:type] = type
@hash[@root][:links][name][:id] = serializer.id.to_s
end

unless options[:embed] == :ids
plural_name = name.to_s.pluralize.to_sym
Expand Down
9 changes: 9 additions & 0 deletions test/adapter/json_api/belongs_to_test.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ def setup
@comment.post = @post
@post.author = @author
@anonymous_post.author = nil
@blog = Blog.new(id: 1, name: "My Blog!!")
@blog.writer = @author
@blog.articles = [@post, @anonymous_post]

@serializer = CommentSerializer.new(@comment)
@adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer)
Expand All @@ -34,6 +37,12 @@ def test_include_nil_author

assert_equal({comments: [], author: nil}, adapter.serializable_hash[:posts][:links])
end

def test_include_type_for_association_when_is_different_than_name
serializer = BlogSerializer.new(@blog)
adapter = ActiveModel::Serializer::Adapter::JsonApi.new(serializer)
assert_equal({type: "author", id: "1"}, adapter.serializable_hash[:blogs][:links][:writer])
end
end
end
end
Expand Down
11 changes: 10 additions & 1 deletion test/adapter/json_api/has_many_test.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,16 @@ class JsonApi
class HasManyTest < Minitest::Test
def setup
@author = Author.new(id: 1, name: 'Steve K.')
@post = Post.new(title: 'New Post', body: 'Body')
@post = Post.new(id: 1, title: 'New Post', body: 'Body')
@first_comment = Comment.new(id: 1, body: 'ZOMG A COMMENT')
@second_comment = Comment.new(id: 2, body: 'ZOMG ANOTHER COMMENT')
@post.comments = [@first_comment, @second_comment]
@first_comment.post = @post
@second_comment.post = @post
@post.author = @author
@blog = Blog.new(id: 1, name: "My Blog!!")
@blog.writer = @author
@blog.articles = [@post]

@serializer = PostSerializer.new(@post)
@adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer)
Expand All @@ -29,6 +32,12 @@ def test_includes_linked_comments
{id: "2", body: 'ZOMG ANOTHER COMMENT'}
], @adapter.serializable_hash[:linked][:comments])
end

def test_include_type_for_association_when_is_different_than_name
serializer = BlogSerializer.new(@blog)
adapter = ActiveModel::Serializer::Adapter::JsonApi.new(serializer)
assert_equal({type: "posts", ids: ["1"]}, adapter.serializable_hash[:blogs][:links][:articles])
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be singular, e.g post?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nevermind. Just confirmed on the specs that it's plural.

end
end
end
end
Expand Down
8 changes: 8 additions & 0 deletions test/fixtures/poro.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ class ProfileSerializer < ActiveModel::Serializer
Post = Class.new(Model)
Comment = Class.new(Model)
Author = Class.new(Model)
Blog = Class.new(Model)

PostSerializer = Class.new(ActiveModel::Serializer) do
attributes :title, :body, :id
Expand All @@ -58,3 +59,10 @@ class ProfileSerializer < ActiveModel::Serializer

has_many :posts, embed: :ids
end

BlogSerializer = Class.new(ActiveModel::Serializer) do
attributes :id, :name

belongs_to :writer
has_many :articles
end