sinatra 1.3.6 → 1.4.0.a

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.


This version of sinatra might be problematic. Click here for more details.

Files changed (71) hide show
  1. data/CHANGES +96 -22
  2. data/Gemfile +11 -3
  3. data/README.de.md +2590 -0
  4. data/README.es.rdoc +66 -38
  5. data/README.fr.md +2630 -0
  6. data/README.hu.rdoc +3 -2
  7. data/README.jp.rdoc +16 -3
  8. data/README.ko.rdoc +11 -5
  9. data/README.md +2699 -0
  10. data/README.pt-br.rdoc +152 -21
  11. data/README.pt-pt.rdoc +3 -2
  12. data/README.ru.md +2724 -0
  13. data/README.zh.rdoc +3 -3
  14. data/Rakefile +3 -4
  15. data/examples/chat.rb +3 -3
  16. data/lib/sinatra/base.rb +433 -247
  17. data/lib/sinatra/main.rb +4 -2
  18. data/lib/sinatra/showexceptions.rb +6 -1
  19. data/lib/sinatra/version.rb +1 -1
  20. data/test/base_test.rb +21 -9
  21. data/test/builder_test.rb +15 -19
  22. data/test/coffee_test.rb +4 -6
  23. data/test/compile_test.rb +154 -0
  24. data/test/contest.rb +4 -6
  25. data/test/creole_test.rb +5 -5
  26. data/test/delegator_test.rb +1 -3
  27. data/test/erb_test.rb +32 -20
  28. data/test/extensions_test.rb +1 -3
  29. data/test/filter_test.rb +65 -56
  30. data/test/haml_test.rb +34 -26
  31. data/test/helpers_test.rb +331 -221
  32. data/test/integration_helper.rb +8 -0
  33. data/test/integration_test.rb +3 -1
  34. data/test/less_test.rb +10 -8
  35. data/test/liquid_test.rb +22 -4
  36. data/test/mapped_error_test.rb +122 -96
  37. data/test/markaby_test.rb +5 -5
  38. data/test/markdown_test.rb +5 -5
  39. data/test/middleware_test.rb +3 -3
  40. data/test/nokogiri_test.rb +4 -6
  41. data/test/rabl_test.rb +89 -0
  42. data/test/radius_test.rb +4 -4
  43. data/test/rdoc_test.rb +7 -7
  44. data/test/readme_test.rb +14 -30
  45. data/test/request_test.rb +15 -0
  46. data/test/response_test.rb +3 -4
  47. data/test/result_test.rb +11 -33
  48. data/test/route_added_hook_test.rb +10 -10
  49. data/test/routing_test.rb +123 -1
  50. data/test/sass_test.rb +26 -26
  51. data/test/scss_test.rb +16 -16
  52. data/test/server_test.rb +2 -2
  53. data/test/settings_test.rb +48 -4
  54. data/test/sinatra_test.rb +2 -7
  55. data/test/slim_test.rb +37 -23
  56. data/test/static_test.rb +56 -15
  57. data/test/streaming_test.rb +11 -2
  58. data/test/templates_test.rb +117 -45
  59. data/test/textile_test.rb +9 -9
  60. data/test/views/hello.rabl +2 -0
  61. data/test/views/hello.wlang +1 -0
  62. data/test/views/hello.yajl +1 -0
  63. data/test/views/layout2.rabl +3 -0
  64. data/test/views/layout2.wlang +2 -0
  65. data/test/wlang_test.rb +87 -0
  66. data/test/yajl_test.rb +86 -0
  67. metadata +27 -17
  68. data/README.de.rdoc +0 -2097
  69. data/README.fr.rdoc +0 -2036
  70. data/README.rdoc +0 -2017
  71. data/README.ru.rdoc +0 -1785
@@ -1,1785 +0,0 @@
1
- = Sinatra
2
- <i>Внимание: Этот документ является переводом английской версии и может быть устаревшим</i>
3
-
4
- Sinatra — это предметно-ориентированный каркас (DSL) для быстрого создания функциональных веб-приложений на Ruby:
5
-
6
- # myapp.rb
7
- require 'sinatra'
8
-
9
- get '/' do
10
- 'Hello world!'
11
- end
12
-
13
- Установите gem:
14
-
15
- gem install sinatra
16
-
17
- и запустите приложение с помощью:
18
-
19
- ruby -rubygems myapp.rb
20
-
21
- Результат можно увидеть: http://localhost:4567
22
-
23
- Рекомендуется также установить thin, сделать это можно командой: <tt>gem install thin</tt>.
24
- Thin - это более производительный и функциональный сервер для разработки приложений на Sinatra.
25
-
26
- == Маршруты
27
-
28
- В Sinatra маршрут — это пара: <HTTP метод> и <шаблон URL>.
29
- Каждый маршрут ассоциирован с блоком кода, исполняемого внутри, пример:
30
-
31
- get '/' do
32
- .. что-то показать ..
33
- end
34
-
35
- post '/' do
36
- .. что-то создать ..
37
- end
38
-
39
- put '/' do
40
- .. что-то заменить ..
41
- end
42
-
43
- patch '/' do
44
- .. что-то изменить ..
45
- end
46
-
47
- delete '/' do
48
- .. что-то удалить ..
49
- end
50
-
51
- options '/' do
52
- .. что-то ответить ..
53
- end
54
-
55
- Маршруты сверяются с запросом в порядке очередности их записи в файле приложения. По умолчанию
56
- будет вызван первый совпавший с запросом маршрут.
57
-
58
- Шаблоны маршрутов могут включать в себя параметры доступные в
59
- <tt>params</tt> xэше:
60
-
61
- get '/hello/:name' do
62
- # соответствует "GET /hello/foo" и "GET /hello/bar",
63
- # где params[:name] 'foo' или 'bar'
64
- "Hello #{params[:name]}!"
65
- end
66
-
67
- Можно также использовать именные параметры в переменных блоков:
68
-
69
- get '/hello/:name' do |n|
70
- "Hello #{n}!"
71
- end
72
-
73
- Шаблоны маршрутов также могут включать splat (или '*' маску, обозначающую любой символ) параметры доступные
74
- в массиве <tt>params[:splat]</tt>:
75
-
76
- get '/say/*/to/*' do
77
- # соответствует /say/hello/to/world
78
- params[:splat] # => ["hello", "world"]
79
- end
80
-
81
- get '/download/*.*' do
82
- # соответствует /download/path/to/file.xml
83
- params[:splat] # => ["path/to/file", "xml"]
84
- end
85
-
86
- Или с параметрами блока:
87
-
88
- get '/download/*.*' do |path, ext|
89
- [path, ext] # => ["path/to/file", "xml"]
90
- end
91
-
92
- Маршруты также могут содержать регулярные выражения:
93
-
94
- get %r{/hello/([\w]+)} do
95
- "Hello, #{params[:captures].first}!"
96
- end
97
-
98
- Или с параметром блока:
99
-
100
- get %r{/hello/([\w]+)} do |c|
101
- "Hello, #{c}!"
102
- end
103
-
104
- === Условия
105
-
106
- Маршруты могут включать различные условия совпадений, такие как user agent:
107
-
108
- get '/foo', :agent => /Songbird (\d\.\d)[\d\/]*?/ do
109
- "You're using Songbird version #{params[:agent][0]}"
110
- end
111
-
112
- get '/foo' do
113
- # соответствует non-songbird браузерам
114
- end
115
-
116
- Другими доступными условиями являются +host_name+ и +provides+:
117
-
118
- get '/', :host_name => /^admin\./ do
119
- "Admin Area, Access denied!"
120
- end
121
-
122
- get '/', :provides => 'html' do
123
- haml :index
124
- end
125
-
126
- get '/', :provides => ['rss', 'atom', 'xml'] do
127
- builder :feed
128
- end
129
-
130
- Вы можете задать собственные условия:
131
-
132
- set(:probability) { |value| condition { rand <= value } }
133
-
134
- get '/win_a_car', :probability => 0.1 do
135
- "You won!"
136
- end
137
-
138
- get '/win_a_car' do
139
- "Sorry, you lost."
140
- end
141
-
142
- === Возвращаемые значения
143
-
144
- Возвращаемое значение блока маршрута ограничивается телом ответа, которое будет передано HTTP клиенту,
145
- или следующей "прослойкой" (middleware) в Rack стеке. Чаще всего это строка, как в примерах выше.
146
- Но и другие значения также приемлемы.
147
-
148
- Вы можете вернуть любой объект, который будет либо корректным Rack ответом, объектом Rack body,
149
- либо кодом состояния HTTP:
150
-
151
- * массив с тремя переменными: <tt>[status (Fixnum), headers (Hash), response body (должен отвечать на #each)]</tt>;
152
- * массив с двумя переменными: <tt>[status (Fixnum), response body (должен отвечать на #each)]</tt>;
153
- * объект, отвечающий на <tt>#each</tt>, который передает только строковые типы данных в этот блок;
154
- * Fixnum, представляющий код состояния HTTP.
155
-
156
- Таким образом, мы легко можем создать поточный пример:
157
-
158
- class Stream
159
- def each
160
- 100.times { |i| yield "#{i}\n" }
161
- end
162
- end
163
-
164
- get('/') { Stream.new }
165
-
166
- === Собственные детекторы совпадений для маршрутов
167
-
168
- Как показано выше, Sinatra поставляется со встроенной поддержкой строк и
169
- регулярных выражений в качестве шаблонов URL. Но и это еще не все. Вы можете
170
- легко определить свои собственные детекторы совпадений (matchers) для маршрутов:
171
-
172
- class AllButPattern
173
- Match = Struct.new(:captures)
174
-
175
- def initialize(except)
176
- @except = except
177
- @captures = Match.new([])
178
- end
179
-
180
- def match(str)
181
- @captures unless @except === str
182
- end
183
- end
184
-
185
- def all_but(pattern)
186
- AllButPattern.new(pattern)
187
- end
188
-
189
- get all_but("/index") do
190
- # ...
191
- end
192
-
193
- Заметьте, что предыдущий пример возможно чересчур сложен, он также может быть представлен как:
194
-
195
- get // do
196
- pass if request.path_info == "/index"
197
- # ...
198
- end
199
-
200
- Или с использованием негативного просмотра вперед:
201
-
202
- get %r{^(?!/index$)} do
203
- # ...
204
- end
205
-
206
- == Статические файлы
207
-
208
- Статические файлы отдаются из <tt>./public</tt> директории. Вы можете указать другое место,
209
- указав его через опцию <tt>:public_folder</tt>:
210
-
211
- set :public_folder, File.dirname(__FILE__) + '/static'
212
-
213
- Учтите, что имя директории со статическими файлами не включено в URL. Например, файл
214
- <tt>./public/css/style.css</tt> будет доступен как
215
- <tt>http://example.com/css/style.css</tt>.
216
-
217
- Используйте опцию <tt>:static_cache_control</tt> (см. ниже), чтобы
218
- добавить заголовок <tt>Cache-Control</tt>.
219
-
220
- == Представления / Шаблоны
221
-
222
- Каждый шаблонизатор представлен своим собственным методом. Эти методы
223
- попросту возвращают строку:
224
-
225
- get '/' do
226
- erb :index
227
- end
228
-
229
- Отобразит <tt>views/index.erb</tt>.
230
-
231
- Вместо имени шаблона вы так же можете передавать непосредственно само
232
- содержимое шаблона
233
-
234
- get '/' do
235
- code = "<%= Time.now %>"
236
- erb code
237
- end
238
-
239
- Эти методы принимают второй аргумент, хеш с опциями:
240
-
241
- get '/' do
242
- erb :index, :layout => :post
243
- end
244
-
245
- Отобразит <tt>views/index.erb</tt>, вложенным в
246
- <tt>views/post.erb</tt> (по умолчанию: <tt>views/layout.erb</tt>, если существует).
247
-
248
- Любые опции, не понимаемые Sinatra, будут переданы в шаблонизатор
249
-
250
- get '/' do
251
- haml :index, :format => :html5
252
- end
253
-
254
- Вы также можете задавать опции для шаблонизаторов в общем:
255
-
256
- set :haml, :format => :html5
257
-
258
- get '/' do
259
- haml :index
260
- end
261
-
262
- Опции, переданные в метод, переопределяют опции, заданные с помощью
263
- +set+.
264
-
265
- Доступные опции:
266
-
267
- [locals]
268
- Список локальных переменных, передаваемых в документ.
269
- Например: <tt>erb "<%= foo %>", :locals => {:foo => "bar"}</tt>
270
-
271
- [default_encoding]
272
- Кодировка, которую следует использовать, если не удалось определить
273
- оригинальную. По умолчанию: <tt>settings.default_encoding</tt>.
274
-
275
- [views]
276
- Директория с шаблонами. По умолчанию: <tt>settings.views</tt>.
277
-
278
- [layout]
279
- Использовать или нет лэйаут (+true+ или +false+). Если же значение Symbol,
280
- то указывает, какой шаблон использовать в качестве лэйаута. Например:
281
- <tt>erb :index, :layout => !request.xhr?</tt>
282
-
283
- [content_type]
284
- Content-Type отображенного шаблона. По умолчанию: задается шаблонизатором.
285
-
286
- [scope]
287
- Область видимости, в которой рендерятся шаблоны. По умолчанию: экземпляр
288
- приложения. Если вы измените эту опцию, то переменные экземпляра и
289
- методы-помощники станут недоступными в ваших шаблонах.
290
-
291
- [layout_engine]
292
- Шаблонизатор, который следует использовать для отображения лэйаута. Полезная
293
- опция для шаблонизаторов, в которых нет никакой поддержки лэйаутов. По
294
- умолчанию: тот же шаблонизатор, что используется и для самого шаблона.
295
- Пример: <tt>set :rdoc, :layout_engine => :erb</tt>
296
-
297
- По умолчанию считается, что шаблоны находятся в директории <tt>./views</tt>.
298
- Чтобы использовать другую директорию с шаблонами:
299
-
300
- set :views, settings.root + '/templates'
301
-
302
- Важное замечание: вы всегда должны ссылаться на шаблоны с помощью символов
303
- (Symbol), даже когда они в поддиректории (в этом случае используйте
304
- <tt>:'subdir/template'</tt>). Вы должны использовать символы, потому что
305
- иначе шаблонизаторы попросту отображают любые строки, переданные им.
306
-
307
- === Доступные шаблонизаторы
308
-
309
- Некоторые языки шаблонов имеют несколько реализаций. Чтобы указать, какую
310
- реализацию использовать, вам следует просто подключить нужную
311
- библиотеку:
312
-
313
- require 'rdiscount' # или require 'bluecloth'
314
- get('/') { markdown :index }
315
-
316
- === Haml шаблоны
317
-
318
- Зависимости:: {haml}[http://haml.info/]
319
- Расширения файлов:: <tt>.haml</tt>
320
- Пример:: <tt>haml :index, :format => :html5</tt>
321
-
322
- === Erb шаблоны
323
-
324
- Зависимости:: {erubis}[http://www.kuwata-lab.com/erubis/] или erb (включен в Ruby)
325
- Расширения файлов:: <tt>.erb</tt>, <tt>.rhtml</tt> or <tt>.erubis</tt> (только Erubis)
326
- Пример:: <tt>erb :index</tt>
327
-
328
- === Builder шаблоны
329
-
330
- Зависимости:: {builder}[http://builder.rubyforge.org/]
331
- Расширения файлов:: <tt>.builder</tt>
332
- Пример:: <tt>builder { |xml| xml.em "hi" }</tt>
333
-
334
- Блок также используется и для встроенных шаблонов (см. пример).
335
-
336
- === Nokogiri шаблоны
337
-
338
- Зависимости:: {nokogiri}[http://nokogiri.org/]
339
- Расширения файлов:: <tt>.nokogiri</tt>
340
- Пример:: <tt>nokogiri { |xml| xml.em "hi" }</tt>
341
-
342
- Блок также используется и для встроенных шаблонов (см. пример).
343
-
344
- === Sass шаблоны
345
-
346
- Зависимости:: {sass}[http://sass-lang.com/]
347
- Расширения файлов:: <tt>.sass</tt>
348
- Пример:: <tt>sass :stylesheet, :style => :expanded</tt>
349
-
350
- === SCSS шаблоны
351
-
352
- Зависимости:: {sass}[http://sass-lang.com/]
353
- Расширения файлов:: <tt>.scss</tt>
354
- Пример:: <tt>scss :stylesheet, :style => :expanded</tt>
355
-
356
- === Less шаблоны
357
-
358
- Зависимости:: {less}[http://www.lesscss.org/]
359
- Расширения файлов:: <tt>.less</tt>
360
- Пример:: <tt>less :stylesheet</tt>
361
-
362
- === Liquid шаблоны
363
-
364
- Зависимости:: {liquid}[http://www.liquidmarkup.org/]
365
- Расширения файлов:: <tt>.liquid</tt>
366
- Пример:: <tt>liquid :index, :locals => { :key => 'value' }</tt>
367
-
368
- Так как в Liquid шаблонах невозможно вызывать методы из Ruby (кроме yield), то
369
- вы почти всегда будете передавать в шаблон локальные переменные.
370
-
371
- === Markdown шаблоны
372
-
373
- Зависимости:: {rdiscount}[https://github.com/rtomayko/rdiscount], {redcarpet}[https://github.com/tanoku/redcarpet], {bluecloth}[http://deveiate.org/projects/BlueCloth], {kramdown}[http://kramdown.rubyforge.org/] или {maruku}[http://maruku.rubyforge.org/]
374
- Расширения файлов:: <tt>.markdown</tt>, <tt>.mkd</tt> and <tt>.md</tt>
375
- Пример:: <tt>markdown :index, :layout_engine => :erb</tt>
376
-
377
- В Markdown невозможно вызывать методы или передавать локальные переменные.
378
- Следовательно, вам, скорее всего, придется использовать этот шаблон совместно
379
- с другим шаблонизатором:
380
-
381
- erb :overview, :locals => { :text => markdown(:introduction) }
382
-
383
- Заметьте, что вы можете вызывать метод +markdown+ из других шаблонов:
384
-
385
- %h1 Hello From Haml!
386
- %p= markdown(:greetings)
387
-
388
- Вы не можете вызывать Ruby из Markdown, соответственно, вы не можете
389
- использовать лэйауты на Markdown. Тем не менее, есть возможность использовать
390
- один шаблонизатор для отображения шаблона, а другой для лэйаута с помощью
391
- опции <tt>:layout_engine</tt>.
392
-
393
- === Textile шаблоны
394
-
395
- Зависимости:: {RedCloth}[http://redcloth.org/]
396
- Расширения файлов:: <tt>.textile</tt>
397
- Пример:: <tt>textile :index, :layout_engine => :erb</tt>
398
-
399
- В Textile невозможно вызывать методы или передавать локальные переменные.
400
- Следовательно, вам, скорее всего, придется использовать этот шаблон совместно с
401
- другим шаблонизатором:
402
-
403
- erb :overview, :locals => { :text => textile(:introduction) }
404
-
405
- Заметьте, что вы можете вызывать метод +textile+ из других шаблонов:
406
-
407
- %h1 Hello From Haml!
408
- %p= textile(:greetings)
409
-
410
- Вы не можете вызывать Ruby из Textile, соответственно, вы не можете
411
- использовать лэйауты на Textile. Тем не менее, есть возможность использовать
412
- один шаблонизатор для отображения шаблона, а другой для лэйаута с помощью
413
- опции <tt>:layout_engine</tt>.
414
-
415
- === RDoc шаблоны
416
-
417
- Зависимости:: {rdoc}[http://rdoc.rubyforge.org/]
418
- Расширения файлов:: <tt>.rdoc</tt>
419
- Пример:: <tt>textile :README, :layout_engine => :erb</tt>
420
-
421
- В RDoc невозможно вызывать методы или передавать локальные переменные.
422
- Следовательно, вам, скорее всего, придется использовать этот шаблон совместно с
423
- другим шаблонизатором:
424
-
425
- erb :overview, :locals => { :text => rdoc(:introduction) }
426
-
427
- Заметьте, что вы можете вызывать метод +rdoc+ из других шаблонов:
428
-
429
- %h1 Hello From Haml!
430
- %p= rdoc(:greetings)
431
-
432
- Вы не можете вызывать Ruby из RDoc, соответственно, вы не можете
433
- использовать лэйауты на RDoc. Тем не менее, есть возможность использовать
434
- один шаблонизатор для отображения шаблона, а другой для лэйаута с помощью
435
- опции <tt>:layout_engine</tt>.
436
-
437
- === Radius шаблоны
438
-
439
- Зависимости:: {radius}[http://radius.rubyforge.org/]
440
- Расширения файлов:: <tt>.radius</tt>
441
- Пример:: <tt>radius :index, :locals => { :key => 'value' }</tt>
442
-
443
- Так как в Radius шаблонах невозможно вызывать методы из Ruby напрямую, то
444
- вы почти всегда будете передавать в шаблон локальные переменные.
445
-
446
- === Markaby шаблоны
447
-
448
- Зависимости:: {markaby}[http://markaby.github.com/]
449
- Расширения файлов:: <tt>.mab</tt>
450
- Пример:: <tt>markaby { h1 "Welcome!" }</tt>
451
-
452
- Блок также используется и для встроенных шаблонов (см. пример).
453
-
454
- === Slim шаблоны
455
-
456
- Зависимости:: {slim}[http://slim-lang.com/]
457
- Расширения файлов:: <tt>.slim</tt>
458
- Пример:: <tt>slim :index</tt>
459
-
460
- === Creole шаблоны
461
-
462
- Зависимости:: {creole}[https://github.com/minad/creole]
463
- Расширения файлов:: <tt>.creole</tt>
464
- Пример:: <tt>creole :wiki, :layout_engine => :erb</tt>
465
-
466
- В Creole невозможно вызывать методы или передавать локальные переменные.
467
- Следовательно, вам, скорее всего, придется использовать этот шаблон совместно с
468
- другим шаблонизатором:
469
-
470
- erb :overview, :locals => { :text => creole(:introduction) }
471
-
472
- Заметьте, что вы можете вызывать метод +creole+ из других шаблонов:
473
-
474
- %h1 Hello From Haml!
475
- %p= creole(:greetings)
476
-
477
- Вы не можете вызывать Ruby из Creole, соответственно, вы не можете
478
- использовать лэйауты на Creole. Тем не менее, есть возможность использовать
479
- один шаблонизатор для отображения шаблона, а другой для лэйаута с помощью
480
- опции <tt>:layout_engine</tt>.
481
-
482
- === CoffeeScript шаблоны
483
-
484
- Зависимости:: {coffee-script}[https://github.com/josh/ruby-coffee-script] и {способ запускать javascript}[https://github.com/sstephenson/execjs/blob/master/README.md#readme]
485
- Расширения файлов:: <tt>.coffee</tt>
486
- Пример:: <tt>coffee :index</tt>
487
-
488
- === Встроенные шаблоны
489
-
490
- get '/' do
491
- haml '%div.title Hello World'
492
- end
493
-
494
- Отобразит встроенный шаблон, переданный строкой.
495
-
496
- === Доступ к переменным в шаблонах
497
-
498
- Шаблоны интерпретируются в том же контексте, что и обработчики маршрутов. Переменные экземпляра,
499
- установленные в процессе обработки маршрутов, будут доступны напрямую в шаблонах:
500
-
501
- get '/:id' do
502
- @foo = Foo.find(params[:id])
503
- haml '%h1= @foo.name'
504
- end
505
-
506
- Либо установите их через хеш локальных переменных:
507
-
508
- get '/:id' do
509
- foo = Foo.find(params[:id])
510
- haml '%h1= bar.name', :locals => { :bar => foo }
511
- end
512
-
513
- Это обычный подход, когда шаблоны рендерятся как части других шаблонов.
514
-
515
- === Вложенные шаблоны
516
-
517
- Шаблоны также могут быть определены в конце исходного файла:
518
-
519
- require 'sinatra'
520
-
521
- get '/' do
522
- haml :index
523
- end
524
-
525
- __END__
526
-
527
- @@ layout
528
- %html
529
- = yield
530
-
531
- @@ index
532
- %div.title Hello world!!!!!
533
-
534
- Заметьте: вложенные шаблоны, определенные в исходном файле, который подключила Sinatra, будут
535
- автоматически загружены. Вызовите <tt>enable :inline_templates</tt> напрямую, если у вас вложенные
536
- шаблоны в других файлах.
537
-
538
- === Именные шаблоны
539
-
540
- Шаблоны также могут быть определены при помощи <tt>template</tt> метода:
541
-
542
- template :layout do
543
- "%html\n =yield\n"
544
- end
545
-
546
- template :index do
547
- '%div.title Hello World!'
548
- end
549
-
550
- get '/' do
551
- haml :index
552
- end
553
-
554
- Если шаблон с именем "layout" существует, то он будет использоваться каждый раз
555
- при рендеринге. Вы можете отключать лэйаут в каждом конкретном случае с помощью
556
- <tt>:layout => false</tt> или отключить его для всего приложения, например, так:
557
- <tt>set :haml, :layout => false</tt>:
558
-
559
- get '/' do
560
- haml :index, :layout => !request.xhr?
561
- end
562
-
563
- === Привязка файловых расширений
564
-
565
- Чтобы связать расширение файла с движком рендеринга, используйте
566
- <tt>Tilt.register</tt>. Например, если вы хотите использовать расширение +tt+
567
- для шаблонов Textile:
568
-
569
- Tilt.register :tt, Tilt[:textile]
570
-
571
- === Добавление собственного движка рендеринга
572
-
573
- Сначала зарегистрируйте свой движок в Tilt, затем создайте метод, отвечающий за отрисовку:
574
-
575
- Tilt.register :myat, MyAwesomeTemplateEngine
576
-
577
- helpers do
578
- def myat(*args) render(:myat, *args) end
579
- end
580
-
581
- get '/' do
582
- myat :index
583
- end
584
-
585
- Отобразит <tt>./views/index.myat</tt>. Чтобы узнать больше о Tilt,
586
- смотрите https://github.com/rtomayko/tilt
587
-
588
- == Фильтры
589
-
590
- +before+-фильтры выполняются перед каждым запросом в том же контексте, что и маршруты. Фильтры могут изменять
591
- как запрос, так и ответ на него. Переменные экземпляра, установленные в фильтрах, доступны в маршрутах и шаблонах:
592
-
593
- before do
594
- @note = 'Hi!'
595
- request.path_info = '/foo/bar/baz'
596
- end
597
-
598
- get '/foo/*' do
599
- @note #=> 'Hi!'
600
- params[:splat] #=> 'bar/baz'
601
- end
602
-
603
- +after+-фильтры выполняются после каждого запроса в том же контексте, что и пути. Фильтры могут изменять
604
- как запрос, так и ответ на него. Переменные экземпляра, установленные в +before+-фильтрах и маршрутах,
605
- будут доступны в +after+-фильтрах:
606
-
607
- after do
608
- puts response.status
609
- end
610
-
611
- Заметьте: если вы используете метод +body+, а не просто возвращаете строку из
612
- маршрута, то тело ответа не будет доступно в +after+-фильтрах, так как оно будет сгенерировано позднее.
613
-
614
- Фильтры могут использовать шаблоны URL и будут интерпретированы только если путь запроса совпадет с этим шаблоном:
615
-
616
- before '/protected/*' do
617
- authenticate!
618
- end
619
-
620
- after '/create/:slug' do |slug|
621
- session[:last_slug] = slug
622
- end
623
-
624
- Как и маршруты, фильтры могут использовать условия:
625
-
626
- before :agent => /Songbird/ do
627
- # ...
628
- end
629
-
630
- after '/blog/*', :host_name => 'example.com' do
631
- # ...
632
- end
633
-
634
- == Методы-помощники
635
-
636
- Используйте метод <tt>helpers</tt>, чтобы определить методы-помощники, которые
637
- в дальнейшем можно будет использовать в обработчиках маршрутов и шаблонах:
638
-
639
- helpers do
640
- def bar(name)
641
- "#{name}bar"
642
- end
643
- end
644
-
645
- get '/:name' do
646
- bar(params[:name])
647
- end
648
-
649
- === Использование сессий
650
-
651
- Сессия используется, чтобы сохранять состояние между запросами. Если эта опция
652
- включена, то у вас будет один хеш сессии на одну пользовательскую сессию:
653
-
654
- enable :sessions
655
-
656
- get '/' do
657
- "value = " << session[:value].inspect
658
- end
659
-
660
- get '/:value' do
661
- session[:value] = params[:value]
662
- end
663
-
664
- Заметьте, что при использовании <tt>enable :sessions</tt> все данные
665
- сохраняются в cookies. Это может быть не совсем то, что вы хотите (например,
666
- сохранение больших объемов данных увеличит ваш трафик). В таком случае вы
667
- можете использовать альтернативную Rack "прослойку" (middleware), реализующую
668
- механизм сессий. Для этого *не надо* вызывать <tt>enable :sessions</tt>,
669
- вместо этого следует подключить ее так же, как и любую другую "прослойку":
670
-
671
- use Rack::Session::Pool, :expire_after => 2592000
672
-
673
- get '/' do
674
- "value = " << session[:value].inspect
675
- end
676
-
677
- get '/:value' do
678
- session[:value] = params[:value]
679
- end
680
-
681
- Для повышения безопасности данные сессии в куках подписываются секретным
682
- ключом. Секретный ключ генерируется Sinatra. Тем не менее, так как этот
683
- ключ будет меняться с каждым запуском приложения, вы, возможно, захотите
684
- установить ключ вручную, чтобы у всех экземпляров вашего приложения
685
- был один и тот же ключ:
686
-
687
- set :session_secret, 'super secret'
688
-
689
- Если вы хотите больше настроек для сессий, вы можете задать их, передав хеш опций в параметр +sessions+:
690
-
691
- set :sessions, :domain => 'foo.com'
692
-
693
- === Прерывание
694
-
695
- Чтобы незамедлительно прервать обработку запроса внутри фильтра или маршрута, используйте:
696
-
697
- halt
698
-
699
- Можно также указать статус при прерывании:
700
-
701
- halt 410
702
-
703
- Тело:
704
-
705
- halt 'this will be the body'
706
-
707
- И то, и другое:
708
-
709
- halt 401, 'go away!'
710
-
711
- Можно указать заголовки:
712
-
713
- halt 402, {'Content-Type' => 'text/plain'}, 'revenge'
714
-
715
- И, конечно, можно использовать шаблоны с +halt+:
716
-
717
- halt erb(:error)
718
-
719
- === Передача
720
-
721
- Маршрут может передать обработку запроса следующему совпадающему маршруту, используя <tt>pass</tt>:
722
-
723
- get '/guess/:who' do
724
- pass unless params[:who] == 'Frank'
725
- 'You got me!'
726
- end
727
-
728
- get '/guess/*' do
729
- 'You missed!'
730
- end
731
-
732
- Блок маршрута сразу же прерывается, и контроль переходит к следующему совпадающему маршруту.
733
- Если соответствующий маршрут не найден, то ответом на запрос будет 404.
734
-
735
- === Вызов другого маршрута
736
-
737
- Иногда +pass+ не подходит, например, если вы хотите получить результат
738
- вызова другого обработчика маршрута. В таком случае просто используйте +call+:
739
-
740
- get '/foo' do
741
- status, headers, body = call env.merge("PATH_INFO" => '/bar')
742
- [status, headers, body.map(&:upcase)]
743
- end
744
-
745
- get '/bar' do
746
- "bar"
747
- end
748
-
749
- Заметьте, что в предыдущем примере можно облегчить тестирование и повысить
750
- производительность, перенеся <tt>"bar"</tt> в метод-помощник, используемый
751
- и в <tt>/foo</tt>, и в <tt>/bar</tt>.
752
-
753
- Если вы хотите, чтобы запрос был отправлен в тот же экземпляр приложения, а не
754
- в его копию, используйте <tt>call!</tt> вместо <tt>call</tt>.
755
-
756
- Если хотите узнать больше о <tt>call</tt>, смотрите спецификацию Rack.
757
-
758
- === Задание тела, кода и заголовков ответа
759
-
760
- Хорошим тоном является установка кода состояния HTTP и тела ответа в возвращаемом
761
- значении обработчика маршрута. Тем не менее, в некоторых ситуациях вам, возможно,
762
- понадобится задать тело ответа в произвольной точке потока исполнения. Вы можете
763
- сделать это с помощью метода-помощника +body+. Если вы задействуете метод +body+,
764
- то вы можете использовать его и в дальнейшем, чтобы получить доступ к телу ответа.
765
-
766
- get '/foo' do
767
- body "bar"
768
- end
769
-
770
- after do
771
- puts body
772
- end
773
-
774
- Также можно передать блок в метод +body+, который затем будет вызван
775
- обработчиком Rack (такой подход может быть использован для реализации поточного
776
- ответа, см. "Возвращаемые значения").
777
-
778
- Аналогично вы можете установить код ответа и его заголовки:
779
-
780
- get '/foo' do
781
- status 418
782
- headers \
783
- "Allow" => "BREW, POST, GET, PROPFIND, WHEN",
784
- "Refresh" => "Refresh: 20; http://www.ietf.org/rfc/rfc2324.txt"
785
- body "I'm a tea pot!"
786
- end
787
-
788
- Как и +body+, методы +headers+ и +status+, вызванные без аргументов, возвращают
789
- свои текущие значения.
790
-
791
- === Логирование
792
-
793
- В области видимости запроса метод +logger+ предоставляет доступ к экземпляру +Logger+:
794
-
795
- get '/' do
796
- logger.info "loading data"
797
- # ...
798
- end
799
-
800
- Этот логер автоматически учитывает ваши настройки логирования в Rack. Если
801
- логирование выключено, то этот метод вернет пустой (dummy) объект, поэтому вы можете
802
- смело использовать его в маршрутах и фильтрах.
803
-
804
- Заметьте, что логирование включено по умолчанию только для <tt>Sinatra::Application</tt>,
805
- а если ваше приложение -- подкласс <tt>Sinatra::Base</tt>, то вы, наверное, захотите включить
806
- его вручную:
807
-
808
- class MyApp < Sinatra::Base
809
- configure(:production, :development) do
810
- enable :logging
811
- end
812
- end
813
-
814
- === Mime-типы
815
-
816
- Когда вы используете <tt>send_file</tt> или статические файлы, у вас могут быть mime-типы, которые Sinatra
817
- не понимает по умолчанию. Используйте +mime_type+ для их регистрации по расширению файла:
818
-
819
- configure do
820
- mime_type :foo, 'text/foo'
821
- end
822
-
823
- Вы также можете использовать это в +content_type+ методе-помощнике:
824
-
825
- get '/' do
826
- content_type :foo
827
- "foo foo foo"
828
- end
829
-
830
- === Генерирование URL
831
-
832
- Чтобы сформировать URL вам следует использовать метод +url+, например, в Haml:
833
-
834
- %a{:href => url('/foo')} foo
835
-
836
- Этот метод учитывает обратные прокси и маршрутизаторы Rack, если они присутствуют.
837
-
838
- Наряду с +url+ вы можете использовать +to+ (смотрите пример ниже).
839
-
840
- === Перенаправление (редирект)
841
-
842
- Вы можете перенаправить браузер пользователя с помощью метода +redirect+:
843
-
844
- get '/foo' do
845
- redirect to('/bar')
846
- end
847
-
848
- Любые дополнительные параметры используются по аналогии с аргументами метода +halt+:
849
-
850
- redirect to('/bar'), 303
851
- redirect 'http://google.com', 'wrong place, buddy'
852
-
853
- Вы также можете перенаправить пользователя обратно, на страницу с которой он пришел,
854
- с помощью <tt>redirect back</tt>:
855
-
856
- get '/foo' do
857
- "<a href='/bar'>do something</a>"
858
- end
859
-
860
- get '/bar' do
861
- do_something
862
- redirect back
863
- end
864
-
865
- Чтобы передать какие-либо параметры вместе с перенаправлением, либо добавьте их в строку запроса:
866
-
867
- redirect to('/bar?sum=42')
868
-
869
- либо используйте сессию:
870
-
871
- enable :sessions
872
-
873
- get '/foo' do
874
- session[:secret] = 'foo'
875
- redirect to('/bar')
876
- end
877
-
878
- get '/bar' do
879
- session[:secret]
880
- end
881
-
882
- === Управление кэшированием
883
-
884
- Установка корректных заголовков — основа правильного HTTP кэширования.
885
-
886
- Вы можете легко выставить заголовок Cache-Control таким образом:
887
-
888
- get '/' do
889
- cache_control :public
890
- "cache it!"
891
- end
892
-
893
- Совет: задавайте кэширование в +before+-фильтре:
894
-
895
- before do
896
- cache_control :public, :must_revalidate, :max_age => 60
897
- end
898
-
899
- Если вы используете метод +expires+ для задания соответствующего заголовка,
900
- то <tt>Cache-Control</tt> будет выставлен автоматически:
901
-
902
- before do
903
- expires 500, :public, :must_revalidate
904
- end
905
-
906
- Чтобы как следует использовать кэширование, вам следует подумать об использовании
907
- +etag+ и +last_modified+. Рекомендуется использовать эти методы-помощники *до*
908
- выполнения ресурсоемких вычислений, так как они немедленно отправят ответ клиенту,
909
- если текущая версия уже есть в их кэше:
910
-
911
- get '/article/:id' do
912
- @article = Article.find params[:id]
913
- last_modified @article.updated_at
914
- etag @article.sha1
915
- erb :article
916
- end
917
-
918
- Также вы можете использовать
919
- {weak ETag}[http://en.wikipedia.org/wiki/HTTP_ETag#Strong_and_weak_validation]:
920
-
921
- etag @article.sha1, :weak
922
-
923
- Эти методы-помощники не станут ничего кэшировать для вас, но они дадут
924
- необходимую информацию для вашего кэша. Если вы ищите легкое решение для
925
- кэширования, попробуйте {rack-cache}[http://rtomayko.github.com/rack-cache/]:
926
-
927
- require 'rack/cache'
928
- require 'sinatra'
929
-
930
- use Rack::Cache
931
-
932
- get '/' do
933
- cache_control :public, :max_age => 36000
934
- sleep 5
935
- "hello"
936
- end
937
-
938
- Используйте опцию <tt>:static_cache_control</tt> (см. ниже), чтобы
939
- добавить заголовок <tt>Cache-Control</tt> к статическим файлам.
940
-
941
- === Отправка файлов
942
-
943
- Для отправки файлов пользователю вы можете использовать метод <tt>send_file</tt>:
944
-
945
- get '/' do
946
- send_file 'foo.png'
947
- end
948
-
949
- Этот метод имеет несколько опций:
950
-
951
- send_file 'foo.png', :type => :jpg
952
-
953
- Возможные опции:
954
-
955
- [filename]
956
- имя файла, по умолчанию: реальное имя файла.
957
-
958
- [last_modified]
959
- значение для заголовка Last-Modified, по умолчанию: mtime (время изменения) файла.
960
-
961
- [type]
962
- тип файла, по умолчанию: предполагается по расширению файла.
963
-
964
- [disposition]
965
- используется для заголовка Content-Disposition, возможные значения:
966
- +nil+ (по умолчанию), <tt>:attachment</tt> и <tt>:inline</tt>.
967
-
968
- [length]
969
- значения для заголовка Content-Length, по умолчанию: размер файла.
970
-
971
-
972
- Этот метод будет использовать возможности Rack сервера для отправки файлов, если они
973
- доступны, а в противном случае, будет напрямую отдавать файл из Ruby процесса.
974
- Метод <tt>send_file</tt> также обеспечивает автоматическую обработку частичных (range)
975
- запросов с помощью Sinatra.
976
-
977
- === Доступ к объекту запроса
978
-
979
- Объект входящего запроса доступен на уровне обработки запроса (в фильтрах, маршрутах,
980
- обработчиках ошибок) с помощью <tt>request</tt> метода:
981
-
982
- # приложение запущено на http://example.com/example
983
- get '/foo' do
984
- t = %w[text/css text/html application/javascript]
985
- request.accept # ['text/html', '*/*']
986
- request.accept? 'text/xml' # true
987
- request.preferred_type(t) # 'text/html'
988
- request.body # тело запроса, посланное клиентом (см. ниже)
989
- request.scheme # "http"
990
- request.script_name # "/example"
991
- request.path_info # "/foo"
992
- request.port # 80
993
- request.request_method # "GET"
994
- request.query_string # ""
995
- request.content_length # длина тела запроса
996
- request.media_type # медиатип тела запроса
997
- request.host # "example.com"
998
- request.get? # true (есть аналоги для других методов HTTP)
999
- request.form_data? # false
1000
- request["some_param"] # значение параметра some_param. Шорткат для хеша params
1001
- request.referrer # источник запроса клиента либо '/'
1002
- request.user_agent # user agent (используется для :agent условия)
1003
- request.cookies # хеш, содержащий cookies браузера
1004
- request.xhr? # является ли запрос ajax запросом?
1005
- request.url # "http://example.com/example/foo"
1006
- request.path # "/example/foo"
1007
- request.ip # IP-адрес клиента
1008
- request.secure? # false (true, если запрос сделан через SSL)
1009
- request.forwarded? # true (если сервер работает за обратным прокси)
1010
- request.env # "сырой" env хеш, полученный Rack
1011
- end
1012
-
1013
- Некоторые опции, такие как <tt>script_name</tt> или <tt>path_info</tt> доступны для изменения:
1014
-
1015
- before { request.path_info = "/" }
1016
-
1017
- get "/" do
1018
- "all requests end up here"
1019
- end
1020
-
1021
- <tt>request.body</tt> является IO или StringIO объектом:
1022
-
1023
- post "/api" do
1024
- request.body.rewind # в случае, если кто-то уже прочитал тело запроса
1025
- data = JSON.parse request.body.read
1026
- "Hello #{data['name']}!"
1027
- end
1028
-
1029
- === Вложения
1030
-
1031
- Вы можете использовать метод +attachment+, чтобы сказать браузеру, что ответ
1032
- сервера должен быть сохранен на диск, а не отображен:
1033
-
1034
- get '/' do
1035
- attachment
1036
- "store it!"
1037
- end
1038
-
1039
- Вы также можете указать имя файла:
1040
-
1041
- get '/' do
1042
- attachment "info.txt"
1043
- "store it!"
1044
- end
1045
-
1046
- === Поиск шаблонов
1047
-
1048
- Для поиска шаблонов и их последующего рендеринга используется метод <tt>find_template</tt>:
1049
-
1050
- find_template settings.views, 'foo', Tilt[:haml] do |file|
1051
- puts "could be #{file}"
1052
- end
1053
-
1054
- Это не слишком полезный пример. Зато полезен тот факт, что вы можете переопределить
1055
- этот метод, чтобы использовать свой собственный механизм поиска. Например, если вы
1056
- хотите, чтобы можно было использовать несколько директорий с шаблонами:
1057
-
1058
- set :views, ['views', 'templates']
1059
-
1060
- helpers do
1061
- def find_template(views, name, engine, &block)
1062
- Array(views).each { |v| super(v, name, engine, &block) }
1063
- end
1064
- end
1065
-
1066
- Другой пример, в котором используются разные директории для движков рендеринга:
1067
-
1068
- set :views, :sass => 'views/sass', :haml => 'templates', :default => 'views'
1069
-
1070
- helpers do
1071
- def find_template(views, name, engine, &block)
1072
- _, folder = views.detect { |k,v| engine == Tilt[k] }
1073
- folder ||= views[:default]
1074
- super(folder, name, engine, &block)
1075
- end
1076
- end
1077
-
1078
- Вы можете легко вынести этот код в расширение и поделиться им с остальными!
1079
-
1080
- Заметьте, что <tt>find_template</tt> не проверяет, существует ли файл на самом деле,
1081
- а вызывает заданный блок для всех возможных путей. Дело тут не в производительности,
1082
- дело в том, что +render+ вызовет +break+, как только файл не будет найден.
1083
- Содержимое и местонахождение шаблонов будет закэшировано, если приложение запущено не
1084
- в режиме разработки (set :environment, :development). Вы должны помнить об этих нюансах,
1085
- если пишите по-настоящему "сумасшедший" метод.
1086
-
1087
- == Конфигурация
1088
-
1089
- Этот блок исполняется один раз при старте в любом окружении, режиме (environment):
1090
-
1091
- configure do
1092
- # задание одной опции
1093
- set :option, 'value'
1094
-
1095
- # устанавливаем несколько опций
1096
- set :a => 1, :b => 2
1097
-
1098
- # то же самое, что и `set :option, true`
1099
- enable :option
1100
-
1101
- # то же самое, что и `set :option, false`
1102
- disable :option
1103
-
1104
- # у вас могут быть "динамические" опции с блоками
1105
- set(:css_dir) { File.join(views, 'css') }
1106
- end
1107
-
1108
- Будет запущено, когда окружение (RACK_ENV переменная) <tt>:production</tt>:
1109
-
1110
- configure :production do
1111
- ...
1112
- end
1113
-
1114
- Будет запущено, когда окружение <tt>:production</tt> или <tt>:test</tt>:
1115
-
1116
- configure :production, :test do
1117
- ...
1118
- end
1119
-
1120
- Вы можете получить доступ к этим опциям с помощью <tt>settings</tt>:
1121
-
1122
- configure do
1123
- set :foo, 'bar'
1124
- end
1125
-
1126
- get '/' do
1127
- settings.foo? # => true
1128
- settings.foo # => 'bar'
1129
- ...
1130
- end
1131
-
1132
- === Доступные настройки
1133
-
1134
- [absolute_redirects] если отключено, то Sinatra будет позволять использование
1135
- относительных перенаправлений, но при этом перестанет
1136
- соответствовать RFC 2616 (HTTP 1.1), который разрешает только
1137
- абсолютные перенаправления.
1138
-
1139
- Включайте эту опцию, если ваше приложение работает за обратным прокси,
1140
- который настроен не совсем корректно. Обратите внимание, метод +url+
1141
- все равно будет генерировать абсолютные URL, если вы не передадите
1142
- +false+ вторым аргументом.
1143
-
1144
- Отключено по умолчанию.
1145
-
1146
- [add_charsets] mime-типы, к которым метод <tt>content_type</tt> будет автоматически
1147
- добавлять информацию о кодировке.
1148
-
1149
- Вам следует добавлять значения к этой опции вместо ее переопределения:
1150
-
1151
- settings.add_charsets << "application/foobar"
1152
-
1153
- [app_file] главный файл приложения, используется для определения корневой директории
1154
- проекта, директорий с шаблонами и статическими файлами, вложенных шаблонов.
1155
-
1156
- [bind] используемый IP-адрес (по умолчанию: 0.0.0.0). Используется только
1157
- встроенным сервером.
1158
-
1159
- [default_encoding] кодировка, если неизвестна (по умолчанию: <tt>"utf-8"</tt>).
1160
-
1161
- [dump_errors] отображать ошибки в логе.
1162
-
1163
- [environment] текущее окружение, по умолчанию, значение <tt>ENV['RACK_ENV']</tt>
1164
- или <tt>"development"</tt>, если <tt>ENV['RACK_ENV']</tt> не доступна.
1165
-
1166
- [logging] использовать логер.
1167
-
1168
- [lock] создает блокировку для каждого запроса, которая гарантирует обработку
1169
- только одного запроса в текущий момент времени в Ruby процессе.
1170
-
1171
- Включайте, если ваше приложение не потоко-безопасно (thread-safe).
1172
- Отключено по умолчанию.
1173
-
1174
- [method_override] использовать "магический" параметр <tt>_method</tt>, чтобы позволить
1175
- использование PUT/DELETE форм в браузерах, которые не поддерживают
1176
- эти методы.
1177
-
1178
- [port] порт, на котором будет работать сервер. Используется только
1179
- встроенным сервером.
1180
-
1181
- [prefixed_redirects] добавлять или нет параметр <tt>request.script_name</tt> к редиректам,
1182
- если не задан абсолютный путь. Таким образом, <tt>redirect '/foo'</tt>
1183
- будет вести себя как <tt>redirect to('/foo')</tt>. Отключено по умолчанию.
1184
-
1185
- [public_folder] директория, откуда будут раздаваться статические файлы.
1186
-
1187
- [reload_templates] перезагружать или нет шаблоны на каждый запрос.
1188
- Включено в режиме разработки.
1189
-
1190
- [root] корневая директория проекта.
1191
-
1192
- [raise_errors] выбрасывать исключения (будет останавливать приложение).
1193
-
1194
- [run] если включено, Sinatra будет самостоятельно запускать веб-сервер.
1195
- Не включайте, если используете rackup или аналогичные средства.
1196
-
1197
- [running] работает ли сейчас встроенный сервер?
1198
- Не меняйте эту опцию!
1199
-
1200
- [server] сервер или список серверов, которые следует использовать в качестве
1201
- встроенного сервера. По умолчанию: ['thin', 'mongrel', 'webrick'],
1202
- порядок задает приоритет.
1203
-
1204
- [sessions] включить сессии на основе кук (cookie).
1205
-
1206
- [show_exceptions] показывать исключения/стек вызовов (stack trace) в браузере.
1207
-
1208
- [static] должна ли Sinatra осуществлять раздачу статических файлов.
1209
- Отключите, когда используете какой-либо веб-сервер для этой цели.
1210
- Отключение значительно улучшит производительность приложения.
1211
- По умолчанию включено в классических и отключено в модульных
1212
- приложениях.
1213
-
1214
- [static_cache_control] Когда Sinatra отдает статические файлы, используйте эту опцию,
1215
- чтобы добавить им заголовок <tt>Cache-Control</tt>. Для этого
1216
- используется метод-помощник +cache_control+. По умолчанию отключено.
1217
- Используйте массив, когда надо задать несколько значений:
1218
- <tt>set :static_cache_control, [:public, :max_age => 300]</tt>
1219
-
1220
- [views] директория с шаблонами.
1221
-
1222
- == Обработка ошибок
1223
-
1224
- Обработчики ошибок исполняются в том же контексте, что и маршруты, и +before+-фильтры, а это означает, что всякие
1225
- прелести вроде <tt>haml</tt>, <tt>erb</tt>, <tt>halt</tt> и т.д. доступны и им.
1226
-
1227
- === Not Found
1228
-
1229
- Когда выброшено исключение <tt>Sinatra::NotFound</tt>, или кодом ответа является 404,
1230
- то будет вызван <tt>not_found</tt> обработчик:
1231
-
1232
- not_found do
1233
- 'This is nowhere to be found.'
1234
- end
1235
-
1236
- === Ошибки
1237
-
1238
- Обработчик ошибок +error+ будет вызван, когда исключение выброшено из блока маршрута, либо из фильтра.
1239
- Объект-исключение доступен как переменная <tt>sinatra.error</tt> в Rack:
1240
-
1241
- error do
1242
- 'Sorry there was a nasty error - ' + env['sinatra.error'].name
1243
- end
1244
-
1245
- Частные ошибки:
1246
-
1247
- error MyCustomError do
1248
- 'So what happened was...' + env['sinatra.error'].message
1249
- end
1250
-
1251
- Тогда, если это произошло:
1252
-
1253
- get '/' do
1254
- raise MyCustomError, 'something bad'
1255
- end
1256
-
1257
- То вы получите:
1258
-
1259
- So what happened was... something bad
1260
-
1261
- Также вы можете установить обработчик ошибок для кода состояния HTTP:
1262
-
1263
- error 403 do
1264
- 'Access forbidden'
1265
- end
1266
-
1267
- get '/secret' do
1268
- 403
1269
- end
1270
-
1271
- Либо набора кодов:
1272
-
1273
- error 400..510 do
1274
- 'Boom'
1275
- end
1276
-
1277
- Sinatra устанавливает специальные <tt>not_found</tt> и <tt>error</tt> обработчики, когда приложение запущено в режиме
1278
- разработки (окружение <tt>:development</tt>).
1279
-
1280
- == Rack "прослойки"
1281
-
1282
- Sinatra использует Rack[http://rack.rubyforge.org/], минимальный стандартный
1283
- интерфейс для веб-фреймворков на Ruby. Одной из самых интересных для разработчиков возможностей Rack
1284
- является поддержка "прослоек" ("middleware") — компонентов,
1285
- находящихся "между" сервером и вашим приложением, которые отслеживают и/или манипулируют
1286
- HTTP запросами/ответами для предоставления различной функциональности.
1287
-
1288
- В Sinatra очень просто использовать такие "прослойки" с помощью метода +use+:
1289
-
1290
- require 'sinatra'
1291
- require 'my_custom_middleware'
1292
-
1293
- use Rack::Lint
1294
- use MyCustomMiddleware
1295
-
1296
- get '/hello' do
1297
- 'Hello World'
1298
- end
1299
-
1300
- Семантика +use+ идентична той, что определена для
1301
- Rack::Builder[http://rack.rubyforge.org/doc/classes/Rack/Builder.html] DSL
1302
- (чаще всего используется в rackup файлах). Например, метод +use+ принимает
1303
- как множественные переменные, так и блоки:
1304
-
1305
- use Rack::Auth::Basic do |username, password|
1306
- username == 'admin' && password == 'secret'
1307
- end
1308
-
1309
- Rack распространяется с различными стандартными "прослойками"
1310
- для логирования, отладки, маршрутизации URL, аутентификации, обработки сессий. Sinatra использует
1311
- многие из этих компонентов автоматически, основываясь на конфигурации, чтобы вам не приходилось
1312
- подключать (+use+) их вручную.
1313
-
1314
- Вы можете найти полезные прослойки в
1315
- {rack}[https://github.com/rack/rack/tree/master/lib/rack],
1316
- {rack-contrib}[https://github.com/rack/rack-contrib#readme],
1317
- {CodeRack}[http://coderack.org/] или в
1318
- {Rack wiki}[https://github.com/rack/rack/wiki/List-of-Middleware].
1319
-
1320
- == Тестирование
1321
-
1322
- Тесты для Sinatra приложений могут быть написаны с помощью библиотек, фреймворков, поддерживающих
1323
- тестирование Rack. {Rack::Test}[http://rdoc.info/github/brynary/rack-test/master/frames] рекомендован:
1324
-
1325
- require 'my_sinatra_app'
1326
- require 'test/unit'
1327
- require 'rack/test'
1328
-
1329
- class MyAppTest < Test::Unit::TestCase
1330
- include Rack::Test::Methods
1331
-
1332
- def app
1333
- Sinatra::Application
1334
- end
1335
-
1336
- def test_my_default
1337
- get '/'
1338
- assert_equal 'Hello World!', last_response.body
1339
- end
1340
-
1341
- def test_with_params
1342
- get '/meet', :name => 'Frank'
1343
- assert_equal 'Hello Frank!', last_response.body
1344
- end
1345
-
1346
- def test_with_rack_env
1347
- get '/', {}, 'HTTP_USER_AGENT' => 'Songbird'
1348
- assert_equal "You're using Songbird!", last_response.body
1349
- end
1350
- end
1351
-
1352
- == Sinatra::Base — "прослойки", библиотеки и модульные приложения
1353
-
1354
- Описание своего приложения самым простейшим способом (с помощью DSL верхнего уровня,
1355
- как в примерах выше) отлично работает для крохотных приложений. Тем не менее,
1356
- такой метод имеет множество недостатков при создании компонентов, таких как
1357
- Rack middleware ("прослоек"), Rails metal, простых библиотек с серверными компонентами,
1358
- расширений Sinatra.
1359
-
1360
- DSL верхнего уровня "загрязняет" пространство имен <tt>Object</tt> и подразумевает стиль конфигурации
1361
- микро-приложения (например, единый файл приложения, <tt>./public</tt> и
1362
- <tt>./views</tt> директории, логирование, страницу деталей об исключениях
1363
- и т.д.). И тут на помощь приходит <tt>Sinatra::Base</tt>:
1364
-
1365
- require 'sinatra/base'
1366
-
1367
- class MyApp < Sinatra::Base
1368
- set :sessions, true
1369
- set :foo, 'bar'
1370
-
1371
- get '/' do
1372
- 'Hello world!'
1373
- end
1374
- end
1375
-
1376
- Методы, доступные <tt>Sinatra::Base</tt> подклассам идентичны тем, что доступны
1377
- в DSL верхнего уровня. Большинство приложений верхнего уровня могут быть
1378
- конвертированы в <tt>Sinatra::Base</tt> компоненты с помощью двух модификаций:
1379
-
1380
- * Вы должны подключать <tt>sinatra/base</tt> вместо +sinatra+,
1381
- иначе все методы, предоставляемые Sinatra, будут импортированы в глобальное пространство имен.
1382
- * Поместите все маршруты, обработчики ошибок, фильтры и опции в подкласс <tt>Sinatra::Base</tt>.
1383
-
1384
- <tt>Sinatra::Base</tt> — это чистый лист. Большинство опций, включая встроенный сервер, по умолчанию отключены.
1385
- Смотрите {Опции и конфигурация}[http://www.sinatrarb.com/configuration.html] для детальной информации
1386
- об опциях и их поведении.
1387
-
1388
- === Модульные приложения против классических
1389
-
1390
- Вопреки всеобщему убеждению, в классическом стиле (самом простом) нет ничего плохого.
1391
- Если этот стиль подходит вашему приложению, вы не обязаны переписывать его в модульное
1392
- приложение.
1393
-
1394
- У классического стиля есть всего два недостатка относительно модульного:
1395
-
1396
- * У вас может быть только одно приложение Sinatra на один Ruby процесс. Если вы планируете
1397
- использовать больше, то переключайтесь на модульный стиль.
1398
-
1399
- * Приложения, использующие классический стиль, добавляют методы к Object. Если вы
1400
- планируете поставлять свое приложение в виде библиотеки/gem, то переходите
1401
- на модульный стиль.
1402
-
1403
- Не существует причин, по которым вы не могли бы смешивать модульный и классический стили.
1404
-
1405
- Переходя с одного стиля на другой, примите во внимание следующие изменения в настройках:
1406
-
1407
- Опция Классический Модульный
1408
-
1409
- app_file файл с приложением файл с подклассом Sinatra::Base
1410
- run $0 == app_file false
1411
- logging true false
1412
- method_override true false
1413
- inline_templates true false
1414
- static true false
1415
-
1416
-
1417
- === Запуск модульных приложений
1418
-
1419
- Есть два общепринятых способа запускать модульные приложения: запуск напрямую с помощью <tt>run!</tt>:
1420
-
1421
- # my_app.rb
1422
- require 'sinatra/base'
1423
-
1424
- class MyApp < Sinatra::Base
1425
- # ... здесь код приложения ...
1426
-
1427
- # запускаем сервер, если исполняется текущий файл
1428
- run! if app_file == $0
1429
- end
1430
-
1431
- И запускаем с помощью:
1432
-
1433
- ruby my_app.rb
1434
-
1435
- Или с помощью конфигурационного файла <tt>config.ru</tt>, который позволяет использовать любой
1436
- Rack-совместимый сервер приложений.
1437
-
1438
- # config.ru
1439
- require './my_app'
1440
- run MyApp
1441
-
1442
- Запускаем:
1443
-
1444
- rackup -p 4567
1445
-
1446
- === Запуск классических приложений с config.ru
1447
-
1448
- Файл приложения:
1449
-
1450
- # app.rb
1451
- require 'sinatra'
1452
-
1453
- get '/' do
1454
- 'Hello world!'
1455
- end
1456
-
1457
- И соответствующий <tt>config.ru</tt>:
1458
-
1459
- require './app'
1460
- run Sinatra::Application
1461
-
1462
- === Когда использовать config.ru?
1463
-
1464
- Вот несколько причин, по которым вы, возможно, захотите использовать <tt>config.ru</tt>:
1465
-
1466
- * вы хотите разворачивать свое приложение на различных Rack-совместимых серверах (Passenger, Unicorn,
1467
- Heroku, ...);
1468
- * вы хотите использовать более одного подкласса <tt>Sinatra::Base</tt>;
1469
- * вы хотите использовать Sinatra только в качестве "прослойки" Rack.
1470
-
1471
- <b>Совсем необязательно переходить на использование <tt>config.ru</tt> лишь потому, что вы стали
1472
- использовать модульный стиль приложения. И необязательно использовать модульный стиль, чтобы
1473
- запускать приложение с помощью <tt>config.ru</tt>.</b>
1474
-
1475
- === Использование Sinatra в качестве "прослойки"
1476
-
1477
- Не только сама Sinatra может использовать "прослойки" Rack, но и любое Sinatra приложение
1478
- само может быть добавлено к любому Rack endpoint в качестве "прослойки". Этим endpoint (конечной точкой)
1479
- может быть другое Sinatra приложение, или приложение, основанное на Rack (Rails/Ramaze/Camping/...):
1480
-
1481
- require 'sinatra/base'
1482
-
1483
- class LoginScreen < Sinatra::Base
1484
- enable :sessions
1485
-
1486
- get('/login') { haml :login }
1487
-
1488
- post('/login') do
1489
- if params[:name] == 'admin' && params[:password] == 'admin'
1490
- session['user_name'] = params[:name]
1491
- else
1492
- redirect '/login'
1493
- end
1494
- end
1495
- end
1496
-
1497
- class MyApp < Sinatra::Base
1498
- # "прослойка" будет запущена перед фильтрами
1499
- use LoginScreen
1500
-
1501
- before do
1502
- unless session['user_name']
1503
- halt "Access denied, please <a href='/login'>login</a>."
1504
- end
1505
- end
1506
-
1507
- get('/') { "Hello #{session['user_name']}." }
1508
- end
1509
-
1510
- === Создание приложений "на лету"
1511
-
1512
- Иногда требуется создавать Sinatra приложения "на лету" (например,
1513
- из другого приложения). Это возможно с помощью <tt>Sinatra.new</tt>:
1514
-
1515
- require 'sinatra/base'
1516
- my_app = Sinatra.new { get('/') { "hi" } }
1517
- my_app.run!
1518
-
1519
- Этот метод может принимать аргументом приложение, от которого
1520
- следует наследоваться:
1521
-
1522
- # config.ru
1523
- require 'sinatra/base'
1524
-
1525
- controller = Sinatra.new do
1526
- enable :logging
1527
- helpers MyHelpers
1528
- end
1529
-
1530
- map('/a') do
1531
- run Sinatra.new(controller) { get('/') { 'a' } }
1532
- end
1533
-
1534
- map('/b') do
1535
- run Sinatra.new(controller) { get('/') { 'b' } }
1536
- end
1537
-
1538
- Это особенно полезно для тестирования расширений Sinatra и при
1539
- использовании Sinatra внутри вашей библиотеки.
1540
-
1541
- Благодаря этому, использовать Sinatra как "прослойку" очень просто:
1542
-
1543
- require 'sinatra/base'
1544
-
1545
- use Sinatra do
1546
- get('/') { ... }
1547
- end
1548
-
1549
- run RailsProject::Application
1550
-
1551
-
1552
- == Области видимости и привязка
1553
-
1554
- Текущая область видимости определяет методы и переменные, доступные
1555
- в данный момент.
1556
-
1557
- === Область видимости приложения / класса
1558
-
1559
- Любое Sinatra приложение соответствует подклассу <tt>Sinatra::Base</tt>. Если вы
1560
- используете DSL верхнего уровня (<tt>require 'sinatra'</tt>), то этим классом будет
1561
- <tt>Sinatra::Application</tt>, иначе это будет подкласс, который вы создали вручную.
1562
- На уровне класса вам будут доступны такие методы, как +get+ или +before+, но вы
1563
- не сможете получить доступ к объектам +request+ или +session+, так как существует
1564
- только один класс приложения для всех запросов.
1565
-
1566
- Опции, созданные с помощью +set+, являются методами уровня класса:
1567
-
1568
- class MyApp < Sinatra::Base
1569
- # Я в области видимости приложения!
1570
- set :foo, 42
1571
- foo # => 42
1572
-
1573
- get '/foo' do
1574
- # Я больше не в области видимости приложения!
1575
- end
1576
- end
1577
-
1578
- У вас будет область видимости приложения внутри:
1579
-
1580
- * тела вашего класса приложения;
1581
- * методов, определенных расширениями;
1582
- * блока, переданного в +helpers+;
1583
- * блоков, использованных как значения для +set+;
1584
- * блока, переданного в <tt>Sinatra.new</tt>.
1585
-
1586
- Вы можете получить доступ к объекту области видимости (классу приложения) следующими способами:
1587
-
1588
- * через объект, переданный блокам конфигурации (<tt>configure { |c| ... }</tt>);
1589
- * +settings+ внутри области видимости запроса.
1590
-
1591
- === Область видимости запроса/экземпляра
1592
-
1593
- Для каждого входящего запроса будет создан новый экземпляр вашего приложения,
1594
- и все блоки обработчика будут запущены в этом контексте. В этой области
1595
- видимости вам доступны +request+ и +session+ объекты, вызовы методов
1596
- рендеринга, такие как +erb+ или +haml+. Вы можете получить доступ к
1597
- области видимости приложения из контекста запроса, используя метод-помощник +settings+:
1598
-
1599
- class MyApp < Sinatra::Base
1600
- # Я в области видимости приложения!
1601
- get '/define_route/:name' do
1602
- # Область видимости запроса '/define_route/:name'
1603
- @value = 42
1604
-
1605
- settings.get("/#{params[:name]}") do
1606
- # Область видимости запроса "/#{params[:name]}"
1607
- @value # => nil (другой запрос)
1608
- end
1609
-
1610
- "Route defined!"
1611
- end
1612
- end
1613
-
1614
- У вас будет область видимости запроса в:
1615
-
1616
- * get/head/post/put/delete/options блоках;
1617
- * before/after фильтрах;
1618
- * методах-помощниках;
1619
- * шаблонах/отображениях.
1620
-
1621
- === Область видимости делегирования
1622
-
1623
- Область видимости делегирования просто перенаправляет методы в область видимости класса.
1624
- Однако, она не полностью ведет себя как область видимости класса, так как у вас нет
1625
- привязки к классу. Только методы, явно помеченные для делегирования, будут доступны,
1626
- а переменных/состояний области видимости класса не будет (иначе говоря,
1627
- у вас будет другой +self+ объект). Вы можете
1628
- непосредственно добавить методы делегирования, используя
1629
- <tt>Sinatra::Delegator.delegate :method_name</tt>.
1630
-
1631
- У вас будет контекст делегирования внутри:
1632
-
1633
- * привязки верхнего уровня, если вы сделали <tt>require 'sinatra'</tt>;
1634
- * объекта, расширенного с помощью <tt>Sinatra::Delegator</tt>.
1635
-
1636
- Посмотрите сами в код: тут
1637
- {Sinatra::Delegator примесь}[http://github.com/sinatra/sinatra/blob/ceac46f0bc129a6e994a06100aa854f606fe5992/lib/sinatra/base.rb#L1128]
1638
- будет {включена в глобальное пространство имен}[http://github.com/sinatra/sinatra/blob/ceac46f0bc129a6e994a06100aa854f606fe5992/lib/sinatra/main.rb#L28].
1639
-
1640
- == Командная строка
1641
-
1642
- Sinatra приложения могут быть запущены напрямую:
1643
-
1644
- ruby myapp.rb [-h] [-x] [-e ENVIRONMENT] [-p PORT] [-o HOST] [-s HANDLER]
1645
-
1646
- Опции включают:
1647
-
1648
- -h # раздел помощи
1649
- -p # указание порта (по умолчанию 4567)
1650
- -o # указание хоста (по умолчанию 0.0.0.0)
1651
- -e # указание окружения, режима (по умолчанию development)
1652
- -s # указание rack сервера/обработчика (по умолчанию thin)
1653
- -x # включить мьютекс-блокировку (по умолчанию выключена)
1654
-
1655
- == Системные требования
1656
-
1657
- Следующие версии Ruby официально поддерживаются:
1658
-
1659
- [ Ruby 1.8.7 ]
1660
- 1.8.7 полностью поддерживается, тем не менее, если вас ничто не держит на
1661
- этой версии, рекомендуем обновиться до 1.9.2 или перейти на JRuby или Rubinius.
1662
-
1663
- [ Ruby 1.9.2 ]
1664
- 1.9.2 поддерживается и рекомендована к использованию. Заметьте, что Radius и Markaby
1665
- пока несовместимы с 1.9.2. Не используйте 1.9.2p0, известно, что эта
1666
- версия весьма нестабильна при использовании Sinatra.
1667
-
1668
- [ Rubinius ]
1669
- Rubinius официально поддерживается (Rubinius >= 1.2.3), всё, включая все
1670
- языки шаблонов, работает.
1671
-
1672
- [ JRuby ]
1673
- JRuby официально поддерживается (JRuby >= 1.6.1). Нет никаких проблем с
1674
- использованием альтернативных шаблонов. Тем не менее, если вы выбираете
1675
- JRuby, то, пожалуйста, посмотрите на JRuby Rack-сервера, так как Thin не
1676
- поддерживается полностью на JRuby. Поддержка расширений на C в JRuby все
1677
- еще экспериментальная, что на данный момент затрагивает только RDiscount и
1678
- Redcarpet.
1679
-
1680
- <b>Ruby 1.8.6 больше не поддерживается.</b> Если вы хотите запускать свое
1681
- приложение на 1.8.6, откатитесь до Sinatra 1.2, которая будет получать все
1682
- исправления ошибок до тех пор, пока не будет выпущена Sinatra 1.4.0
1683
-
1684
- Мы также следим за предстоящими к выходу версиями Ruby.
1685
-
1686
- Следующие реализации Ruby не поддерживаются официально, но известно, что на
1687
- них запускается Sinatra:
1688
-
1689
- * старые версии JRuby и Rubinius;
1690
- * MacRuby, Maglev, IronRuby;
1691
- * Ruby 1.9.0 и 1.9.1;
1692
- * Ruby 1.8.6 с помощью {backports}[https://github.com/marcandre/backports/#readme].
1693
-
1694
- То, что версия официально не поддерживается, означает, что, если что-то не
1695
- работает на этой версии, а на поддерживаемой работает - это не наша проблема, а их.
1696
-
1697
- Мы также запускаем наши CI-тесты на последней версии Ruby (предстоящей 1.9.3),
1698
- но мы не можем ничего гарантировать, так как она постоянно развивается.
1699
- Предполагается, что 1.9.3p0 будет поддерживаться.
1700
-
1701
- Sinatra должна работать на любой операционной системе, в которой есть одна из указанных выше версий Ruby.
1702
-
1703
- == На острие
1704
-
1705
- Если вы хотите использовать самый последний код Sinatra, не бойтесь запускать
1706
- свое приложение вместе с кодом из master ветки Sinatra, она весьма стабильна.
1707
-
1708
- Мы также время от времени выпускаем предварительные версии, так что вы можете делать так:
1709
-
1710
- gem install sinatra --pre
1711
-
1712
- Чтобы воспользоваться некоторыми самыми последними возможностями.
1713
-
1714
- === С помощью Bundler
1715
-
1716
- Если вы хотите запускать свое приложение с последней версией Sinatra, то
1717
- рекомендуем использовать {Bundler}[http://gembundler.com/].
1718
-
1719
- Сначала установите Bundler, если у вас его еще нет:
1720
-
1721
- gem install bundler
1722
-
1723
- Затем создайте файл +Gemfile+ в директории вашего проекта:
1724
-
1725
- source :rubygems
1726
- gem 'sinatra', :git => "git://github.com/sinatra/sinatra.git"
1727
-
1728
- # другие зависимости
1729
- gem 'haml' # например, если используете haml
1730
- gem 'activerecord', '~> 3.0' # может быть, вам нужен и ActiveRecord 3.x
1731
-
1732
- Обратите внимание, вам нужно будет указывать все зависимости вашего приложения
1733
- в этом файле. Однако, непосредственные зависимости Sinatra (Rack и Tilt) Bundler
1734
- автоматически скачает и добавит.
1735
-
1736
- Теперь вы можете запускать свое приложение так:
1737
-
1738
- bundle exec ruby myapp.rb
1739
-
1740
- === Вручную
1741
-
1742
- Создайте локальный клон репозитория и запускайте свое приложение с <tt>sinatra/lib</tt>
1743
- директорией в <tt>$LOAD_PATH</tt>:
1744
-
1745
- cd myapp
1746
- git clone git://github.com/sinatra/sinatra.git
1747
- ruby -Isinatra/lib myapp.rb
1748
-
1749
- Чтобы обновить исходники Sinatra:
1750
-
1751
- cd myapp/sinatra
1752
- git pull
1753
-
1754
- === Установка глобально
1755
-
1756
- Вы можете самостоятельно собрать gem:
1757
-
1758
- git clone git://github.com/sinatra/sinatra.git
1759
- cd sinatra
1760
- rake sinatra.gemspec
1761
- rake install
1762
-
1763
- Если вы устанавливаете пакеты (gem) от пользователя root, то вашим следующим шагом должна быть команда
1764
-
1765
- sudo rake install
1766
-
1767
- == Версии
1768
-
1769
- Sinatra использует {Semantic Versioning}[http://semver.org/], SemVer и
1770
- SemVerTag.
1771
-
1772
- == Дальнейшее чтение
1773
-
1774
- * {Веб-сайт проекта}[http://www.sinatrarb.com/] - Дополнительная документация,
1775
- новости и ссылки на другие ресурсы.
1776
- * {Участие в проекте}[http://www.sinatrarb.com/contributing] - Обнаружили баг? Нужна помощь? Написали патч?
1777
- * {Слежение за проблемами/ошибками}[http://github.com/sinatra/sinatra/issues]
1778
- * {Twitter}[http://twitter.com/sinatra]
1779
- * {Группы рассылки}[http://groups.google.com/group/sinatrarb/topics]
1780
- * {IRC: #sinatra}[irc://chat.freenode.net/#sinatra] на http://freenode.net
1781
- * {Sinatra Book}[http://sinatra-book.gittr.com] учебник и сборник рецептов
1782
- * {Sinatra Recipes}[http://recipes.sinatrarb.com/] сборник рецептов
1783
- * API документация к {последнему релизу}[http://rubydoc.info/gems/sinatra]
1784
- или {текущему HEAD}[http://rubydoc.info/github/sinatra/sinatra] на
1785
- http://rubydoc.info