CODEWITHSUNDEEP
ruby-on-railsjson
Chris Butler
Chris Butler

Reputation: 743

Rails: generating URLs for actions in JSON response

In a view I am generating an HTML canvas of figures based on model data in an app. In the view I am preloading JSON model data in the page like this (to avoid an initial request back):

<script type="text/javascript" charset="utf-8"> 
  <% ActiveRecord::Base.include_root_in_json = false -%>
  var objects = <%= @objects.to_json(:include => :other_objects) %>;
  ...

Based on mouse (or touch) interaction I want to redirect to other parts of my app that are controller specific (such as view, edit, delete, etc.).

Rather than hard code the URLs in my JavaScript I want to generate them from Rails (which means it always adapts the latest routes).

It seems like I have one of three options:

  1. Add an empty attr to the model that the controller fills in with the appropriate URL (we don't want to use routes in the model) before the JSON is generated
  2. Generate custom JSON where I add the different URLs manually
  3. Generate the URL as a template from Rails and replace the IDs in JavaScript as appropriate

I am starting to lean towards #1 for ease of implementation and maintainability.

Are there any other options that I am missing? Is #1 not the best?

Thanks!

Chris

Upvotes: 2

Views: 1268

Answers (1)

Andy Lindeman
Andy Lindeman

Reputation: 12165

I wrote a bit about this on my blog: Rails Dilemma: HATEOAS in XML/JSON Responses.

I came to similar conclusions. There's no incredibly clean way to do it as far as I know, because by default the model is responsible for creating a JSON representation of itself, but generating URLs is strictly a controller/view responsibility.

Feel free to look over my thoughts/conclusions and add comments here or there.

Upvotes: 3

Related Questions