Add ability to use nested only parameter
- The only string works much the same as before with its comma separation -- Nested includes are indicated with square brackets "[ ]" -- The nested include is the value immediately preceding the square brackets -- The only string is the comma separated string inside those brackets - Default includes are split between format types when necessary -- This prevents unnecessary includes from being added on page load - Available includes are those items which are allowed to be accessible to the user -- Some aren't because they are sensitive, such as the creator of a flag -- Some aren't because the number of associated items is too large - The amount of times the same model can be included to prevent recursions -- One exception is the root model may include the same model once --- e.g. the user model can include the inviter which is also the user model -- Another exception is if the include is a has_many association --- e.g. artist urls can include the artist, and then artist urls again
This commit is contained in:
@@ -3,10 +3,10 @@ class ArtistUrlsController < ApplicationController
|
||||
before_action :member_only, except: [:index]
|
||||
|
||||
def index
|
||||
@artist_urls = ArtistUrl.includes(:artist).paginated_search(params)
|
||||
@artist_urls = ArtistUrl.paginated_search(params).includes(model_includes(params))
|
||||
respond_with(@artist_urls) do |format|
|
||||
format.json { render json: @artist_urls.to_json(include: "artist") }
|
||||
format.xml { render xml: @artist_urls.to_xml(include: "artist", root: "artist-urls") }
|
||||
format.json { render json: @artist_urls.to_json(format_params) }
|
||||
format.xml { render xml: @artist_urls.to_xml(format_params) }
|
||||
end
|
||||
end
|
||||
|
||||
@@ -18,6 +18,27 @@ class ArtistUrlsController < ApplicationController
|
||||
|
||||
private
|
||||
|
||||
def default_includes(params)
|
||||
if ["json", "xml"].include?(params[:format])
|
||||
[{artist: [:urls]}]
|
||||
else
|
||||
[:artist]
|
||||
end
|
||||
end
|
||||
|
||||
def format_params
|
||||
param_hash = {}
|
||||
if params[:only]
|
||||
param_hash[:only] = params[:only]
|
||||
else
|
||||
param_hash[:include] = [:artist]
|
||||
end
|
||||
if request.format.symbol == :xml
|
||||
param_hash[:root] = "artist-urls"
|
||||
end
|
||||
param_hash
|
||||
end
|
||||
|
||||
def artist_url_params
|
||||
permitted_params = %i[is_active]
|
||||
|
||||
|
||||
Reference in New Issue
Block a user