sinatra-acd 1.4.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (128) hide show
  1. checksums.yaml +7 -0
  2. data/.yardopts +5 -0
  3. data/AUTHORS +61 -0
  4. data/CHANGES +1293 -0
  5. data/Gemfile +76 -0
  6. data/LICENSE +23 -0
  7. data/README.de.md +2864 -0
  8. data/README.es.md +2786 -0
  9. data/README.fr.md +2924 -0
  10. data/README.hu.md +694 -0
  11. data/README.ja.md +2726 -0
  12. data/README.ko.md +2832 -0
  13. data/README.md +2980 -0
  14. data/README.pt-br.md +965 -0
  15. data/README.pt-pt.md +791 -0
  16. data/README.ru.md +2799 -0
  17. data/README.zh.md +2158 -0
  18. data/Rakefile +199 -0
  19. data/examples/chat.rb +61 -0
  20. data/examples/simple.rb +3 -0
  21. data/examples/stream.ru +26 -0
  22. data/lib/sinatra.rb +4 -0
  23. data/lib/sinatra/base.rb +2044 -0
  24. data/lib/sinatra/images/404.png +0 -0
  25. data/lib/sinatra/images/500.png +0 -0
  26. data/lib/sinatra/main.rb +34 -0
  27. data/lib/sinatra/show_exceptions.rb +345 -0
  28. data/lib/sinatra/version.rb +3 -0
  29. data/sinatra.gemspec +19 -0
  30. data/test/asciidoctor_test.rb +72 -0
  31. data/test/base_test.rb +171 -0
  32. data/test/builder_test.rb +91 -0
  33. data/test/coffee_test.rb +90 -0
  34. data/test/compile_test.rb +183 -0
  35. data/test/contest.rb +100 -0
  36. data/test/creole_test.rb +65 -0
  37. data/test/delegator_test.rb +160 -0
  38. data/test/encoding_test.rb +20 -0
  39. data/test/erb_test.rb +116 -0
  40. data/test/extensions_test.rb +98 -0
  41. data/test/filter_test.rb +487 -0
  42. data/test/haml_test.rb +109 -0
  43. data/test/helper.rb +131 -0
  44. data/test/helpers_test.rb +1917 -0
  45. data/test/integration/app.rb +79 -0
  46. data/test/integration_helper.rb +236 -0
  47. data/test/integration_test.rb +104 -0
  48. data/test/less_test.rb +69 -0
  49. data/test/liquid_test.rb +77 -0
  50. data/test/mapped_error_test.rb +285 -0
  51. data/test/markaby_test.rb +80 -0
  52. data/test/markdown_test.rb +82 -0
  53. data/test/mediawiki_test.rb +68 -0
  54. data/test/middleware_test.rb +68 -0
  55. data/test/nokogiri_test.rb +67 -0
  56. data/test/public/favicon.ico +0 -0
  57. data/test/rabl_test.rb +89 -0
  58. data/test/rack_test.rb +45 -0
  59. data/test/radius_test.rb +59 -0
  60. data/test/rdoc_test.rb +66 -0
  61. data/test/readme_test.rb +130 -0
  62. data/test/request_test.rb +97 -0
  63. data/test/response_test.rb +63 -0
  64. data/test/result_test.rb +76 -0
  65. data/test/route_added_hook_test.rb +59 -0
  66. data/test/routing_test.rb +1412 -0
  67. data/test/sass_test.rb +115 -0
  68. data/test/scss_test.rb +88 -0
  69. data/test/server_test.rb +48 -0
  70. data/test/settings_test.rb +582 -0
  71. data/test/sinatra_test.rb +12 -0
  72. data/test/slim_test.rb +102 -0
  73. data/test/static_test.rb +236 -0
  74. data/test/streaming_test.rb +149 -0
  75. data/test/stylus_test.rb +90 -0
  76. data/test/templates_test.rb +382 -0
  77. data/test/textile_test.rb +65 -0
  78. data/test/views/a/in_a.str +1 -0
  79. data/test/views/ascii.erb +2 -0
  80. data/test/views/b/in_b.str +1 -0
  81. data/test/views/calc.html.erb +1 -0
  82. data/test/views/error.builder +3 -0
  83. data/test/views/error.erb +3 -0
  84. data/test/views/error.haml +3 -0
  85. data/test/views/error.sass +2 -0
  86. data/test/views/explicitly_nested.str +1 -0
  87. data/test/views/foo/hello.test +1 -0
  88. data/test/views/hello.asciidoc +1 -0
  89. data/test/views/hello.builder +1 -0
  90. data/test/views/hello.coffee +1 -0
  91. data/test/views/hello.creole +1 -0
  92. data/test/views/hello.erb +1 -0
  93. data/test/views/hello.haml +1 -0
  94. data/test/views/hello.less +5 -0
  95. data/test/views/hello.liquid +1 -0
  96. data/test/views/hello.mab +1 -0
  97. data/test/views/hello.md +1 -0
  98. data/test/views/hello.mediawiki +1 -0
  99. data/test/views/hello.nokogiri +1 -0
  100. data/test/views/hello.rabl +2 -0
  101. data/test/views/hello.radius +1 -0
  102. data/test/views/hello.rdoc +1 -0
  103. data/test/views/hello.sass +2 -0
  104. data/test/views/hello.scss +3 -0
  105. data/test/views/hello.slim +1 -0
  106. data/test/views/hello.str +1 -0
  107. data/test/views/hello.styl +2 -0
  108. data/test/views/hello.test +1 -0
  109. data/test/views/hello.textile +1 -0
  110. data/test/views/hello.wlang +1 -0
  111. data/test/views/hello.yajl +1 -0
  112. data/test/views/layout2.builder +3 -0
  113. data/test/views/layout2.erb +2 -0
  114. data/test/views/layout2.haml +2 -0
  115. data/test/views/layout2.liquid +2 -0
  116. data/test/views/layout2.mab +2 -0
  117. data/test/views/layout2.nokogiri +3 -0
  118. data/test/views/layout2.rabl +3 -0
  119. data/test/views/layout2.radius +2 -0
  120. data/test/views/layout2.slim +3 -0
  121. data/test/views/layout2.str +2 -0
  122. data/test/views/layout2.test +1 -0
  123. data/test/views/layout2.wlang +2 -0
  124. data/test/views/nested.str +1 -0
  125. data/test/views/utf8.erb +2 -0
  126. data/test/wlang_test.rb +87 -0
  127. data/test/yajl_test.rb +86 -0
  128. metadata +280 -0
@@ -0,0 +1,2158 @@
1
+ # Sinatra
2
+
3
+ *注:本文档是英文版的翻译,内容更新有可能不及时。
4
+ 如有不一致的地方,请以英文版为准。*
5
+
6
+ Sinatra是一个基于Ruby语言的[DSL](http://en.wikipedia.org/wiki/Domain-specific_language)(
7
+ 领域专属语言),可以轻松、快速的创建web应用。
8
+
9
+ ~~~~ ruby
10
+ # myapp.rb
11
+ require 'sinatra'
12
+
13
+ get '/' do
14
+ 'Hello world!'
15
+ end
16
+ ~~~~
17
+
18
+ 安装gem,然后运行:
19
+
20
+ ~~~~ shell
21
+ gem install sinatra
22
+ ruby myapp.rb
23
+ ~~~~
24
+
25
+ 在该地址查看: [localhost:4567](http://localhost:4567)
26
+
27
+ 安装Sintra后,最好再运行`gem install thin`安装Thin。这样,Sinatra会优先选择Thin作为服务器。
28
+
29
+ ## 路由(route)
30
+
31
+ 在Sinatra中,一个路由分为两部分:HTTP方法(GET, POST等)和URL匹配范式。
32
+ 每个路由都有一个要执行的代码块:
33
+
34
+ ~~~~ ruby
35
+ get '/' do
36
+ .. 显示内容 ..
37
+ end
38
+
39
+ post '/' do
40
+ .. 创建内容 ..
41
+ end
42
+
43
+ put '/' do
44
+ .. 更新内容 ..
45
+ end
46
+
47
+ delete '/' do
48
+ .. 删除内容 ..
49
+ end
50
+
51
+ options '/' do
52
+ .. 显示命令列表 ..
53
+ end
54
+
55
+ link '/' do
56
+ .. 建立某种联系 ..
57
+ end
58
+
59
+ unlink '/' do
60
+ .. 解除某种联系 ..
61
+ end
62
+
63
+
64
+ ~~~~
65
+
66
+ 路由按照它们被定义的顺序进行匹配。 第一个与请求匹配的路由会被调用。
67
+
68
+ 路由范式可以包括具名参数,可通过`params`哈希表获得:
69
+
70
+ ~~~~ ruby
71
+ get '/hello/:name' do
72
+ # 匹配 "GET /hello/foo" 和 "GET /hello/bar"
73
+ # params[:name] 的值是 'foo' 或者 'bar'
74
+ "Hello #{params[:name]}!"
75
+ end
76
+ ~~~~
77
+
78
+ 你同样可以通过代码块参数获得具名参数:
79
+
80
+ ~~~~ ruby
81
+ get '/hello/:name' do |n|
82
+ "Hello #{n}!"
83
+ end
84
+ ~~~~
85
+
86
+ 路由范式也可以包含通配符参数, 可以通过`params[:splat]`数组获得。
87
+
88
+ ~~~~ ruby
89
+ get '/say/*/to/*' do
90
+ # 匹配 /say/hello/to/world
91
+ params[:splat] # => ["hello", "world"]
92
+ end
93
+
94
+ get '/download/*.*' do
95
+ # 匹配 /download/path/to/file.xml
96
+ params[:splat] # => ["path/to/file", "xml"]
97
+ end
98
+ ~~~~
99
+
100
+ 通过正则表达式匹配的路由:
101
+
102
+ ~~~~ ruby
103
+ get %r{/hello/([\w]+)} do
104
+ "Hello, #{params[:captures].first}!"
105
+ end
106
+ ~~~~
107
+
108
+ 或者使用代码块参数:
109
+
110
+ ~~~~ ruby
111
+ get %r{/hello/([\w]+)} do |c|
112
+ "Hello, #{c}!"
113
+ end
114
+ ~~~~
115
+
116
+ ### 条件
117
+
118
+ 路由也可以包含多样的匹配条件,比如user agent:
119
+
120
+ ~~~~ ruby
121
+ get '/foo', :agent => /Songbird (\d\.\d)[\d\/]*?/ do
122
+ "你正在使用Songbird,版本是 #{params[:agent][0]}"
123
+ end
124
+
125
+ get '/foo' do
126
+ # 匹配除Songbird以外的浏览器
127
+ end
128
+ ~~~~
129
+
130
+ 其他可选的条件是 `host_name` 和 `provides`:
131
+
132
+ ~~~~ ruby
133
+ get '/', :host_name => /^admin\./ do
134
+ "管理员区域,无权进入!"
135
+ end
136
+
137
+ get '/', :provides => 'html' do
138
+ haml :index
139
+ end
140
+
141
+ get '/', :provides => ['rss', 'atom', 'xml'] do
142
+ builder :feed
143
+ end
144
+ ~~~~
145
+
146
+ 你也可以自定义条件:
147
+
148
+ ~~~~ ruby
149
+ set(:probability) { |value| condition { rand <= value } }
150
+
151
+ get '/win_a_car', :probability => 0.1 do
152
+ "You won!"
153
+ end
154
+
155
+ get '/win_a_car' do
156
+ "Sorry, you lost."
157
+ end
158
+ ~~~~
159
+
160
+ ### 返回值
161
+
162
+ 路由代码块的返回值至少决定了返回给HTTP客户端的响应体,
163
+ 或者至少决定了在Rack堆栈中的下一个中间件。
164
+ 大多数情况下,将是一个字符串,就像上面的例子中的一样。
165
+ 但是其他值也是可以接受的。
166
+
167
+ 你可以返回任何对象,或者是一个合理的Rack响应, Rack
168
+ body对象或者HTTP状态码:
169
+
170
+ - 一个包含三个元素的数组:
171
+ `[状态 (Fixnum), 头 (Hash), 响应体 (回应 #each)]`
172
+
173
+ - 一个包含两个元素的数组: `[状态 (Fixnum), 响应体 (回应 #each)]`
174
+
175
+ - 一个能够回应 `#each` ,只传回字符串的对象
176
+
177
+ - 一个代表状态码的数字
178
+
179
+ 那样,我们可以轻松的实现例如流式传输的例子:
180
+
181
+ ~~~~ ruby
182
+ class Stream
183
+ def each
184
+ 100.times { |i| yield "#{i}\n" }
185
+ end
186
+ end
187
+
188
+ get('/') { Stream.new }
189
+ ~~~~
190
+
191
+ ### 自定义路由匹配器
192
+
193
+ 如上显示,Sinatra内置了对于使用字符串和正则表达式作为路由匹配的支持。
194
+ 但是,它并没有只限于此。 你可以非常容易地定义你自己的匹配器:
195
+
196
+ ~~~~ ruby
197
+ class AllButPattern
198
+ Match = Struct.new(:captures)
199
+
200
+ def initialize(except)
201
+ @except = except
202
+ @captures = Match.new([])
203
+ end
204
+
205
+ def match(str)
206
+ @captures unless @except === str
207
+ end
208
+ end
209
+
210
+ def all_but(pattern)
211
+ AllButPattern.new(pattern)
212
+ end
213
+
214
+ get all_but("/index") do
215
+ # ...
216
+ end
217
+ ~~~~
218
+
219
+ 上面的例子可能太繁琐了, 因为它也可以用更简单的方式表述:
220
+
221
+ ~~~~ ruby
222
+ get // do
223
+ pass if request.path_info == "/index"
224
+ # ...
225
+ end
226
+ ~~~~
227
+
228
+ 或者,使用消极向前查找:
229
+
230
+ ~~~~ ruby
231
+ get %r{^(?!/index$)} do
232
+ # ...
233
+ end
234
+ ~~~~
235
+
236
+ ## 静态文件
237
+
238
+ 静态文件是从 `./public_folder` 目录提供服务。你可以通过设置`:public`
239
+ 选项设定一个不同的位置:
240
+
241
+ ~~~~ ruby
242
+ set :public_folder, File.dirname(__FILE__) + '/static'
243
+ ~~~~
244
+
245
+ 请注意public目录名并没有被包含在URL之中。文件
246
+ `./public/css/style.css`是通过
247
+ `http://example.com/css/style.css`地址访问的。
248
+
249
+ ## 视图 / 模板
250
+
251
+ 模板被假定直接位于`./views`目录。 要使用不同的视图目录:
252
+
253
+ ~~~~ ruby
254
+ set :views, File.dirname(__FILE__) + '/templates'
255
+ ~~~~
256
+
257
+ 请记住一件非常重要的事情,你只可以通过符号引用模板, 即使它们在子目录下
258
+ (在这种情况下,使用 `:'subdir/template'`)。 你必须使用一个符号,
259
+ 因为渲染方法会直接地渲染任何传入的字符串。
260
+
261
+ ### Haml模板
262
+
263
+ 需要引入 `haml` gem/library以渲染 HAML 模板:
264
+
265
+ ~~~~ ruby
266
+ # 你需要在你的应用中引入 haml
267
+ require 'haml'
268
+
269
+ get '/' do
270
+ haml :index
271
+ end
272
+ ~~~~
273
+
274
+ 渲染 `./views/index.haml`。
275
+
276
+ [Haml的选项](http://haml.info/docs/yardoc/file.HAML_REFERENCE.html#options)
277
+ 可以通过Sinatra的配置全局设定, 参见
278
+ [选项和配置](http://www.sinatrarb.com/configuration.html),
279
+ 也可以个别的被覆盖。
280
+
281
+ ~~~~ ruby
282
+ set :haml, {:format => :html5 } # 默认的Haml输出格式是 :xhtml
283
+
284
+ get '/' do
285
+ haml :index, :haml_options => {:format => :html4 } # 被覆盖,变成:html4
286
+ end
287
+ ~~~~
288
+
289
+ ### Erb模板
290
+
291
+ ~~~~ ruby
292
+ # 你需要在你的应用中引入 erb
293
+ require 'erb'
294
+
295
+ get '/' do
296
+ erb :index
297
+ end
298
+ ~~~~
299
+
300
+ 这里调用的是 `./views/index.erb`
301
+
302
+ ### Erubis
303
+
304
+ 需要引入 `erubis` gem/library以渲染 erubis 模板:
305
+
306
+ ~~~~ ruby
307
+ # 你需要在你的应用中引入 erubis
308
+ require 'erubis'
309
+
310
+ get '/' do
311
+ erubis :index
312
+ end
313
+ ~~~~
314
+
315
+ 这里调用的是 `./views/index.erubis`
316
+
317
+ 使用Erubis代替Erb也是可能的:
318
+
319
+ ~~~~ ruby
320
+ require 'erubis'
321
+ Tilt.register :erb, Tilt[:erubis]
322
+
323
+ get '/' do
324
+ erb :index
325
+ end
326
+ ~~~~
327
+
328
+ 使用Erubis来渲染 `./views/index.erb`。
329
+
330
+ ### Builder 模板
331
+
332
+ 需要引入 `builder` gem/library 以渲染 builder templates:
333
+
334
+ ~~~~ ruby
335
+ # 需要在你的应用中引入builder
336
+ require 'builder'
337
+
338
+ get '/' do
339
+ builder :index
340
+ end
341
+ ~~~~
342
+
343
+ 这里调用的是 `./views/index.builder`。
344
+
345
+ ### Nokogiri 模板
346
+
347
+ 需要引入 `nokogiri` gem/library 以渲染 nokogiri 模板:
348
+
349
+ ~~~~ ruby
350
+ # 需要在你的应用中引入 nokogiri
351
+ require 'nokogiri'
352
+
353
+ get '/' do
354
+ nokogiri :index
355
+ end
356
+ ~~~~
357
+
358
+ 这里调用的是 `./views/index.nokogiri`。
359
+
360
+ ### Sass 模板
361
+
362
+ 需要引入 `haml` 或者 `sass` gem/library 以渲染 Sass 模板:
363
+
364
+ ~~~~ ruby
365
+ # 需要在你的应用中引入 haml 或者 sass
366
+ require 'sass'
367
+
368
+ get '/stylesheet.css' do
369
+ sass :stylesheet
370
+ end
371
+ ~~~~
372
+
373
+ 这里调用的是 `./views/stylesheet.sass`。
374
+
375
+ [Sass
376
+ 的选项](http://sass-lang.com/docs/yardoc/file.SASS_REFERENCE.html#options)
377
+ 可以通过Sinatra选项全局设定, 参考
378
+ [选项和配置(英文)](http://www.sinatrarb.com/configuration.html),
379
+ 也可以在个体的基础上覆盖。
380
+
381
+ ~~~~ ruby
382
+ set :sass, {:style => :compact } # 默认的 Sass 样式是 :nested
383
+
384
+ get '/stylesheet.css' do
385
+ sass :stylesheet, :style => :expanded # 覆盖
386
+ end
387
+ ~~~~
388
+
389
+ ### Scss 模板
390
+
391
+ 需要引入 `haml` 或者 `sass` gem/library 来渲染 Scss templates:
392
+
393
+ ~~~~ ruby
394
+ # 需要在你的应用中引入 haml 或者 sass
395
+ require 'sass'
396
+
397
+ get '/stylesheet.css' do
398
+ scss :stylesheet
399
+ end
400
+ ~~~~
401
+
402
+ 这里调用的是 `./views/stylesheet.scss`。
403
+
404
+ [Scss的选项](http://sass-lang.com/docs/yardoc/file.SASS_REFERENCE.html#options)
405
+ 可以通过Sinatra选项全局设定, 参考
406
+ [选项和配置(英文)](http://www.sinatrarb.com/configuration.html),
407
+ 也可以在个体的基础上覆盖。
408
+
409
+ ~~~~ ruby
410
+ set :scss, :style => :compact # default Scss style is :nested
411
+
412
+ get '/stylesheet.css' do
413
+ scss :stylesheet, :style => :expanded # overridden
414
+ end
415
+ ~~~~
416
+
417
+ ### Less 模板
418
+
419
+ 需要引入 `less` gem/library 以渲染 Less 模板:
420
+
421
+ ~~~~ ruby
422
+ # 需要在你的应用中引入 less
423
+ require 'less'
424
+
425
+ get '/stylesheet.css' do
426
+ less :stylesheet
427
+ end
428
+ ~~~~
429
+
430
+ 这里调用的是 `./views/stylesheet.less`。
431
+
432
+ ### Liquid 模板
433
+
434
+ 需要引入 `liquid` gem/library 来渲染 Liquid 模板:
435
+
436
+ ~~~~ ruby
437
+ # 需要在你的应用中引入 liquid
438
+ require 'liquid'
439
+
440
+ get '/' do
441
+ liquid :index
442
+ end
443
+ ~~~~
444
+
445
+ 这里调用的是 `./views/index.liquid`。
446
+
447
+ 因为你不能在Liquid 模板中调用 Ruby 方法 (除了 `yield`) ,
448
+ 你几乎总是需要传递locals给它:
449
+
450
+ ~~~~ ruby
451
+ liquid :index, :locals => { :key => 'value' }
452
+ ~~~~
453
+
454
+ ### Markdown 模板
455
+
456
+ 需要引入 `rdiscount` gem/library 以渲染 Markdown 模板:
457
+
458
+ ~~~~ ruby
459
+ # 需要在你的应用中引入rdiscount
460
+ require "rdiscount"
461
+
462
+ get '/' do
463
+ markdown :index
464
+ end
465
+ ~~~~
466
+
467
+ 这里调用的是 `./views/index.markdown` (`md` 和 `mkd` 也是合理的文件扩展名)。
468
+
469
+ 在markdown中是不可以调用方法的,也不可以传递 locals给它。
470
+ 你因此一般会结合其他的渲染引擎来使用它:
471
+
472
+ ~~~~ ruby
473
+ erb :overview, :locals => { :text => markdown(:introduction) }
474
+ ~~~~
475
+
476
+ 请注意你也可以从其他模板中调用 markdown 方法:
477
+
478
+ ~~~~ ruby
479
+ %h1 Hello From Haml!
480
+ %p= markdown(:greetings)
481
+ ~~~~
482
+
483
+ 既然你不能在Markdown中调用Ruby,你不能使用Markdown编写的布局。
484
+ 不过,使用其他渲染引擎作为模版的布局是可能的,
485
+ 通过传递`:layout_engine`选项:
486
+
487
+ ~~~~ ruby
488
+ get '/' do
489
+ markdown :index, :layout_engine => :erb
490
+ end
491
+ ~~~~
492
+
493
+ 这将会调用 `./views/index.md` 并使用 `./views/layout.erb` 作为布局。
494
+
495
+ 请记住你可以全局设定这个选项:
496
+
497
+ ~~~~ ruby
498
+ set :markdown, :layout_engine => :haml, :layout => :post
499
+
500
+ get '/' do
501
+ markdown :index
502
+ end
503
+ ~~~~
504
+
505
+ 这将会调用 `./views/index.markdown` (和任何其他的 Markdown 模版) 并使用
506
+ `./views/post.haml` 作为布局.
507
+
508
+ 也可能使用BlueCloth而不是RDiscount来解析Markdown文件:
509
+
510
+ ~~~~ ruby
511
+ require 'bluecloth'
512
+
513
+ Tilt.register 'markdown', BlueClothTemplate
514
+ Tilt.register 'mkd', BlueClothTemplate
515
+ Tilt.register 'md', BlueClothTemplate
516
+
517
+ get '/' do
518
+ markdown :index
519
+ end
520
+ ~~~~
521
+
522
+ 使用BlueCloth来渲染 `./views/index.md` 。
523
+
524
+ ### Textile 模板
525
+
526
+ 需要引入 `RedCloth` gem/library 以渲染 Textile 模板:
527
+
528
+ ~~~~ ruby
529
+ # 在你的应用中引入redcloth
530
+ require "redcloth"
531
+
532
+ get '/' do
533
+ textile :index
534
+ end
535
+ ~~~~
536
+
537
+ 这里调用的是 `./views/index.textile`。
538
+
539
+ 在textile中是不可以调用方法的,也不可以传递 locals给它。
540
+ 你因此一般会结合其他的渲染引擎来使用它:
541
+
542
+ ~~~~ ruby
543
+ erb :overview, :locals => { :text => textile(:introduction) }
544
+ ~~~~
545
+
546
+ 请注意你也可以从其他模板中调用`textile`方法:
547
+
548
+ ~~~~ ruby
549
+ %h1 Hello From Haml!
550
+ %p= textile(:greetings)
551
+ ~~~~
552
+
553
+ 既然你不能在Textile中调用Ruby,你不能使用Textile编写的布局。
554
+ 不过,使用其他渲染引擎作为模版的布局是可能的,
555
+ 通过传递`:layout_engine`选项:
556
+
557
+ ~~~~ ruby
558
+ get '/' do
559
+ textile :index, :layout_engine => :erb
560
+ end
561
+ ~~~~
562
+
563
+ 这将会渲染 `./views/index.textile` 并使用 `./views/layout.erb`
564
+ 作为布局。
565
+
566
+ 请记住你可以全局设定这个选项:
567
+
568
+ ~~~~ ruby
569
+ set :textile, :layout_engine => :haml, :layout => :post
570
+
571
+ get '/' do
572
+ textile :index
573
+ end
574
+ ~~~~
575
+
576
+ 这将会调用 `./views/index.textile` (和任何其他的 Textile 模版) 并使用
577
+ `./views/post.haml` 作为布局.
578
+
579
+ ### RDoc 模板
580
+
581
+ 需要引入 `RDoc` gem/library 以渲染RDoc模板:
582
+
583
+ ~~~~ ruby
584
+ # 需要在你的应用中引入rdoc/markup/to_html
585
+ require "rdoc"
586
+ require "rdoc/markup/to_html"
587
+
588
+ get '/' do
589
+ rdoc :index
590
+ end
591
+ ~~~~
592
+
593
+ 这里调用的是 `./views/index.rdoc`。
594
+
595
+ 在rdoc中是不可以调用方法的,也不可以传递locals给它。
596
+ 你因此一般会结合其他的渲染引擎来使用它:
597
+
598
+ ~~~~ ruby
599
+ erb :overview, :locals => { :text => rdoc(:introduction) }
600
+ ~~~~
601
+
602
+ 请注意你也可以从其他模板中调用`rdoc`方法:
603
+
604
+ ~~~~ ruby
605
+ %h1 Hello From Haml!
606
+ %p= rdoc(:greetings)
607
+ ~~~~
608
+
609
+ 既然你不能在RDoc中调用Ruby,你不能使用RDoc编写的布局。
610
+ 不过,使用其他渲染引擎作为模版的布局是可能的,
611
+ 通过传递`:layout_engine`选项:
612
+
613
+ ~~~~ ruby
614
+ get '/' do
615
+ rdoc :index, :layout_engine => :erb
616
+ end
617
+ ~~~~
618
+
619
+ 这将会调用 `./views/index.rdoc` 并使用 `./views/layout.erb` 作为布局。
620
+
621
+ 请记住你可以全局设定这个选项:
622
+
623
+ ~~~~ ruby
624
+ set :rdoc, :layout_engine => :haml, :layout => :post
625
+
626
+ get '/' do
627
+ rdoc :index
628
+ end
629
+ ~~~~
630
+
631
+ 这将会调用 `./views/index.rdoc` (和任何其他的 RDoc 模版) 并使用
632
+ `./views/post.haml` 作为布局.
633
+
634
+ ### Radius 模板
635
+
636
+ 需要引入 `radius` gem/library 以渲染 Radius 模板:
637
+
638
+ ~~~~ ruby
639
+ # 需要在你的应用中引入radius
640
+ require 'radius'
641
+
642
+ get '/' do
643
+ radius :index
644
+ end
645
+ ~~~~
646
+
647
+ 这里调用的是 `./views/index.radius`。
648
+
649
+ 因为你不能在Radius 模板中调用 Ruby 方法 (除了 `yield`) ,
650
+ 你几乎总是需要传递locals给它:
651
+
652
+ ~~~~ ruby
653
+ radius :index, :locals => { :key => 'value' }
654
+ ~~~~
655
+
656
+ ### Markaby 模板
657
+
658
+ 需要引入`markaby` gem/library以渲染Markaby模板:
659
+
660
+ ~~~~ ruby
661
+ #需要在你的应用中引入 markaby
662
+ require 'markaby'
663
+
664
+ get '/' do
665
+ markaby :index
666
+ end
667
+ ~~~~
668
+
669
+ 这里调用的是 `./views/index.mab`。
670
+
671
+ 你也可以使用嵌入的 Markaby:
672
+
673
+ ~~~~ ruby
674
+ get '/' do
675
+ markaby { h1 "Welcome!" }
676
+ end
677
+ ~~~~
678
+
679
+ ### Slim 模板
680
+
681
+ 需要引入 `slim` gem/library 来渲染 Slim 模板:
682
+
683
+ ~~~~ ruby
684
+ # 需要在你的应用中引入 slim
685
+ require 'slim'
686
+
687
+ get '/' do
688
+ slim :index
689
+ end
690
+ ~~~~
691
+
692
+ 这里调用的是 `./views/index.slim`。
693
+
694
+ ### Creole 模板
695
+
696
+ 需要引入 `creole` gem/library 来渲染 Creole 模板:
697
+
698
+ ~~~~ ruby
699
+ # 需要在你的应用中引入 creole
700
+ require 'creole'
701
+
702
+ get '/' do
703
+ creole :index
704
+ end
705
+ ~~~~
706
+
707
+ 这里调用的是 `./views/index.creole`。
708
+
709
+ ### CoffeeScript 模板
710
+
711
+ 需要引入 `coffee-script` gem/library 并至少满足下面条件一项
712
+ 以执行Javascript:
713
+
714
+ - `node` (来自 Node.js) 在你的路径中
715
+
716
+ - 你正在运行 OSX
717
+
718
+ - `therubyracer` gem/library
719
+
720
+ 请察看
721
+ [github.com/josh/ruby-coffee-script](http://github.com/josh/ruby-coffee-script)
722
+ 获取更新的选项。
723
+
724
+ 现在你可以调用 CoffeeScript 模版了:
725
+
726
+ ~~~~ ruby
727
+ # 需要在你的应用中引入coffee-script
728
+ require 'coffee-script'
729
+
730
+ get '/application.js' do
731
+ coffee :application
732
+ end
733
+ ~~~~
734
+
735
+ 这里调用的是 `./views/application.coffee`。
736
+
737
+ ### 嵌入模板字符串
738
+
739
+ ~~~~ ruby
740
+ get '/' do
741
+ haml '%div.title Hello World'
742
+ end
743
+ ~~~~
744
+
745
+ 调用嵌入模板字符串。
746
+
747
+ ### 在模板中访问变量
748
+
749
+ 模板和路由执行器在同样的上下文求值。
750
+ 在路由执行器中赋值的实例变量可以直接被模板访问。
751
+
752
+ ~~~~ ruby
753
+ get '/:id' do
754
+ @foo = Foo.find(params[:id])
755
+ haml '%h1= @foo.name'
756
+ end
757
+ ~~~~
758
+
759
+ 或者,显式地指定一个本地变量的哈希:
760
+
761
+ ~~~~ ruby
762
+ get '/:id' do
763
+ foo = Foo.find(params[:id])
764
+ haml '%h1= foo.name', :locals => { :foo => foo }
765
+ end
766
+ ~~~~
767
+
768
+ 典型的使用情况是在别的模板中按照局部模板的方式来渲染。
769
+
770
+ ### 内联模板
771
+
772
+ 模板可以在源文件的末尾定义:
773
+
774
+ ~~~~ ruby
775
+ require 'sinatra'
776
+
777
+ get '/' do
778
+ haml :index
779
+ end
780
+
781
+ __END__
782
+
783
+ @@ layout
784
+ %html
785
+ = yield
786
+
787
+ @@ index
788
+ %div.title Hello world!!!!!
789
+ ~~~~
790
+
791
+ 注意:引入sinatra的源文件中定义的内联模板才能被自动载入。
792
+ 如果你在其他源文件中有内联模板,
793
+ 需要显式执行调用`enable :inline_templates`。
794
+
795
+ ### 具名模板
796
+
797
+ 模板可以通过使用顶层 `template` 方法定义:
798
+
799
+ ~~~~ ruby
800
+ template :layout do
801
+ "%html\n =yield\n"
802
+ end
803
+
804
+ template :index do
805
+ '%div.title Hello World!'
806
+ end
807
+
808
+ get '/' do
809
+ haml :index
810
+ end
811
+ ~~~~
812
+
813
+ 如果存在名为“layout”的模板,该模板会在每个模板渲染的时候被使用。
814
+ 你可以单独地通过传送 `:layout => false`来禁用,
815
+ 或者通过`set :haml, :layout => false`来禁用他们。
816
+
817
+ ~~~~ ruby
818
+ get '/' do
819
+ haml :index, :layout => !request.xhr?
820
+ end
821
+ ~~~~
822
+
823
+ ### 关联文件扩展名
824
+
825
+ 为了关联一个文件扩展名到一个模版引擎,使用
826
+ `Tilt.register`。比如,如果你喜欢使用 `tt`
827
+ 作为Textile模版的扩展名,你可以这样做:
828
+
829
+ ~~~~ ruby
830
+ Tilt.register :tt, Tilt[:textile]
831
+ ~~~~
832
+
833
+ ### 添加你自己的模版引擎
834
+
835
+ 首先,通过Tilt注册你自己的引擎,然后创建一个渲染方法:
836
+
837
+ ~~~~ ruby
838
+ Tilt.register :myat, MyAwesomeTemplateEngine
839
+
840
+ helpers do
841
+ def myat(*args) render(:myat, *args) end
842
+ end
843
+
844
+ get '/' do
845
+ myat :index
846
+ end
847
+ ~~~~
848
+
849
+ 这里调用的是 `./views/index.myat`。察看
850
+ [github.com/rtomayko/tilt](https://github.com/rtomayko/tilt)
851
+ 来更多了解Tilt.
852
+
853
+ ## 过滤器
854
+
855
+ 前置过滤器在每个请求前,在请求的上下文环境中被执行,
856
+ 而且可以修改请求和响应。 在过滤器中设定的实例变量可以被路由和模板访问:
857
+
858
+ ~~~~ ruby
859
+ before do
860
+ @note = 'Hi!'
861
+ request.path_info = '/foo/bar/baz'
862
+ end
863
+
864
+ get '/foo/*' do
865
+ @note #=> 'Hi!'
866
+ params[:splat] #=> 'bar/baz'
867
+ end
868
+ ~~~~
869
+
870
+ 后置过滤器在每个请求之后,在请求的上下文环境中执行,
871
+ 而且可以修改请求和响应。
872
+ 在前置过滤器和路由中设定的实例变量可以被后置过滤器访问:
873
+
874
+ ~~~~ ruby
875
+ after do
876
+ puts response.status
877
+ end
878
+ ~~~~
879
+
880
+ 请注意:除非你显式使用 `body` 方法,而不是在路由中直接返回字符串,
881
+ 消息体在后置过滤器是不可用的, 因为它在之后才会生成。
882
+
883
+ 过滤器可以可选地带有范式, 只有请求路径满足该范式时才会执行:
884
+
885
+ ~~~~ ruby
886
+ before '/protected/*' do
887
+ authenticate!
888
+ end
889
+
890
+ after '/create/:slug' do |slug|
891
+ session[:last_slug] = slug
892
+ end
893
+ ~~~~
894
+
895
+ 和路由一样,过滤器也可以带有条件:
896
+
897
+ ~~~~ ruby
898
+ before :agent => /Songbird/ do
899
+ # ...
900
+ end
901
+
902
+ after '/blog/*', :host_name => 'example.com' do
903
+ # ...
904
+ end
905
+ ~~~~
906
+
907
+ ## 辅助方法
908
+
909
+ 使用顶层的 `helpers` 方法来定义辅助方法, 以便在路由处理器和模板中使用:
910
+
911
+ ~~~~ ruby
912
+ helpers do
913
+ def bar(name)
914
+ "#{name}bar"
915
+ end
916
+ end
917
+
918
+ get '/:name' do
919
+ bar(params[:name])
920
+ end
921
+ ~~~~
922
+
923
+ ### 使用 Sessions
924
+
925
+ Session被用来在请求之间保持状态。如果被激活,每一个用户会话
926
+ 对应有一个session哈希:
927
+
928
+ ~~~~ ruby
929
+ enable :sessions
930
+
931
+ get '/' do
932
+ "value = " << session[:value].inspect
933
+ end
934
+
935
+ get '/:value' do
936
+ session[:value] = params[:value]
937
+ end
938
+ ~~~~
939
+
940
+ 请注意 `enable :sessions` 实际上保存所有的数据在一个cookie之中。
941
+ 这可能不会总是做你想要的(比如,保存大量的数据会增加你的流量)。
942
+ 你可以使用任何的Rack session中间件,为了这么做, \*不要\*调用
943
+ `enable :sessions`,而是 按照自己的需要引入你的中间件:
944
+
945
+ ~~~~ ruby
946
+ use Rack::Session::Pool, :expire_after => 2592000
947
+
948
+ get '/' do
949
+ "value = " << session[:value].inspect
950
+ end
951
+
952
+ get '/:value' do
953
+ session[:value] = params[:value]
954
+ end
955
+ ~~~~
956
+
957
+ ### 挂起
958
+
959
+ 要想直接地停止请求,在过滤器或者路由中使用:
960
+
961
+ ~~~~ ruby
962
+ halt
963
+ ~~~~
964
+
965
+ 你也可以指定挂起时的状态码:
966
+
967
+ ~~~~ ruby
968
+ halt 410
969
+ ~~~~
970
+
971
+ 或者消息体:
972
+
973
+ ~~~~ ruby
974
+ halt 'this will be the body'
975
+ ~~~~
976
+
977
+ 或者两者;
978
+
979
+ ~~~~ ruby
980
+ halt 401, 'go away!'
981
+ ~~~~
982
+
983
+ 也可以带消息头:
984
+
985
+ ~~~~ ruby
986
+ halt 402, {'Content-Type' => 'text/plain'}, 'revenge'
987
+ ~~~~
988
+
989
+ ### 让路
990
+
991
+ 一个路由可以放弃处理,将处理让给下一个匹配的路由,使用 `pass`:
992
+
993
+ ~~~~ ruby
994
+ get '/guess/:who' do
995
+ pass unless params[:who] == 'Frank'
996
+ 'You got me!'
997
+ end
998
+
999
+ get '/guess/*' do
1000
+ 'You missed!'
1001
+ end
1002
+ ~~~~
1003
+
1004
+ 路由代码块被直接退出,控制流继续前进到下一个匹配的路由。
1005
+ 如果没有匹配的路由,将返回404。
1006
+
1007
+ ### 触发另一个路由
1008
+
1009
+ 有些时候,`pass` 并不是你想要的,你希望得到的是另一个路由的结果
1010
+ 。简单的使用 `call` 可以做到这一点:
1011
+
1012
+ ~~~~ ruby
1013
+ get '/foo' do
1014
+ status, headers, body = call env.merge("PATH_INFO" => '/bar')
1015
+ [status, headers, body.map(&:upcase)]
1016
+ end
1017
+
1018
+ get '/bar' do
1019
+ "bar"
1020
+ end
1021
+ ~~~~
1022
+
1023
+ 请注意在以上例子中,你可以更加简化测试并增加性能,只要简单的移动
1024
+
1025
+ <tt>"bar"</tt>到一个被<tt>/foo</tt>
1026
+
1027
+ 和 `/bar`同时使用的helper。
1028
+
1029
+ 如果你希望请求被发送到同一个应用,而不是副本, 使用 `call!` 而不是
1030
+ `call`.
1031
+
1032
+ 如果想更多了解 `call`,请察看 Rack specification。
1033
+
1034
+ ### 设定 消息体,状态码和消息头
1035
+
1036
+ 通过路由代码块的返回值来设定状态码和消息体不仅是可能的,而且是推荐的。
1037
+ 但是,在某些场景中你可能想在作业流程中的特定点上设置消息体。 你可以通过
1038
+ `body` 辅助方法这么做。 如果你这样做了,
1039
+ 你可以在那以后使用该方法获得消息体:
1040
+
1041
+ ~~~~ ruby
1042
+ get '/foo' do
1043
+ body "bar"
1044
+ end
1045
+
1046
+ after do
1047
+ puts body
1048
+ end
1049
+ ~~~~
1050
+
1051
+ 也可以传一个代码块给 `body`,它将会被Rack处理器执行(
1052
+ 这将可以被用来实现streaming,参见“返回值”)。
1053
+
1054
+ 和消息体类似,你也可以设定状态码和消息头:
1055
+
1056
+ ~~~~ ruby
1057
+ get '/foo' do
1058
+ status 418
1059
+ headers \
1060
+ "Allow" => "BREW, POST, GET, PROPFIND, WHEN",
1061
+ "Refresh" => "Refresh: 20; http://www.ietf.org/rfc/rfc2324.txt"
1062
+ body "I'm a tea pot!"
1063
+ end
1064
+ ~~~~
1065
+
1066
+ 如同 `body`, 不带参数的 `headers` 和 `status` 可以用来访问
1067
+ 他们你的当前值.
1068
+
1069
+ ### 媒体(MIME)类型
1070
+
1071
+ 使用 `send_file` 或者静态文件的时候,Sinatra可能不能识别你的媒体类型。
1072
+ 使用 `mime_type` 通过文件扩展名来注册它们:
1073
+
1074
+ ~~~~ ruby
1075
+ mime_type :foo, 'text/foo'
1076
+ ~~~~
1077
+
1078
+ 你也可以使用 `content_type` 辅助方法:
1079
+
1080
+ ~~~~ ruby
1081
+ get '/' do
1082
+ content_type :foo
1083
+ "foo foo foo"
1084
+ end
1085
+ ~~~~
1086
+
1087
+ ### 生成 URL
1088
+
1089
+ 为了生成URL,你需要使用 `url` 辅助方法, 例如,在Haml中:
1090
+
1091
+ ~~~~ ruby
1092
+ %a{:href => url('/foo')} foo
1093
+ ~~~~
1094
+
1095
+ 如果使用反向代理和Rack路由,生成URL的时候会考虑这些因素。
1096
+
1097
+ 这个方法还有一个别名 `to` (见下面的例子).
1098
+
1099
+ ### 浏览器重定向
1100
+
1101
+ 你可以通过 `redirect` 辅助方法触发浏览器重定向:
1102
+
1103
+ ~~~~ ruby
1104
+ get '/foo' do
1105
+ redirect to('/bar')
1106
+ end
1107
+ ~~~~
1108
+
1109
+ 其他参数的用法,与 `halt`相同:
1110
+
1111
+ ~~~~ ruby
1112
+ redirect to('/bar'), 303
1113
+ redirect 'http://google.com', 'wrong place, buddy'
1114
+ ~~~~
1115
+
1116
+ 用 `redirect back`可以把用户重定向到原始页面:
1117
+
1118
+ ~~~~ ruby
1119
+ get '/foo' do
1120
+ "<a href='/bar'>do something</a>"
1121
+ end
1122
+
1123
+ get '/bar' do
1124
+ do_something
1125
+ redirect back
1126
+ end
1127
+ ~~~~
1128
+
1129
+ 如果想传递参数给redirect,可以用query string:
1130
+
1131
+ ~~~~ ruby
1132
+ redirect to('/bar?sum=42')
1133
+ ~~~~
1134
+
1135
+ 或者用session:
1136
+
1137
+ ~~~~ ruby
1138
+ enable :sessions
1139
+
1140
+ get '/foo' do
1141
+ session[:secret] = 'foo'
1142
+ redirect to('/bar')
1143
+ end
1144
+
1145
+ get '/bar' do
1146
+ session[:secret]
1147
+ end
1148
+ ~~~~
1149
+
1150
+ ### 缓存控制
1151
+
1152
+ 要使用HTTP缓存,必须正确地设定消息头。
1153
+
1154
+ 你可以这样设定 Cache-Control 消息头:
1155
+
1156
+ ~~~~ ruby
1157
+ get '/' do
1158
+ cache_control :public
1159
+ "cache it!"
1160
+ end
1161
+ ~~~~
1162
+
1163
+ 核心提示: 在前置过滤器中设定缓存.
1164
+
1165
+ ~~~~ ruby
1166
+ before do
1167
+ cache_control :public, :must_revalidate, :max_age => 60
1168
+ end
1169
+ ~~~~
1170
+
1171
+ 如果你正在用 `expires` 辅助方法设定对应的消息头 `Cache-Control`
1172
+ 会自动设定:
1173
+
1174
+ ~~~~ ruby
1175
+ before do
1176
+ expires 500, :public, :must_revalidate
1177
+ end
1178
+ ~~~~
1179
+
1180
+ 为了合适地使用缓存,你应该考虑使用 `etag` 和 `last_modified`方法。
1181
+ 推荐在执行繁重任务\*之前\*使用这些helpers,这样一来,
1182
+ 如果客户端在缓存中已经有相关内容,就会立即得到显示。
1183
+
1184
+
1185
+ ~~~~ ruby
1186
+ get '/article/:id' do
1187
+ @article = Article.find params[:id]
1188
+ last_modified @article.updated_at
1189
+ etag @article.sha1
1190
+ erb :article
1191
+ end
1192
+ ~~~~
1193
+
1194
+ 使用 [weak
1195
+ ETag](http://en.wikipedia.org/wiki/HTTP_ETag#Strong_and_weak_validation)
1196
+ 也是有可能的:
1197
+
1198
+ ~~~~ ruby
1199
+ etag @article.sha1, :weak
1200
+ ~~~~
1201
+
1202
+ 这些辅助方法并不会为你做任何缓存,而是将必要的信息传送给你的缓存
1203
+ 如果你在寻找缓存的快速解决方案,试试
1204
+ [rack-cache](https://github.com/rtomayko/rack-cache):
1205
+
1206
+ ~~~~ ruby
1207
+ require "rack/cache"
1208
+ require "sinatra"
1209
+
1210
+ use Rack::Cache
1211
+
1212
+ get '/' do
1213
+ cache_control :public, :max_age => 36000
1214
+ sleep 5
1215
+ "hello"
1216
+ end
1217
+ ~~~~
1218
+
1219
+ ### 发送文件
1220
+
1221
+ 为了发送文件,你可以使用 `send_file` 辅助方法:
1222
+
1223
+ ~~~~ ruby
1224
+ get '/' do
1225
+ send_file 'foo.png'
1226
+ end
1227
+ ~~~~
1228
+
1229
+ 也可以带一些选项:
1230
+
1231
+ ~~~~ ruby
1232
+ send_file 'foo.png', :type => :jpg
1233
+ ~~~~
1234
+
1235
+ 可用的选项有:
1236
+
1237
+ <dl>
1238
+ <dt>filename</dt>
1239
+ <dd>响应中的文件名,默认是真实文件的名字。</dd>
1240
+
1241
+ <dt>last_modified</dt>
1242
+ <dd>Last-Modified 消息头的值,默认是文件的mtime(修改时间)。</dd>
1243
+
1244
+ <dt>type</dt>
1245
+ <dd>使用的内容类型,如果没有会从文件扩展名猜测。</dd>
1246
+
1247
+ <dt>disposition</dt>
1248
+ <dd>
1249
+ 用于 Content-Disposition,可能的包括: <tt>nil</tt> (默认), <tt>:attachment</tt> 和
1250
+ <tt>:inline</tt>
1251
+ </dd>
1252
+
1253
+ <dt>length</dt>
1254
+ <dd>Content-Length 的值,默认是文件的大小。</dd>
1255
+ </dl>
1256
+
1257
+ 如果Rack处理器支持的话,Ruby进程也能使用除streaming以外的方法。
1258
+ 如果你使用这个辅助方法, Sinatra会自动处理range请求。
1259
+
1260
+ ### 访问请求对象
1261
+
1262
+ 传入的请求对象可以在请求层(过滤器,路由,错误处理) 通过 `request`
1263
+ 方法被访问:
1264
+
1265
+ ~~~~ ruby
1266
+ # 在 http://example.com/example 上运行的应用
1267
+ get '/foo' do
1268
+ request.body # 被客户端设定的请求体(见下)
1269
+ request.scheme # "http"
1270
+ request.script_name # "/example"
1271
+ request.path_info # "/foo"
1272
+ request.port # 80
1273
+ request.request_method # "GET"
1274
+ request.query_string # ""
1275
+ request.content_length # request.body的长度
1276
+ request.media_type # request.body的媒体类型
1277
+ request.host # "example.com"
1278
+ request.get? # true (其他动词也具有类似方法)
1279
+ request.form_data? # false
1280
+ request["SOME_HEADER"] # SOME_HEADER header的值
1281
+ request.referrer # 客户端的referrer 或者 '/'
1282
+ request.user_agent # user agent (被 :agent 条件使用)
1283
+ request.cookies # 浏览器 cookies 哈希
1284
+ request.xhr? # 这是否是ajax请求?
1285
+ request.url # "http://example.com/example/foo"
1286
+ request.path # "/example/foo"
1287
+ request.ip # 客户端IP地址
1288
+ request.secure? # false(如果是ssl则为true)
1289
+ request.forwarded? # true (如果是运行在反向代理之后)
1290
+ request.env # Rack中使用的未处理的env哈希
1291
+ end
1292
+ ~~~~
1293
+
1294
+ 一些选项,例如 `script_name` 或者 `path_info` 也是可写的:
1295
+
1296
+ ~~~~ ruby
1297
+ before { request.path_info = "/" }
1298
+
1299
+ get "/" do
1300
+ "all requests end up here"
1301
+ end
1302
+ ~~~~
1303
+
1304
+ `request.body` 是一个IO或者StringIO对象:
1305
+
1306
+ ~~~~ ruby
1307
+ post "/api" do
1308
+ request.body.rewind # 如果已经有人读了它
1309
+ data = JSON.parse request.body.read
1310
+ "Hello #{data['name']}!"
1311
+ end
1312
+ ~~~~
1313
+
1314
+ ### 附件
1315
+
1316
+ 你可以使用 `attachment` 辅助方法来告诉浏览器响应
1317
+ 应当被写入磁盘而不是在浏览器中显示。
1318
+
1319
+ ~~~~ ruby
1320
+ get '/' do
1321
+ attachment
1322
+ "store it!"
1323
+ end
1324
+ ~~~~
1325
+
1326
+ 你也可以传递一个文件名:
1327
+
1328
+ ~~~~ ruby
1329
+ get '/' do
1330
+ attachment "info.txt"
1331
+ "store it!"
1332
+ end
1333
+ ~~~~
1334
+
1335
+ ### 查找模板文件
1336
+
1337
+ `find_template` 辅助方法被用于在渲染时查找模板文件:
1338
+
1339
+ ~~~~ ruby
1340
+ find_template settings.views, 'foo', Tilt[:haml] do |file|
1341
+ puts "could be #{file}"
1342
+ end
1343
+ ~~~~
1344
+
1345
+ 这并不是很有用。但是在你需要重载这个方法
1346
+ 来实现你自己的查找机制的时候有用。 比如,如果你想支持多于一个视图目录:
1347
+
1348
+ ~~~~ ruby
1349
+ set :views, ['views', 'templates']
1350
+
1351
+ helpers do
1352
+ def find_template(views, name, engine, &block)
1353
+ Array(views).each { |v| super(v, name, engine, &block) }
1354
+ end
1355
+ end
1356
+ ~~~~
1357
+
1358
+ 另一个例子是为不同的引擎使用不同的目录:
1359
+
1360
+ ~~~~ ruby
1361
+ set :views, :sass => 'views/sass', :haml => 'templates', :default => 'views'
1362
+
1363
+ helpers do
1364
+ def find_template(views, name, engine, &block)
1365
+ _, folder = views.detect { |k,v| engine == Tilt[k] }
1366
+ folder ||= views[:default]
1367
+ super(folder, name, engine, &block)
1368
+ end
1369
+ end
1370
+ ~~~~
1371
+
1372
+ 你可以很容易地包装成一个扩展然后与他人分享!
1373
+
1374
+ 请注意 `find_template` 并不会检查文件真的存在,
1375
+ 而是对任何可能的路径调用给入的代码块。这并不会带来性能问题, 因为
1376
+ `render` 会在找到文件的时候马上使用 `break` 。
1377
+ 同样的,模板的路径(和内容)会在除development mode以外的场合
1378
+ 被缓存。你应该时刻提醒自己这一点, 如果你真的想写一个非常疯狂的方法。
1379
+
1380
+ ## 配置
1381
+
1382
+ 运行一次,在启动的时候,在任何环境下:
1383
+
1384
+ ~~~~ ruby
1385
+ configure do
1386
+ # setting one option
1387
+ set :option, 'value'
1388
+
1389
+ # setting multiple options
1390
+ set :a => 1, :b => 2
1391
+
1392
+ # same as `set :option, true`
1393
+ enable :option
1394
+
1395
+ # same as `set :option, false`
1396
+ disable :option
1397
+
1398
+ # you can also have dynamic settings with blocks
1399
+ set(:css_dir) { File.join(views, 'css') }
1400
+ end
1401
+ ~~~~
1402
+
1403
+ 只当环境 (RACK\_ENV environment 变量) 被设定为 `:production`的时候运行:
1404
+
1405
+ ~~~~ ruby
1406
+ configure :production do
1407
+ ...
1408
+ end
1409
+ ~~~~
1410
+
1411
+ 当环境被设定为 `:production` 或者 `:test`的时候运行:
1412
+
1413
+ ~~~~ ruby
1414
+ configure :production, :test do
1415
+ ...
1416
+ end
1417
+ ~~~~
1418
+
1419
+ 你可以使用 `settings` 获得这些配置:
1420
+
1421
+ ~~~~ ruby
1422
+ configure do
1423
+ set :foo, 'bar'
1424
+ end
1425
+
1426
+ get '/' do
1427
+ settings.foo? # => true
1428
+ settings.foo # => 'bar'
1429
+ ...
1430
+ end
1431
+ ~~~~
1432
+
1433
+ ### 可选的设置
1434
+
1435
+ <dl>
1436
+ <dt>absolute_redirects</dt>
1437
+ <dd>
1438
+ <p>
1439
+ 如果被禁用,Sinatra会允许使用相对路径重定向, 但是,Sinatra就不再遵守
1440
+ RFC 2616标准 (HTTP 1.1), 该标准只允许绝对路径重定向。
1441
+ </p>
1442
+
1443
+ <p>
1444
+ 如果你的应用运行在一个未恰当设置的反向代理之后,
1445
+ 你需要启用这个选项。注意 <tt>url</tt> 辅助方法 仍然会生成绝对 URL,除非你传入
1446
+ <tt>false</tt> 作为第二参数。
1447
+ </p>
1448
+ <p>
1449
+ 默认禁用。
1450
+ </p>
1451
+ </dd>
1452
+
1453
+ <dt>add_charsets</dt>
1454
+ <dd>
1455
+ <p>
1456
+ 设定 <tt>content_type</tt> 辅助方法会 自动加上字符集信息的多媒体类型。
1457
+ </p>
1458
+
1459
+ <p>
1460
+ 你应该添加而不是覆盖这个选项:
1461
+ <tt>settings.add_charsets << "application/foobar"</tt>
1462
+ </p>
1463
+ </dd>
1464
+
1465
+ <dt>app_file</dt>
1466
+ <dd>
1467
+ 主应用文件,用来检测项目的根路径, views和public文件夹和内联模板。
1468
+ </dd>
1469
+
1470
+ <dt>bind</dt>
1471
+ <dd>
1472
+ 绑定的IP 地址 (默认: 0.0.0.0)。 仅对于内置的服务器有用。
1473
+ </dd>
1474
+
1475
+ <dt>default_encoding</dt>
1476
+ <dd>
1477
+ 默认编码 (默认为 <tt>"utf-8"</tt>)。
1478
+ </dd>
1479
+
1480
+ <dt>dump_errors</dt>
1481
+ <dd>
1482
+ 在log中显示错误。
1483
+ </dd>
1484
+
1485
+ <dt>environment</dt>
1486
+ <dd>
1487
+ 当前环境,默认是 <tt>ENV['RACK_ENV']</tt>, 或者 <tt>"development"</tt> 如果不可用。
1488
+ </dd>
1489
+
1490
+ <dt>logging</dt>
1491
+ <dd>
1492
+ 使用logger
1493
+ </dd>
1494
+
1495
+ <dt>lock</dt>
1496
+ <dd>
1497
+ <p>
1498
+ 对每一个请求放置一个锁, 只使用进程并发处理请求。
1499
+ </p>
1500
+
1501
+ <p>
1502
+ 如果你的应用不是线程安全则需启动。 默认禁用。
1503
+ </p>
1504
+ </dd>
1505
+
1506
+ <dt>method_override</dt>
1507
+ <dd>
1508
+ 使用 <tt>_method</tt> 魔法以允许在旧的浏览器中在 表单中使用 put/delete 方法
1509
+ </dd>
1510
+
1511
+ <dt>port</dt>
1512
+ <dd>
1513
+ 监听的端口号。只对内置服务器有用。
1514
+ </dd>
1515
+
1516
+ <dt>prefixed_redirects</dt>
1517
+ <dd>
1518
+ 是否添加 <tt>request.script_name</tt> 到
1519
+ 重定向请求,如果没有设定绝对路径。那样的话 <tt>redirect '/foo'</tt> 会和
1520
+ <tt>redirect to('/foo')</tt>起相同作用。默认禁用。
1521
+ </dd>
1522
+
1523
+ <dt>public_folder</dt>
1524
+ <dd>
1525
+ public文件夹的位置。
1526
+ </dd>
1527
+
1528
+ <dt>reload_templates</dt>
1529
+ <dd>
1530
+ 是否每个请求都重新载入模板。 在development mode和 Ruby 1.8.6
1531
+ 中被企业(用来 消除一个Ruby内存泄漏的bug)。
1532
+ </dd>
1533
+
1534
+ <dt>root</dt>
1535
+ <dd>
1536
+ 项目的根目录。
1537
+ </dd>
1538
+
1539
+ <dt>raise_errors</dt>
1540
+ <dd>
1541
+ 抛出异常(应用会停下)。
1542
+ </dd>
1543
+
1544
+ <dt>run</dt>
1545
+ <dd>
1546
+ 如果启用,Sinatra会开启web服务器。 如果使用rackup或其他方式则不要启用。
1547
+ </dd>
1548
+
1549
+ <dt>running</dt>
1550
+ <dd>
1551
+ 内置的服务器在运行吗? 不要修改这个设置!
1552
+ </dd>
1553
+
1554
+ <dt>server</dt>
1555
+ <dd>
1556
+ 服务器,或用于内置服务器的列表。 默认是 [‘thin’, ‘mongrel’, ‘webrick’],
1557
+ 顺序表明了 优先级。
1558
+ </dd>
1559
+
1560
+ <dt>sessions</dt>
1561
+ <dd>
1562
+ 开启基于cookie的sesson。
1563
+ </dd>
1564
+
1565
+ <dt>show_exceptions</dt>
1566
+ <dd>
1567
+ 在浏览器中显示一个stack trace。
1568
+ </dd>
1569
+
1570
+ <dt>static</dt>
1571
+ <dd>
1572
+ Sinatra是否处理静态文件。 当服务器能够处理则禁用。 禁用会增强性能。
1573
+ 默认开启。
1574
+ </dd>
1575
+
1576
+ <dt>views</dt>
1577
+ <dd>
1578
+ views 文件夹。
1579
+ </dd>
1580
+ </dl>
1581
+
1582
+
1583
+ ## 错误处理
1584
+
1585
+ 错误处理在与路由和前置过滤器相同的上下文中运行,
1586
+ 这意味着你可以使用许多好东西,比如 `haml`, `erb`, `halt`,等等。
1587
+
1588
+ ### 未找到
1589
+
1590
+ 当一个 `Sinatra::NotFound` 错误被抛出的时候,
1591
+ 或者响应状态码是404,`not_found` 处理器会被调用:
1592
+
1593
+ ~~~~ ruby
1594
+ not_found do
1595
+ 'This is nowhere to be found'
1596
+ end
1597
+ ~~~~
1598
+
1599
+ ### 错误
1600
+
1601
+ `error` 处理器,在任何路由代码块或者过滤器抛出异常的时候会被调用。
1602
+ 异常对象可以通过`sinatra.error` Rack 变量获得:
1603
+
1604
+ ~~~~ ruby
1605
+ error do
1606
+ 'Sorry there was a nasty error - ' + env['sinatra.error'].name
1607
+ end
1608
+ ~~~~
1609
+
1610
+ 自定义错误:
1611
+
1612
+ ~~~~ ruby
1613
+ error MyCustomError do
1614
+ 'So what happened was...' + env['sinatra.error'].message
1615
+ end
1616
+ ~~~~
1617
+
1618
+ 那么,当这个发生的时候:
1619
+
1620
+ ~~~~ ruby
1621
+ get '/' do
1622
+ raise MyCustomError, 'something bad'
1623
+ end
1624
+ ~~~~
1625
+
1626
+ 你会得到:
1627
+
1628
+ So what happened was... something bad
1629
+
1630
+ 另一种替代方法是,为一个状态码安装错误处理器:
1631
+
1632
+ ~~~~ ruby
1633
+ error 403 do
1634
+ 'Access forbidden'
1635
+ end
1636
+
1637
+ get '/secret' do
1638
+ 403
1639
+ end
1640
+ ~~~~
1641
+
1642
+ 或者一个范围:
1643
+
1644
+ ~~~~ ruby
1645
+ error 400..510 do
1646
+ 'Boom'
1647
+ end
1648
+ ~~~~
1649
+
1650
+ 在运行在development环境下时,Sinatra会安装特殊的 `not_found` 和 `error`
1651
+ 处理器。
1652
+
1653
+ ## Rack 中间件
1654
+
1655
+ Sinatra 依靠 [Rack](http://rack.rubyforge.org/), 一个面向Ruby
1656
+ web框架的最小标准接口。
1657
+ Rack的一个最有趣的面向应用开发者的能力是支持“中间件”——坐落在服务器和你的应用之间,
1658
+ 监视 并/或 操作HTTP请求/响应以 提供多样类型的常用功能。
1659
+
1660
+ Sinatra 让建立Rack中间件管道异常简单, 通过顶层的 `use` 方法:
1661
+
1662
+ ~~~~ ruby
1663
+ require 'sinatra'
1664
+ require 'my_custom_middleware'
1665
+
1666
+ use Rack::Lint
1667
+ use MyCustomMiddleware
1668
+
1669
+ get '/hello' do
1670
+ 'Hello World'
1671
+ end
1672
+ ~~~~
1673
+
1674
+ `use` 的语义和在
1675
+ [Rack::Builder](http://rack.rubyforge.org/doc/classes/Rack/Builder.html)
1676
+ DSL(在rack文件中最频繁使用)中定义的完全一样。例如,`use` 方法接受
1677
+ 多个/可变 参数,包括代码块:
1678
+
1679
+ ~~~~ ruby
1680
+ use Rack::Auth::Basic do |username, password|
1681
+ username == 'admin' && password == 'secret'
1682
+ end
1683
+ ~~~~
1684
+
1685
+ Rack中分布有多样的标准中间件,针对日志,
1686
+ 调试,URL路由,认证和session处理。 Sinatra会自动使用这里面的大部分组件,
1687
+ 所以你一般不需要显示地 `use` 他们。
1688
+
1689
+ ## 测试
1690
+
1691
+ Sinatra的测试可以使用任何基于Rack的测试程序库或者框架来编写。
1692
+ [Rack::Test](http://gitrdoc.com/brynary/rack-test) 是推荐候选:
1693
+
1694
+ ~~~~ ruby
1695
+ require 'my_sinatra_app'
1696
+ require 'test/unit'
1697
+ require 'rack/test'
1698
+
1699
+ class MyAppTest < Test::Unit::TestCase
1700
+ include Rack::Test::Methods
1701
+
1702
+ def app
1703
+ Sinatra::Application
1704
+ end
1705
+
1706
+ def test_my_default
1707
+ get '/'
1708
+ assert_equal 'Hello World!', last_response.body
1709
+ end
1710
+
1711
+ def test_with_params
1712
+ get '/meet', :name => 'Frank'
1713
+ assert_equal 'Hello Frank!', last_response.body
1714
+ end
1715
+
1716
+ def test_with_rack_env
1717
+ get '/', {}, 'HTTP_USER_AGENT' => 'Songbird'
1718
+ assert_equal "You're using Songbird!", last_response.body
1719
+ end
1720
+ end
1721
+ ~~~~
1722
+
1723
+ 请注意: 内置的 Sinatra::Test 模块和 Sinatra::TestHarness 类 在 0.9.2
1724
+ 版本已废弃。
1725
+
1726
+ ## Sinatra::Base - 中间件,程序库和模块化应用
1727
+
1728
+ 把你的应用定义在顶层,对于微型应用这会工作得很好,
1729
+ 但是在构建可复用的组件时候会带来客观的不利, 比如构建Rack中间件,Rails
1730
+ metal,带有服务器组件的简单程序库,
1731
+ 或者甚至是Sinatra扩展。顶层的DSL污染了Object命名空间,
1732
+ 并假定了一个微型应用风格的配置 (例如, 单一的应用文件, ./public 和
1733
+ ./views 目录,日志,异常细节页面,等等)。 这时应该让 Sinatra::Base
1734
+ 走到台前了:
1735
+
1736
+ ~~~~ ruby
1737
+ require 'sinatra/base'
1738
+
1739
+ class MyApp < Sinatra::Base
1740
+ set :sessions, true
1741
+ set :foo, 'bar'
1742
+
1743
+ get '/' do
1744
+ 'Hello world!'
1745
+ end
1746
+ end
1747
+ ~~~~
1748
+
1749
+ Sinatra::Base子类可用的方法实际上就是通过顶层 DSL 可用的方法。
1750
+ 大部分顶层应用可以通过两个改变转换成Sinatra::Base组件:
1751
+
1752
+ - 你的文件应当引入 `sinatra/base` 而不是 `sinatra`;
1753
+ 否则,所有的Sinatra的 DSL 方法将会被引进到 主命名空间。
1754
+
1755
+ - 把你的应用的路由,错误处理,过滤器和选项放在
1756
+ 一个Sinatra::Base的子类中。
1757
+
1758
+ `+Sinatra::Base+` 是一张白纸。大部分的选项默认是禁用的,
1759
+ 包含内置的服务器。参见
1760
+ [选项和配置](http://sinatra.github.com/configuration.html)
1761
+ 查看可用选项的具体细节和他们的行为。
1762
+
1763
+ ### 模块化 vs. 传统的方式
1764
+
1765
+ 与通常的认识相反,传统的方式没有任何错误。
1766
+ 如果它适合你的应用,你不需要转换到模块化的应用。
1767
+
1768
+ 和模块化方式相比只有两个缺点:
1769
+
1770
+ - 你对每个Ruby进程只能定义一个Sinatra应用,如果你需要更多,
1771
+ 切换到模块化方式。
1772
+
1773
+ - 传统方式使用代理方法污染了 Object 。如果你打算 把你的应用封装进一个
1774
+ library/gem,转换到模块化方式。
1775
+
1776
+ 没有任何原因阻止你混合模块化和传统方式。
1777
+
1778
+ 如果从一种转换到另一种,你需要注意settings中的 一些微小的不同:
1779
+
1780
+ Setting Classic Modular
1781
+
1782
+ app_file file loading sinatra nil
1783
+ run $0 == app_file false
1784
+ logging true false
1785
+ method_override true false
1786
+ inline_templates true false
1787
+
1788
+ ### 运行一个模块化应用
1789
+
1790
+ 有两种方式运行一个模块化应用,使用 `run!`来运行:
1791
+
1792
+ ~~~~ ruby
1793
+ # my_app.rb
1794
+ require 'sinatra/base'
1795
+
1796
+ class MyApp < Sinatra::Base
1797
+ # ... app code here ...
1798
+
1799
+ # start the server if ruby file executed directly
1800
+ run! if app_file == $0
1801
+ end
1802
+ ~~~~
1803
+
1804
+ 运行:
1805
+
1806
+ ruby my_app.rb
1807
+
1808
+ 或者使用一个 `config.ru`,允许你使用任何Rack处理器:
1809
+
1810
+ ~~~~ ruby
1811
+ # config.ru
1812
+ require './my_app'
1813
+ run MyApp
1814
+ ~~~~
1815
+
1816
+ 运行:
1817
+
1818
+ rackup -p 4567
1819
+
1820
+ ### 使用config.ru运行传统方式的应用
1821
+
1822
+ 编写你的应用:
1823
+
1824
+ ~~~~ ruby
1825
+ # app.rb
1826
+ require 'sinatra'
1827
+
1828
+ get '/' do
1829
+ 'Hello world!'
1830
+ end
1831
+ ~~~~
1832
+
1833
+ 加入相应的 `config.ru`:
1834
+
1835
+ ~~~~ ruby
1836
+ require './app'
1837
+ run Sinatra::Application
1838
+ ~~~~
1839
+
1840
+ ### 什么时候用 config.ru?
1841
+
1842
+ 以下情况你可能需要使用 `config.ru`:
1843
+
1844
+ - 你要使用不同的 Rack 处理器部署 (Passenger, Unicorn, Heroku, …).
1845
+
1846
+ - 你想使用一个或者多个 `Sinatra::Base`的子类.
1847
+
1848
+ - 你只想把Sinatra当作中间件使用,而不是端点。
1849
+
1850
+ **你并不需要切换到`config.ru`仅仅因为你切换到模块化方式,
1851
+ 你同样不需要切换到模块化方式, 仅仅因为要运行 `config.ru`.**
1852
+
1853
+ ### 把Sinatra当成中间件来使用
1854
+
1855
+ 不仅Sinatra有能力使用其他的Rack中间件,任何Sinatra
1856
+ 应用程序都可以反过来自身被当作中间件,被加在任何Rack端点前面。
1857
+ 这个端点可以是任何Sinatra应用,或者任何基于Rack的应用程序
1858
+ (Rails/Ramaze/Camping/…)。
1859
+
1860
+ ~~~~ ruby
1861
+ require 'sinatra/base'
1862
+
1863
+ class LoginScreen < Sinatra::Base
1864
+ enable :sessions
1865
+
1866
+ get('/login') { haml :login }
1867
+
1868
+ post('/login') do
1869
+ if params[:name] = 'admin' and params[:password] = 'admin'
1870
+ session['user_name'] = params[:name]
1871
+ else
1872
+ redirect '/login'
1873
+ end
1874
+ end
1875
+ end
1876
+
1877
+ class MyApp < Sinatra::Base
1878
+ # 在前置过滤器前运行中间件
1879
+ use LoginScreen
1880
+
1881
+ before do
1882
+ unless session['user_name']
1883
+ halt "Access denied, please <a href='/login'>login</a>."
1884
+ end
1885
+ end
1886
+
1887
+ get('/') { "Hello #{session['user_name']}." }
1888
+ end
1889
+ ~~~~
1890
+
1891
+ ## 变量域和绑定
1892
+
1893
+ 当前所在的变量域决定了哪些方法和变量是可用的。
1894
+
1895
+ ### 应用/类 变量域
1896
+
1897
+ 每个Sinatra应用相当与Sinatra::Base的一个子类。
1898
+ 如果你在使用顶层DSL(`require 'sinatra'`),那么这个类就是
1899
+ Sinatra::Application,或者这个类就是你显式创建的子类。
1900
+ 在类层面,你具有的方法类似于 \`get\` 或者 \`before\`,但是你不能访问
1901
+ \`request\` 对象或者 \`session\`, 因为对于所有的请求,
1902
+ 只有单一的应用类。
1903
+
1904
+ 通过 \`set\` 创建的选项是类层面的方法:
1905
+
1906
+ ~~~~ ruby
1907
+ class MyApp < Sinatra::Base
1908
+ # 嘿,我在应用变量域!
1909
+ set :foo, 42
1910
+ foo # => 42
1911
+
1912
+ get '/foo' do
1913
+ # 嘿,我不再处于应用变量域了!
1914
+ end
1915
+ end
1916
+ ~~~~
1917
+
1918
+ 在下列情况下你将拥有应用变量域的绑定:
1919
+
1920
+ - 在应用类中
1921
+
1922
+ - 在扩展中定义的方法
1923
+
1924
+ - 传递给 \`helpers\` 的代码块
1925
+
1926
+ - 用作\`set\`值的过程/代码块
1927
+
1928
+ 你可以访问变量域对象(就是应用类)就像这样:
1929
+
1930
+ - 通过传递给代码块的对象 (`configure { |c| ... }`)
1931
+
1932
+ - 在请求变量域中使用\`settings\`
1933
+
1934
+ ### 请求/实例 变量域
1935
+
1936
+ 对于每个进入的请求,一个新的应用类的实例会被创建
1937
+ 所有的处理器代码块在该变量域被运行。在这个变量域中, 你可以访问
1938
+ \`request\` 和 \`session\` 对象,或者调用渲染方法比如 \`erb\` 或者
1939
+ \`haml\`。你可以在请求变量域当中通过\`settings\`辅助方法
1940
+ 访问应用变量域:
1941
+
1942
+ ~~~~ ruby
1943
+ class MyApp < Sinatra::Base
1944
+ # 嘿,我在应用变量域!
1945
+ get '/define_route/:name' do
1946
+ # 针对 '/define_route/:name' 的请求变量域
1947
+ @value = 42
1948
+
1949
+ settings.get("/#{params[:name]}") do
1950
+ # 针对 "/#{params[:name]}" 的请求变量域
1951
+ @value # => nil (并不是相同的请求)
1952
+ end
1953
+
1954
+ "Route defined!"
1955
+ end
1956
+ end
1957
+ ~~~~
1958
+
1959
+ 在以下情况将获得请求变量域:
1960
+
1961
+ - get/head/post/put/delete 代码块
1962
+
1963
+ - 前置/后置 过滤器
1964
+
1965
+ - 辅助方法
1966
+
1967
+ - 模板/视图
1968
+
1969
+ ### 代理变量域
1970
+
1971
+ 代理变量域只是把方法转送到类变量域。可是,
1972
+ 他并非表现得100%类似于类变量域, 因为你并不能获得类的绑定:
1973
+ 只有显式地标记为供代理使用的方法才是可用的,
1974
+ 而且你不能和类变量域共享变量/状态。(解释:你有了一个不同的 \`self\`)。
1975
+ 你可以显式地增加方法代理,通过调用
1976
+ `Sinatra::Delegator.delegate :method_name`。
1977
+
1978
+ 在以下情况将获得代理变量域:
1979
+
1980
+ - 顶层的绑定,如果你做过 `require "sinatra"`
1981
+
1982
+ - 在扩展了 \`Sinatra::Delegator\` mixin的对象
1983
+
1984
+ 自己在这里看一下代码: [Sinatra::Delegator
1985
+ mixin](http://github.com/sinatra/sinatra/blob/ceac46f0bc129a6e994a06100aa854f606fe5992/lib/sinatra/base.rb#L1128)
1986
+ 已经
1987
+ [被包含进了主命名空间](http://github.com/sinatra/sinatra/blob/ceac46f0bc129a6e994a06100aa854f606fe5992/lib/sinatra/main.rb#L28)。
1988
+
1989
+ ## 命令行
1990
+
1991
+ Sinatra 应用可以被直接运行:
1992
+
1993
+ ruby myapp.rb [-h] [-x] [-e ENVIRONMENT] [-p PORT] [-o HOST] [-s HANDLER]
1994
+
1995
+ 选项是:
1996
+
1997
+ -h # help
1998
+ -p # 设定端口 (默认是 4567)
1999
+ -o # 设定主机名 (默认是 0.0.0.0)
2000
+ -e # 设定环境 (默认是 development)
2001
+ -s # 限定 rack 服务器/处理器 (默认是 thin)
2002
+ -x # 打开互斥锁 (默认是 off)
2003
+
2004
+ ## 必要条件
2005
+
2006
+ 推荐在 Ruby 1.8.7, 1.9.2, JRuby 或者 Rubinius 上安装Sinatra。
2007
+
2008
+ 下面的Ruby版本是官方支持的:
2009
+
2010
+ <dl>
2011
+ <dt>Ruby 1.8.6</dt>
2012
+ <dd>
2013
+ 不推荐在1.8.6上安装Sinatra, 但是直到Sinatra
2014
+ 1.3.0发布才会放弃对它的支持。 RDoc 和
2015
+ CoffeScript模板不被这个Ruby版本支持。
2016
+ 1.8.6在它的Hash实现中包含一个内存泄漏问题,
2017
+ 该问题会被1.1.1版本之前的Sinatra引发。
2018
+ 当前版本使用性能下降的代价排除了这个问题。你需要把Rack降级到1.1.x,
2019
+ 因为Rack \>= 1.2不再支持1.8.6。
2020
+ </dd>
2021
+
2022
+ <dt>Ruby 1.8.7</dt>
2023
+ <dd>
2024
+ 1.8.7 被完全支持,但是,如果没有特别原因, 我们推荐你升级到 1.9.2
2025
+ 或者切换到 JRuby 或者 Rubinius.
2026
+ </dd>
2027
+
2028
+ <dt>Ruby 1.9.2</dt>
2029
+ <dd>
2030
+ 1.9.2 被支持而且推荐。注意 Radius 和 Markaby 模板并不和1.9兼容。不要使用
2031
+ 1.9.2p0, 它被已知会产生 segmentation faults.
2032
+ </dd>
2033
+
2034
+ <dt>Rubinius</dt>
2035
+ <dd>
2036
+ Rubinius 被官方支持 (Rubinius \>= 1.2.2), 除了Textile模板。
2037
+ </dd>
2038
+
2039
+ <dt>JRuby</dt>
2040
+ <dd>
2041
+ JRuby 被官方支持 (JRuby \>= 1.5.6)。 目前未知和第三方模板库有关的问题,
2042
+ 但是,如果你选择了JRuby,请查看一下JRuby rack 处理器, 因为 Thin web
2043
+ 服务器还没有在JRuby上获得支持。
2044
+ </dd>
2045
+ </dl>
2046
+
2047
+ 我们也会时刻关注新的Ruby版本。
2048
+
2049
+ 下面的 Ruby 实现没有被官方支持, 但是已知可以运行 Sinatra:
2050
+
2051
+ - JRuby 和 Rubinius 老版本
2052
+
2053
+ - MacRuby
2054
+
2055
+ - Maglev
2056
+
2057
+ - IronRuby
2058
+
2059
+ - Ruby 1.9.0 and 1.9.1
2060
+
2061
+ 不被官方支持的意思是,如果在不被支持的平台上有运行错误,
2062
+ 我们假定不是我们的问题,而是平台的问题。
2063
+
2064
+ Sinatra应该会运行在任何支持上述Ruby实现的操作系统。
2065
+
2066
+ ## 紧追前沿
2067
+
2068
+ 如果你喜欢使用 Sinatra 的最新鲜的代码,请放心的使用 master
2069
+ 分支来运行你的程序,它会非常的稳定。
2070
+
2071
+ cd myapp
2072
+ git clone git://github.com/sinatra/sinatra.git
2073
+ ruby -Isinatra/lib myapp.rb
2074
+
2075
+ 我们也会不定期的发布预发布gems,所以你也可以运行
2076
+
2077
+ gem install sinatra --pre
2078
+
2079
+ 来获得最新的特性。
2080
+
2081
+ ### 通过Bundler
2082
+
2083
+ 如果你想使用最新的Sinatra运行你的应用,通过
2084
+ [Bundler](http://gembundler.com/) 是推荐的方式。
2085
+
2086
+ 首先,安装bundler,如果你还没有安装:
2087
+
2088
+ gem install bundler
2089
+
2090
+ 然后,在你的项目目录下,创建一个 `Gemfile`:
2091
+
2092
+ ~~~~ ruby
2093
+ source :rubygems
2094
+ gem 'sinatra', :git => "git://github.com/sinatra/sinatra.git"
2095
+
2096
+ # 其他的依赖关系
2097
+ gem 'haml' # 举例,如果你想用haml
2098
+ gem 'activerecord', '~> 3.0' # 也许你还需要 ActiveRecord 3.x
2099
+ ~~~~
2100
+
2101
+ 请注意在这里你需要列出你的应用的所有依赖关系。 Sinatra的直接依赖关系
2102
+ (Rack and Tilt) 将会, 自动被Bundler获取和添加。
2103
+
2104
+ 现在你可以像这样运行你的应用:
2105
+
2106
+ bundle exec ruby myapp.rb
2107
+
2108
+ ### 使用自己的
2109
+
2110
+ 创建一个本地克隆并通过 `sinatra/lib` 目录运行你的应用, 通过
2111
+ `$LOAD_PATH`:
2112
+
2113
+ cd myapp
2114
+ git clone git://github.com/sinatra/sinatra.git
2115
+ ruby -Isinatra/lib myapp.rb
2116
+
2117
+ 为了在未来更新 Sinatra 源代码:
2118
+
2119
+ cd myapp/sinatra
2120
+ git pull
2121
+
2122
+ ### 全局安装
2123
+
2124
+ 你可以自行编译 gem :
2125
+
2126
+ git clone git://github.com/sinatra/sinatra.git
2127
+ cd sinatra
2128
+ rake sinatra.gemspec
2129
+ rake install
2130
+
2131
+ 如果你以root身份安装 gems,最后一步应该是
2132
+
2133
+ sudo rake install
2134
+
2135
+ ## 更多
2136
+
2137
+ - [项目主页(英文)](http://www.sinatrarb.com/) - 更多的文档,
2138
+ 新闻,和其他资源的链接。
2139
+
2140
+ - [贡献](http://www.sinatrarb.com/contributing) - 找到了一个bug?
2141
+ 需要帮助?有了一个 patch?
2142
+
2143
+ - [问题追踪](http://github.com/sinatra/sinatra/issues)
2144
+
2145
+ - [Twitter](http://twitter.com/sinatra)
2146
+
2147
+ - [邮件列表](http://groups.google.com/group/sinatrarb/topics)
2148
+
2149
+ - [IRC: \#sinatra](irc://chat.freenode.net/#sinatra) on
2150
+ [freenode.net](http://freenode.net)
2151
+
2152
+ - [Sinatra宝典](http://sinatra-book.gittr.com/) Cookbook教程
2153
+
2154
+ - [Sinatra使用技巧](http://recipes.sinatrarb.com/) 网友贡献的实用技巧
2155
+
2156
+ - [最新版本](http://rubydoc.info/gems/sinatra)API文档;[http://rubydoc.info](http://rubydoc.info)的[当前HEAD](http://rubydoc.info/github/sinatra/sinatra)
2157
+
2158
+ - [CI服务器](http://travis-ci.org/sinatra/sinatra)