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.

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

Don't render relationships unless explicity requested in 'include' param (which fixes a bunch of bugs with it) #125

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 5 additions & 4 deletions lib/jsonapi/serializable/resource.rb
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,7 @@ def as_jsonapi(fields: nil, include: [])
attrs = requested_attributes(fields).each_with_object({}) do |(k, v), h|
h[k] = instance_eval(&v)
end
rels = requested_relationships(fields)
.each_with_object({}) do |(k, v), h|
rels = requested_relationships(include).each_with_object({}) do |(k, v), h|
h[k] = v.as_jsonapi(include.include?(k))
end
links = link_blocks.each_with_object({}) do |(k, v), h|
Expand Down Expand Up @@ -92,8 +91,10 @@ def requested_attributes(fields)
end

# @api private
def requested_relationships(fields)
@_relationships.select { |k, _| fields.nil? || fields.include?(k) }
def requested_relationships(includes)
@_relationships.select do |k, v|
v.instance_variable_get('@_include_linkage') || includes.include?(k)
end
end

# @api private
Expand Down
2 changes: 1 addition & 1 deletion spec/renderer/relationship_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,6 @@
end
end
expect_any_instance_of(JSONAPI::Serializable::Relationship).to receive(:included?)
subject.render(user, class: { User: klass, Post: SerializablePost })
subject.render(user, include: [:posts], class: { User: klass, Post: SerializablePost })
end
end
89 changes: 1 addition & 88 deletions spec/resource/as_jsonapi_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,6 @@
attributes: {
name: 'Lucas',
address: '22 Ruby drive'
},
relationships: {
posts: {
meta: { included: false }
}
}
}

Expand All @@ -34,12 +29,7 @@
actual = resource.as_jsonapi(fields: [:posts])
expected = {
type: :users,
id: 'foo',
relationships: {
posts: {
meta: { included: false }
}
}
id: 'foo'
}

expect(actual).to eq(expected)
Expand Down Expand Up @@ -74,83 +64,6 @@
expect(actual).to eq(expected)
end

it 'omits linkage data for non-included relationships with links' do
klass = Class.new(JSONAPI::Serializable::Resource) do
type 'users'
attribute :name
relationship :posts do
link :self do
"http://api.example.com/users/#{@object.id}/relationships/posts"
end
end
end

resource = klass.new(object: user)
actual = resource.as_jsonapi
expected = {
type: :users,
id: 'foo',
attributes: { name: 'Lucas' },
relationships: {
posts: {
links: {
self: 'http://api.example.com/users/foo/relationships/posts'
}
}
}
}

expect(actual).to eq(expected)
end

it 'omits linkage data for non-included relationships with meta' do
klass = Class.new(JSONAPI::Serializable::Resource) do
type 'users'
attribute :name
relationship :posts do
meta foo: 'bar'
end
end

resource = klass.new(object: user)
actual = resource.as_jsonapi
expected = {
type: :users,
id: 'foo',
attributes: { name: 'Lucas' },
relationships: {
posts: {
meta: { foo: 'bar' }
}
}
}

expect(actual).to eq(expected)
end

it 'omits linkage data for non-included relationships no links nor meta' do
klass = Class.new(JSONAPI::Serializable::Resource) do
type 'users'
attribute :name
relationship :posts
end

resource = klass.new(object: user)
actual = resource.as_jsonapi
expected = {
type: :users,
id: 'foo',
attributes: { name: 'Lucas' },
relationships: {
posts: {
meta: { included: false }
}
}
}

expect(actual).to eq(expected)
end

it 'explicitly sets linkage data' do
klass = Class.new(JSONAPI::Serializable::Resource) do
type 'users'
Expand Down
17 changes: 1 addition & 16 deletions spec/resource/key_format_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -34,22 +34,7 @@
expected = {
type: :foo,
id: 'bar',
attributes: { Name: nil, Address: nil },
relationships: {
Posts: {
meta: { included: false }
},
Author: {
meta: { included: false }
},
Comments: {
meta: { included: false }
},
Review: {
meta: { included: false }
}
}

attributes: { Name: nil, Address: nil }
}
it { is_expected.to eq(expected) }

Expand Down
17 changes: 0 additions & 17 deletions spec/resource/linkage_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -43,21 +43,4 @@

expect(actual).to eq(expected)
end

it 'does not include overriden linkage unless included' do
klass = Class.new(JSONAPI::Serializable::Resource) do
type 'users'
relationship :posts, class: SerializablePost do
linkage do
[{ type: :posts, id: '5' }]
end
end
end

resource = klass.new(object: user, _class: inferrer)
actual = resource.as_jsonapi[:relationships][:posts]
expected = { meta: { included: false } }

expect(actual).to eq(expected)
end
end