85b41c45d4
If you include a default empty `data` option in your JSON API response, many frontend frameworks will ignore your `related` link that could be used to load relationship records, and will instead treat the relationship as empty. This adds a `lazy_load_data` option which will: * stop the serializer attempting to load the data and; * exclude the `data` key from the final response This allows you to lazy load a JSON API relationship.
72 lines
2.3 KiB
Ruby
72 lines
2.3 KiB
Ruby
require 'spec_helper'
|
|
|
|
describe FastJsonapi::ObjectSerializer do
|
|
include_context 'movie class'
|
|
|
|
context "params option" do
|
|
let(:hash) { serializer.serializable_hash }
|
|
|
|
context "generating links for a serializer relationship" do
|
|
let(:params) { { } }
|
|
let(:options_with_params) { { params: params } }
|
|
let(:relationship_url) { "http://movies.com/#{movie.id}/relationships/actors" }
|
|
let(:related_url) { "http://movies.com/movies/#{movie.name.parameterize}/actors/" }
|
|
|
|
before(:context) do
|
|
class MovieSerializer
|
|
has_many :actors, lazy_load_data: false, links: {
|
|
self: :actors_relationship_url,
|
|
related: -> (object, params = {}) {
|
|
"#{params.has_key?(:secure) ? "https" : "http"}://movies.com/movies/#{object.name.parameterize}/actors/"
|
|
}
|
|
}
|
|
end
|
|
end
|
|
|
|
context "with a single record" do
|
|
let(:serializer) { MovieSerializer.new(movie, options_with_params) }
|
|
let(:links) { hash[:data][:relationships][:actors][:links] }
|
|
|
|
it "handles relationship links that call a method" do
|
|
expect(links).to be_present
|
|
expect(links[:self]).to eq(relationship_url)
|
|
end
|
|
|
|
it "handles relationship links that call a proc" do
|
|
expect(links).to be_present
|
|
expect(links[:related]).to eq(related_url)
|
|
end
|
|
|
|
context "with serializer params" do
|
|
let(:params) { { secure: true } }
|
|
let(:secure_related_url) { related_url.gsub("http", "https") }
|
|
|
|
it "passes the params to the link serializer correctly" do
|
|
expect(links).to be_present
|
|
expect(links[:related]).to eq(secure_related_url)
|
|
end
|
|
end
|
|
end
|
|
|
|
end
|
|
|
|
context "lazy loading relationship data" do
|
|
before(:context) do
|
|
class LazyLoadingMovieSerializer < MovieSerializer
|
|
has_many :actors, lazy_load_data: true, links: {
|
|
related: :actors_relationship_url
|
|
}
|
|
end
|
|
end
|
|
|
|
let(:serializer) { LazyLoadingMovieSerializer.new(movie) }
|
|
let(:actor_hash) { hash[:data][:relationships][:actors] }
|
|
|
|
it "does not include the :data key" do
|
|
expect(actor_hash).to be_present
|
|
expect(actor_hash).not_to have_key(:data)
|
|
end
|
|
end
|
|
end
|
|
end
|