1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
|
h2. Action View Overview
In this guide you will learn:
* What Action View is, and how to use it with Rails
* How to use Action View outside of Rails
* How best to use templates, partials, and layouts
* What helpers are provided by Action View, and how to make your own
* How to use localized views
endprologue.
h3. What is Action View?
Action View and Action Controller are the two major components of Action Pack. In Rails, web requests are handled by Action Pack, which splits the work into a controller part (performing the logic) and a view part (rendering a template). Typically, Action Controller will be concerned with communicating with the database and performing CRUD actions where necessary. Action View is then responsible for compiling the response.
Action View templates are written using embedded Ruby in tags mingled with HTML. To avoid cluttering the templates with boilerplate code, a number of helper classes provide common behavior for forms, dates, and strings. It's also easy to add new helpers to your application as it evolves.
Note: Some features of Action View are tied to Active Record, but that doesn't mean that Action View depends on Active Record. Action View is an independent package that can be used with any sort of backend.
h3. Using Action View with Rails
For each controller there is an associated directory in the <tt>app/views</tt> directory which holds the template files that make up the views associated with that controller. These files are used to display the view that results from each controller action.
Let's take a look at what Rails does by default when creating a new resource using the scaffold generator:
<shell>
$ rails generate scaffold post
[...]
invoke scaffold_controller
create app/controllers/posts_controller.rb
invoke erb
create app/views/posts
create app/views/posts/index.html.erb
create app/views/posts/edit.html.erb
create app/views/posts/show.html.erb
create app/views/posts/new.html.erb
create app/views/posts/_form.html.erb
[...]
</shell>
There is a naming convention for views in Rails. Typically, the views share their name with the associated controller action, as you can see above.
For example, the index controller action of the <tt>posts_controller.rb</tt> will use the <tt>index.html.erb</tt> view file in the <tt>app/views/posts</tt> directory.
The complete HTML returned to the client is composed of a combination of this ERB file, a layout template that wraps it, and all the partials that the view may reference. Later on this guide you can find a more detailed documentation of each one of this three components.
h3. Using Action View outside of Rails
Action View works well with Action Record, but it can also be used with other Ruby tools. We can demonstrate this by creating a small "Rack":http://rack.rubyforge.org/ application that includes Action View functionality. This may be useful, for example, if you'd like access to Action View's helpers in a Rack application.
Let's start by ensuring that you have the Action Pack and Rack gems installed:
<shell>
$ gem install actionpack
$ gem install rack
</shell>
Now we'll create a simple "Hello World" application that uses the +titleize+ method provided by Active Support.
*hello_world.rb:*
<ruby>
require 'rubygems'
require 'active_support/core_ext/string/inflections'
require 'rack'
def hello_world(env)
[200, {"Content-Type" => "text/html"}, "hello world".titleize]
end
Rack::Handler::Mongrel.run method(:hello_world), :Port => 4567
</ruby>
We can see this all come together by starting up the application and then visiting +http://localhost:4567/+
<shell>
$ ruby hello_world.rb
</shell>
TODO needs a screenshot? I have one - not sure where to put it.
Notice how 'hello world' has been converted into 'Hello World' by the +titleize+ helper method.
Action View can also be used with "Sinatra":http://www.sinatrarb.com/ in the same way.
Let's start by ensuring that you have the Action Pack and Sinatra gems installed:
<shell>
$ gem install actionpack
$ gem install sinatra
</shell>
Now we'll create the same "Hello World" application in Sinatra.
*hello_world.rb:*
<ruby>
require 'rubygems'
require 'action_view'
require 'sinatra'
get '/' do
erb 'hello world'.titleize
end
</ruby>
Then, we can run the application:
<shell>
$ ruby hello_world.rb
</shell>
Once the application is running, you can see Sinatra and Action View working together by visiting +http://localhost:4567/+
TODO needs a screenshot? I have one - not sure where to put it.
h3. Templates, Partials and Layouts
As mentioned before, the final HTML output is a composition of three Rails elements: +Templates+, +Partials+ and +Layouts+.
Find below a brief overview of each one of them.
h4. Partials
Partial templates – usually just called "partials" – are another device for breaking the rendering process into more manageable chunks. With a partial, you can move the code for rendering a particular piece of a response to its own file.
h5. Naming Partials
To render a partial as part of a view, you use the +render+ method within the view:
<ruby>
<%= render "menu" %>
</ruby>
This will render a file named +_menu.html.erb+ at that point within the view is being rendered. Note the leading underscore character: partials are named with a leading underscore to distinguish them from regular views, even though they are referred to without the underscore. This holds true even when you're pulling in a partial from another folder:
<ruby>
<%= render "shared/menu" %>
</ruby>
That code will pull in the partial from +app/views/shared/_menu.html.erb+.
h5. Using Partials to Simplify Views
One way to use partials is to treat them as the equivalent of subroutines: as a way to move details out of a view so that you can grasp what's going on more easily. For example, you might have a view that looked like this:
<erb>
<%= render "shared/ad_banner" %>
<h1>Products</h1>
<p>Here are a few of our fine products:</p>
<% @products.each do |product| %>
<%= render :partial => "product", :locals => { :product => product } %>
<% end %>
<%= render "shared/footer" %>
</erb>
Here, the +_ad_banner.html.erb+ and +_footer.html.erb+ partials could contain content that is shared among many pages in your application. You don't need to see the details of these sections when you're concentrating on a particular page.
h5. The :as and :object options
By default <tt>ActionView::Partials::PartialRenderer</tt> has its object in a local variable with the same name as the template. So, given
<erb>
<%= render :partial => "product" %>
</erb>
within product we'll get <tt>@product</tt> in the local variable +product+, as if we had written:
<erb>
<%= render :partial => "product", :locals => { :product => @product } %>
</erb>
With the <tt>:as</tt> option we can specify a different name for said local variable. For example, if we wanted it to be +item+ instead of product+ we'd do:
<erb>
<%= render :partial => "product", :as => 'item' %>
</erb>
The <tt>:object</tt> option can be used to directly specify which object is rendered into the partial; useful when the template's object is elsewhere, in a different ivar or in a local variable for instance.
For example, instead of:
<erb>
<%= render :partial => "product", :locals => { :product => @item } %>
</erb>
you'd do:
<erb>
<%= render :partial => "product", :object => @item %>
</erb>
The <tt>:object</tt> and <tt>:as</tt> options can be used together.
h5. Rendering Collections
The example of partial use describes a familiar pattern where a template needs to iterate over an array and render a sub template for each of the elements. This pattern has been implemented as a single method that accepts an array and renders a partial by the same name as the elements contained within.
So the three-lined example for rendering all the products can be rewritten with a single line:
<erb>
<%= render :partial => "product", :collection => @products %>
</erb>
When a partial is called with a pluralized collection, then the individual instances of the partial have access to the member of the collection being rendered via a variable named after the partial. In this case, the partial is +_product+ , and within the +_product+ partial, you can refer to +product+ to get the instance that is being rendered.
You can use a shorthand syntax for rendering collections. Assuming @products is a collection of +Product+ instances, you can simply write the following to produce the same result:
<erb>
<%= render @products %>
</erb>
Rails determines the name of the partial to use by looking at the model name in the collection. In fact, you can even create a heterogeneous collection and render it this way, and Rails will choose the proper partial for each member of the collection.
h5. Spacer Templates
You can also specify a second partial to be rendered between instances of the main partial by using the +:spacer_template+ option:
<erb>
<%= render @products, :spacer_template => "product_ruler" %>
</erb>
Rails will render the +_product_ruler+ partial (with no data passed in to it) between each pair of +_product+ partials.
h3. Using Templates, Partials and Layouts in "The Rails Way"
TODO...
h3. Partial Layouts
Partials can have their own layouts applied to them. These layouts are different than the ones that are specified globally for the entire action, but they work in a similar fashion.
Let's say we're displaying a post on a page where it should be wrapped in a +div+ for display purposes. First, we'll create a new +Post+:
<ruby>
Post.create(:body => 'Partial Layouts are cool!')
</ruby>
In the +show+ template, we'll render the +post+ partial wrapped in the +box+ layout:
*posts/show.html.erb*
<ruby>
<%= render :partial => 'post', :layout => 'box', :locals => {:post => @post} %>
</ruby>
The +box+ layout simply wraps the +post+ partial in a +div+:
*posts/_box.html.erb*
<ruby>
<div class='box'>
<%= yield %>
</div>
</ruby>
The +post+ partial wraps the post's +body+ in a +div+ with the +id+ of the post using the +div_for+ helper:
*posts/_post.html.erb*
<ruby>
<%= div_for(post) do %>
<p><%= post.body %></p>
<% end %>
</ruby>
This example would output the following:
<html>
<div class='box'>
<div id='post_1'>
<p>Partial Layouts are cool!</p>
</div>
</div>
</html>
Note that the partial layout has access to the local +post+ variable that was passed into the +render+ call. However, unlike application-wide layouts, partial layouts still have the underscore prefix.
You can also render a block of code within a partial layout instead of calling +yield+. For example, if we didn't have the +post+ partial, we could do this instead:
*posts/show.html.erb*
<ruby>
<% render(:layout => 'box', :locals => {:post => @post}) do %>
<%= div_for(post) do %>
<p><%= post.body %></p>
<% end %>
<% end %>
</ruby>
If we're using the same +box+ partial from above, his would produce the same output as the previous example.
h3. View Paths
TODO...
h3. Overview of all the helpers provided by Action View
The following is only a brief overview summary of the helpers available in Action View. It's recommended that you review the API Documentation, which covers all of the helpers in more detail, but this should serve as a good starting point.
h4. ActiveRecordHelper
The Active Record Helper makes it easier to create forms for records kept in instance variables. You may also want to review the "Rails Form helpers guide":form_helpers.html.
h5. error_message_on
Returns a string containing the error message attached to the method on the object if one exists.
<ruby>
error_message_on "post", "title"
</ruby>
h5. error_messages_for
Returns a string with a DIV containing all of the error messages for the objects located as instance variables by the names given.
<ruby>
error_messages_for "post"
</ruby>
h5. form
Returns a form with inputs for all attributes of the specified Active Record object. For example, let's say we have a +@post+ with attributes named +title+ of type +String+ and +body+ of type +Text+. Calling +form+ would produce a form to creating a new post with inputs for those attributes.
<ruby>
form("post")
</ruby>
<html>
<form action='/posts/create' method='post'>
<p>
<label for="post_title">Title</label><br />
<input id="post_title" name="post[title]" size="30" type="text" value="Hello World" />
</p>
<p>
<label for="post_body">Body</label><br />
<textarea cols="40" id="post_body" name="post[body]" rows="20"></textarea>
</p>
<input name="commit" type="submit" value="Create" />
</form>
</html>
Typically, +form_for+ is used instead of +form+ because it doesn't automatically include all of the model's attributes.
h5. input
Returns a default input tag for the type of object returned by the method.
For example, if +@post+ has an attribute +title+ mapped to a +String+ column that holds "Hello World":
<ruby>
input("post", "title") # =>
<input id="post_title" name="post[title]" size="30" type="text" value="Hello World" />
</ruby>
h4. AssetTagHelper
This module provides methods for generating HTML that links views to assets such as images, JavaScript files, stylesheets, and feeds.
By default, Rails links to these assets on the current host in the public folder, but you can direct Rails to link to assets from a dedicated assets server by setting +ActionController::Base.asset_host+ in the application configuration, typically in +config/environments/production.rb+. For example, let's say your asset host is +assets.example.com+:
<ruby>
ActionController::Base.asset_host = "assets.example.com"
image_tag("rails.png") # => <img src="http://assets.example.com/images/rails.png" alt="Rails" />
</ruby>
h5. register_javascript_expansion
Register one or more JavaScript files to be included when symbol is passed to javascript_include_tag. This method is typically intended to be called from plugin initialization to register JavaScript files that the plugin installed in +public/javascripts+.
<ruby>
ActionView::Helpers::AssetTagHelper.register_javascript_expansion :monkey => ["head", "body", "tail"]
javascript_include_tag :monkey # =>
<script type="text/javascript" src="/javascripts/head.js"></script>
<script type="text/javascript" src="/javascripts/body.js"></script>
<script type="text/javascript" src="/javascripts/tail.js"></script>
</ruby>
h5. register_stylesheet_expansion
Register one or more stylesheet files to be included when symbol is passed to +stylesheet_link_tag+. This method is typically intended to be called from plugin initialization to register stylesheet files that the plugin installed in +public/stylesheets+.
<ruby>
ActionView::Helpers::AssetTagHelper.register_stylesheet_expansion :monkey => ["head", "body", "tail"]
stylesheet_link_tag :monkey # =>
<link href="/stylesheets/head.css" media="screen" rel="stylesheet" type="text/css" />
<link href="/stylesheets/body.css" media="screen" rel="stylesheet" type="text/css" />
<link href="/stylesheets/tail.css" media="screen" rel="stylesheet" type="text/css" />
</ruby>
h5. auto_discovery_link_tag
Returns a link tag that browsers and news readers can use to auto-detect an RSS or ATOM feed.
<ruby>
auto_discovery_link_tag(:rss, "http://www.example.com/feed.rss", {:title => "RSS Feed"}) # =>
<link rel="alternate" type="application/rss+xml" title="RSS Feed" href="http://www.example.com/feed" />
</ruby>
h5. image_path
Computes the path to an image asset in the +public/images+ directory. Full paths from the document root will be passed through. Used internally by +image_tag+ to build the image path.
<ruby>
image_path("edit.png") # => /images/edit.png
</ruby>
h5. image_tag
Returns an html image tag for the source. The source can be a full path or a file that exists in your +public/images+ directory.
<ruby>
image_tag("icon.png") # => <img src="/images/icon.png" alt="Icon" />
</ruby>
h5. javascript_include_tag
Returns an html script tag for each of the sources provided. You can pass in the filename (+.js+ extension is optional) of JavaScript files that exist in your +public/javascripts+ directory for inclusion into the current page or you can pass the full path relative to your document root.
<ruby>
javascript_include_tag "common" # =>
<script type="text/javascript" src="/javascripts/common.js"></script>
</ruby>
To include the Prototype and Scriptaculous JavaScript libraries in your application, pass +:defaults+ as the source. When using +:defaults+, if an +application.js+ file exists in your +public/javascripts+ directory, it will be included as well.
<ruby>
javascript_include_tag :defaults
</ruby>
You can also include all JavaScript files in the +public/javascripts+ directory using +:all+ as the source.
<ruby>
javascript_include_tag :all
</ruby>
You can also cache multiple JavaScript files into one file, which requires less HTTP connections to download and can better be compressed by gzip (leading to faster transfers). Caching will only happen if +ActionController::Base.perform_caching+ is set to true (which is the case by default for the Rails production environment, but not for the development environment).
<ruby>
javascript_include_tag :all, :cache => true # =>
<script type="text/javascript" src="/javascripts/all.js"></script>
</ruby>
h5. javascript_path
Computes the path to a JavaScript asset in the +public/javascripts+ directory. If the source filename has no extension, +.js+ will be appended. Full paths from the document root will be passed through. Used internally by +javascript_include_tag+ to build the script path.
<ruby>
javascript_path "common" # => /javascripts/common.js
</ruby>
h5. stylesheet_link_tag
Returns a stylesheet link tag for the sources specified as arguments. If you don't specify an extension, +.css+ will be appended automatically.
<ruby>
stylesheet_link_tag "application" # =>
<link href="/stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" />
</ruby>
You can also include all styles in the stylesheet directory using :all as the source:
<ruby>
stylesheet_link_tag :all
</ruby>
You can also cache multiple stylesheets into one file, which requires less HTTP connections and can better be compressed by gzip (leading to faster transfers). Caching will only happen if ActionController::Base.perform_caching is set to true (which is the case by default for the Rails production environment, but not for the development environment).
<ruby>
stylesheet_link_tag :all, :cache => true
<link href="/stylesheets/all.css" media="screen" rel="stylesheet" type="text/css" />
</ruby>
h5. stylesheet_path
Computes the path to a stylesheet asset in the +public/stylesheets+ directory. If the source filename has no extension, .css will be appended. Full paths from the document root will be passed through. Used internally by stylesheet_link_tag to build the stylesheet path.
<ruby>
stylesheet_path "application" # => /stylesheets/application.css
</ruby>
h4. AtomFeedHelper
h5. atom_feed
This helper makes building an ATOM feed easy. Here's a full usage example:
*config/routes.rb*
<ruby>
resources :posts
</ruby>
*app/controllers/posts_controller.rb*
<ruby>
def index
@posts = Post.all
respond_to do |format|
format.html
format.atom
end
end
</ruby>
*app/views/posts/index.atom.builder*
<ruby>
atom_feed do |feed|
feed.title("Posts Index")
feed.updated((@posts.first.created_at))
for post in @posts
feed.entry(post) do |entry|
entry.title(post.title)
entry.content(post.body, :type => 'html')
entry.author do |author|
author.name(post.author_name)
end
end
end
end
</ruby>
h4. BenchmarkHelper
h5. benchmark
Allows you to measure the execution time of a block in a template and records the result to the log. Wrap this block around expensive operations or possible bottlenecks to get a time reading for the operation.
<ruby>
<% benchmark "Process data files" do %>
<%= expensive_files_operation %>
<% end %>
</ruby>
This would add something like "Process data files (0.34523)" to the log, which you can then use to compare timings when optimizing your code.
h4. CacheHelper
h5. cache
A method for caching fragments of a view rather than an entire action or page. This technique is useful caching pieces like menus, lists of news topics, static HTML fragments, and so on. This method takes a block that contains the content you wish to cache. See +ActionController::Caching::Fragments+ for more information.
<ruby>
<% cache do %>
<%= render "shared/footer" %>
<% end %>
</ruby>
h4. CaptureHelper
h5. capture
The +capture+ method allows you to extract part of a template into a variable. You can then use this variable anywhere in your templates or layout.
<ruby>
<% @greeting = capture do %>
<p>Welcome! The date and time is <%= Time.now %></p>
<% end %>
</ruby>
The captured variable can then be used anywhere else.
<ruby>
<html>
<head>
<title>Welcome!</title>
</head>
<body>
<%= @greeting %>
</body>
</html>
</ruby>
h5. content_for
Calling +content_for+ stores a block of markup in an identifier for later use. You can make subsequent calls to the stored content in other templates or the layout by passing the identifier as an argument to +yield+.
For example, let's say we have a standard application layout, but also a special page that requires certain Javascript that the rest of the site doesn't need. We can use +content_for+ to include this Javascript on our special page without fattening up the rest of the site.
*app/views/layouts/application.html.erb*
<ruby>
<html>
<head>
<title>Welcome!</title>
<%= yield :special_script %>
</head>
<body>
<p>Welcome! The date and time is <%= Time.now %></p>
</body>
</html>
</ruby>
*app/views/posts/special.html.erb*
<ruby>
<p>This is a special page.</p>
<% content_for :special_script do %>
<script type="text/javascript">alert('Hello!')</script>
<% end %>
</ruby>
h4. DateHelper
h5. date_select
Returns a set of select tags (one for year, month, and day) pre-selected for accessing a specified date-based attribute.
<ruby>
date_select("post", "published_on")
</ruby>
h5. datetime_select
Returns a set of select tags (one for year, month, day, hour, and minute) pre-selected for accessing a specified datetime-based attribute.
<ruby>
datetime_select("post", "published_on")
</ruby>
h5. distance_of_time_in_words
Reports the approximate distance in time between two Time or Date objects or integers as seconds. Set +include_seconds+ to true if you want more detailed approximations.
<ruby>
distance_of_time_in_words(Time.now, Time.now + 15.seconds) # => less than a minute
distance_of_time_in_words(Time.now, Time.now + 15.seconds, true) # => less than 20 seconds
</ruby>
h5. select_date
Returns a set of html select-tags (one for year, month, and day) pre-selected with the +date+ provided.
<ruby>
# Generates a date select that defaults to the date provided (six days after today)
select_date(Time.today + 6.days)
# Generates a date select that defaults to today (no specified date)
select_date()
</ruby>
h5. select_datetime
Returns a set of html select-tags (one for year, month, day, hour, and minute) pre-selected with the +datetime+ provided.
<ruby>
# Generates a datetime select that defaults to the datetime provided (four days after today)
select_datetime(Time.now + 4.days)
# Generates a datetime select that defaults to today (no specified datetime)
select_datetime()
</ruby>
h5. select_day
Returns a select tag with options for each of the days 1 through 31 with the current day selected.
<ruby>
# Generates a select field for days that defaults to the day for the date provided
select_day(Time.today + 2.days)
# Generates a select field for days that defaults to the number given
select_day(5)
</ruby>
h5. select_hour
Returns a select tag with options for each of the hours 0 through 23 with the current hour selected.
<ruby>
# Generates a select field for minutes that defaults to the minutes for the time provided
select_minute(Time.now + 6.hours)
</ruby>
h5. select_minute
Returns a select tag with options for each of the minutes 0 through 59 with the current minute selected.
<ruby>
# Generates a select field for minutes that defaults to the minutes for the time provided.
select_minute(Time.now + 6.hours)
</ruby>
h5. select_month
Returns a select tag with options for each of the months January through December with the current month selected.
<ruby>
# Generates a select field for months that defaults to the current month
select_month(Date.today)
</ruby>
h5. select_second
Returns a select tag with options for each of the seconds 0 through 59 with the current second selected.
<ruby>
# Generates a select field for seconds that defaults to the seconds for the time provided
select_second(Time.now + 16.minutes)
</ruby>
h5. select_time
Returns a set of html select-tags (one for hour and minute).
<ruby>
# Generates a time select that defaults to the time provided
select_time(Time.now)
</ruby>
h5. select_year
Returns a select tag with options for each of the five years on each side of the current, which is selected. The five year radius can be changed using the +:start_year+ and +:end_year+ keys in the +options+.
<ruby>
# Generates a select field for five years on either side of +Date.today+ that defaults to the current year
select_year(Date.today)
# Generates a select field from 1900 to 2009 that defaults to the current year
select_year(Date.today, :start_year => 1900, :end_year => 2009)
</ruby>
h5. time_ago_in_words
Like +distance_of_time_in_words+, but where +to_time+ is fixed to +Time.now+.
<ruby>
time_ago_in_words(3.minutes.from_now) # => 3 minutes
</ruby>
h5. time_select
Returns a set of select tags (one for hour, minute and optionally second) pre-selected for accessing a specified time-based attribute. The selects are prepared for multi-parameter assignment to an Active Record object.
<ruby>
# Creates a time select tag that, when POSTed, will be stored in the order variable in the submitted attribute
time_select("order", "submitted")
</ruby>
h4. DebugHelper
Returns a +pre+ tag that has object dumped by YAML. This creates a very readable way to inspect an object.
<ruby>
my_hash = {'first' => 1, 'second' => 'two', 'third' => [1,2,3]}
debug(my_hash)
</ruby>
<html>
<pre class='debug_dump'>---
first: 1
second: two
third:
- 1
- 2
- 3
</pre>
</html>
h4. FormHelper
Form helpers are designed to make working with models much easier compared to using just standard HTML elements by providing a set of methods for creating forms based on your models. This helper generates the HTML for forms, providing a method for each sort of input (e.g., text, password, select, and so on). When the form is submitted (i.e., when the user hits the submit button or form.submit is called via JavaScript), the form inputs will be bundled into the params object and passed back to the controller.
There are two types of form helpers: those that specifically work with model attributes and those that don't. This helper deals with those that work with model attributes; to see an example of form helpers that don‘t work with model attributes, check the ActionView::Helpers::FormTagHelper documentation.
The core method of this helper, form_for, gives you the ability to create a form for a model instance; for example, let's say that you have a model Person and want to create a new instance of it:
<ruby>
# Note: a @person variable will have been created in the controller (e.g. @person = Person.new)
<%= form_for @person, :url => { :action => "create" } do |f| %>
<%= f.text_field :first_name %>
<%= f.text_field :last_name %>
<%= submit_tag 'Create' %>
<% end %>
</ruby>
The HTML generated for this would be:
<html>
<form action="/persons/create" method="post">
<input id="person_first_name" name="person[first_name]" size="30" type="text" />
<input id="person_last_name" name="person[last_name]" size="30" type="text" />
<input name="commit" type="submit" value="Create" />
</form>
</html>
The params object created when this form is submitted would look like:
<ruby>
{"action"=>"create", "controller"=>"persons", "person"=>{"first_name"=>"William", "last_name"=>"Smith"}}
</ruby>
The params hash has a nested person value, which can therefore be accessed with params[:person] in the controller.
h5. check_box
Returns a checkbox tag tailored for accessing a specified attribute.
<ruby>
# Let's say that @post.validated? is 1:
check_box("post", "validated")
# => <input type="checkbox" id="post_validated" name="post[validated]" value="1" />
# <input name="post[validated]" type="hidden" value="0" />
</ruby>
h5. fields_for
Creates a scope around a specific model object like form_for, but doesn‘t create the form tags themselves. This makes fields_for suitable for specifying additional model objects in the same form:
<ruby>
<%= form_for @person, :url => { :action => "update" } do |person_form| %>
First name: <%= person_form.text_field :first_name %>
Last name : <%= person_form.text_field :last_name %>
<%= fields_for @person.permission do |permission_fields| %>
Admin? : <%= permission_fields.check_box :admin %>
<% end %>
<% end %>
</ruby>
h5. file_field
Returns an file upload input tag tailored for accessing a specified attribute.
<ruby>
file_field(:user, :avatar)
# => <input type="file" id="user_avatar" name="user[avatar]" />
</ruby>
h5. form_for
Creates a form and a scope around a specific model object that is used as a base for questioning about values for the fields.
<ruby>
<%= form_for @post do |f| %>
<%= f.label :title, 'Title' %>:
<%= f.text_field :title %><br />
<%= f.label :body, 'Body' %>:
<%= f.text_area :body %><br />
<% end %>
</ruby>
h5. hidden_field
Returns a hidden input tag tailored for accessing a specified attribute.
<ruby>
hidden_field(:user, :token)
# => <input type="hidden" id="user_token" name="user[token]" value="#{@user.token}" />
</ruby>
h5. label
Returns a label tag tailored for labelling an input field for a specified attribute.
<ruby>
label(:post, :title)
# => <label for="post_title">Title</label>
</ruby>
h5. password_field
Returns an input tag of the "password" type tailored for accessing a specified attribute.
<ruby>
password_field(:login, :pass)
# => <input type="text" id="login_pass" name="login[pass]" value="#{@login.pass}" />
</ruby>
h5. radio_button
Returns a radio button tag for accessing a specified attribute.
<ruby>
# Let's say that @post.category returns "rails":
radio_button("post", "category", "rails")
radio_button("post", "category", "java")
# => <input type="radio" id="post_category_rails" name="post[category]" value="rails" checked="checked" />
# <input type="radio" id="post_category_java" name="post[category]" value="java" />
</ruby>
h5. text_area
Returns a textarea opening and closing tag set tailored for accessing a specified attribute.
<ruby>
text_area(:comment, :text, :size => "20x30")
# => <textarea cols="20" rows="30" id="comment_text" name="comment[text]">
# #{@comment.text}
# </textarea>
</ruby>
h5. text_field
Returns an input tag of the "text" type tailored for accessing a specified attribute.
<ruby>
text_field(:post, :title)
# => <input type="text" id="post_title" name="post[title]" value="#{@post.title}" />
</ruby>
h4. FormOptionsHelper
Provides a number of methods for turning different kinds of containers into a set of option tags.
h5. collection_select
Returns +select+ and +option+ tags for the collection of existing return values of +method+ for +object+'s class.
Example object structure for use with this method:
<ruby>
class Post < ActiveRecord::Base
belongs_to :author
end
class Author < ActiveRecord::Base
has_many :posts
def name_with_initial
"#{first_name.first}. #{last_name}"
end
end
</ruby>
Sample usage (selecting the associated Author for an instance of Post, +@post+):
<ruby>
collection_select(:post, :author_id, Author.all, :id, :name_with_initial, {:prompt => true})
</ruby>
If @post.author_id is already 1, this would return:
<html>
<select name="post[author_id]">
<option value="">Please select</option>
<option value="1" selected="selected">D. Heinemeier Hansson</option>
<option value="2">D. Thomas</option>
<option value="3">M. Clark</option>
</select>
</html>
h5. country_options_for_select
Returns a string of option tags for pretty much any country in the world.
h5. country_select
Return select and option tags for the given object and method, using country_options_for_select to generate the list of option tags.
h5. option_groups_from_collection_for_select
Returns a string of +option+ tags, like +options_from_collection_for_select+, but groups them by +optgroup+ tags based on the object relationships of the arguments.
Example object structure for use with this method:
<ruby>
class Continent < ActiveRecord::Base
has_many :countries
# attribs: id, name
end
class Country < ActiveRecord::Base
belongs_to :continent
# attribs: id, name, continent_id
end
</ruby>
Sample usage:
<ruby>
option_groups_from_collection_for_select(@continents, :countries, :name, :id, :name, 3)
</ruby>
TODO check above textile output looks right
Possible output:
<html>
<optgroup label="Africa">
<option value="1">Egypt</option>
<option value="4">Rwanda</option>
...
</optgroup>
<optgroup label="Asia">
<option value="3" selected="selected">China</option>
<option value="12">India</option>
<option value="5">Japan</option>
...
</optgroup>
</html>
Note: Only the +optgroup+ and +option+ tags are returned, so you still have to wrap the output in an appropriate +select+ tag.
h5. options_for_select
Accepts a container (hash, array, enumerable, your type) and returns a string of option tags.
<ruby>
options_for_select([ "VISA", "MasterCard" ])
# => <option>VISA</option> <option>MasterCard</option>
</ruby>
Note: Only the +option+ tags are returned, you have to wrap this call in a regular HTML +select+ tag.
h5. options_from_collection_for_select
Returns a string of option tags that have been compiled by iterating over the +collection+ and assigning the result of a call to the +value_method+ as the option value and the +text_method+ as the option text.
<ruby>
# options_from_collection_for_select(collection, value_method, text_method, selected = nil)
</ruby>
For example, imagine a loop iterating over each person in @project.people to generate an input tag:
<ruby>
options_from_collection_for_select(@project.people, "id", "name")
# => <option value="#{person.id}">#{person.name}</option>
</ruby>
Note: Only the +option+ tags are returned, you have to wrap this call in a regular HTML +select+ tag.
h5. select
Create a select tag and a series of contained option tags for the provided object and method.
Example with @post.person_id => 1:
<ruby>
select("post", "person_id", Person.all.collect {|p| [ p.name, p.id ] }, { :include_blank => true })
</ruby>
could become:
<html>
<select name="post[person_id]">
<option value=""></option>
<option value="1" selected="selected">David</option>
<option value="2">Sam</option>
<option value="3">Tobias</option>
</select>
</html>
h5. time_zone_options_for_select
Returns a string of option tags for pretty much any time zone in the world.
h5. time_zone_select
Return select and option tags for the given object and method, using +time_zone_options_for_select+ to generate the list of option tags.
<ruby>
time_zone_select( "user", "time_zone")
</ruby>
h4. FormTagHelper
Provides a number of methods for creating form tags that doesn't rely on an Active Record object assigned to the template like FormHelper does. Instead, you provide the names and values manually.
h5. check_box_tag
Creates a check box form input tag.
<ruby>
check_box_tag 'accept'
# => <input id="accept" name="accept" type="checkbox" value="1" />
</ruby>
h5. field_set_tag
Creates a field set for grouping HTML form elements.
<ruby>
<%= field_set_tag do %>
<p><%= text_field_tag 'name' %></p>
<% end %>
# => <fieldset><p><input id="name" name="name" type="text" /></p></fieldset>
</ruby>
h5. file_field_tag
Creates a file upload field.
If you are using file uploads then you will also need to set the multipart option for the form tag:
<ruby>
<%= form_tag { :action => "post" }, { :multipart => true } do %>
<label for="file">File to Upload</label> <%= file_field_tag "file" %>
<%= submit_tag %>
<% end %>
</ruby>
Example output:
<ruby>
file_field_tag 'attachment'
# => <input id="attachment" name="attachment" type="file" />
</ruby>
h5. form_tag
Starts a form tag that points the action to an url configured with +url_for_options+ just like +ActionController::Base#url_for+.
<ruby>
<%= form_tag '/posts' do %>
<div><%= submit_tag 'Save' %></div>
<% end %>
# => <form action="/posts" method="post"><div><input type="submit" name="submit" value="Save" /></div></form>
</ruby>
h5. hidden_field_tag
Creates a hidden form input field used to transmit data that would be lost due to HTTP's statelessness or data that should be hidden from the user.
<ruby>
hidden_field_tag 'token', 'VUBJKB23UIVI1UU1VOBVI@'
# => <input id="token" name="token" type="hidden" value="VUBJKB23UIVI1UU1VOBVI@" />
</ruby>
h5. image_submit_tag
Displays an image which when clicked will submit the form.
<ruby>
image_submit_tag("login.png")
# => <input src="/images/login.png" type="image" />
</ruby>
h5. label_tag
Creates a label field.
<ruby>
label_tag 'name'
# => <label for="name">Name</label>
</ruby>
h5. password_field_tag
Creates a password field, a masked text field that will hide the users input behind a mask character.
<ruby>
password_field_tag 'pass'
# => <input id="pass" name="pass" type="password" />
</ruby>
h5. radio_button_tag
Creates a radio button; use groups of radio buttons named the same to allow users to select from a group of options.
<ruby>
radio_button_tag 'gender', 'male'
# => <input id="gender_male" name="gender" type="radio" value="male" />
</ruby>
h5. select_tag
Creates a dropdown selection box.
<ruby>
select_tag "people", "<option>David</option>"
# => <select id="people" name="people"><option>David</option></select>
</ruby>
h5. submit_tag
Creates a submit button with the text provided as the caption.
<ruby>
submit_tag "Publish this post"
# => <input name="commit" type="submit" value="Publish this post" />
</ruby>
h5. text_area_tag
Creates a text input area; use a textarea for longer text inputs such as blog posts or descriptions.
<ruby>
text_area_tag 'post'
# => <textarea id="post" name="post"></textarea>
</ruby>
h5. text_field_tag
Creates a standard text field; use these text fields to input smaller chunks of text like a username or a search query.
<ruby>
text_field_tag 'name'
# => <input id="name" name="name" type="text" />
</ruby>
h4. JavaScriptHelper
Provides functionality for working with JavaScript in your views.
Rails includes the Prototype JavaScript framework and the Scriptaculous JavaScript controls and visual effects library. If you wish to use these libraries and their helpers, make sure +<%= javascript_include_tag :defaults, :cache => true %>+ is in the HEAD section of your page. This function will include the necessary JavaScript files Rails generated in the +public/javascripts+ directory.
h5. button_to_function
Returns a button that'll trigger a JavaScript function using the onclick handler. Examples:
<ruby>
button_to_function "Greeting", "alert('Hello world!')"
button_to_function "Delete", "if (confirm('Really?')) do_delete()"
button_to_function "Details" do |page|
page[:details].visual_effect :toggle_slide
end
</ruby>
h5. define_javascript_functions
Includes the Action Pack JavaScript libraries inside a single +script+ tag.
h5. escape_javascript
Escape carrier returns and single and double quotes for JavaScript segments.
h5. javascript_tag
Returns a JavaScript tag wrapping the provided code.
<ruby>
javascript_tag "alert('All is good')"
</ruby>
<html>
<script type="text/javascript">
//<![CDATA[
alert('All is good')
//]]>
</script>
</html>
h5. link_to_function
Returns a link that will trigger a JavaScript function using the onclick handler and return false after the fact.
<ruby>
link_to_function "Greeting", "alert('Hello world!')"
# => <a onclick="alert('Hello world!'); return false;" href="#">Greeting</a>
</ruby>
h4. NumberHelper
Provides methods for converting numbers into formatted strings. Methods are provided for phone numbers, currency, percentage, precision, positional notation, and file size.
h5. number_to_currency
Formats a number into a currency string (e.g., $13.65).
<ruby>
number_to_currency(1234567890.50) # => $1,234,567,890.50
</ruby>
h5. number_to_human_size
Formats the bytes in size into a more understandable representation; useful for reporting file sizes to users.
<ruby>
number_to_human_size(1234) # => 1.2 KB
number_to_human_size(1234567) # => 1.2 MB
</ruby>
h5. number_to_percentage
Formats a number as a percentage string.
<ruby>
number_to_percentage(100, :precision => 0) # => 100%
</ruby>
h5. number_to_phone
Formats a number into a US phone number.
<ruby>
number_to_phone(1235551234) # => 123-555-1234
</ruby>
h5. number_with_delimiter
Formats a number with grouped thousands using a delimiter.
<ruby>
number_with_delimiter(12345678) # => 12,345,678
</ruby>
h5. number_with_precision
Formats a number with the specified level of +precision+, which defaults to 3.
<ruby>
number_with_precision(111.2345) # => 111.235
number_with_precision(111.2345, 2) # => 111.23
</ruby>
h4. PrototypeHelper
Prototype is a JavaScript library that provides DOM manipulation, Ajax functionality, and more traditional object-oriented facilities for JavaScript. This module provides a set of helpers to make it more convenient to call functions from Prototype using Rails, including functionality to call remote Rails methods (that is, making a background request to a Rails action) using Ajax.
To be able to use these helpers, you must first include the Prototype JavaScript framework in the HEAD of the pages with Prototype functions.
<ruby>
javascript_include_tag 'prototype'
</ruby>
h5. evaluate_remote_response
Returns +eval(request.responseText)+ which is the JavaScript function that form_remote_tag can call in +:complete+ to evaluate a multiple update return document using +update_element_function+ calls.
h5. form_remote_tag
Returns a form tag that will submit using XMLHttpRequest in the background instead of the regular reloading POST arrangement. Even though it‘s using JavaScript to serialize the form elements, the form submission will work just like a regular submission as viewed by the receiving side.
For example, this:
<ruby>
form_remote_tag :html => { :action => url_for(:controller => "some", :action => "place") }
</ruby>
would generate the following:
<html>
<form action="/some/place" method="post" onsubmit="new Ajax.Request('',
{asynchronous:true, evalScripts:true, parameters:Form.serialize(this)}); return false;">
</html>
h5. link_to_remote
Returns a link to a remote action that's called in the background using XMLHttpRequest. You can generate a link that uses AJAX in the general case, while degrading gracefully to plain link behavior in the absence of JavaScript. For example:
<ruby>
link_to_remote "Delete this post",
{ :update => "posts", :url => { :action => "destroy", :id => post.id } },
:href => url_for(:action => "destroy", :id => post.id)
</ruby>
h5. observe_field
Observes the field specified and calls a callback when its contents have changed.
<ruby>
observe_field("my_field", :function => "alert('Field changed')")
</ruby>
h5. observe_form
Observes the form specified and calls a callback when its contents have changed. The options for observe_form are the same as the options for observe_field.
<ruby>
observe_field("my_form", :function => "alert('Form changed')")
</ruby>
h5. periodically_call_remote
Periodically calls the specified url as often as specified. Usually used to update a specified div with the results of the remote call. The following example will call update every 20 seconds and update the news_block div:
<ruby>
periodically_call_remote(:url => 'update', :frequency => '20', :update => 'news_block')
# => PeriodicalExecuter(function() {new Ajax.Updater('news_block', 'update', {asynchronous:true, evalScripts:true})}, 20)
</ruby>
h5. remote_form_for
Creates a form that will submit using XMLHttpRequest in the background instead of the regular reloading POST arrangement and a scope around a specific resource that is used as a base for questioning about values for the fields.
<ruby>
<%= remote_form_for(@post) do |f| %>
...
<% end %>
</ruby>
h5. remote_function
Returns the JavaScript needed for a remote function. Takes the same arguments as +link_to_remote+.
<ruby>
<select id="options" onchange="<%= remote_function(:update => "options", :url => { :action => :update_options }) %>">
<option value="0">Hello</option>
<option value="1">World</option>
</select>
# => <select id="options" onchange="new Ajax.Updater('options', '/testing/update_options', {asynchronous:true, evalScripts:true})">
</ruby>
h5. submit_to_remote
Returns a button input tag that will submit form using XMLHttpRequest in the background instead of a regular POST request that reloads the page.
For example, the following:
<ruby>
submit_to_remote 'create_btn', 'Create', :url => { :action => 'create' }
</ruby>
would generate:
<html>
<input name="create_btn" onclick="new Ajax.Request('/testing/create',
{asynchronous:true, evalScripts:true, parameters:Form.serialize(this.form)});
return false;" type="button" value="Create" />
</html>
h5. update_page
Yields a JavaScriptGenerator and returns the generated JavaScript code. Use this to update multiple elements on a page in an Ajax response.
<ruby>
update_page do |page|
page.hide 'spinner'
end
</ruby>
h5. update_page_tag
Works like update_page but wraps the generated JavaScript in a +script+ tag. Use this to include generated JavaScript in an ERB template.
h4. PrototypeHelper::JavaScriptGenerator::GeneratorMethods
JavaScriptGenerator generates blocks of JavaScript code that allow you to change the content and presentation of multiple DOM elements. Use this in your Ajax response bodies, either in a +script+ tag or as plain JavaScript sent with a Content-type of "text/javascript".
h5(#push). <<
Writes raw JavaScript to the page.
<ruby>
page << "alert('JavaScript with Prototype.');"
</ruby>
h5(#at). []
Returns a element reference by finding it through it's id in the DOM.
<ruby>
page['blank_slate'].show # => $('blank_slate').show();
</ruby>
h5. alert
Displays an alert dialog with the given message.
<ruby>
page.alert('This message is from Rails!')
</ruby>
h5. assign
Assigns the JavaScript variable the given value.
<ruby>
page.assign 'tabulated_total', @total_from_cart
</ruby>
h5. call
Calls the JavaScript function, optionally with the given arguments.
<ruby>
page.call 'Element.replace', 'my_element', "My content to replace with."
</ruby>
h5. delay
Executes the content of the block after a delay of the number of seconds provided.
<ruby>
page.delay(20) do
page.visual_effect :fade, 'notice'
end
</ruby>
h5. draggable
Creates a script.aculo.us draggable element. See ActionView::Helpers::ScriptaculousHelper for more information.
h5. drop_receiving
Creates a script.aculo.us drop receiving element. See ActionView::Helpers::ScriptaculousHelper for more information.
h5. hide
Hides the visible DOM elements with the given ids.
<ruby>
page.hide 'person_29', 'person_9', 'person_0'
</ruby>
h5. insert_html
Inserts HTML at the specified position relative to the DOM element identified by the given id.
<ruby>
page.insert_html :bottom, 'my_list', '<li>Last item</li>'
</ruby>
h5. literal
Returns an object whose to_json evaluates to the code provided. Use this to pass a literal JavaScript expression as an argument to another JavaScriptGenerator method.
h5. redirect_to
Redirects the browser to the given location using JavaScript, in the same form as +url_for+.
<ruby>
page.redirect_to(:controller => 'accounts', :action => 'new')
</ruby>
h5. remove
Removes the DOM elements with the given ids from the page.
<ruby>
page.remove 'person_23', 'person_9', 'person_2'
</ruby>
h5. replace
Replaces the "outer HTML" (i.e., the entire element, not just its contents) of the DOM element with the given id.
<ruby>
page.replace 'person-45', :partial => 'person', :object => @person
</ruby>
h5. replace_html
Replaces the inner HTML of the DOM element with the given id.
<ruby>
page.replace_html 'person-45', :partial => 'person', :object => @person
</ruby>
h5(#prototype-select). select
Returns a collection reference by finding it through a CSS pattern in the DOM.
<ruby>
page.select('p.welcome b').first.hide # => $$('p.welcome b').first().hide();
</ruby>
h5. show
Shows hidden DOM elements with the given ids.
<ruby>
page.show 'person_6', 'person_13', 'person_223'
</ruby>
h5. sortable
Creates a script.aculo.us sortable element. Useful to recreate sortable elements after items get added or deleted. See ActionView::Helpers::ScriptaculousHelper for more information.
h5. toggle
Toggles the visibility of the DOM elements with the given ids. Example:
<ruby>
page.toggle 'person_14', 'person_12', 'person_23' # Hides the elements
page.toggle 'person_14', 'person_12', 'person_23' # Shows the previously hidden elements
</ruby>
h5. visual_effect
Starts a script.aculo.us visual effect. See ActionView::Helpers::ScriptaculousHelper for more information.
TODO start from RecordIdentificationHelper
h3. Localized Views
Action View has the ability render different templates depending on the current locale.
For example, suppose you have a Posts controller with a show action. By default, calling this action will render +app/views/posts/show.html.erb+. But if you set +I18n.locale = :de+, then +app/views/posts/show.de.html.erb+ will be rendered instead. If the localized template isn't present, the undecorated version will be used. This means you're not required to provide localized views for all cases, but they will be preferred and used if available.
You can use the same technique to localize the rescue files in your public directory. For example, setting +I18n.locale = :de+ and creating +public/500.de.html+ and +public/404.de.html+ would allow you to have localized rescue pages.
Since Rails doesn't restrict the symbols that you use to set I18n.locale, you can leverage this system to display different content depending on anything you like. For example, suppose you have some "expert" users that should see different pages from "normal" users. You could add the following to +app/controllers/application.rb+:
<ruby>
before_filter :set_expert_locale
def set_expert_locale
I18n.locale = :expert if current_user.expert?
end
</ruby>
Then you could create special views like +app/views/posts/show.expert.html.erb+ that would only be displayed to expert users.
You can read more about the Rails Internationalization (I18n) API "here":i18n.html.
h3. Changelog
* September 3, 2009: Continuing work by Trevor Turk, leveraging the Action Pack docs and "What's new in Edge Rails":http://ryandaigle.com/articles/2007/8/3/what-s-new-in-edge-rails-partials-get-layouts
* April 5, 2009: Starting work by Trevor Turk, leveraging Mike Gunderloy's docs
|