Support has_one to be compatible with 0.8.x

Update README and CHANGELOG
This commit is contained in:
Gary Gordon 2014-11-06 14:54:16 -05:00
parent 77fb050d24
commit 651b99f22e
6 changed files with 66 additions and 7 deletions

View File

@ -2,3 +2,4 @@
* adds support for `meta` and `meta_key` [@kurko]
* adds method to override association [adcb99e, @kurko]
* add `has_one` attribute for backwards compatibility [@ggordon]

View File

@ -224,13 +224,14 @@ $ rails g serializer post
```
The generated seralizer will contain basic `attributes` and
`has_many`/`belongs_to` declarations, based on the model. For example:
`has_many`/`has_one`/`belongs_to` declarations, based on the model. For example:
```ruby
class PostSerializer < ActiveModel::Serializer
attributes :title, :body
has_many :comments
has_one :author
url :post
end
@ -250,7 +251,7 @@ end
The attribute names are a **whitelist** of attributes to be serialized.
The `has_many` and `belongs_to` declarations describe relationships between
The `has_many`, `has_one`, and `belongs_to` declarations describe relationships between
resources. By default, when you serialize a `Post`, you will get its `Comment`s
as well.

View File

@ -66,6 +66,16 @@ module ActiveModel
associate(:belongs_to, attrs)
end
# Defines an association in the object should be rendered.
#
# The serializer object should implement the association name
# as a method which should return an object when invoked. If a method
# with the association name does not exist, the association name is
# dispatched to the serialized object.
def self.has_one(*attrs)
associate(:has_one, attrs)
end
def self.associate(type, attrs) #:nodoc:
options = attrs.extract_options!
self._associations = _associations.dup

View File

@ -0,0 +1,44 @@
require 'test_helper'
module ActiveModel
class Serializer
class Adapter
class JsonApi
class HasOneTest < Minitest::Test
def setup
@author = Author.new(id: 1, name: 'Steve K.')
@bio = Bio.new(id: 43, content: 'AMS Contributor')
@author.bio = @bio
@bio.author = @author
@post = Post.new(id: 42, title: 'New Post', body: 'Body')
@anonymous_post = Post.new(id: 43, title: 'Hello!!', body: 'Hello, world!!')
@comment = Comment.new(id: 1, body: 'ZOMG A COMMENT')
@post.comments = [@comment]
@anonymous_post.comments = []
@comment.post = @post
@comment.author = nil
@post.author = @author
@anonymous_post.author = nil
@blog = Blog.new(id: 1, name: "My Blog!!")
@blog.writer = @author
@blog.articles = [@post, @anonymous_post]
@author.posts = []
@author.roles = []
@serializer = AuthorSerializer.new(@author)
@adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer, include: 'bio,posts')
end
def test_includes_bio_id
assert_equal("43", @adapter.serializable_hash[:authors][:links][:bio])
end
def test_includes_linked_bio
@adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer, include: 'bio')
assert_equal([{id: "43", :content=>"AMS Contributor", :links=>{:author=>"1"}}], @adapter.serializable_hash[:linked][:bios])
end
end
end
end
end
end

View File

@ -99,7 +99,7 @@ AuthorSerializer = Class.new(ActiveModel::Serializer) do
has_many :posts, embed: :ids
has_many :roles, embed: :ids
belongs_to :bio
has_one :bio
end
RoleSerializer = Class.new(ActiveModel::Serializer) do

View File

@ -23,7 +23,6 @@ module ActiveModel
end
end
def setup
@author = Author.new(name: 'Steve K.')
@author.bio = nil
@ -43,11 +42,11 @@ module ActiveModel
@comment_serializer = CommentSerializer.new(@comment)
end
def test_has_many
def test_has_many_and_has_one
assert_equal(
{ posts: { type: :has_many, association_options: { embed: :ids } },
roles: { type: :has_many, association_options: { embed: :ids } },
bio: { type: :belongs_to, association_options: {} } },
bio: { type: :has_one, association_options: {} } },
@author_serializer.class._associations
)
@author_serializer.each_association do |name, serializer, options|
@ -67,7 +66,11 @@ module ActiveModel
end
def test_belongs_to
assert_equal({post: {type: :belongs_to, association_options: {}}, :author=>{:type=>:belongs_to, :association_options=>{}}}, @comment_serializer.class._associations)
assert_equal(
{ post: { type: :belongs_to, association_options: {} },
author: { type: :belongs_to, association_options: {} } },
@comment_serializer.class._associations
)
@comment_serializer.each_association do |name, serializer, options|
if name == :post
assert_equal({}, options)