Skip to content

Commit

Permalink
Unify the two JSON API relationship test files
Browse files Browse the repository at this point in the history 
I accidentally introduced the duplication when
merging
#1543 (comment)
and they've evolved separately since then.

They both have some value and need to be combined.
  • Loading branch information
@bf4
bf4 committed Sep 26, 2016
1 parent 257ca53 commit baa4716
Show file tree
Hide file tree
Showing 2 changed files with 276 additions and 286 deletions.
289 changes: 276 additions & 13 deletions test/adapter/json_api/relationship_test.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,19 @@ def test_relationship_with_data
type: 'blogs'
}
}
test_relationship(expected, options: { include_data: true })
assert_relationship(expected, options: { include_data: true })
end

def test_relationship_with_nil_model
@serializer = BlogSerializer.new(nil)
expected = { data: nil }
test_relationship(expected, options: { include_data: true })
assert_relationship(expected, options: { include_data: true })
end

def test_relationship_with_nil_serializer
@serializer = nil
expected = { data: nil }
test_relationship(expected, options: { include_data: true })
assert_relationship(expected, options: { include_data: true })
end

def test_relationship_with_data_array
Expand All @@ -50,16 +50,39 @@ def test_relationship_with_data_array
}
]
}
test_relationship(expected, options: { include_data: true })
assert_relationship(expected, options: { include_data: true })
end

def test_relationship_data_not_included
test_relationship({ meta: {} }, options: { include_data: false })
expected = {meta: {}}
assert_relationship(expected, options: { include_data: false })
end

def test_relationship_simple_link
links = { self: 'a link' }
test_relationship({ links: { self: 'a link' } }, links: links)
assert_relationship({ links: { self: 'a link' } }, links: links)
end

def test_take2_relationship_simple_link
expected = {
data: {
id: '1337',
type: 'bios'
},
links: {
self: '//example.com/link_author/relationships/bio'
}
}

model_attributes = { bio: Bio.new(id: 1337) }
relationship_name = :bio
model = new_model(model_attributes)
actual = build_serializer_and_serialize_relationship(model, relationship_name) do
has_one :bio do
link :self, '//example.com/link_author/relationships/bio'
end
end
assert_equal(expected, actual)
end

def test_relationship_many_links
Expand All @@ -73,13 +96,33 @@ def test_relationship_many_links
related: 'another link'
}
}
test_relationship(expected, links: links)
assert_relationship(expected, links: links)
end

def test_relationship_block_link
links = { self: proc { object.id.to_s } }
expected = { links: { self: @blog.id.to_s } }
test_relationship(expected, links: links)
assert_relationship(expected, links: links)
end

def test_take2_relationship_block_link
expected = {
data: { id: '1337', type: 'profiles' },
links: { related: '//example.com/profiles/1337' }
}

model_attributes = { profile: Profile.new(id: 1337) }
relationship_name = :profile
model = new_model(model_attributes)
actual = build_serializer_and_serialize_relationship(model, relationship_name) do
has_one :profile do
id = object.profile.id
link :related do
"//example.com/profiles/#{id}" if id != 123
end
end
end
assert_equal(expected, actual)
end

def test_relationship_block_link_with_meta
Expand All @@ -97,13 +140,13 @@ def test_relationship_block_link_with_meta
}
}
}
test_relationship(expected, links: links)
assert_relationship(expected, links: links)
end

def test_relationship_simple_meta
meta = { id: '1' }
expected = { meta: meta }
test_relationship(expected, meta: meta)
assert_relationship(expected, meta: meta)
end

def test_relationship_block_meta
Expand All @@ -115,7 +158,7 @@ def test_relationship_block_meta
id: @blog.id
}
}
test_relationship(expected, meta: meta)
assert_relationship(expected, meta: meta)
end

def test_relationship_with_everything
Expand Down Expand Up @@ -145,12 +188,196 @@ def test_relationship_with_everything
id: @blog.id
}
}
test_relationship(expected, meta: meta, options: { include_data: true }, links: links)
assert_relationship(expected, meta: meta, options: { include_data: true }, links: links)
end

def test_take2_relationship_with_everything
expected = {
data: [{ id: '1337', type: 'likes' }],
links: {
related: {
href: '//example.com/likes/1337',
meta: { ids: '1337' }
}
},
meta: { liked: true }
}

model_attributes = { likes: [Like.new(id: 1337)] }
relationship_name = :likes
model = new_model(model_attributes)
actual = build_serializer_and_serialize_relationship(model, relationship_name) do
has_many :likes do
link :related do
ids = object.likes.map(&:id).join(',')
href "//example.com/likes/#{ids}"
meta ids: ids
end
meta liked: object.likes.any?
end
end
assert_equal(expected, actual)
end

### BEGIN NEW TESTS TO DISAMBIGUATE
def test_take2_relationship_nil_link
expected = {
data: { id: '123', type: 'profiles' }
}

model_attributes = { profile: Profile.new(id: 123) }
relationship_name = :profile
model = new_model(model_attributes)
actual = build_serializer_and_serialize_relationship(model, relationship_name) do
has_one :profile do
id = object.profile.id
link :related do
"//example.com/profiles/#{id}" if id != 123
end
end
end
assert_equal(expected, actual)
end

def test_take2_relationship_block_link_href
expected = {
data: [{ id: '1337', type: 'locations' }],
links: {
related: { href: '//example.com/locations/1337' }
}
}

model_attributes = { locations: [Location.new(id: 1337)] }
relationship_name = :locations
model = new_model(model_attributes)
actual = build_serializer_and_serialize_relationship(model, relationship_name) do
has_many :locations do
link :related do
ids = object.locations.map(&:id).join(',')
href "//example.com/locations/#{ids}"
end
end
end
assert_equal(expected, actual)
end

def test_take2_relationship_block_link_href_and_meta
expected = {
data: [{ id: '1337', type: 'posts' }],
links: {
related: {
href: '//example.com/posts/1337',
meta: { ids: '1337' }
}
}
}

model_attributes = { posts: [Post.new(id: 1337, comments: [], author: nil)] }
relationship_name = :posts
model = new_model(model_attributes)
actual = build_serializer_and_serialize_relationship(model, relationship_name) do
has_many :posts do
link :related do
ids = object.posts.map(&:id).join(',')
href "//example.com/posts/#{ids}"
meta ids: ids
end
end
end
assert_equal(expected, actual)
end

def test_take2_relationship_block_link_meta
expected = {
data: [{ id: '1337', type: 'comments' }],
links: {
self: {
meta: { ids: [1] }
}
}
}

model_attributes = { comments: [Comment.new(id: 1337)] }
relationship_name = :comments
model = new_model(model_attributes)
actual = build_serializer_and_serialize_relationship(model, relationship_name) do
has_many :comments do
link :self do
meta ids: [1]
end
end
end
assert_equal(expected, actual)
end

def test_take2_relationship_meta
expected = {
data: [{ id: 'from-serializer-method', type: 'roles' }],
meta: { count: 1 }
}

model_attributes = { roles: [Role.new(id: 'from-record')] }
relationship_name = :roles
model = new_model(model_attributes)
actual = build_serializer_and_serialize_relationship(model, relationship_name) do
has_many :roles do |serializer|
meta count: object.roles.count
serializer.cached_roles
end
def cached_roles
[
Role.new(id: 'from-serializer-method')
]
end
end
assert_equal(expected, actual)
end

def test_take2_relationship_not_including_data
expected = {
links: { self: '//example.com/link_author/relationships/blog' }
}

model_attributes = { blog: Object }
relationship_name = :blog
model = new_model(model_attributes)
model.define_singleton_method(:read_attribute_for_serialization) do |attr|
fail 'should not be called' if attr == :blog
super(attr)
end
assert_nothing_raised do
actual = build_serializer_and_serialize_relationship(model, relationship_name) do
has_one :blog do
link :self, '//example.com/link_author/relationships/blog'
include_data false
end
end
assert_equal(expected, actual)
end
end

def test_take2_relationship_including_data_explicit
expected = {
data: { id: '1337', type: 'authors' },
meta: { name: 'Dan Brown' }
}

model_attributes = { reviewer: Author.new(id: 1337) }
relationship_name = :reviewer
model = new_model(model_attributes)
actual = build_serializer_and_serialize_relationship(model, relationship_name) do
belongs_to :reviewer do
meta name: 'Dan Brown'
include_data true
end
end
assert_equal(expected, actual)
end
### END NEW TESTS TO DISAMBIGUATE

private

def test_relationship(expected, test_options = {})
def assert_relationship(expected, test_options = {})
parent_serializer = AuthorSerializer.new(@author)

serializable_resource_options = {} # adapter.instance_options
Expand All @@ -171,6 +398,42 @@ def test_relationship(expected, test_options = {})
relationship = Relationship.new(parent_serializer, serializable_resource_options, association)
assert_equal(expected, relationship.as_json)
end

def build_serializer_and_serialize_relationship(model, relationship_name, &block)
serializer_class = Class.new(ActiveModel::Serializer, &block)
hash = serializable(model, serializer: serializer_class, adapter: :json_api).serializable_hash
hash[:data][:relationships][relationship_name]
end

def new_model(model_attributes)
post = Post.new(id: 1337, comments: [], author: nil)
bio = Bio.new(id: 1337)
like = Like.new(id: 1337)
role = Role.new(id: 'from-record')
profile = Profile.new(id: 1337)
location = Location.new(id: 1337)
reviewer = Author.new(id: 1337)
comment = Comment.new(id: 1337)
default_model_attributes = {
id: 1337,
posts: [post],
reviewer: reviewer,
bio: bio,
likes: [like],
roles: [role],
locations: [location],
profile: profile,
comments: [comment]
}
model_attributes.reverse_merge!(default_model_attributes)
Class.new(ActiveModelSerializers::Model) do
attr_accessor(*model_attributes.keys)

def self.name
'TestModel'
end
end.new(model_attributes)
end
end
end
end
Expand Down
Loading

0 comments on commit baa4716

Please sign in to comment.