-
Notifications
You must be signed in to change notification settings - Fork 219
/
README.html
2360 lines (1839 loc) · 72.5 KB
/
README.html
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
<div class='toc'>
<ol class='level-1'>
<li><a href='#Routes'>Routes</a></li>
<ol class='level-2'>
<li><a href='#Conditions'>Conditions</a></li>
<li><a href='#Return%20Values'>Return Values</a></li>
<li><a href='#Custom%20Route%20Matchers'>Custom Route Matchers</a></li>
</ol>
<li><a href='#Static%20Files'>Static Files</a></li>
<li><a href='#Views%20/%20Templates'>Views / Templates</a></li>
<ol class='level-2'>
<li><a href='#Available%20Template%20Languages'>Available Template Languages</a></li>
<li><a href='#Haml%20Templates'>Haml Templates</a></li>
<li><a href='#Erb%20Templates'>Erb Templates</a></li>
<li><a href='#Builder%20Templates'>Builder Templates</a></li>
<li><a href='#Nokogiri%20Templates'>Nokogiri Templates</a></li>
<li><a href='#Sass%20Templates'>Sass Templates</a></li>
<li><a href='#SCSS%20Templates'>SCSS Templates</a></li>
<li><a href='#Less%20Templates'>Less Templates</a></li>
<li><a href='#Liquid%20Templates'>Liquid Templates</a></li>
<li><a href='#Markdown%20Templates'>Markdown Templates</a></li>
<li><a href='#Textile%20Templates'>Textile Templates</a></li>
<li><a href='#RDoc%20Templates'>RDoc Templates</a></li>
<li><a href='#Radius%20Templates'>Radius Templates</a></li>
<li><a href='#Markaby%20Templates'>Markaby Templates</a></li>
<li><a href='#Slim%20Templates'>Slim Templates</a></li>
<li><a href='#Creole%20Templates'>Creole Templates</a></li>
<li><a href='#CoffeeScript%20Templates'>CoffeeScript Templates</a></li>
<li><a href='#Embedded%20Templates'>Embedded Templates</a></li>
<li><a href='#Accessing%20Variables%20in%20Templates'>Accessing Variables in Templates</a></li>
<li><a href='#Inline%20Templates'>Inline Templates</a></li>
<li><a href='#Named%20Templates'>Named Templates</a></li>
<li><a href='#Associating%20File%20Extensions'>Associating File Extensions</a></li>
<li><a href='#Adding%20Your%20Own%20Template%20Engine'>Adding Your Own Template Engine</a></li>
</ol>
<li><a href='#Filters'>Filters</a></li>
<li><a href='#Helpers'>Helpers</a></li>
<ol class='level-2'>
<li><a href='#Using%20Sessions'>Using Sessions</a></li>
<li><a href='#Halting'>Halting</a></li>
<li><a href='#Passing'>Passing</a></li>
<li><a href='#Triggering%20Another%20Route'>Triggering Another Route</a></li>
<li><a href='#Setting%20Body,%20Status%20Code%20and%20Headers'>Setting Body, Status Code and Headers</a></li>
<li><a href='#Streaming%20Responses'>Streaming Responses</a></li>
<li><a href='#Logging'>Logging</a></li>
<li><a href='#Mime%20Types'>Mime Types</a></li>
<li><a href='#Generating%20URLs'>Generating URLs</a></li>
<li><a href='#Browser%20Redirect'>Browser Redirect</a></li>
<li><a href='#Cache%20Control'>Cache Control</a></li>
<li><a href='#Sending%20Files'>Sending Files</a></li>
<li><a href='#Accessing%20the%20Request%20Object'>Accessing the Request Object</a></li>
<li><a href='#Attachments'>Attachments</a></li>
<li><a href='#Dealing%20with%20Date%20and%20Time'>Dealing with Date and Time</a></li>
<li><a href='#Looking%20Up%20Template%20Files'>Looking Up Template Files</a></li>
</ol>
<li><a href='#Configuration'>Configuration</a></li>
<ol class='level-2'>
<li><a href='#Configuring%20attack%20protection'>Configuring attack protection</a></li>
<li><a href='#Available%20Settings'>Available Settings</a></li>
</ol>
<li><a href='#Environments'>Environments</a></li>
<li><a href='#Error%20Handling'>Error Handling</a></li>
<ol class='level-2'>
<li><a href='#Not%20Found'>Not Found</a></li>
<li><a href='#Error'>Error</a></li>
</ol>
<li><a href='#Rack%20Middleware'>Rack Middleware</a></li>
<li><a href='#Testing'>Testing</a></li>
<li><a href='#Sinatra::Base%20-%20Middleware,%20Libraries,%20and%20Modular%20Apps'>Sinatra::Base - Middleware, Libraries, and Modular Apps</a></li>
<ol class='level-2'>
<li><a href='#Modular%20vs.%20Classic%20Style'>Modular vs. Classic Style</a></li>
<li><a href='#Serving%20a%20Modular%20Application'>Serving a Modular Application</a></li>
<li><a href='#Using%20a%20Classic%20Style%20Application%20with%20a%20config.ru'>Using a Classic Style Application with a config.ru</a></li>
<li><a href='#When%20to%20use%20a%20config.ru?'>When to use a config.ru?</a></li>
<li><a href='#Using%20Sinatra%20as%20Middleware'>Using Sinatra as Middleware</a></li>
<li><a href='#Dynamic%20Application%20Creation'>Dynamic Application Creation</a></li>
</ol>
<li><a href='#Scopes%20and%20Binding'>Scopes and Binding</a></li>
<ol class='level-2'>
<li><a href='#Application/Class%20Scope'>Application/Class Scope</a></li>
<li><a href='#Request/Instance%20Scope'>Request/Instance Scope</a></li>
<li><a href='#Delegation%20Scope'>Delegation Scope</a></li>
</ol>
<li><a href='#Command%20Line'>Command Line</a></li>
<li><a href='#Requirement'>Requirement</a></li>
<li><a href='#The%20Bleeding%20Edge'>The Bleeding Edge</a></li>
<ol class='level-2'>
<li><a href='#With%20Bundler'>With Bundler</a></li>
<li><a href='#Roll%20Your%20Own'>Roll Your Own</a></li>
<li><a href='#Install%20Globally'>Install Globally</a></li>
</ol>
<li><a href='#Versioning'>Versioning</a></li>
<li><a href='#Further%20Reading'>Further Reading</a></li>
</ol>
</div>
<p>Sinatra is a DSL for quickly creating web applications in Ruby with minimal
effort:</p>
<pre># myapp.rb
require 'sinatra'
get '/' do
'Hello world!'
end</pre>
<p>Install the gem and run with:</p>
<pre>gem install sinatra
ruby -rubygems myapp.rb</pre>
<p>View at: <a href="http://localhost:4567">localhost:4567</a></p>
<p>It is recommended to also run <tt>gem install thin</tt>, which Sinatra will
pick up if available.</p>
<a name='Routes'></a>
<h2>Routes</h2>
<p>In Sinatra, a route is an HTTP method paired with a URL-matching pattern.
Each route is associated with a block:</p>
<pre>get '/' do
.. show something ..
end
post '/' do
.. create something ..
end
put '/' do
.. replace something ..
end
patch '/' do
.. modify something ..
end
delete '/' do
.. annihilate something ..
end
options '/' do
.. appease something ..
end</pre>
<p>Routes are matched in the order they are defined. The first route that
matches the request is invoked.</p>
<p>Route patterns may include named parameters, accessible via the
<tt>params</tt> hash:</p>
<pre>get '/hello/:name' do
# matches "GET /hello/foo" and "GET /hello/bar"
# params[:name] is 'foo' or 'bar'
"Hello #{params[:name]}!"
end</pre>
<p>You can also access named parameters via block parameters:</p>
<pre>get '/hello/:name' do |n|
"Hello #{n}!"
end</pre>
<p>Route patterns may also include splat (or wildcard) parameters, accessible
via the <tt>params[:splat]</tt> array:</p>
<pre>get '/say/*/to/*' do
# matches /say/hello/to/world
params[:splat] # => ["hello", "world"]
end
get '/download/*.*' do
# matches /download/path/to/file.xml
params[:splat] # => ["path/to/file", "xml"]
end</pre>
<p>Or with block parameters:</p>
<pre>get '/download/*.*' do |path, ext|
[path, ext] # => ["path/to/file", "xml"]
end</pre>
<p>Route matching with Regular Expressions:</p>
<pre>get %r{/hello/([\w]+)} do
"Hello, #{params[:captures].first}!"
end</pre>
<p>Or with a block parameter:</p>
<pre>get %r{/hello/([\w]+)} do |c|
"Hello, #{c}!"
end</pre>
<p>Route patterns may have optional parameters:</p>
<pre>get '/posts.?:format?' do
# matches "GET /posts" and any extension "GET /posts.json", "GET /posts.xml" etc.
end</pre>
<p>By the way, unless you disable the path traversal attack protection (see
below), the request path might be modified before matching against your
routes.</p>
<a name='Conditions'></a>
<h3>Conditions</h3>
<p>Routes may include a variety of matching conditions, such as the user
agent:</p>
<pre>get '/foo', :agent => /Songbird (\d\.\d)[\d\/]*?/ do
"You're using Songbird version #{params[:agent][0]}"
end
get '/foo' do
# Matches non-songbird browsers
end</pre>
<p>Other available conditions are <tt>host_name</tt> and <tt>provides</tt>:</p>
<pre>get '/', :host_name => /^admin\./ do
"Admin Area, Access denied!"
end
get '/', :provides => 'html' do
haml :index
end
get '/', :provides => ['rss', 'atom', 'xml'] do
builder :feed
end</pre>
<p>You can easily define your own conditions:</p>
<pre>set(:probability) { |value| condition { rand <= value } }
get '/win_a_car', :probability => 0.1 do
"You won!"
end
get '/win_a_car' do
"Sorry, you lost."
end</pre>
<p>For a condition that takes multiple values use a splat:</p>
<pre>set(:auth) do |*roles| # <- notice the splat here
condition do
unless logged_in? && roles.any? {|role| current_user.in_role? role }
redirect "/login/", 303
end
end
end
get "/my/account/", :auth => [:user, :admin] do
"Your Account Details"
end
get "/only/admin/", :auth => :admin do
"Only admins are allowed here!"
end</pre>
<a name='Return%20Values'></a>
<h3>Return Values</h3>
<p>The return value of a route block determines at least the response body
passed on to the HTTP client, or at least the next middleware in the Rack
stack. Most commonly, this is a string, as in the above examples. But other
values are also accepted.</p>
<p>You can return any object that would either be a valid Rack response, Rack
body object or HTTP status code:</p>
<ul><li>
<p>An Array with three elements: <tt>[status (Fixnum), headers (Hash),
response body (responds to #each)]</tt></p>
</li><li>
<p>An Array with two elements: <tt>[status (Fixnum), response body (responds
to #each)]</tt></p>
</li><li>
<p>An object that responds to <tt>#each</tt> and passes nothing but strings to
the given block</p>
</li><li>
<p>A Fixnum representing the status code</p>
</li></ul>
<p>That way we can, for instance, easily implement a streaming example:</p>
<pre>class Stream
def each
100.times { |i| yield "#{i}\n" }
end
end
get('/') { Stream.new }</pre>
<p>You can also use the <tt>stream</tt> helper method (described below) to
reduce boiler plate and embed the streaming logic in the route.</p>
<a name='Custom%20Route%20Matchers'></a>
<h3>Custom Route Matchers</h3>
<p>As shown above, Sinatra ships with built-in support for using String
patterns and regular expressions as route matches. However, it does not
stop there. You can easily define your own matchers:</p>
<pre>class AllButPattern
Match = Struct.new(:captures)
def initialize(except)
@except = except
@captures = Match.new([])
end
def match(str)
@captures unless @except === str
end
end
def all_but(pattern)
AllButPattern.new(pattern)
end
get all_but("/index") do
# ...
end</pre>
<p>Note that the above example might be over-engineered, as it can also be
expressed as:</p>
<pre>get // do
pass if request.path_info == "/index"
# ...
end</pre>
<p>Or, using negative look ahead:</p>
<pre>get %r{^(?!/index$)} do
# ...
end</pre>
<a name='Static%20Files'></a>
<h2>Static Files</h2>
<p>Static files are served from the <tt>./public</tt> directory. You can
specify a different location by setting the <tt>:public_folder</tt> option:</p>
<pre>set :public_folder, File.dirname(__FILE__) + '/static'</pre>
<p>Note that the public directory name is not included in the URL. A file
<tt>./public/css/style.css</tt> is made available as
<tt>http://example.com/css/style.css</tt>.</p>
<p>Use the <tt>:static_cache_control</tt> setting (see below) to add
<tt>Cache-Control</tt> header info.</p>
<a name='Views%20/%20Templates'></a>
<h2>Views / Templates</h2>
<p>Each template language is exposed as via its own rendering method. These
methods simply return a string:</p>
<pre>get '/' do
erb :index
end</pre>
<p>This renders <tt>views/index.erb</tt>.</p>
<p>Instead of a template name, you can also just pass in the template content
directly:</p>
<pre>get '/' do
code = "<%= Time.now %>"
erb code
end</pre>
<p>Templates take a second argument, the options hash:</p>
<pre>get '/' do
erb :index, :layout => :post
end</pre>
<p>This will render <tt>views/index.erb</tt> embedded in the
<tt>views/post.erb</tt> (default is <tt>views/layout.erb</tt>, if it
exists).</p>
<p>Any options not understood by Sinatra will be passed on to the template
engine:</p>
<pre>get '/' do
haml :index, :format => :html5
end</pre>
<p>You can also set options per template language in general:</p>
<pre>set :haml, :format => :html5
get '/' do
haml :index
end</pre>
<p>Options passed to the render method override options set via <tt>set</tt>.</p>
<p>Available Options:</p>
<dl class="rdoc-list"><dt>locals</dt>
<dd>
<p>List of locals passed to the document. Handy with partials. Example:
<tt>erb "<%= foo %>", :locals => {:foo =>
"bar"}</tt></p>
</dd><dt>default_encoding</dt>
<dd>
<p>String encoding to use if uncertain. Defaults to
<tt>settings.default_encoding</tt>.</p>
</dd><dt>views</dt>
<dd>
<p>Views folder to load templates from. Defaults to <tt>settings.views</tt>.</p>
</dd><dt>layout</dt>
<dd>
<p>Whether to use a layout (<tt>true</tt> or <tt>false</tt>), if it's a
Symbol, specifies what template to use. Example: <tt>erb :index, :layout
=> !request.xhr?</tt></p>
</dd><dt>content_type</dt>
<dd>
<p>Content-Type the template produces, default depends on template language.</p>
</dd><dt>scope</dt>
<dd>
<p>Scope to render template under. Defaults to the application instance. If
you change this, instance variables and helper methods will not be
available.</p>
</dd><dt>layout_engine</dt>
<dd>
<p>Template engine to use for rendering the layout. Useful for languages that
do not support layouts otherwise. Defaults to the engine used for the
template. Example: <tt>set :rdoc, :layout_engine => :erb</tt></p>
</dd></dl>
<p>Templates are assumed to be located directly under the <tt>./views</tt>
directory. To use a different views directory:</p>
<pre>set :views, settings.root + '/templates'</pre>
<p>One important thing to remember is that you always have to reference
templates with symbols, even if they're in a subdirectory (in this case,
use <tt>:'subdir/template'</tt>). You must use a symbol because otherwise
rendering methods will render any strings passed to them directly.</p>
<a name='Available%20Template%20Languages'></a>
<h3>Available Template Languages</h3>
<p>Some languages have multiple implementations. To specify what
implementation to use (and to be thread-safe), you should simply require it
first:</p>
<pre>require 'rdiscount' # or require 'bluecloth'
get('/') { markdown :index }</pre>
<a name='Haml%20Templates'></a>
<h3>Haml Templates</h3>
<table class="rdoc-list"><tr><td class="rdoc-term"><p>Dependency</p></td>
<td>
<p><a href="http://haml-lang.com/">haml</a></p>
</td></tr><tr><td class="rdoc-term"><p>File Extensions</p></td>
<td>
<p><tt>.haml</tt></p>
</td></tr><tr><td class="rdoc-term"><p>Example</p></td>
<td>
<p><tt>haml :index, :format => :html5</tt></p>
</td></tr></table>
<a name='Erb%20Templates'></a>
<h3>Erb Templates</h3>
<table class="rdoc-list"><tr><td class="rdoc-term"><p>Dependency</p></td>
<td>
<p><a href="http://www.kuwata-lab.com/erubis/">erubis</a> or erb (included in
Ruby)</p>
</td></tr><tr><td class="rdoc-term"><p>File Extensions</p></td>
<td>
<p><tt>.erb</tt>, <tt>.rhtml</tt> or <tt>.erubis</tt> (Erubis only)</p>
</td></tr><tr><td class="rdoc-term"><p>Example</p></td>
<td>
<p><tt>erb :index</tt></p>
</td></tr></table>
<a name='Builder%20Templates'></a>
<h3>Builder Templates</h3>
<table class="rdoc-list"><tr><td class="rdoc-term"><p>Dependency</p></td>
<td>
<p><a href="http://builder.rubyforge.org/">builder</a></p>
</td></tr><tr><td class="rdoc-term"><p>File Extensions</p></td>
<td>
<p><tt>.builder</tt></p>
</td></tr><tr><td class="rdoc-term"><p>Example</p></td>
<td>
<p><tt>builder { |xml| xml.em "hi" }</tt></p>
</td></tr></table>
<p>It also takes a block for inline templates (see example).</p>
<a name='Nokogiri%20Templates'></a>
<h3>Nokogiri Templates</h3>
<table class="rdoc-list"><tr><td class="rdoc-term"><p>Dependency</p></td>
<td>
<p><a href="http://nokogiri.org/">nokogiri</a></p>
</td></tr><tr><td class="rdoc-term"><p>File Extensions</p></td>
<td>
<p><tt>.nokogiri</tt></p>
</td></tr><tr><td class="rdoc-term"><p>Example</p></td>
<td>
<p><tt>nokogiri { |xml| xml.em "hi" }</tt></p>
</td></tr></table>
<p>It also takes a block for inline templates (see example).</p>
<a name='Sass%20Templates'></a>
<h3>Sass Templates</h3>
<table class="rdoc-list"><tr><td class="rdoc-term"><p>Dependency</p></td>
<td>
<p><a href="http://sass-lang.com/">sass</a></p>
</td></tr><tr><td class="rdoc-term"><p>File Extensions</p></td>
<td>
<p><tt>.sass</tt></p>
</td></tr><tr><td class="rdoc-term"><p>Example</p></td>
<td>
<p><tt>sass :stylesheet, :style => :expanded</tt></p>
</td></tr></table>
<a name='SCSS%20Templates'></a>
<h3>SCSS Templates</h3>
<table class="rdoc-list"><tr><td class="rdoc-term"><p>Dependency</p></td>
<td>
<p><a href="http://sass-lang.com/">sass</a></p>
</td></tr><tr><td class="rdoc-term"><p>File Extensions</p></td>
<td>
<p><tt>.scss</tt></p>
</td></tr><tr><td class="rdoc-term"><p>Example</p></td>
<td>
<p><tt>scss :stylesheet, :style => :expanded</tt></p>
</td></tr></table>
<a name='Less%20Templates'></a>
<h3>Less Templates</h3>
<table class="rdoc-list"><tr><td class="rdoc-term"><p>Dependency</p></td>
<td>
<p><a href="http://www.lesscss.org/">less</a></p>
</td></tr><tr><td class="rdoc-term"><p>File Extensions</p></td>
<td>
<p><tt>.less</tt></p>
</td></tr><tr><td class="rdoc-term"><p>Example</p></td>
<td>
<p><tt>less :stylesheet</tt></p>
</td></tr></table>
<a name='Liquid%20Templates'></a>
<h3>Liquid Templates</h3>
<table class="rdoc-list"><tr><td class="rdoc-term"><p>Dependency</p></td>
<td>
<p><a href="http://www.liquidmarkup.org/">liquid</a></p>
</td></tr><tr><td class="rdoc-term"><p>File Extensions</p></td>
<td>
<p><tt>.liquid</tt></p>
</td></tr><tr><td class="rdoc-term"><p>Example</p></td>
<td>
<p><tt>liquid :index, :locals => { :key => 'value' }</tt></p>
</td></tr></table>
<p>Since you cannot call Ruby methods (except for <tt>yield</tt>) from a
Liquid template, you almost always want to pass locals to it.</p>
<a name='Markdown%20Templates'></a>
<h3>Markdown Templates</h3>
<table class="rdoc-list"><tr><td class="rdoc-term"><p>Dependency</p></td>
<td>
<p><a href="https://github.com/rtomayko/rdiscount">rdiscount</a>, <a
href="https://github.com/tanoku/redcarpet">redcarpet</a>, <a
href="http://deveiate.org/projects/BlueCloth">bluecloth</a>, <a
href="http://kramdown.rubyforge.org/">kramdown</a> <b>or</b> <a
href="http://maruku.rubyforge.org/">maruku</a></p>
</td></tr><tr><td class="rdoc-term"><p>File Extensions</p></td>
<td>
<p><tt>.markdown</tt>, <tt>.mkd</tt> and <tt>.md</tt></p>
</td></tr><tr><td class="rdoc-term"><p>Example</p></td>
<td>
<p><tt>markdown :index, :layout_engine => :erb</tt></p>
</td></tr></table>
<p>It is not possible to call methods from markdown, nor to pass locals to it.
You therefore will usually use it in combination with another rendering
engine:</p>
<pre>erb :overview, :locals => { :text => markdown(:introduction) }</pre>
<p>Note that you may also call the <tt>markdown</tt> method from within other
templates:</p>
<pre>%h1 Hello From Haml!
%p= markdown(:greetings)</pre>
<p>Since you cannot call Ruby from Markdown, you cannot use layouts written in
Markdown. However, it is possible to use another rendering engine for the
template than for the layout by passing the <tt>:layout_engine</tt> option.</p>
<a name='Textile%20Templates'></a>
<h3>Textile Templates</h3>
<table class="rdoc-list"><tr><td class="rdoc-term"><p>Dependency</p></td>
<td>
<p><a href="http://redcloth.org/">RedCloth</a></p>
</td></tr><tr><td class="rdoc-term"><p>File Extensions</p></td>
<td>
<p><tt>.textile</tt></p>
</td></tr><tr><td class="rdoc-term"><p>Example</p></td>
<td>
<p><tt>textile :index, :layout_engine => :erb</tt></p>
</td></tr></table>
<p>It is not possible to call methods from textile, nor to pass locals to it.
You therefore will usually use it in combination with another rendering
engine:</p>
<pre>erb :overview, :locals => { :text => textile(:introduction) }</pre>
<p>Note that you may also call the <tt>textile</tt> method from within other
templates:</p>
<pre>%h1 Hello From Haml!
%p= textile(:greetings)</pre>
<p>Since you cannot call Ruby from Textile, you cannot use layouts written in
Textile. However, it is possible to use another rendering engine for the
template than for the layout by passing the <tt>:layout_engine</tt> option.</p>
<a name='RDoc%20Templates'></a>
<h3>RDoc Templates</h3>
<table class="rdoc-list"><tr><td class="rdoc-term"><p>Dependency</p></td>
<td>
<p><a href="http://rdoc.rubyforge.org/">rdoc</a></p>
</td></tr><tr><td class="rdoc-term"><p>File Extensions</p></td>
<td>
<p><tt>.rdoc</tt></p>
</td></tr><tr><td class="rdoc-term"><p>Example</p></td>
<td>
<p><tt>rdoc :README, :layout_engine => :erb</tt></p>
</td></tr></table>
<p>It is not possible to call methods from rdoc, nor to pass locals to it. You
therefore will usually use it in combination with another rendering engine:</p>
<pre>erb :overview, :locals => { :text => rdoc(:introduction) }</pre>
<p>Note that you may also call the <tt>rdoc</tt> method from within other
templates:</p>
<pre>%h1 Hello From Haml!
%p= rdoc(:greetings)</pre>
<p>Since you cannot call Ruby from RDoc, you cannot use layouts written in
RDoc. However, it is possible to use another rendering engine for the
template than for the layout by passing the <tt>:layout_engine</tt> option.</p>
<a name='Radius%20Templates'></a>
<h3>Radius Templates</h3>
<table class="rdoc-list"><tr><td class="rdoc-term"><p>Dependency</p></td>
<td>
<p><a href="http://radius.rubyforge.org/">radius</a></p>
</td></tr><tr><td class="rdoc-term"><p>File Extensions</p></td>
<td>
<p><tt>.radius</tt></p>
</td></tr><tr><td class="rdoc-term"><p>Example</p></td>
<td>
<p><tt>radius :index, :locals => { :key => 'value' }</tt></p>
</td></tr></table>
<p>Since you cannot call Ruby methods directly from a Radius template, you
almost always want to pass locals to it.</p>
<a name='Markaby%20Templates'></a>
<h3>Markaby Templates</h3>
<table class="rdoc-list"><tr><td class="rdoc-term"><p>Dependency</p></td>
<td>
<p><a href="http://markaby.github.com/">markaby</a></p>
</td></tr><tr><td class="rdoc-term"><p>File Extensions</p></td>
<td>
<p><tt>.mab</tt></p>
</td></tr><tr><td class="rdoc-term"><p>Example</p></td>
<td>
<p><tt>markaby { h1 "Welcome!" }</tt></p>
</td></tr></table>
<p>It also takes a block for inline templates (see example).</p>
<a name='Slim%20Templates'></a>
<h3>Slim Templates</h3>
<table class="rdoc-list"><tr><td class="rdoc-term"><p>Dependency</p></td>
<td>
<p><a href="http://slim-lang.com/">slim</a></p>
</td></tr><tr><td class="rdoc-term"><p>File Extensions</p></td>
<td>
<p><tt>.slim</tt></p>
</td></tr><tr><td class="rdoc-term"><p>Example</p></td>
<td>
<p><tt>slim :index</tt></p>
</td></tr></table>
<a name='Creole%20Templates'></a>
<h3>Creole Templates</h3>
<table class="rdoc-list"><tr><td class="rdoc-term"><p>Dependency</p></td>
<td>
<p><a href="https://github.com/minad/creole">creole</a></p>
</td></tr><tr><td class="rdoc-term"><p>File Extensions</p></td>
<td>
<p><tt>.creole</tt></p>
</td></tr><tr><td class="rdoc-term"><p>Example</p></td>
<td>
<p><tt>creole :wiki, :layout_engine => :erb</tt></p>
</td></tr></table>
<p>It is not possible to call methods from creole, nor to pass locals to it.
You therefore will usually use it in combination with another rendering
engine:</p>
<pre>erb :overview, :locals => { :text => creole(:introduction) }</pre>
<p>Note that you may also call the <tt>creole</tt> method from within other
templates:</p>
<pre>%h1 Hello From Haml!
%p= creole(:greetings)</pre>
<p>Since you cannot call Ruby from Creole, you cannot use layouts written in
Creole. However, it is possible to use another rendering engine for the
template than for the layout by passing the <tt>:layout_engine</tt> option.</p>
<a name='CoffeeScript%20Templates'></a>
<h3>CoffeeScript Templates</h3>
<table class="rdoc-list"><tr><td class="rdoc-term"><p>Dependency</p></td>
<td>
<p><a href="https://github.com/josh/ruby-coffee-script">coffee-script</a> and
a <a
href="https://github.com/sstephenson/execjs/blob/master/README.md#readme">way
to execute javascript</a></p>
</td></tr><tr><td class="rdoc-term"><p>File Extensions</p></td>
<td>
<p><tt>.coffee</tt></p>
</td></tr><tr><td class="rdoc-term"><p>Example</p></td>
<td>
<p><tt>coffee :index</tt></p>
</td></tr></table>
<a name='Embedded%20Templates'></a>
<h3>Embedded Templates</h3>
<pre>get '/' do
haml '%div.title Hello World'
end</pre>
<p>Renders the embedded template string.</p>
<a name='Accessing%20Variables%20in%20Templates'></a>
<h3>Accessing Variables in Templates</h3>
<p>Templates are evaluated within the same context as route handlers. Instance
variables set in route handlers are directly accessible by templates:</p>
<pre>get '/:id' do
@foo = Foo.find(params[:id])
haml '%h1= @foo.name'
end</pre>
<p>Or, specify an explicit Hash of local variables:</p>
<pre>get '/:id' do
foo = Foo.find(params[:id])
haml '%h1= bar.name', :locals => { :bar => foo }
end</pre>
<p>This is typically used when rendering templates as partials from within
other templates.</p>
<a name='Inline%20Templates'></a>
<h3>Inline Templates</h3>
<p>Templates may be defined at the end of the source file:</p>
<pre>require 'sinatra'
get '/' do
haml :index
end
__END__
@@ layout
%html
= yield
@@ index
%div.title Hello world.</pre>
<p>NOTE: Inline templates defined in the source file that requires sinatra are
automatically loaded. Call <tt>enable :inline_templates</tt> explicitly if
you have inline templates in other source files.</p>
<a name='Named%20Templates'></a>
<h3>Named Templates</h3>
<p>Templates may also be defined using the top-level <tt>template</tt> method:</p>
<pre>template :layout do
"%html\n =yield\n"
end
template :index do
'%div.title Hello World!'
end
get '/' do
haml :index
end</pre>
<p>If a template named "layout" exists, it will be used each time a template
is rendered. You can individually disable layouts by passing <tt>:layout
=> false</tt> or disable them by default via <tt>set :haml, :layout
=> false</tt>:</p>
<pre>get '/' do
haml :index, :layout => !request.xhr?
end</pre>
<a name='Associating%20File%20Extensions'></a>
<h3>Associating File Extensions</h3>
<p>To associate a file extension with a template engine, use
<tt>Tilt.register</tt>. For instance, if you like to use the file extension
<tt>tt</tt> for Textile templates, you can do the following:</p>
<pre>Tilt.register :tt, Tilt[:textile]</pre>
<a name='Adding%20Your%20Own%20Template%20Engine'></a>
<h3>Adding Your Own Template Engine</h3>
<p>First, register your engine with Tilt, then create a rendering method:</p>
<pre>Tilt.register :myat, MyAwesomeTemplateEngine
helpers do
def myat(*args) render(:myat, *args) end
end
get '/' do
myat :index
end</pre>
<p>Renders <tt>./views/index.myat</tt>. See <a
href="https://github.com/rtomayko/tilt">github.com/rtomayko/tilt</a> to
learn more about Tilt.</p>
<a name='Filters'></a>
<h2>Filters</h2>
<p>Before filters are evaluated before each request within the same context as
the routes will be and can modify the request and response. Instance
variables set in filters are accessible by routes and templates:</p>
<pre>before do
@note = 'Hi!'
request.path_info = '/foo/bar/baz'
end
get '/foo/*' do
@note #=> 'Hi!'
params[:splat] #=> 'bar/baz'
end</pre>
<p>After filters are evaluated after each request within the same context and
can also modify the request and response. Instance variables set in before
filters and routes are accessible by after filters:</p>
<pre>after do
puts response.status
end</pre>
<p>Note: Unless you use the <tt>body</tt> method rather than just returning a
String from the routes, the body will not yet be available in the after
filter, since it is generated later on.</p>
<p>Filters optionally take a pattern, causing them to be evaluated only if the
request path matches that pattern:</p>
<pre>before '/protected/*' do
authenticate!
end
after '/create/:slug' do |slug|
session[:last_slug] = slug
end</pre>
<p>Like routes, filters also take conditions:</p>
<pre>before :agent => /Songbird/ do
# ...
end
after '/blog/*', :host_name => 'example.com' do
# ...
end</pre>
<a name='Helpers'></a>
<h2>Helpers</h2>
<p>Use the top-level <tt>helpers</tt> method to define helper methods for use
in route handlers and templates:</p>
<pre>helpers do
def bar(name)
"#{name}bar"
end
end
get '/:name' do
bar(params[:name])
end</pre>
<p>Alternatively, helper methods can be separately defined in a module:</p>
<pre>module FooUtils
def foo(name) "#{name}foo" end
end
module BarUtils
def bar(name) "#{name}bar" end
end
helpers FooUtils, BarUtils</pre>
<p>The effect is the same as including the modules in the application class.</p>
<a name='Using%20Sessions'></a>
<h3>Using Sessions</h3>
<p>A session is used to keep state during requests. If activated, you have one
session hash per user session:</p>
<pre>enable :sessions
get '/' do
"value = " << session[:value].inspect
end
get '/:value' do
session[:value] = params[:value]
end</pre>
<p>Note that <tt>enable :sessions</tt> actually stores all data in a cookie.
This might not always be what you want (storing lots of data will increase
your traffic, for instance). You can use any Rack session middleware: in
order to do so, do <b>not</b> call <tt>enable :sessions</tt>, but instead
pull in your middleware of choice as you would any other middleware:</p>
<pre>use Rack::Session::Pool, :expire_after => 2592000
get '/' do
"value = " << session[:value].inspect
end
get '/:value' do
session[:value] = params[:value]
end</pre>
<p>To improve security, the session data in the cookie is signed with a
session secret. A random secret is generate for you by Sinatra. However,
since this secret will change with every start of your application, you
might want to set the secret yourself, so all your application instances
share it:</p>
<pre>set :session_secret, 'super secret'</pre>
<p>If you want to configure it further, you may also store a hash with options
in the <tt>sessions</tt> setting:</p>
<pre>set :sessions, :domain => 'foo.com'</pre>
<a name='Halting'></a>
<h3>Halting</h3>
<p>To immediately stop a request within a filter or route use:</p>
<pre>halt</pre>
<p>You can also specify the status when halting:</p>
<pre>halt 410</pre>
<p>Or the body:</p>
<pre>halt 'this will be the body'</pre>
<p>Or both:</p>
<pre>halt 401, 'go away!'</pre>