Bad propagation of format with partial! when using render

[rails]

Bad propagation of format with partial! when using render

[ryanb]

This has resurfaced for me in Rails 6. Passing the formats: [:json] option is necessary otherwise I get the missing template error.

json.posts list.posts.order('created_at DESC'), partial: 'jbuilders/post.json.builder', as: :post

Including the extension resolves the missing template error but has a couple unwanted side effects:

• Relative locales do not lookup the template path correctly (it includes the extension).
• The fragment cache key includes the json.jbuilder extension. If you render the partial a different way elsewhere it will generate two caches since they have a different key.

Specifying the formats option resolves these two issues for me.

[rgarver]

I was just noticing that too. I was worried that rails/rails#5308 had resurfaced, but (without rigorous testing yet) it seems to be jbuilder specific. <----WRONG

Scratch that. Redid my testing and I'm still seeing the problem on master also.

[rgarver]

The latest master fixes this for me.

[mutewinter]

I'm also getting this error, even when using the latest master. Switching the partial to .json fixes the problem, but causes deprecation warning.

[Sephi-Chan]

Any news? Is there something I can do to help fixing it?

JBuilder is a great way to seed Javascript objects: it's very useful for client side apps.
If you depreciate it today, it means that you will break it. If this bug remains, our use case will be broken. :(

[shobee]

Today we faced the same problem but previously everything was fine. Since we have updated rails to 3.2.6 and some other gems this issue occurs.

[Sephi-Chan]

@shobee I ended up writing this very simple helper in my ApplicationHelper:

def json_partial!(json, template, locals)
  json.partial!(partial: template, formats: [:json], handlers: [:jbuilder], locals: locals)
end

So now, instead of writing:

json.partial!('vehicles/vehicle_part_purchases.json.jbuilder', vehicle: vehicle)

I write:

json_partial!(json, 'vehicles/vehicle_urls', vehicle: vehicle)

[mutewinter]

@Sephi-Chan I'm trying your helper idea, but I'm getting an error with the json object not being declared in my view context. Did you do anything special to get jbuilder's json object into the view scope?

[Sephi-Chan]

This jsonobject is available in any my_view.json.jbuilder. How do you use it?

For instance, in versions/index.json.jbuilder:

json.array! @versions do |json, version|
  json_partial!(json, 'versions/version', version: version)
end

And when I use it to seed JSON in my view, I have brands/seeds/brand.js.coffee:

json_partial!(json, '/brands/brand', brand: brand)

Then in the Haml view data_sheets/brands.html.haml:

= seed_data('type', 'vehicle_types/seeds/type', type: @type)

With the following code for seed_data defined in ApplicationHelper:

def seed_data(property, template_name, locals, options = {})
  options.reverse_merge!(prefix: 'window.Seeds')

  file = Rails.root.join('app', 'views', template_name)
  json = render(file: file, formats: [:json], handlers: [:jbuilder], locals: locals)
  key  = "#{options[:prefix]}.#{property}"
  code = "#{key} = #{json};\n"

  javascript_tag { raw(code) }
end

[mutewinter]

Ah, I was trying to use the helper in my haml view, not in the jbuilder files themselves. I am able to get the json_partial! helper to be called, but it's returning nothing when called inside my jbuilder files.

Here's an example

projects/show.json.jbuilder

json_partial!(json, "projects/show", project: @project)

It is my intent for this to include the contents of the projects/_show.json.jbuilder partial. I have this in a partial since I need to return the same thing for the create and update actions in my controller.

The partial does work if I change my code to

json.test json_partial!(json, "projects/show", project: @project)

This isn't ideal, however, since I don't want a root tag for this json output.

[bwillis]

This has been fixed in this commit: e2a6616 and is available in gem version 0.4.3.

This allows you to supply a hash to override settings like formats, handlers, etc., but make sure you explicitly set the partial name with :partial and any locals:

json.test json_partial! partial: "projects/show", formats: :json, locals: { project: @project }

[vedmant]

I have the same issue:

This doesn't work:
json.posts list.posts.order('created_at DESC'), partial: 'jbuilders/post', as: :post

And this works:
json.posts list.posts.order('created_at DESC'), partial: 'jbuilders/post.json.builder', as: :post