Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 810 lines (551 sloc) 20.348 kB
df800b5 Docs are started
Blake Mizerany authored
1 = Sinatra
2
4c91e54 @watchdogtimer Web applications should not be hyphenated
watchdogtimer authored
3 Sinatra is a DSL for quickly creating web applications in Ruby with minimal
17cb177 @cypher README and CHANGES tweaks for 0.9.0 release (#63)
cypher authored
4 effort:
df800b5 Docs are started
Blake Mizerany authored
5
6 # myapp.rb
7 require 'sinatra'
c37db5c @rkh minor adjustments and fixes for the readme examples
rkh authored
8
df800b5 Docs are started
Blake Mizerany authored
9 get '/' do
10 'Hello world!'
11 end
12
4298a77 @rtomayko Tweak README formatting; move community/contributing to website
rtomayko authored
13 Install the gem and run with:
df800b5 Docs are started
Blake Mizerany authored
14
8465d49 @rkh Avoid `require "rubygems"` and `sudo` in README.
rkh authored
15 gem install sinatra
16 ruby -rubygems myapp.rb
4298a77 @rtomayko Tweak README formatting; move community/contributing to website
rtomayko authored
17
18 View at: http://localhost:4567
19
20 == Routes
21
22 In Sinatra, a route is an HTTP method paired with an URL matching pattern.
23 Each route is associated with a block:
df800b5 Docs are started
Blake Mizerany authored
24
25 get '/' do
4298a77 @rtomayko Tweak README formatting; move community/contributing to website
rtomayko authored
26 .. show something ..
df800b5 Docs are started
Blake Mizerany authored
27 end
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
28
df800b5 Docs are started
Blake Mizerany authored
29 post '/' do
30 .. create something ..
31 end
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
32
df800b5 Docs are started
Blake Mizerany authored
33 put '/' do
34 .. update something ..
35 end
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
36
df800b5 Docs are started
Blake Mizerany authored
37 delete '/' do
38 .. annihilate something ..
39 end
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
40
4298a77 @rtomayko Tweak README formatting; move community/contributing to website
rtomayko authored
41 Routes are matched in the order they are defined. The first route that
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
42 matches the request is invoked.
1776a80 Added Version and Docs
Blake Mizerany authored
43
17cb177 @cypher README and CHANGES tweaks for 0.9.0 release (#63)
cypher authored
44 Route patterns may include named parameters, accessible via the
45 <tt>params</tt> hash:
1776a80 Added Version and Docs
Blake Mizerany authored
46
4298a77 @rtomayko Tweak README formatting; move community/contributing to website
rtomayko authored
47 get '/hello/:name' do
ce0fe87 @scottj97 fix inaccurate comment in README
scottj97 authored
48 # matches "GET /hello/foo" and "GET /hello/bar"
a734cf3 @rtomayko I knew I shoulda taken that left turn at Hoboken
rtomayko authored
49 # params[:name] is 'foo' or 'bar'
17cb177 @cypher README and CHANGES tweaks for 0.9.0 release (#63)
cypher authored
50 "Hello #{params[:name]}!"
1776a80 Added Version and Docs
Blake Mizerany authored
51 end
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
52
6569d1b @bdimcheff Added route block params in routing statements [#140]
bdimcheff authored
53 You can also access named parameters via block parameters:
54
55 get '/hello/:name' do |n|
56 "Hello #{n}!"
57 end
58
17cb177 @cypher README and CHANGES tweaks for 0.9.0 release (#63)
cypher authored
59 Route patterns may also include splat (or wildcard) parameters, accessible
60 via the <tt>params[:splat]</tt> array.
1776a80 Added Version and Docs
Blake Mizerany authored
61
9c85e99 @vic Specs, documentation and fixes for splat'n routes
vic authored
62 get '/say/*/to/*' do
63 # matches /say/hello/to/world
a734cf3 @rtomayko I knew I shoulda taken that left turn at Hoboken
rtomayko authored
64 params[:splat] # => ["hello", "world"]
9c85e99 @vic Specs, documentation and fixes for splat'n routes
vic authored
65 end
66
67 get '/download/*.*' do
68 # matches /download/path/to/file.xml
a734cf3 @rtomayko I knew I shoulda taken that left turn at Hoboken
rtomayko authored
69 params[:splat] # => ["path/to/file", "xml"]
1776a80 Added Version and Docs
Blake Mizerany authored
70 end
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
71
17cb177 @cypher README and CHANGES tweaks for 0.9.0 release (#63)
cypher authored
72 Route matching with Regular Expressions:
73
74 get %r{/hello/([\w]+)} do
75 "Hello, #{params[:captures].first}!"
76 end
77
6569d1b @bdimcheff Added route block params in routing statements [#140]
bdimcheff authored
78 Or with a block parameter:
79
80 get %r{/hello/([\w]+)} do |c|
81 "Hello, #{c}!"
82 end
83
726feeb @rkh Documentation for condition. Fixes GH #15.
rkh authored
84 === Conditions
85
17cb177 @cypher README and CHANGES tweaks for 0.9.0 release (#63)
cypher authored
86 Routes may include a variety of matching conditions, such as the user agent:
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
87
1776a80 Added Version and Docs
Blake Mizerany authored
88 get '/foo', :agent => /Songbird (\d\.\d)[\d\/]*?/ do
89 "You're using Songbird version #{params[:agent][0]}"
90 end
91
92 get '/foo' do
a734cf3 @rtomayko I knew I shoulda taken that left turn at Hoboken
rtomayko authored
93 # Matches non-songbird browsers
1776a80 Added Version and Docs
Blake Mizerany authored
94 end
df800b5 Docs are started
Blake Mizerany authored
95
fa52709 @rkh fix markup for inline code in README
rkh authored
96 Other available conditions are +host_name+ and +provides+:
726feeb @rkh Documentation for condition. Fixes GH #15.
rkh authored
97
98 get '/', :host_name => /^admin\./ do
99 "Admin Area, Access denied!"
100 end
101
102 get '/', :provides => 'html' do
103 haml :index
104 end
105
106 get '/', :provides => ['rss', 'atom', 'xml'] do
107 builder :feed
108 end
109
110 You can easily define your own conditions:
111
112 set(:probability) { |value| condition { rand <= value } }
113
114 get '/win_a_car', :probability => 0.1 do
115 "You won!"
116 end
117
118 get '/win_a_car' do
119 "Sorry, you lost."
120 end
121
aaeb564 @rkh document route return values, fixes GH #23
rkh authored
122 === Return values
123
124 The return value of a route block determines at least the response body passed
125 on to the HTTP client, or at least the next middleware in the Rack stack.
126 Most commonly this is a string, as in the above examples. But other values are
127 also accepted.
128
c6d0614 @rkh Minor README improvements.
rkh authored
129 You can return any object that would either be a valid Rack response, Rack
130 body object or HTTP status code:
aaeb564 @rkh document route return values, fixes GH #23
rkh authored
131
626f689 @rkh fix markup for multi word inline code in README
rkh authored
132 * An Array with three elements: <tt>[status (Fixnum), headers (Hash), response body (responds to #each)]</tt>
133 * An Array with two elements: <tt>[status (Fixnum), response body (responds to #each)]</tt>
9c73cf7 @rkh fix markup for multi word inline code in README, take two (apparently…
rkh authored
134 * An object that responds to <tt>#each</tt> and passes nothing but strings to the given block
aaeb564 @rkh document route return values, fixes GH #23
rkh authored
135 * A Fixnum representing the status code
136
137 That way we can for instance easily implement a streaming example:
138
139 class Stream
140 def each
141 100.times { |i| yield "#{i}\n" }
142 end
143 end
144
8fbd9c2 @rkh Simplify streaming example.
rkh authored
145 get('/') { Stream.new }
aaeb564 @rkh document route return values, fixes GH #23
rkh authored
146
a734cf3 @rtomayko I knew I shoulda taken that left turn at Hoboken
rtomayko authored
147 == Static Files
047edc6 update README with Static help
Blake Mizerany authored
148
17cb177 @cypher README and CHANGES tweaks for 0.9.0 release (#63)
cypher authored
149 Static files are served from the <tt>./public</tt> directory. You can specify
150 a different location by setting the <tt>:public</tt> option:
a734cf3 @rtomayko I knew I shoulda taken that left turn at Hoboken
rtomayko authored
151
152 set :public, File.dirname(__FILE__) + '/static'
df800b5 Docs are started
Blake Mizerany authored
153
4298a77 @rtomayko Tweak README formatting; move community/contributing to website
rtomayko authored
154 Note that the public directory name is not included in the URL. A file
85b4462 @rtomayko README: fix formatting on static file note
rtomayko authored
155 <tt>./public/css/style.css</tt> is made available as
156 <tt>http://example.com/css/style.css</tt>.
4298a77 @rtomayko Tweak README formatting; move community/contributing to website
rtomayko authored
157
17cb177 @cypher README and CHANGES tweaks for 0.9.0 release (#63)
cypher authored
158 == Views / Templates
df800b5 Docs are started
Blake Mizerany authored
159
4298a77 @rtomayko Tweak README formatting; move community/contributing to website
rtomayko authored
160 Templates are assumed to be located directly under the <tt>./views</tt>
17cb177 @cypher README and CHANGES tweaks for 0.9.0 release (#63)
cypher authored
161 directory. To use a different views directory:
a734cf3 @rtomayko I knew I shoulda taken that left turn at Hoboken
rtomayko authored
162
163 set :views, File.dirname(__FILE__) + '/templates'
164
06161bf @cypher Note on passing template symbols vs. strings in README
cypher authored
165 One important thing to remember is that you always have to reference
166 templates with symbols, even if they're in a subdirectory (in this
167 case use <tt>:'subdir/template'</tt>). Rendering methods will render
168 any strings passed to them directly.
169
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
170 === Haml Templates
df800b5 Docs are started
Blake Mizerany authored
171
17cb177 @cypher README and CHANGES tweaks for 0.9.0 release (#63)
cypher authored
172 The haml gem/library is required to render HAML templates:
173
801163e @bmizerany closes #9779 Auto-require haml/erb/builder/sass
bmizerany authored
174 ## You'll need to require haml in your app
175 require 'haml'
176
df800b5 Docs are started
Blake Mizerany authored
177 get '/' do
178 haml :index
179 end
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
180
181 Renders <tt>./views/index.haml</tt>.
182
0321ada @dougireton In README docs, fix links to HAML and SASS Options pages.
dougireton authored
183 {Haml's options}[http://haml-lang.com/docs/yardoc/file.HAML_REFERENCE.html#options]
d359dc9 @kematzy Merge app-level haml/sass options with call options [#184]
kematzy authored
184 can be set globally through Sinatra's configurations,
185 see {Options and Configurations}[http://www.sinatrarb.com/configuration.html],
186 and overridden on an individual basis.
187
c37db5c @rkh minor adjustments and fixes for the readme examples
rkh authored
188 set :haml, :format => :html5 # default Haml format is :xhtml
d359dc9 @kematzy Merge app-level haml/sass options with call options [#184]
kematzy authored
189
190 get '/' do
c37db5c @rkh minor adjustments and fixes for the readme examples
rkh authored
191 haml :index, :format => :html4 # overridden
d359dc9 @kematzy Merge app-level haml/sass options with call options [#184]
kematzy authored
192 end
193
194
17cb177 @cypher README and CHANGES tweaks for 0.9.0 release (#63)
cypher authored
195 === Erb Templates
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
196
801163e @bmizerany closes #9779 Auto-require haml/erb/builder/sass
bmizerany authored
197 ## You'll need to require erb in your app
198 require 'erb'
199
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
200 get '/' do
201 erb :index
202 end
203
204 Renders <tt>./views/index.erb</tt>
205
7c5d693 @sr Doc for erubis
sr authored
206 === Erubis
207
84f2e0c @jstewart Correction to erubis template rendering instructions
jstewart authored
208 The erubis gem/library is required to render erubis templates:
7c5d693 @sr Doc for erubis
sr authored
209
210 ## You'll need to require erubis in your app
211 require 'erubis'
212
213 get '/' do
214 erubis :index
215 end
216
217 Renders <tt>./views/index.erubis</tt>
218
17cb177 @cypher README and CHANGES tweaks for 0.9.0 release (#63)
cypher authored
219 === Builder Templates
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
220
17cb177 @cypher README and CHANGES tweaks for 0.9.0 release (#63)
cypher authored
221 The builder gem/library is required to render builder templates:
df800b5 Docs are started
Blake Mizerany authored
222
801163e @bmizerany closes #9779 Auto-require haml/erb/builder/sass
bmizerany authored
223 ## You'll need to require builder in your app
224 require 'builder'
225
17cb177 @cypher README and CHANGES tweaks for 0.9.0 release (#63)
cypher authored
226 get '/' do
227 content_type 'application/xml', :charset => 'utf-8'
228 builder :index
229 end
230
231 Renders <tt>./views/index.builder</tt>.
232
233 === Sass Templates
234
235 The sass gem/library is required to render Sass templates:
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
236
801163e @bmizerany closes #9779 Auto-require haml/erb/builder/sass
bmizerany authored
237 ## You'll need to require haml or sass in your app
238 require 'sass'
239
4144ac1 @nmeans Added Sass information to documentation.
nmeans authored
240 get '/stylesheet.css' do
ccc19b0 @rtomayko content_type response helper with mime type lookup and parameter supp…
rtomayko authored
241 content_type 'text/css', :charset => 'utf-8'
4144ac1 @nmeans Added Sass information to documentation.
nmeans authored
242 sass :stylesheet
243 end
244
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
245 Renders <tt>./views/stylesheet.sass</tt>.
246
0321ada @dougireton In README docs, fix links to HAML and SASS Options pages.
dougireton authored
247 {Sass' options}[http://sass-lang.com/docs/yardoc/file.SASS_REFERENCE.html#options]
d359dc9 @kematzy Merge app-level haml/sass options with call options [#184]
kematzy authored
248 can be set globally through Sinatra's configurations,
249 see {Options and Configurations}[http://www.sinatrarb.com/configuration.html],
250 and overridden on an individual basis.
251
c37db5c @rkh minor adjustments and fixes for the readme examples
rkh authored
252 set :sass, :style => :compact # default Sass style is :nested
d359dc9 @kematzy Merge app-level haml/sass options with call options [#184]
kematzy authored
253
254 get '/stylesheet.css' do
255 content_type 'text/css', :charset => 'utf-8'
b90d00c @sr Update sass example re. options
sr authored
256 sass :stylesheet, :style => :expanded # overridden
d359dc9 @kematzy Merge app-level haml/sass options with call options [#184]
kematzy authored
257 end
258
cf3c218 @pedromenezes Adding scss support through specific command
pedromenezes authored
259 === Scss Templates
260
261 The sass gem/library is required to render Scss templates:
262
263 ## You'll need to require haml or sass in your app
264 require 'sass'
265
266 get '/stylesheet.css' do
267 content_type 'text/css', :charset => 'utf-8'
268 scss :stylesheet
269 end
270
271 Renders <tt>./views/stylesheet.scss</tt>.
272
273 {Scss' options}[http://sass-lang.com/docs/yardoc/file.SASS_REFERENCE.html#options]
274 can be set globally through Sinatra's configurations,
275 see {Options and Configurations}[http://www.sinatrarb.com/configuration.html],
276 and overridden on an individual basis.
277
c37db5c @rkh minor adjustments and fixes for the readme examples
rkh authored
278 set :scss, :style => :compact # default Scss style is :nested
cf3c218 @pedromenezes Adding scss support through specific command
pedromenezes authored
279
280 get '/stylesheet.css' do
281 content_type 'text/css', :charset => 'utf-8'
282 scss :stylesheet, :style => :expanded # overridden
283 end
284
621bfcb @Ptico Added Less support
Ptico authored
285 === Less Templates
286
287 The less gem/library is required to render Less templates:
288
289 ## You'll need to require less in your app
290 require 'less'
291
292 get '/stylesheet.css' do
293 content_type 'text/css', :charset => 'utf-8'
294 less :stylesheet
295 end
296
297 Renders <tt>./views/stylesheet.less</tt>.
298
28a3a35 @rkh Add liquid helper method. Tilt supports liquid for quite some time no…
rkh authored
299 === Liquid Templates
300
301 The liquid gem/library is required to render Liquid templates:
302
303 ## You'll need to require liquid in your app
304 require 'liquid'
305
306 get '/' do
307 liquid :index
308 end
309
310 Renders <tt>./views/index.liquid</tt>.
311
312 Since you cannot call Ruby methods (except for +yield+) from a Liquid
313 template, you almost always want to pass locals to it:
314
315 liquid :index, :locals => { :key => 'value' }
316
970169b @rkh Add markdown helper method. Tilt supports markdown for quite some tim…
rkh authored
317 === Markdown Templates
318
319 The rdiscount gem/library is required to render Markdown templates:
320
321 ## You'll need to require rdiscount in your app
322 require "rdiscount"
323
324 get '/' do
325 markdown :index
326 end
327
328 Renders <tt>./views/index.markdown</tt> (+md+ and +mkd+ are also valid file
329 extensions).
330
331 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:
332
333 erb :overview, :locals => { :text => markdown(:introduction) }
334
335 Note that you may also call the markdown method from within other templates:
336
337 %h1 Hello From Haml!
338 %p= markdown(:greetings)
339
b464e02 @rkh Add textile helper method. Tilt supports textile for quite some time …
rkh authored
340 === Textile Templates
341
342 The RedCloth gem/library is required to render Textile templates:
343
344 ## You'll need to require rdiscount in your app
345 require "redcloth"
346
347 get '/' do
348 textile :index
349 end
350
351 Renders <tt>./views/index.textile</tt>.
352
353 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:
354
355 erb :overview, :locals => { :text => textile(:introduction) }
356
357 Note that you may also call the textile method from within other templates:
358
359 %h1 Hello From Haml!
360 %p= textile(:greetings)
361
c248dba @rkh Add rdoc helper method. Tilt supports RDoc for quite some time now, b…
rkh authored
362 === RDoc Templates
363
364 The RDoc gem/library is required to render RDoc templates:
365
366 ## You'll need to require rdiscount in your app
367 require "rdoc"
368
369 get '/' do
370 rdoc :index
371 end
372
373 Renders <tt>./views/index.rdoc</tt>.
374
375 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:
376
377 erb :overview, :locals => { :text => rdoc(:introduction) }
378
379 Note that you may also call the rdoc method from within other templates:
380
381 %h1 Hello From Haml!
382 %p= rdoc(:greetings)
383
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
384 === Inline Templates
df800b5 Docs are started
Blake Mizerany authored
385
386 get '/' do
387 haml '%div.title Hello World'
388 end
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
389
390 Renders the inlined template string.
df800b5 Docs are started
Blake Mizerany authored
391
4298a77 @rtomayko Tweak README formatting; move community/contributing to website
rtomayko authored
392 === Accessing Variables in Templates
df800b5 Docs are started
Blake Mizerany authored
393
5018264 @rtomayko Tidy up README a bit; link to @sinatra on Twitter
rtomayko authored
394 Templates are evaluated within the same context as route handlers. Instance
395 variables set in route handlers are direcly accessible by templates:
df800b5 Docs are started
Blake Mizerany authored
396
397 get '/:id' do
398 @foo = Foo.find(params[:id])
95aca76 @bleything fix documentation of variable interpolation into templates
bleything authored
399 haml '%h1= @foo.name'
df800b5 Docs are started
Blake Mizerany authored
400 end
401
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
402 Or, specify an explicit Hash of local variables:
df800b5 Docs are started
Blake Mizerany authored
403
404 get '/:id' do
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
405 foo = Foo.find(params[:id])
95aca76 @bleything fix documentation of variable interpolation into templates
bleything authored
406 haml '%h1= foo.name', :locals => { :foo => foo }
df800b5 Docs are started
Blake Mizerany authored
407 end
408
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
409 This is typically used when rendering templates as partials from within
410 other templates.
411
3ef8eed @sr Deprecate use_in_file_templates!
sr authored
412 === Inline Templates
83cba9c @bmizerany updated README with helpful tidbits
bmizerany authored
413
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
414 Templates may be defined at the end of the source file:
83cba9c @bmizerany updated README with helpful tidbits
bmizerany authored
415
eec7d21 @bmizerany In-file-templates are automaticly loaded for you.
bmizerany authored
416 require 'sinatra'
417
83cba9c @bmizerany updated README with helpful tidbits
bmizerany authored
418 get '/' do
419 haml :index
420 end
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
421
83cba9c @bmizerany updated README with helpful tidbits
bmizerany authored
422 __END__
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
423
f71330e @bmizerany quick doc fix
bmizerany authored
424 @@ layout
17cb177 @cypher README and CHANGES tweaks for 0.9.0 release (#63)
cypher authored
425 %html
426 = yield
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
427
f71330e @bmizerany quick doc fix
bmizerany authored
428 @@ index
83cba9c @bmizerany updated README with helpful tidbits
bmizerany authored
429 %div.title Hello world!!!!!
430
3ef8eed @sr Deprecate use_in_file_templates!
sr authored
431 NOTE: Inline templates defined in the source file that requires sinatra
fa52709 @rkh fix markup for inline code in README
rkh authored
432 are automatically loaded. Call +enable :inline_templates+ explicitly if you
3ef8eed @sr Deprecate use_in_file_templates!
sr authored
433 have inline templates in other source files.
eec7d21 @bmizerany In-file-templates are automaticly loaded for you.
bmizerany authored
434
4298a77 @rtomayko Tweak README formatting; move community/contributing to website
rtomayko authored
435 === Named Templates
436
5018264 @rtomayko Tidy up README a bit; link to @sinatra on Twitter
rtomayko authored
437 Templates may also be defined using the top-level <tt>template</tt> method:
83cba9c @bmizerany updated README with helpful tidbits
bmizerany authored
438
439 template :layout do
17cb177 @cypher README and CHANGES tweaks for 0.9.0 release (#63)
cypher authored
440 "%html\n =yield\n"
83cba9c @bmizerany updated README with helpful tidbits
bmizerany authored
441 end
442
443 template :index do
444 '%div.title Hello World!'
445 end
446
447 get '/' do
448 haml :index
449 end
450
17cb177 @cypher README and CHANGES tweaks for 0.9.0 release (#63)
cypher authored
451 If a template named "layout" exists, it will be used each time a template
452 is rendered. You can disable layouts by passing <tt>:layout => false</tt>.
578bbab @djanowski Updating README for :layout => true.
djanowski authored
453
454 get '/' do
455 haml :index, :layout => !request.xhr?
456 end
457
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
458 == Helpers
df800b5 Docs are started
Blake Mizerany authored
459
17cb177 @cypher README and CHANGES tweaks for 0.9.0 release (#63)
cypher authored
460 Use the top-level <tt>helpers</tt> method to define helper methods for use in
5018264 @rtomayko Tidy up README a bit; link to @sinatra on Twitter
rtomayko authored
461 route handlers and templates:
df800b5 Docs are started
Blake Mizerany authored
462
463 helpers do
464 def bar(name)
465 "#{name}bar"
466 end
467 end
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
468
1776a80 Added Version and Docs
Blake Mizerany authored
469 get '/:name' do
470 bar(params[:name])
471 end
df800b5 Docs are started
Blake Mizerany authored
472
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
473 == Filters
df800b5 Docs are started
Blake Mizerany authored
474
c6d0614 @rkh Minor README improvements.
rkh authored
475 Before filters are evaluated before each request within the same context as
476 the routes will be and can modify the request and response. Instance variables
477 set in filters are accessible by routes and templates:
1776a80 Added Version and Docs
Blake Mizerany authored
478
df800b5 Docs are started
Blake Mizerany authored
479 before do
a734cf3 @rtomayko I knew I shoulda taken that left turn at Hoboken
rtomayko authored
480 @note = 'Hi!'
481 request.path_info = '/foo/bar/baz'
482 end
483
484 get '/foo/*' do
485 @note #=> 'Hi!'
486 params[:splat] #=> 'bar/baz'
df800b5 Docs are started
Blake Mizerany authored
487 end
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
488
c6d0614 @rkh Minor README improvements.
rkh authored
489 After filter are evaluated after each request within the same context and can
490 also modify the request and response. Instance variables set in before filters
491 and routes are accessible by after filters:
4e50ddb @jschementi Adds after filters
jschementi authored
492
493 after do
494 puts response.status
495 end
496
c6d0614 @rkh Minor README improvements.
rkh authored
497 Filters optionally taking a pattern, causing them to be evaluated only if the
498 request path matches that pattern:
da047d3 @rkh add pattern matching to before/after filters.
rkh authored
499
500 before '/protected/*' do
501 authenticate!
502 end
503
504 after '/create/:slug' do |slug|
505 session[:last_slug] = slug
506 end
507
17cb177 @cypher README and CHANGES tweaks for 0.9.0 release (#63)
cypher authored
508 == Halting
a734cf3 @rtomayko I knew I shoulda taken that left turn at Hoboken
rtomayko authored
509
4e50ddb @jschementi Adds after filters
jschementi authored
510 To immediately stop a request within a filter or route use:
df800b5 Docs are started
Blake Mizerany authored
511
17cb177 @cypher README and CHANGES tweaks for 0.9.0 release (#63)
cypher authored
512 halt
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
513
c6d0614 @rkh Minor README improvements.
rkh authored
514 You can also specify the status when halting:
fbbd822 @sr More 'halt' doc
sr authored
515
516 halt 410
517
c6d0614 @rkh Minor README improvements.
rkh authored
518 Or the body:
df800b5 Docs are started
Blake Mizerany authored
519
17cb177 @cypher README and CHANGES tweaks for 0.9.0 release (#63)
cypher authored
520 halt 'this will be the body'
df800b5 Docs are started
Blake Mizerany authored
521
c6d0614 @rkh Minor README improvements.
rkh authored
522 Or both:
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
523
17cb177 @cypher README and CHANGES tweaks for 0.9.0 release (#63)
cypher authored
524 halt 401, 'go away!'
df800b5 Docs are started
Blake Mizerany authored
525
c6d0614 @rkh Minor README improvements.
rkh authored
526 With headers:
fbbd822 @sr More 'halt' doc
sr authored
527
528 halt 402, {'Content-Type' => 'text/plain'}, 'revenge'
529
17cb177 @cypher README and CHANGES tweaks for 0.9.0 release (#63)
cypher authored
530 == Passing
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
531
5018264 @rtomayko Tidy up README a bit; link to @sinatra on Twitter
rtomayko authored
532 A route can punt processing to the next matching route using <tt>pass</tt>:
df800b5 Docs are started
Blake Mizerany authored
533
17cb177 @cypher README and CHANGES tweaks for 0.9.0 release (#63)
cypher authored
534 get '/guess/:who' do
535 pass unless params[:who] == 'Frank'
6c9488e @sr Stick to single quote; kill a blank line
sr authored
536 'You got me!'
17cb177 @cypher README and CHANGES tweaks for 0.9.0 release (#63)
cypher authored
537 end
538
539 get '/guess/*' do
6c9488e @sr Stick to single quote; kill a blank line
sr authored
540 'You missed!'
17cb177 @cypher README and CHANGES tweaks for 0.9.0 release (#63)
cypher authored
541 end
542
543 The route block is immediately exited and control continues with the next
544 matching route. If no matching route is found, a 404 is returned.
df800b5 Docs are started
Blake Mizerany authored
545
13fc79d @rtomayko Remove support for source file reloading [#166]
rtomayko authored
546 == Configuration
1776a80 Added Version and Docs
Blake Mizerany authored
547
17cb177 @cypher README and CHANGES tweaks for 0.9.0 release (#63)
cypher authored
548 Run once, at startup, in any environment:
1776a80 Added Version and Docs
Blake Mizerany authored
549
550 configure do
e75f4b3 @rtomayko misc README formatting tweaks
rtomayko authored
551 ...
1776a80 Added Version and Docs
Blake Mizerany authored
552 end
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
553
17cb177 @cypher README and CHANGES tweaks for 0.9.0 release (#63)
cypher authored
554 Run only when the environment (RACK_ENV environment variable) is set to
13fc79d @rtomayko Remove support for source file reloading [#166]
rtomayko authored
555 <tt>:production</tt>:
1776a80 Added Version and Docs
Blake Mizerany authored
556
557 configure :production do
e75f4b3 @rtomayko misc README formatting tweaks
rtomayko authored
558 ...
1776a80 Added Version and Docs
Blake Mizerany authored
559 end
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
560
13fc79d @rtomayko Remove support for source file reloading [#166]
rtomayko authored
561 Run when the environment is set to either <tt>:production</tt> or
562 <tt>:test</tt>:
1776a80 Added Version and Docs
Blake Mizerany authored
563
564 configure :production, :test do
e75f4b3 @rtomayko misc README formatting tweaks
rtomayko authored
565 ...
1776a80 Added Version and Docs
Blake Mizerany authored
566 end
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
567
e75f4b3 @rtomayko misc README formatting tweaks
rtomayko authored
568 == Error handling
1776a80 Added Version and Docs
Blake Mizerany authored
569
17cb177 @cypher README and CHANGES tweaks for 0.9.0 release (#63)
cypher authored
570 Error handlers run within the same context as routes and before filters, which
c6d0614 @rkh Minor README improvements.
rkh authored
571 means you get all the goodies it has to offer, like <tt>haml</tt>,
572 <tt>erb</tt>, <tt>halt</tt>, etc.
1776a80 Added Version and Docs
Blake Mizerany authored
573
e75f4b3 @rtomayko misc README formatting tweaks
rtomayko authored
574 === Not Found
1776a80 Added Version and Docs
Blake Mizerany authored
575
17cb177 @cypher README and CHANGES tweaks for 0.9.0 release (#63)
cypher authored
576 When a <tt>Sinatra::NotFound</tt> exception is raised, or the response's status
577 code is 404, the <tt>not_found</tt> handler is invoked:
1776a80 Added Version and Docs
Blake Mizerany authored
578
579 not_found do
c6d0614 @rkh Minor README improvements.
rkh authored
580 'This is nowhere to be found.'
1776a80 Added Version and Docs
Blake Mizerany authored
581 end
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
582
e75f4b3 @rtomayko misc README formatting tweaks
rtomayko authored
583 === Error
83cba9c @bmizerany updated README with helpful tidbits
bmizerany authored
584
17cb177 @cypher README and CHANGES tweaks for 0.9.0 release (#63)
cypher authored
585 The +error+ handler is invoked any time an exception is raised from a route
63fd773 @sr Small doc fix re. after filter
sr authored
586 block or a filter. The exception object can be obtained from the
4298a77 @rtomayko Tweak README formatting; move community/contributing to website
rtomayko authored
587 <tt>sinatra.error</tt> Rack variable:
83cba9c @bmizerany updated README with helpful tidbits
bmizerany authored
588
1776a80 Added Version and Docs
Blake Mizerany authored
589 error do
17cb177 @cypher README and CHANGES tweaks for 0.9.0 release (#63)
cypher authored
590 'Sorry there was a nasty error - ' + env['sinatra.error'].name
83cba9c @bmizerany updated README with helpful tidbits
bmizerany authored
591 end
592
e75f4b3 @rtomayko misc README formatting tweaks
rtomayko authored
593 Custom errors:
83cba9c @bmizerany updated README with helpful tidbits
bmizerany authored
594
595 error MyCustomError do
e7e0e55 @rtomayko Minor docfixes in README.rdoc
rtomayko authored
596 'So what happened was...' + request.env['sinatra.error'].message
1776a80 Added Version and Docs
Blake Mizerany authored
597 end
83cba9c @bmizerany updated README with helpful tidbits
bmizerany authored
598
e75f4b3 @rtomayko misc README formatting tweaks
rtomayko authored
599 Then, if this happens:
83cba9c @bmizerany updated README with helpful tidbits
bmizerany authored
600
601 get '/' do
602 raise MyCustomError, 'something bad'
603 end
604
e75f4b3 @rtomayko misc README formatting tweaks
rtomayko authored
605 You get this:
83cba9c @bmizerany updated README with helpful tidbits
bmizerany authored
606
607 So what happened was... something bad
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
608
59e797e @sr Doc for error(500) { }
sr authored
609 Alternatively, you can install error handler for a status code:
610
611 error 403 do
612 'Access forbidden'
613 end
614
615 get '/secret' do
616 403
617 end
618
619 Or a range:
620
621 error 400..510 do
622 'Boom'
623 end
624
4298a77 @rtomayko Tweak README formatting; move community/contributing to website
rtomayko authored
625 Sinatra installs special <tt>not_found</tt> and <tt>error</tt> handlers when
626 running under the development environment.
83cba9c @bmizerany updated README with helpful tidbits
bmizerany authored
627
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
628 == Mime types
629
17cb177 @cypher README and CHANGES tweaks for 0.9.0 release (#63)
cypher authored
630 When using <tt>send_file</tt> or static files you may have mime types Sinatra
6d8b333 @sr Update README re. mime_type
sr authored
631 doesn't understand. Use +mime_type+ to register them by file extension:
83cba9c @bmizerany updated README with helpful tidbits
bmizerany authored
632
6d8b333 @sr Update README re. mime_type
sr authored
633 mime_type :foo, 'text/foo'
1776a80 Added Version and Docs
Blake Mizerany authored
634
cb8fcb6 @sr Doc for content_type :foo
sr authored
635 You can also use it with the +content_type+ helper:
636
637 content_type :foo
638
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
639 == Rack Middleware
bda21f1 @rtomayko add doc on using Rack middleware to README
rtomayko authored
640
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
641 Sinatra rides on Rack[http://rack.rubyforge.org/], a minimal standard
642 interface for Ruby web frameworks. One of Rack's most interesting capabilities
643 for application developers is support for "middleware" -- components that sit
644 between the server and your application monitoring and/or manipulating the
645 HTTP request/response to provide various types of common functionality.
bda21f1 @rtomayko add doc on using Rack middleware to README
rtomayko authored
646
e75f4b3 @rtomayko misc README formatting tweaks
rtomayko authored
647 Sinatra makes building Rack middleware pipelines a cinch via a top-level
648 +use+ method:
bda21f1 @rtomayko add doc on using Rack middleware to README
rtomayko authored
649
650 require 'sinatra'
651 require 'my_custom_middleware'
652
653 use Rack::Lint
654 use MyCustomMiddleware
655
656 get '/hello' do
657 'Hello World'
658 end
659
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
660 The semantics of +use+ are identical to those defined for the
661 Rack::Builder[http://rack.rubyforge.org/doc/classes/Rack/Builder.html] DSL
662 (most frequently used from rackup files). For example, the +use+ method
663 accepts multiple/variable args as well as blocks:
bda21f1 @rtomayko add doc on using Rack middleware to README
rtomayko authored
664
665 use Rack::Auth::Basic do |username, password|
666 username == 'admin' && password == 'secret'
667 end
668
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
669 Rack is distributed with a variety of standard middleware for logging,
670 debugging, URL routing, authentication, and session handling. Sinatra uses
671 many of of these components automatically based on configuration so you
672 typically don't have to +use+ them explicitly.
bda21f1 @rtomayko add doc on using Rack middleware to README
rtomayko authored
673
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
674 == Testing
1776a80 Added Version and Docs
Blake Mizerany authored
675
c831278 @rtomayko Recommend Rack::Test in README / note Sinatra::Test deprecation
rtomayko authored
676 Sinatra tests can be written using any Rack-based testing library
677 or framework. {Rack::Test}[http://gitrdoc.com/brynary/rack-test] is
678 recommended:
c00a25e @rtomayko Test framework refactoring
rtomayko authored
679
7cfe04a @jcrosby Fix for test/unit and test/spec docs
jcrosby authored
680 require 'my_sinatra_app'
c831278 @rtomayko Recommend Rack::Test in README / note Sinatra::Test deprecation
rtomayko authored
681 require 'rack/test'
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
682
1776a80 Added Version and Docs
Blake Mizerany authored
683 class MyAppTest < Test::Unit::TestCase
c831278 @rtomayko Recommend Rack::Test in README / note Sinatra::Test deprecation
rtomayko authored
684 include Rack::Test::Methods
685
686 def app
687 Sinatra::Application
688 end
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
689
2f377e2 @rtomayko Trim down Testing section in the README; link to doc site instead
rtomayko authored
690 def test_my_default
c00a25e @rtomayko Test framework refactoring
rtomayko authored
691 get '/'
c831278 @rtomayko Recommend Rack::Test in README / note Sinatra::Test deprecation
rtomayko authored
692 assert_equal 'Hello World!', last_response.body
1776a80 Added Version and Docs
Blake Mizerany authored
693 end
10c90d5 @sr document testing with rspec
sr authored
694
2f377e2 @rtomayko Trim down Testing section in the README; link to doc site instead
rtomayko authored
695 def test_with_params
c831278 @rtomayko Recommend Rack::Test in README / note Sinatra::Test deprecation
rtomayko authored
696 get '/meet', :name => 'Frank'
697 assert_equal 'Hello Frank!', last_response.body
10c90d5 @sr document testing with rspec
sr authored
698 end
699
2f377e2 @rtomayko Trim down Testing section in the README; link to doc site instead
rtomayko authored
700 def test_with_rack_env
c831278 @rtomayko Recommend Rack::Test in README / note Sinatra::Test deprecation
rtomayko authored
701 get '/', {}, 'HTTP_USER_AGENT' => 'Songbird'
702 assert_equal "You're using Songbird!", last_response.body
1fb5b99 @dylanegan Bacon support
dylanegan authored
703 end
704 end
705
c831278 @rtomayko Recommend Rack::Test in README / note Sinatra::Test deprecation
rtomayko authored
706 NOTE: The built-in Sinatra::Test module and Sinatra::TestHarness class
707 are deprecated as of the 0.9.2 release.
1776a80 Added Version and Docs
Blake Mizerany authored
708
5360333 @sr Add a note about Sinatra::Base to the README
sr authored
709 == Sinatra::Base - Middleware, Libraries, and Modular Apps
710
711 Defining your app at the top-level works well for micro-apps but has
712 considerable drawbacks when building reuseable components such as Rack
713 middleware, Rails metal, simple libraries with a server component, or
714 even Sinatra extensions. The top-level DSL pollutes the Object namespace
715 and assumes a micro-app style configuration (e.g., a single application
716 file, ./public and ./views directories, logging, exception detail page,
717 etc.). That's where Sinatra::Base comes into play:
718
719 require 'sinatra/base'
720
721 class MyApp < Sinatra::Base
722 set :sessions, true
723 set :foo, 'bar'
724
725 get '/' do
726 'Hello world!'
727 end
728 end
729
730 The MyApp class is an independent Rack component that can act as
731 Rack middleware, a Rack application, or Rails metal. You can +use+ or
732 +run+ this class from a rackup +config.ru+ file; or, control a server
733 component shipped as a library:
734
735 MyApp.run! :host => 'localhost', :port => 9090
736
737 The methods available to Sinatra::Base subclasses are exactly as those
738 available via the top-level DSL. Most top-level apps can be converted to
739 Sinatra::Base components with two modifications:
740
741 * Your file should require +sinatra/base+ instead of +sinatra+;
742 otherwise, all of Sinatra's DSL methods are imported into the main
743 namespace.
744 * Put your app's routes, error handlers, filters, and options in a subclass
745 of Sinatra::Base.
746
747 +Sinatra::Base+ is a blank slate. Most options are disabled by default,
748 including the built-in server. See {Options and Configuration}[http://sinatra.github.com/configuration.html]
749 for details on available options and their behavior.
750
751 SIDEBAR: Sinatra's top-level DSL is implemented using a simple delegation
752 system. The +Sinatra::Application+ class -- a special subclass of
753 Sinatra::Base -- receives all :get, :put, :post, :delete, :before,
754 :error, :not_found, :configure, and :set messages sent to the
755 top-level. Have a look at the code for yourself: here's the
035fe47 @sr fix Delegator links in README
sr authored
756 {Sinatra::Delegator mixin}[http://github.com/sinatra/sinatra/blob/ceac46f0bc129a6e994a06100aa854f606fe5992/lib/sinatra/base.rb#L1128]
757 being {included into the main namespace}[http://github.com/sinatra/sinatra/blob/ceac46f0bc129a6e994a06100aa854f606fe5992/lib/sinatra/main.rb#L28]
5360333 @sr Add a note about Sinatra::Base to the README
sr authored
758
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
759 == Command line
1776a80 Added Version and Docs
Blake Mizerany authored
760
e75f4b3 @rtomayko misc README formatting tweaks
rtomayko authored
761 Sinatra applications can be run directly:
f44fb6a @rtomayko grammar/formatting pass over README
rtomayko authored
762
4d61607 @sr update README/CHANGES re. -o
sr authored
763 ruby myapp.rb [-h] [-x] [-e ENVIRONMENT] [-p PORT] [-o HOST] [-s HANDLER]
1776a80 Added Version and Docs
Blake Mizerany authored
764
765 Options are:
766
767 -h # help
768 -p # set the port (default is 4567)
4d61607 @sr update README/CHANGES re. -o
sr authored
769 -o # set the host (default is 0.0.0.0)
1776a80 Added Version and Docs
Blake Mizerany authored
770 -e # set the environment (default is development)
f29486b @karmi Note "-s" (server) command line option in README
karmi authored
771 -s # specify rack server/handler (default is thin)
e7e0e55 @rtomayko Minor docfixes in README.rdoc
rtomayko authored
772 -x # turn on the mutex lock (default is off)
1776a80 Added Version and Docs
Blake Mizerany authored
773
4298a77 @rtomayko Tweak README formatting; move community/contributing to website
rtomayko authored
774 == The Bleeding Edge
6326809 @cypher Add a subsection about tools needed for Sinatra to the Contributing s…
cypher authored
775
4298a77 @rtomayko Tweak README formatting; move community/contributing to website
rtomayko authored
776 If you would like to use Sinatra's latest bleeding code, create a local
777 clone and run your app with the <tt>sinatra/lib</tt> directory on the
778 <tt>LOAD_PATH</tt>:
6326809 @cypher Add a subsection about tools needed for Sinatra to the Contributing s…
cypher authored
779
4298a77 @rtomayko Tweak README formatting; move community/contributing to website
rtomayko authored
780 cd myapp
ba92616 @bmizerany Updated README to point to github.com/sinatra/sinatra.git
bmizerany authored
781 git clone git://github.com/sinatra/sinatra.git
4298a77 @rtomayko Tweak README formatting; move community/contributing to website
rtomayko authored
782 ruby -Isinatra/lib myapp.rb
480fbfa @rtomayko minor formatting tweaks to cypher's README updates
rtomayko authored
783
4f30c1c fix unclosed <tt> in README
Mathew Cucuzella authored
784 Alternatively, you can add the <tt>sinatra/lib</tt> directory to the
4298a77 @rtomayko Tweak README formatting; move community/contributing to website
rtomayko authored
785 <tt>LOAD_PATH</tt> in your application:
1776a80 Added Version and Docs
Blake Mizerany authored
786
17cb177 @cypher README and CHANGES tweaks for 0.9.0 release (#63)
cypher authored
787 $LOAD_PATH.unshift File.dirname(__FILE__) + '/sinatra/lib'
4298a77 @rtomayko Tweak README formatting; move community/contributing to website
rtomayko authored
788 require 'rubygems'
1776a80 Added Version and Docs
Blake Mizerany authored
789 require 'sinatra'
790
791 get '/about' do
4298a77 @rtomayko Tweak README formatting; move community/contributing to website
rtomayko authored
792 "I'm running version " + Sinatra::VERSION
1776a80 Added Version and Docs
Blake Mizerany authored
793 end
e6c5471 @cypher Add a community section with info about the mailing list and irc channel
cypher authored
794
4298a77 @rtomayko Tweak README formatting; move community/contributing to website
rtomayko authored
795 To update the Sinatra sources in the future:
d8fec16 @cypher Add subsection about contributing a patch as well as a link to the is…
cypher authored
796
4298a77 @rtomayko Tweak README formatting; move community/contributing to website
rtomayko authored
797 cd myproject/sinatra
798 git pull
e6c5471 @cypher Add a community section with info about the mailing list and irc channel
cypher authored
799
4298a77 @rtomayko Tweak README formatting; move community/contributing to website
rtomayko authored
800 == More
e6c5471 @cypher Add a community section with info about the mailing list and irc channel
cypher authored
801
754f116 @rtomayko README: better links to project website and mailing list
rtomayko authored
802 * {Project Website}[http://www.sinatrarb.com/] - Additional documentation,
4298a77 @rtomayko Tweak README formatting; move community/contributing to website
rtomayko authored
803 news, and links to other resources.
754f116 @rtomayko README: better links to project website and mailing list
rtomayko authored
804 * {Contributing}[http://www.sinatrarb.com/contributing] - Find a bug? Need
4298a77 @rtomayko Tweak README formatting; move community/contributing to website
rtomayko authored
805 help? Have a patch?
60ac449 @sr lighthouse => github issue
sr authored
806 * {Issue tracker}[http://github.com/sinatra/sinatra/issues]
5018264 @rtomayko Tidy up README a bit; link to @sinatra on Twitter
rtomayko authored
807 * {Twitter}[http://twitter.com/sinatra]
754f116 @rtomayko README: better links to project website and mailing list
rtomayko authored
808 * {Mailing List}[http://groups.google.com/group/sinatrarb/topics]
4298a77 @rtomayko Tweak README formatting; move community/contributing to website
rtomayko authored
809 * {IRC: #sinatra}[irc://chat.freenode.net/#sinatra] on http://freenode.net
Something went wrong with that request. Please try again.