Rails 4: Passing a variable from controller to javascript - javascript

I'm new to Rails and have been confused by this problem for a while.
I'm looking to create a translation app. When a user clicks a link containing a word, I want the rails controller to get the translation through an external API call, save the word and translation, and then display the translation, all without refreshing the page.
The particular issue I have is getting some string (which will be the translation) to be passed from the controller to a js file, where it can then update the HTML to display the translation.
In the controller (texts_controller.rb):
def createword
#word = Word.new(word_params)
#word.save
#translation = "Some string"
respond_to do |format|
format.js
end
end
In the javascript (createword.js.erb)
console.log("done");
$(".message").html(<%= #translation %>);
When I delete the second line containing #translation, the javascript works just fine and logs "done" to the console. However, when I do include that line, none of it works.
How can I get this variable to the js, or if that is not possible, what is the best way to get it to the view?

I didn't try this, but adding some quotes will probably do what you want:
$(".message").text("<%= #translation %>");

Related

Rails 5.2. Rendering a js.erb partial from a helper method

I have a model called Question, and it has action create;
My goal is to display a flash message instantly, using a helper method (show_alert for example) when the instance is not valid.
question_controller.rb
def create
question = Question.new(question_params)
if question.save then
redirect_to show_question_path(question.id)
else
show_alert(:warning, question.errors)
end
end
application_controller.rb
helper_method :show_alert
def show_alert(type, message)
#type = type; #msg = message
respond_to do |format|
format.js { render :template => 'alert.js.erb'}
end
end
alert.js.erb
var div = $('<div></div>').addClass(`alert alert-${#type}`)
$('<ul></ul>').append( $('<li></li>').html(#msg)
div.append(ul)
$('#alerts').html(div)
But instead of displaying the flash, I get only the partial's code on the white screen.
see the screenshot
Since I've used respond_to I got another error: ActionController::UnknownFormat
I need the snippet of code in alert.js.erb to be executed, in order to render the flash, I think the trick is somewhere in the render function, but two hours of googling were just a waste of time.
Please help! Thank you in advance
ActionController::UnknownFormat error is showing up because the browser is sending HTML request to Rails server, but the respond_to block has only specified what to do in case of a javascript request from web server.
You will need to add a little bit of Ajax to achieve what you want. See this tutorial on Ajax. https://www.tutorialspoint.com/ruby-on-rails/rails-and-ajax.htm
Ajax will send a js request to browser in the background (i.e the browser will not refresh or show any signs of loading). This js request will be sent to Rails server and it will return the .js.erb file containing the script back to the browser. Now since this script was returned as a response to Ajax request by browser, the browser will already know that it is javascript that needs to be executed.
If you do not wish to implement Ajax, you have the alternate of doing something like this in your create controller:-
def create
question = Question.new(question_params)
if question.save then
redirect_to show_question_path(question.id)
else
redirect_to new_question_path(error: question.errors) #new_question_path is the action that displays the question form to the user
end
end
and then you can initialize an error variable in the action that displays the question form. e.g.
def new
#error=params[:error]
#rest of the code...
end
And then in somewhere in your new.html.erb (or whatever the html.erb file name is)
<script>
<% if #error %>
var div = $('<div></div>').addClass(`alert alert-<%= #type %>`)
$('<ul></ul>').append( $('<li></li>').html(<%= #msg %>)
div.append(ul)
$('#alerts').html(div)
<% end %>
// you might need to tweak the variable names in controller or the above code
</script>
(This code above may not be perfect. its just to give u an idea)
However this approach will not be as quick and beautiful as ajax because when the user will submit their question, the entire page will load again to display the error warning.
By default, all output from helpers is escaped. To show the HTMl as-is, you need to use the html_safe method (https://apidock.com/rails/v4.2.1/String/html_safe). See Using helpers in a view escapes the html?
I cannot be sure this without seeing your alert.js.erb but it could be that you need to use escape_javascript in your alert.js.erb
Something like (and I haven't tested this out) in your alert.js.erb
$('<%= escape_javascript("#{type} - #{msg}") %>').appendTo("#alert")
You can read more about it on Rails Guides - Working With Javascript in Rails
Hope this helps!

Basic API in Rails

Let's assume I have a Users controller with a returnjson action. Say I want to create an API so when the client calls on that method, it would return the user's data to the client. For example:
https://www.example.com/returnjson?username&password
A get request would be made by JavaScript with that URL and than the rails would than return the user info in a JSON format. How would I got about doing this?
Thanks in advance!
Oh i see, you only want to return the attributes requested in the parameters. Sorry.
First of all, i would just us the show action for this rather than making a new action. The purpose of show semantically is to return data for a single record, so it's the right action for this job.
Your parameters for the request aren't well structured - i would structure them like
https://www.example.com/users/123?required[]=username&required[]=password
which would give you
params = {:required => ["username", "password"]}
I would do it like so:
def show
#user = User.find_by_id(params[:id])
respond_to do |format|
format.html #default to standard 'render the show template'
format.js #default to standard 'render .js file' or whatever
format.json do
#filter out the ones we want
if params[:required]
hash = #user.attributes.slice(params[:required])
else
hash = #user.attributes
end
#this will automatically call `.to_json` on the thing we pass to it (`hash` in this case)
render json: hash
end
end
end
You can add extra security things in here, for example to limit the fields which you make accessable via the api.

Jquery AJAX call not finding Rails route

I'm working on a project where I need to be able to mark certain objects for review or deletion. I'm using checkboxes, then using JavaScript to harvest the data from the checkboxes. I'm trying to use AJAX to send that data back to the Rails Controller but I keep getting a 404 error, and I'm not sure what I'm doing wrong.
This is the AJAX call (review_list and purge_list are both defined, I've checked):
function callHandleSelected() {
...
$.post('itemresults/handle_selected', { review: review_list, purge: purge_list },
function(data) {
alert(data);
});
}
And this is the route I wrote to match it:
post 'itemresults/handle_selected', to: 'processed_item#handle_selected'
I've tried adding as: :ajax into the route to see if that makes a difference without any luck.
The HTML element that calls the ajax function looks like so:
<button type="button" class="btn btn-normal" onclick="callHandleSelected()">Mark Selected as Reviewed and/or for Purge</button>
There is also a matching handle_selected method in my Ruby Controller. Every time I try to use the AJAX method I get the following error:
POST http://localhost:3000/itemresults/handle_selected 404 (Not Found) jquery.js?body=1:9667
jQuery.ajaxTransport.send jquery.js?body=1:9667
jQuery.extend.ajax jquery.js?body=1:9212
jQuery.each.jQuery.(anonymous function) jquery.js?body=1:9358
callHandleSelected processed_item.js?body=1:37
onclick
In case you need it, here is the controller method:
def handle_selected
review_list = params[:review]
purge_list = params[:purge]
review_list.each do |item|
item.split("_")
proc_item = ProcessedItem.find(item[1])
proc_item.reviewed = true;
proc_item.save!
end
purge_list.each do |item|
item.split("_")
proc_item = ProcessedItem.find(item[1])
proc_item.purge = true;
proc_item.save!
end
redirect_to processed_items_path()
#add alert
end
I think the problem is just that you need a leading slash on your request url:
$.post('itemresults/handle_selected' ...
should be
$.post('/itemresults/handle_selected'
Without the leading slash, it will add the url onto the end of the current page url.
EDIT: you should put a leading slash on the path in your routes.rb file as well. I think that rails "forgives" you for not doing this but i'm not sure: either way you should do it properly, ie with the leading slash.
A combination of the comments on my initial post answered the question. I took out the redirect_to line and replaced it with this:
respond_to do |format|
format.js {render inline: "location.reload();" }
end
I was getting the 404 error because I was trying to load objects incorrectly as Baloo pointed out. The new (relevant) code looks like this:
review_list.each do |item|
id = item.split("_")[1]
proc_item = ProcessedItem.find(id)
Thanks all!

Redirect_to another page in rails

In my application I have a set of entities. Now I want to build a search form on my start page that calls the action of controller a. If it finds more than one entitiy it shall show all the products if it finds exactly one product it should redirecto to another controller that loads the detailed information about the entity and shows it. In my first controller I do this by calling
if #entities.length==1
redirect_to show_path(:id=>#entities[0].id)
end
I would expect that now a new site is opened like /show?id=1234 but that does not happen. Instead the controller behind the entity path loads the detailed information of the entity but nothing is shown.
I get the following error:
ActionView::MissingTemplate (Missing template entities/show with {:formats=>[:js, :"*/*"], :handlers=>[:rjs, :rhtml, :rxml, :erb, :builder], :locale=>[:en, :en]} in view paths ..."):
How do I get the right page loaded, simply adding the show.js.erb to the entities folder makes the error disappear but the problem still remains that the show page is not shown.
EDIT:
render :update do |page|
page.redirect_to show_product_path(:id=>#entities[0].id)
end
this works but why? what is the difference?
I would suggest to rederect straight to object. Rails is smart enough to create route for your object.
if #entities.length==1
redirect_to #entities.first
end
I thnink
render :update do |page|
page.redirect_to show_product_path(:id=>#entities[0].id)
end
code is looking for a show action in the same controller, where as
render :update do |page|
page.redirect_to show_product_path(:id=>#entities[0].id)
end
is redirecting to products/show in products controller. I think you dont have a 'show' action in 'entities' controller thats why you are getting
ActionView::MissingTemplate (Missing template entities/show with {:formats=>[:js, :"*/*"], :handlers=>[:rjs, :rhtml, :rxml, :erb, :builder], :locale=>[:en, :en]} in view paths ..."):
With the default rails configuration it works as follows
in your controller
class EntitiesController < ApplicationController
def index
#will display all the products
**#you need to have a index.erb.html file as well**
#products = <Your product getting logic here>
end
def show
#display only one product
#you need to have a show.erb.html
#product = Product.find(params[:id])
end
end
So in you case you should redirect as
show_product_path with an id
and make sure you have show action defined in the controller
HTH
sameera

How does js.erb work

Lately i have run into a few applications that are using js.erb and i am not really sure how to use it ...here is the code below. Can someone help me understand how this works?
in the routes.rb file
map.resources :player_emails
my controller player_emails_controller.rb in the create action
def create
#player_email = PlayerEmail.create(params[:player_email])
if #player_email.save
#response_txt = "The player has been emailed."
PlayerEmailsMailer.deliver_pattern_email(#something, #player_email, request.host_with_port)
#error = false
else
#error = true
#response_txt = "Please make sure you entered your name and a valid email address."
end
end
then i have the file player_emails/create.js.erb
$('#player_email_ind').hide();
$('#player_email_submit').show();
$('#player_response_msg').html("<%= escape_javascript #response_txt %>").fadeIn();
<% unless #error %>
$('#player_email_form')[0].reset();
<% end %>
i know what the jquery is going but i dont know how this is doing the ajax call. Does it just automatically do an ajax call when there is a js.erb...can someone explain the way this works and why i dont need a respond_to in the controller action telling it this is format.js
If a js (ajax) request is made it will respond by rendering the js.erb file and viceversa.
This is the default behaviour that is being performed:
respond_to do |format|
format.js{
render :template => 'create.js.erb'
}
format.html{
render :template => 'create.html.erb'
}
end
When the form is submitted, it does a POST to /player_emails. The resource declaration in routes.rb ensures the request is handled by PlayerEmailsController#create.
The controller is responsible for handling each format it receives. In the case of an AJAX call, the format is 'js', and is set by explicitly adding the format string to the end of the URL (/player_emails.js) or (more likely) by deducing the format from the request header.
In your case, the create action does not expect anything other than AJAX, so it takes a shortcut and omits the respond_to and format blocks. The controller has already figured out that the format is 'js', so when create is complete it takes the default action of rendering the appropriate template for the format (create.js.erb).
Does your form submit button have a :remote => true on it? If so, there might be some JavaScript in rails.js or application.js that automatically submits via AJAX. Bottom line is, there has to be some JavaScript somewhere that is making an AJAX call and asking for a js or JSON response, otherwise it would be an html request.
As for why you don't need a respond_to block, I'm not entirely sure. Maybe since the call is always being made by AJAX and there is a js.erb template available, it just does its thing without complaining. Is there an html.erb template at all? If not, try doing a regular form submit and see if it complains.

Categories