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,2799 @@
1
+ # Sinatra
2
+
3
+ *Внимание: Этот документ является переводом английской версии и может быть
4
+ устаревшим*
5
+
6
+ Sinatra — это предметно-ориентированный каркас
7
+ ([DSL](http://ru.wikipedia.org/wiki/Предметно-ориентированный_язык_программирования))
8
+ для быстрого создания функциональных веб-приложений на Ruby с минимумом усилий:
9
+
10
+ ```ruby
11
+ # myapp.rb
12
+ require 'sinatra'
13
+
14
+ get '/' do
15
+ 'Hello world!'
16
+ end
17
+ ```
18
+
19
+ Установите gem:
20
+
21
+ ```
22
+ gem install sinatra
23
+ ```
24
+
25
+ и запустите приложение с помощью:
26
+
27
+ ```
28
+ ruby myapp.rb
29
+ ```
30
+
31
+ Оцените результат: http://localhost:4567
32
+
33
+ Рекомендуется также установить Thin, сделать это можно командой: `gem install
34
+ thin`. Thin — это более производительный и функциональный сервер для
35
+ разработки приложений на Sinatra.
36
+
37
+ ## Маршруты
38
+
39
+ В Sinatra маршрут — это пара: <HTTP метод> и <шаблон URL>. Каждый маршрут
40
+ связан с блоком кода:
41
+
42
+ ```ruby
43
+ get '/' do
44
+ # .. что-то показать ..
45
+ end
46
+
47
+ post '/' do
48
+ # .. что-то создать ..
49
+ end
50
+
51
+ put '/' do
52
+ # .. что-то заменить ..
53
+ end
54
+
55
+ patch '/' do
56
+ # .. что-то изменить ..
57
+ end
58
+
59
+ delete '/' do
60
+ # .. что-то удалить ..
61
+ end
62
+
63
+ options '/' do
64
+ # .. что-то ответить ..
65
+ end
66
+
67
+ link '/' do
68
+ .. что-то подключить ..
69
+ end
70
+
71
+ unlink '/' do
72
+ .. что-то отключить ..
73
+ end
74
+ ```
75
+
76
+ Маршруты сверяются с запросом в порядке очередности их записи в файле
77
+ приложения. Первый же совпавший с запросом маршрут и будет вызван.
78
+
79
+ Шаблоны маршрутов могут включать в себя именованные параметры, доступные в xэше
80
+ `params`:
81
+
82
+ ```ruby
83
+ get '/hello/:name' do
84
+ # соответствует "GET /hello/foo" и "GET /hello/bar",
85
+ # где params[:name] 'foo' или 'bar'
86
+ "Hello #{params[:name]}!"
87
+ end
88
+ ```
89
+
90
+ Также можно использовать именованные параметры в качестве переменных блока:
91
+
92
+ ```ruby
93
+ get '/hello/:name' do |n|
94
+ "Hello #{n}!"
95
+ end
96
+ ```
97
+
98
+ Шаблоны маршрутов также могут включать в себя splat (или '*' маску,
99
+ обозначающую любой символ) параметры, доступные в массиве `params[:splat]`:
100
+
101
+ ```ruby
102
+ get '/say/*/to/*' do
103
+ # соответствует /say/hello/to/world
104
+ params[:splat] # => ["hello", "world"]
105
+ end
106
+
107
+ get '/download/*.*' do
108
+ # соответствует /download/path/to/file.xml
109
+ params[:splat] # => ["path/to/file", "xml"]
110
+ end
111
+ ```
112
+
113
+ Или с параметрами блока:
114
+
115
+ ```ruby
116
+ get '/download/*.*' do |path, ext|
117
+ [path, ext] # => ["path/to/file", "xml"]
118
+ end
119
+ ```
120
+
121
+ Регулярные выражения в качестве шаблонов маршрутов:
122
+
123
+ ```ruby
124
+ get %r{/hello/([\w]+)} do
125
+ "Hello, #{params[:captures].first}!"
126
+ end
127
+ ```
128
+
129
+ Или с параметром блока:
130
+
131
+ ```ruby
132
+ get %r{/hello/([\w]+)} do |c|
133
+ "Hello, #{c}!"
134
+ end
135
+ ```
136
+
137
+ Шаблоны маршрутов могут иметь необязательные параметры:
138
+
139
+ ```ruby
140
+ get '/posts.?:format?' do
141
+ # соответствует "GET /posts", "GET /posts.json", "GET /posts.xml" и т.д.
142
+ end
143
+ ```
144
+
145
+ Кстати, если вы не отключите защиту от обратного пути в директориях (path
146
+ traversal, см. ниже), путь запроса может быть изменен до начала поиска
147
+ подходящего маршрута.
148
+
149
+ ### Условия
150
+
151
+ Маршруты могут включать различные условия совпадений, например, клиентское
152
+ приложение (user agent):
153
+
154
+ ```ruby
155
+ get '/foo', :agent => /Songbird (\d\.\d)[\d\/]*?/ do
156
+ "You're using Songbird version #{params[:agent][0]}"
157
+ end
158
+
159
+ get '/foo' do
160
+ # соответствует не-songbird браузерам
161
+ end
162
+ ```
163
+
164
+ Другими доступными условиями являются `host_name` и `provides`:
165
+
166
+ ```ruby
167
+ get '/', :host_name => /^admin\./ do
168
+ "Admin Area, Access denied!"
169
+ end
170
+
171
+ get '/', :provides => 'html' do
172
+ haml :index
173
+ end
174
+
175
+ get '/', :provides => ['rss', 'atom', 'xml'] do
176
+ builder :feed
177
+ end
178
+ ```
179
+
180
+ Вы можете задать собственные условия:
181
+
182
+ ```ruby
183
+ set(:probability) { |value| condition { rand <= value } }
184
+
185
+ get '/win_a_car', :probability => 0.1 do
186
+ "You won!"
187
+ end
188
+
189
+ get '/win_a_car' do
190
+ "Sorry, you lost."
191
+ end
192
+ ```
193
+
194
+ Для условия, которое принимает несколько параметров, используйте звездочку:
195
+
196
+ ```ruby
197
+ set(:auth) do |*roles| # <- обратите внимание на звездочку
198
+ condition do
199
+ unless logged_in? && roles.any? {|role| current_user.in_role? role }
200
+ redirect "/login/", 303
201
+ end
202
+ end
203
+ end
204
+
205
+ get "/my/account/", :auth => [:user, :admin] do
206
+ "Your Account Details"
207
+ end
208
+
209
+ get "/only/admin/", :auth => :admin do
210
+ "Only admins are allowed here!"
211
+ end
212
+ ```
213
+
214
+ ### Возвращаемые значения
215
+
216
+ Возвращаемое значение блока маршрута ограничивается телом ответа, которое
217
+ будет передано HTTP клиенту, или следующей "прослойкой" (middleware) в Rack
218
+ стеке. Чаще всего это строка, как в примерах выше. Но также приемлемы и
219
+ другие значения.
220
+
221
+ Вы можете вернуть любой объект, который будет либо корректным Rack ответом,
222
+ объектом Rack body, либо кодом состояния HTTP:
223
+
224
+ * массив с тремя переменными: `[код (Fixnum), заголовки (Hash), тело ответа
225
+ (должно отвечать на #each)]`;
226
+ * массив с двумя переменными: `[код (Fixnum), тело ответа (должно отвечать
227
+ на #each)]`;
228
+ * объект, отвечающий на `#each`, который передает только строковые типы
229
+ данных в этот блок;
230
+ * Fixnum, представляющий код состояния HTTP.
231
+
232
+
233
+ Таким образом, легко можно реализовать, например, поточный пример:
234
+
235
+ ```ruby
236
+ class Stream
237
+ def each
238
+ 100.times { |i| yield "#{i}\n" }
239
+ end
240
+ end
241
+
242
+ get('/') { Stream.new }
243
+ ```
244
+
245
+ Вы также можете использовать метод `stream` (описываемый ниже), чтобы
246
+ уменьшить количество дублируемого кода и держать логику стриминга прямо в
247
+ маршруте.
248
+
249
+ ### Собственные детекторы совпадений для маршрутов
250
+
251
+ Как показано выше, Sinatra поставляется со встроенной поддержкой строк и
252
+ регулярных выражений в качестве шаблонов URL. Но и это еще не все. Вы можете
253
+ легко определить свои собственные детекторы совпадений (matchers) для
254
+ маршрутов:
255
+
256
+ ```ruby
257
+ class AllButPattern
258
+ Match = Struct.new(:captures)
259
+
260
+ def initialize(except)
261
+ @except = except
262
+ @captures = Match.new([])
263
+ end
264
+
265
+ def match(str)
266
+ @captures unless @except === str
267
+ end
268
+ end
269
+
270
+ def all_but(pattern)
271
+ AllButPattern.new(pattern)
272
+ end
273
+
274
+ get all_but("/index") do
275
+ # ...
276
+ end
277
+ ```
278
+
279
+ Заметьте, что предыдущий пример, возможно, чересчур усложнен, потому что он
280
+ может быть реализован так:
281
+
282
+ ```ruby
283
+ get // do
284
+ pass if request.path_info == "/index"
285
+ # ...
286
+ end
287
+ ```
288
+
289
+ Или с использованием негативного просмотра вперед:
290
+
291
+ ```ruby
292
+ get %r{^(?!/index$)} do
293
+ # ...
294
+ end
295
+ ```
296
+
297
+ ## Статические файлы
298
+
299
+ Статические файлы отдаются из `./public` директории. Вы можете указать другое
300
+ место, используя опцию `:public_folder`:
301
+
302
+ ```ruby
303
+ set :public_folder, File.dirname(__FILE__) + '/static'
304
+ ```
305
+
306
+ Учтите, что имя директории со статическими файлами не включено в URL.
307
+ Например, файл `./public/css/style.css` будет доступен как
308
+ `http://example.com/css/style.css`.
309
+
310
+ Используйте опцию `:static_cache_control` (см. ниже), чтобы добавить заголовок
311
+ `Cache-Control`.
312
+
313
+ ## Представления / Шаблоны
314
+
315
+ Каждый шаблонизатор представлен своим собственным методом. Эти методы попросту
316
+ возвращают строку:
317
+
318
+ ```ruby
319
+ get '/' do
320
+ erb :index
321
+ end
322
+ ```
323
+
324
+ Отобразит `views/index.erb`.
325
+
326
+ Вместо имени шаблона вы так же можете передавать непосредственно само
327
+ содержимое шаблона:
328
+
329
+ ```ruby
330
+ get '/' do
331
+ code = "<%= Time.now %>"
332
+ erb code
333
+ end
334
+ ```
335
+
336
+ Эти методы принимают второй аргумент, хеш с опциями:
337
+
338
+ ```ruby
339
+ get '/' do
340
+ erb :index, :layout => :post
341
+ end
342
+ ```
343
+
344
+ Отобразит `views/index.erb`, вложенным в `views/post.erb` (по умолчанию:
345
+ `views/layout.erb`, если существует).
346
+
347
+ Любые опции, не понимаемые Sinatra, будут переданы в шаблонизатор:
348
+
349
+ ```ruby
350
+ get '/' do
351
+ haml :index, :format => :html5
352
+ end
353
+ ```
354
+
355
+ Вы также можете задавать опции для шаблонизаторов в общем:
356
+
357
+ ```ruby
358
+ set :haml, :format => :html5
359
+
360
+ get '/' do
361
+ haml :index
362
+ end
363
+ ```
364
+
365
+ Опции, переданные в метод, переопределяют опции, заданные с помощью `set`.
366
+
367
+ Доступные опции:
368
+
369
+ <dl>
370
+ <dt>locals</dt>
371
+ <dd>
372
+ Список локальных переменных, передаваемых в документ.
373
+ Например: <tt>erb "<%= foo %>", :locals => {:foo => "bar"}</tt>
374
+ </dd>
375
+
376
+ <dt>default_encoding</dt>
377
+ <dd>
378
+ Кодировка, которую следует использовать, если не удалось определить
379
+ оригинальную. По умолчанию: <tt>settings.default_encoding</tt>.
380
+ </dd>
381
+
382
+ <dt>views</dt>
383
+ <dd>
384
+ Директория с шаблонами. По умолчанию: <tt>settings.views</tt>.
385
+ </dd>
386
+
387
+ <dt>layout</dt>
388
+ <dd>
389
+ Использовать или нет лэйаут (<tt>true</tt> или <tt>false</tt>). Если же значение Symbol,
390
+ то указывает, какой шаблон использовать в качестве лэйаута. Например:
391
+ <tt>erb :index, :layout => !request.xhr?</tt>
392
+ </dd>
393
+
394
+ <dt>content_type</dt>
395
+ <dd>
396
+ Content-Type отображенного шаблона. По умолчанию: задается шаблонизатором.
397
+ </dd>
398
+
399
+ <dt>scope</dt>
400
+ <dd>
401
+ Область видимости, в которой рендерятся шаблоны. По умолчанию: экземпляр
402
+ приложения. Если вы измените эту опцию, то переменные экземпляра и
403
+ методы-помощники станут недоступными в ваших шаблонах.
404
+ </dd>
405
+
406
+ <dt>layout_engine</dt>
407
+ <dd>
408
+ Шаблонизатор, который следует использовать для отображения лэйаута.
409
+ Полезная опция для шаблонизаторов, в которых нет никакой поддержки
410
+ лэйаутов. По умолчанию: тот же шаблонизатор, что используется и для самого
411
+ шаблона. Пример: <tt>set :rdoc, :layout_engine => :erb</tt>
412
+ </dd>
413
+ </dl>
414
+
415
+ По умолчанию считается, что шаблоны находятся в директории `./views`. Чтобы
416
+ использовать другую директорию с шаблонами:
417
+
418
+ ```ruby
419
+ set :views, settings.root + '/templates'
420
+ ```
421
+
422
+ Важное замечание: вы всегда должны ссылаться на шаблоны с помощью символов
423
+ (Symbol), даже когда они в поддиректории (в этом случае используйте
424
+ `:'subdir/template'`). Вы должны использовать символы, потому что иначе
425
+ шаблонизаторы попросту отображают любые строки, переданные им.
426
+
427
+ ### Буквальные шаблоны
428
+
429
+ ```ruby
430
+ get '/' do
431
+ haml '%div.title Hello World'
432
+ end
433
+ ```
434
+
435
+ Отобразит шаблон, переданный строкой.
436
+
437
+ ### Доступные шаблонизаторы
438
+
439
+ Некоторые языки шаблонов имеют несколько реализаций. Чтобы указать, какую
440
+ реализацию использовать, вам следует просто подключить нужную библиотеку:
441
+
442
+ ```ruby
443
+ require 'rdiscount' # или require 'bluecloth'
444
+ get('/') { markdown :index }
445
+ ```
446
+
447
+ #### Haml шаблоны
448
+
449
+ <table>
450
+ <tr>
451
+ <td>Зависимости</td>
452
+ <td><a href="http://haml.info/" title="haml">haml</a></td>
453
+ </tr>
454
+ <tr>
455
+ <td>Расширения файлов</td>
456
+ <td><tt>.haml</tt></td>
457
+ </tr>
458
+ <tr>
459
+ <td>Пример</td>
460
+ <td><tt>haml :index, :format => :html5</tt></td>
461
+ </tr>
462
+ </table>
463
+
464
+ #### Erb шаблоны
465
+
466
+ <table>
467
+ <tr>
468
+ <td>Зависимости</td>
469
+ <td>
470
+ <a href="http://www.kuwata-lab.com/erubis/" title="erubis">erubis</a>
471
+ или erb (включен в Ruby)
472
+ </td>
473
+ </tr>
474
+ <tr>
475
+ <td>Расширения файлов</td>
476
+ <td><tt>.erb</tt>, <tt>.rhtml</tt> or <tt>.erubis</tt> (только Erubis)</td>
477
+ </tr>
478
+ <tr>
479
+ <td>Пример</td>
480
+ <td><tt>erb :index</tt></td>
481
+ </tr>
482
+ </table>
483
+
484
+ #### Builder шаблоны
485
+
486
+ <table>
487
+ <tr>
488
+ <td>Зависимости</td>
489
+ <td>
490
+ <a href="http://builder.rubyforge.org/" title="builder">builder</a>
491
+ </td>
492
+ </tr>
493
+ <tr>
494
+ <td>Расширения файлов</td>
495
+ <td><tt>.builder</tt></td>
496
+ </tr>
497
+ <tr>
498
+ <td>Пример</td>
499
+ <td><tt>builder { |xml| xml.em "hi" }</tt></td>
500
+ </tr>
501
+ </table>
502
+
503
+ Блок также используется и для встроенных шаблонов (см. пример).
504
+
505
+ #### Nokogiri шаблоны
506
+
507
+ <table>
508
+ <tr>
509
+ <td>Зависимости</td>
510
+ <td><a href="http://nokogiri.org/" title="nokogiri">nokogiri</a></td>
511
+ </tr>
512
+ <tr>
513
+ <td>Расширения файлов</td>
514
+ <td><tt>.nokogiri</tt></td>
515
+ </tr>
516
+ <tr>
517
+ <td>Пример</td>
518
+ <td><tt>nokogiri { |xml| xml.em "hi" }</tt></td>
519
+ </tr>
520
+ </table>
521
+
522
+ Блок также используется и для встроенных шаблонов (см. пример).
523
+
524
+ #### Sass шаблоны
525
+
526
+ <table>
527
+ <tr>
528
+ <td>Зависимости</td>
529
+ <td><a href="http://sass-lang.com/" title="sass">sass</a></td>
530
+ </tr>
531
+ <tr>
532
+ <td>Расширения файлов</td>
533
+ <td><tt>.sass</tt></td>
534
+ </tr>
535
+ <tr>
536
+ <td>Пример</td>
537
+ <td><tt>sass :stylesheet, :style => :expanded</tt></td>
538
+ </tr>
539
+ </table>
540
+
541
+ #### SCSS шаблоны
542
+
543
+ <table>
544
+ <tr>
545
+ <td>Зависимости</td>
546
+ <td><a href="http://sass-lang.com/" title="sass">sass</a></td>
547
+ </tr>
548
+ <tr>
549
+ <td>Расширения файлов</td>
550
+ <td><tt>.scss</tt></td>
551
+ </tr>
552
+ <tr>
553
+ <td>Пример</td>
554
+ <td><tt>scss :stylesheet, :style => :expanded</tt></td>
555
+ </tr>
556
+ </table>
557
+
558
+ #### Less шаблоны
559
+
560
+ <table>
561
+ <tr>
562
+ <td>Зависимости</td>
563
+ <td><a href="http://www.lesscss.org/" title="less">less</a></td>
564
+ </tr>
565
+ <tr>
566
+ <td>Расширения файлов</td>
567
+ <td><tt>.less</tt></td>
568
+ </tr>
569
+ <tr>
570
+ <td>Пример</td>
571
+ <td><tt>less :stylesheet</tt></td>
572
+ </tr>
573
+ </table>
574
+
575
+ #### Liquid шаблоны
576
+
577
+ <table>
578
+ <tr>
579
+ <td>Зависимости</td>
580
+ <td><a href="http://www.liquidmarkup.org/" title="liquid">liquid</a></td>
581
+ </tr>
582
+ <tr>
583
+ <td>Расширения файлов</td>
584
+ <td><tt>.liquid</tt></td>
585
+ </tr>
586
+ <tr>
587
+ <td>Пример</td>
588
+ <td><tt>liquid :index, :locals => { :key => 'value' }</tt></td>
589
+ </tr>
590
+ </table>
591
+
592
+ Так как в Liquid шаблонах невозможно вызывать методы из Ruby (кроме `yield`), то
593
+ вы почти всегда будете передавать в шаблон локальные переменные.
594
+
595
+ #### Markdown шаблоны
596
+
597
+ <table>
598
+ <tr>
599
+ <td>Зависимости</td>
600
+ <td>
601
+ Любая из библиотек:
602
+ <a href="https://github.com/rtomayko/rdiscount" title="RDiscount">RDiscount</a>,
603
+ <a href="https://github.com/vmg/redcarpet" title="RedCarpet">RedCarpet</a>,
604
+ <a href="http://deveiate.org/projects/BlueCloth" title="BlueCloth">BlueCloth</a>,
605
+ <a href="http://kramdown.rubyforge.org/" title="kramdown">kramdown</a>,
606
+ <a href="http://maruku.rubyforge.org/" title="maruku">maruku</a>
607
+ </td>
608
+ </tr>
609
+ <tr>
610
+ <td>Расширения файлов</td>
611
+ <td><tt>.markdown</tt>, <tt>.mkd</tt> and <tt>.md</tt></td>
612
+ </tr>
613
+ <tr>
614
+ <td>Пример</td>
615
+ <td><tt>markdown :index, :layout_engine => :erb</tt></td>
616
+ </tr>
617
+ </table>
618
+
619
+ В Markdown невозможно вызывать методы или передавать локальные переменные.
620
+ Следовательно, вам, скорее всего, придется использовать этот шаблон совместно
621
+ с другим шаблонизатором:
622
+
623
+ ```ruby
624
+ erb :overview, :locals => { :text => markdown(:introduction) }
625
+ ```
626
+
627
+ Заметьте, что вы можете вызывать метод `markdown` из других шаблонов:
628
+
629
+ ```ruby
630
+ %h1 Hello From Haml!
631
+ %p= markdown(:greetings)
632
+ ```
633
+
634
+ Вы не можете вызывать Ruby из Markdown, соответственно, вы не можете
635
+ использовать лэйауты на Markdown. Тем не менее, есть возможность использовать
636
+ один шаблонизатор для отображения шаблона, а другой для лэйаута с помощью
637
+ опции `:layout_engine`.
638
+
639
+ #### Textile шаблоны
640
+
641
+ <table>
642
+ <tr>
643
+ <td>Зависимости</td>
644
+ <td><a href="http://redcloth.org/" title="RedCloth">RedCloth</a></td>
645
+ </tr>
646
+ <tr>
647
+ <td>Расширения файлов</td>
648
+ <td><tt>.textile</tt></td>
649
+ </tr>
650
+ <tr>
651
+ <td>Пример</td>
652
+ <td><tt>textile :index, :layout_engine => :erb</tt></td>
653
+ </tr>
654
+ </table>
655
+
656
+ В Textile невозможно вызывать методы или передавать локальные переменные.
657
+ Следовательно, вам, скорее всего, придется использовать этот шаблон совместно
658
+ с другим шаблонизатором:
659
+
660
+ ```ruby
661
+ erb :overview, :locals => { :text => textile(:introduction) }
662
+ ```
663
+
664
+ Заметьте, что вы можете вызывать метод `textile` из других шаблонов:
665
+
666
+ ```ruby
667
+ %h1 Hello From Haml!
668
+ %p= textile(:greetings)
669
+ ```
670
+
671
+ Вы не можете вызывать Ruby из Textile, соответственно, вы не можете
672
+ использовать лэйауты на Textile. Тем не менее, есть возможность использовать
673
+ один шаблонизатор для отображения шаблона, а другой для лэйаута с помощью
674
+ опции `:layout_engine`.
675
+
676
+ #### RDoc шаблоны
677
+
678
+ <table>
679
+ <tr>
680
+ <td>Зависимости</td>
681
+ <td><a href="http://rdoc.rubyforge.org/" title="RDoc">RDoc</a></td>
682
+ </tr>
683
+ <tr>
684
+ <td>Расширения файлов</td>
685
+ <td><tt>.rdoc</tt></td>
686
+ </tr>
687
+ <tr>
688
+ <td>Пример</td>
689
+ <td><tt>rdoc :README, :layout_engine => :erb</tt></td>
690
+ </tr>
691
+ </table>
692
+
693
+ В RDoc невозможно вызывать методы или передавать локальные переменные.
694
+ Следовательно, вам, скорее всего, придется использовать этот шаблон совместно
695
+ с другим шаблонизатором:
696
+
697
+ ```ruby
698
+ erb :overview, :locals => { :text => rdoc(:introduction) }
699
+ ```
700
+
701
+ Заметьте, что вы можете вызывать метод `rdoc` из других шаблонов:
702
+
703
+ ```ruby
704
+ %h1 Hello From Haml!
705
+ %p= rdoc(:greetings)
706
+ ```
707
+
708
+ Вы не можете вызывать Ruby из RDoc, соответственно, вы не можете использовать
709
+ лэйауты на RDoc. Тем не менее, есть возможность использовать один шаблонизатор
710
+ для отображения шаблона, а другой для лэйаута с помощью опции
711
+ `:layout_engine`.
712
+
713
+ #### AsciiDoc шаблоны
714
+
715
+ <table>
716
+ <tr>
717
+ <td>Зависимости</td>
718
+ <td><a href="http://asciidoctor.org/" title="Asciidoctor">Asciidoctor</a></td>
719
+ </tr>
720
+ <tr>
721
+ <td>Расширения файлов</td>
722
+ <td><tt>.asciidoc</tt>, <tt>.adoc</tt> и <tt>.ad</tt></td>
723
+ </tr>
724
+ <tr>
725
+ <td>Пример</td>
726
+ <td><tt>asciidoc :README, :layout_engine => :erb</tt></td>
727
+ </tr>
728
+ </table>
729
+
730
+ Так как в AsciiDoc шаблонах невозможно вызывать методы из Ruby напрямую, то вы
731
+ почти всегда будете передавать в шаблон локальные переменные.
732
+
733
+ #### Radius шаблоны
734
+
735
+ <table>
736
+ <tr>
737
+ <td>Зависимости</td>
738
+ <td><a href="http://radius.rubyforge.org/" title="Radius">Radius</a></td>
739
+ </tr>
740
+ <tr>
741
+ <td>Расширения файлов</td>
742
+ <td><tt>.radius</tt></td>
743
+ </tr>
744
+ <tr>
745
+ <td>Пример</td>
746
+ <td><tt>radius :index, :locals => { :key => 'value' }</tt></td>
747
+ </tr>
748
+ </table>
749
+
750
+ Так как в Radius шаблонах невозможно вызывать методы из Ruby напрямую, то вы
751
+ почти всегда будете передавать в шаблон локальные переменные.
752
+
753
+ #### Markaby шаблоны
754
+
755
+ <table>
756
+ <tr>
757
+ <td>Зависимости</td>
758
+ <td><a href="http://markaby.github.com/" title="Markaby">Markaby</a></td>
759
+ </tr>
760
+ <tr>
761
+ <td>Расширения файлов</td>
762
+ <td><tt>.mab</tt></td>
763
+ </tr>
764
+ <tr>
765
+ <td>Пример</td>
766
+ <td><tt>markaby { h1 "Welcome!" }</tt></td>
767
+ </tr>
768
+ </table>
769
+
770
+ Блок также используется и для встроенных шаблонов (см. пример).
771
+
772
+ #### RABL шаблоны
773
+
774
+ <table>
775
+ <tr>
776
+ <td>Зависимости</td>
777
+ <td><a href="https://github.com/nesquena/rabl" title="Rabl">Rabl</a></td>
778
+ </tr>
779
+ <tr>
780
+ <td>Расширения файлов</td>
781
+ <td><tt>.rabl</tt></td>
782
+ </tr>
783
+ <tr>
784
+ <td>Пример</td>
785
+ <td><tt>rabl :index</tt></td>
786
+ </tr>
787
+ </table>
788
+
789
+ #### Slim шаблоны
790
+
791
+ <table>
792
+ <tr>
793
+ <td>Зависимости</td>
794
+ <td><a href="http://slim-lang.com/" title="Slim Lang">Slim Lang</a></td>
795
+ </tr>
796
+ <tr>
797
+ <td>Расширения файлов</td>
798
+ <td><tt>.slim</tt></td>
799
+ </tr>
800
+ <tr>
801
+ <td>Пример</td>
802
+ <td><tt>slim :index</tt></td>
803
+ </tr>
804
+ </table>
805
+
806
+ #### Creole шаблоны
807
+
808
+ <table>
809
+ <tr>
810
+ <td>Зависимости</td>
811
+ <td><a href="https://github.com/minad/creole" title="Creole">Creole</a></td>
812
+ </tr>
813
+ <tr>
814
+ <td>Расширения файлов</td>
815
+ <td><tt>.creole</tt></td>
816
+ </tr>
817
+ <tr>
818
+ <td>Пример</td>
819
+ <td><tt>creole :wiki, :layout_engine => :erb</tt></td>
820
+ </tr>
821
+ </table>
822
+
823
+ В Creole невозможно вызывать методы или передавать локальные переменные.
824
+ Следовательно, вам, скорее всего, придется использовать этот шаблон совместно
825
+ с другим шаблонизатором:
826
+
827
+ ```ruby
828
+ erb :overview, :locals => { :text => creole(:introduction) }
829
+ ```
830
+
831
+ Заметьте, что вы можете вызывать метод `creole` из других шаблонов:
832
+
833
+ ```ruby
834
+ %h1 Hello From Haml!
835
+ %p= creole(:greetings)
836
+ ```
837
+
838
+ Вы не можете вызывать Ruby из Creole, соответственно, вы не можете
839
+ использовать лэйауты на Creole. Тем не менее, есть возможность использовать
840
+ один шаблонизатор для отображения шаблона, а другой для лэйаута с помощью
841
+ опции `:layout_engine`.
842
+
843
+ #### MediaWiki шаблоны
844
+
845
+ <table>
846
+ <tr>
847
+ <td>Зависимости</td>
848
+ <td><a href="https://github.com/nricciar/wikicloth" title="WikiCloth">WikiCloth</a></td>
849
+ </tr>
850
+ <tr>
851
+ <td>Расширения файлов</td>
852
+ <td><tt>.mediawiki</tt> и <tt>.mw</tt></td>
853
+ </tr>
854
+ <tr>
855
+ <td>Пример</td>
856
+ <td><tt>mediawiki :wiki, :layout_engine => :erb</tt></td>
857
+ </tr>
858
+ </table>
859
+
860
+ В разметке MediaWiki невозможно вызывать методы или передавать локальные переменные.
861
+ Следовательно, вам, скорее всего, придется использовать этот шаблон совместно
862
+ с другим шаблонизатором:
863
+
864
+ ```ruby
865
+ erb :overview, :locals => { :text => mediawiki(:introduction) }
866
+ ```
867
+
868
+ Заметьте, что вы можете вызывать метод `mediawiki` из других шаблонов:
869
+
870
+ ```ruby
871
+ %h1 Hello From Haml!
872
+ %p= mediawiki(:greetings)
873
+ ```
874
+
875
+ Вы не можете вызывать Ruby из MediaWiki, соответственно, вы не можете
876
+ использовать лэйауты на MediaWiki. Тем не менее, есть возможность использовать
877
+ один шаблонизатор для отображения шаблона, а другой для лэйаута с помощью
878
+ опции `:layout_engine`.
879
+
880
+ #### CoffeeScript шаблоны
881
+
882
+ <table>
883
+ <tr>
884
+ <td>Зависимости</td>
885
+ <td>
886
+ <a href="https://github.com/josh/ruby-coffee-script" title="Ruby CoffeeScript">
887
+ CoffeeScript
888
+ </a> и способ
889
+ <a href="https://github.com/sstephenson/execjs/blob/master/README.md#readme" title="ExecJS">
890
+ запускать JavaScript
891
+ </a>
892
+ </td>
893
+ </tr>
894
+ <tr>
895
+ <td>Расширения файлов</td>
896
+ <td><tt>.coffee</tt></td>
897
+ </tr>
898
+ <tr>
899
+ <td>Пример</td>
900
+ <td><tt>coffee :index</tt></td>
901
+ </tr>
902
+ </table>
903
+
904
+ #### Yajl шаблоны
905
+
906
+ <table>
907
+ <tr>
908
+ <td>Зависимости</td>
909
+ <td><a href="https://github.com/brianmario/yajl-ruby" title="yajl-ruby">yajl-ruby</a></td>
910
+ </tr>
911
+ <tr>
912
+ <td>Расширения файлов</td>
913
+ <td><tt>.yajl</tt></td>
914
+ </tr>
915
+ <tr>
916
+ <td>Пример</td>
917
+ <td>
918
+ <tt>
919
+ yajl :index,
920
+ :locals => { :key => 'qux' },
921
+ :callback => 'present',
922
+ :variable => 'resource'
923
+ </tt>
924
+ </td>
925
+ </tr>
926
+ </table>
927
+
928
+ Содержимое шаблона интерпретируется как код на Ruby, а результирующая
929
+ переменная json затем конвертируется с помощью `#to_json`.
930
+
931
+ ```ruby
932
+ json = { :foo => 'bar' }
933
+ json[:baz] = key
934
+ ```
935
+
936
+ Опции `:callback` и `:variable` используются для "декорирования" итогового
937
+ объекта.
938
+
939
+ ```ruby
940
+ var resource = {"foo":"bar","baz":"qux"}; present(resource);
941
+ ```
942
+
943
+ #### WLang шаблоны
944
+
945
+ <table>
946
+ <tr>
947
+ <td>Зависимости</td>
948
+ <td><a href="https://github.com/blambeau/wlang/" title="wlang">wlang</a></td>
949
+ </tr>
950
+ <tr>
951
+ <td>Расширения файлов</td>
952
+ <td><tt>.wlang</tt></td>
953
+ </tr>
954
+ <tr>
955
+ <td>Пример</td>
956
+ <td><tt>wlang :index, :locals => { :key => 'value' }</tt></td>
957
+ </tr>
958
+ </table>
959
+
960
+ Так как в WLang шаблонах невозможно вызывать методы из Ruby напрямую (за
961
+ исключением `yield`), то вы почти всегда будете передавать в шаблон локальные
962
+ переменные.
963
+
964
+ ### Доступ к переменным в шаблонах
965
+
966
+ Шаблоны интерпретируются в том же контексте, что и обработчики маршрутов.
967
+ Переменные экземпляра, установленные в процессе обработки маршрутов, будут
968
+ доступны напрямую в шаблонах:
969
+
970
+ ```ruby
971
+ get '/:id' do
972
+ @foo = Foo.find(params[:id])
973
+ haml '%h1= @foo.name'
974
+ end
975
+ ```
976
+
977
+ Либо установите их через хеш локальных переменных:
978
+
979
+ ```ruby
980
+ get '/:id' do
981
+ foo = Foo.find(params[:id])
982
+ haml '%h1= bar.name', :locals => { :bar => foo }
983
+ end
984
+ ```
985
+
986
+ Это обычный подход, когда шаблоны рендерятся как части других шаблонов.
987
+
988
+ ### Шаблоны с `yield` и вложенные раскладки (layout)
989
+
990
+ Раскладка (layout) обычно представляет собой шаблон, который исполняет
991
+ `yield`.
992
+ Такой шаблон может быть либо использован с помощью опции `:template`,
993
+ как описано выше, либо он может быть дополнен блоком:
994
+
995
+ ```ruby
996
+ erb :post, :layout => false do
997
+ erb :index
998
+ end
999
+ ```
1000
+
1001
+ Эти инструкции в основном эквивалентны `erb :index, :layout => :post`.
1002
+
1003
+ Передача блоков интерпретирующим шаблоны методам наиболее полезна для
1004
+ создания вложенных раскладок:
1005
+
1006
+ ```ruby
1007
+ erb :main_layout, :layout => false do
1008
+ erb :admin_layout do
1009
+ erb :user
1010
+ end
1011
+ end
1012
+ ```
1013
+
1014
+ Это же самое может быть сделано короче:
1015
+
1016
+ ```ruby
1017
+ erb :admin_layout, :layout => :main_layout do
1018
+ erb :user
1019
+ end
1020
+ ```
1021
+
1022
+ В настоящее время, следующие интерпретирующие шаблоны методы
1023
+ принимают блок:
1024
+ `erb`, `haml`, `liquid`, `slim `, `wlang`.
1025
+ Общий метод заполнения шаблонов `render` также принимает блок.
1026
+
1027
+ ### Включённые шаблоны
1028
+
1029
+ Шаблоны также могут быть определены в конце исходного файла:
1030
+
1031
+ ```ruby
1032
+ require 'sinatra'
1033
+
1034
+ get '/' do
1035
+ haml :index
1036
+ end
1037
+
1038
+ __END__
1039
+
1040
+ @@ layout
1041
+ %html
1042
+ = yield
1043
+
1044
+ @@ index
1045
+ %div.title Hello world.
1046
+ ```
1047
+
1048
+ Заметьте: включённые шаблоны, определенные в исходном файле, который подключил
1049
+ Sinatra, будут загружены автоматически. Вызовите `enable :inline_templates`
1050
+ напрямую, если используете включённые шаблоны в других файлах.
1051
+
1052
+ ### Именованные шаблоны
1053
+
1054
+ Шаблоны также могут быть определены при помощи `template` метода:
1055
+
1056
+ ```ruby
1057
+ template :layout do
1058
+ "%html\n =yield\n"
1059
+ end
1060
+
1061
+ template :index do
1062
+ '%div.title Hello World!'
1063
+ end
1064
+
1065
+ get '/' do
1066
+ haml :index
1067
+ end
1068
+ ```
1069
+
1070
+ Если шаблон с именем "layout" существует, то он будет использоваться каждый
1071
+ раз при рендеринге. Вы можете отключать лэйаут в каждом конкретном случае с
1072
+ помощью `:layout => false` или отключить его для всего приложения: `set :haml,
1073
+ :layout => false`:
1074
+
1075
+ ```ruby
1076
+ get '/' do
1077
+ haml :index, :layout => !request.xhr?
1078
+ end
1079
+ ```
1080
+
1081
+ ### Привязка файловых расширений
1082
+
1083
+ Чтобы связать расширение файла с движком рендеринга, используйте
1084
+ `Tilt.register`. Например, если вы хотите использовать расширение `tt` для
1085
+ шаблонов Textile:
1086
+
1087
+ ```ruby
1088
+ Tilt.register :tt, Tilt[:textile]
1089
+ ```
1090
+
1091
+ ### Добавление собственного движка рендеринга
1092
+
1093
+ Сначала зарегистрируйте свой движок в Tilt, а затем создайте метод, отвечающий
1094
+ за рендеринг:
1095
+
1096
+ ```ruby
1097
+ Tilt.register :myat, MyAwesomeTemplateEngine
1098
+
1099
+ helpers do
1100
+ def myat(*args) render(:myat, *args) end
1101
+ end
1102
+
1103
+ get '/' do
1104
+ myat :index
1105
+ end
1106
+ ```
1107
+
1108
+ Отобразит `./views/index.myat`. Чтобы узнать больше о Tilt, смотрите
1109
+ https://github.com/rtomayko/tilt
1110
+
1111
+ ## Фильтры
1112
+
1113
+ `before`-фильтры выполняются перед каждым запросом в том же контексте, что и
1114
+ маршруты, и могут изменять как запрос, так и ответ на него. Переменные
1115
+ экземпляра, установленные в фильтрах, доступны в маршрутах и шаблонах:
1116
+
1117
+ ```ruby
1118
+ before do
1119
+ @note = 'Hi!'
1120
+ request.path_info = '/foo/bar/baz'
1121
+ end
1122
+
1123
+ get '/foo/*' do
1124
+ @note #=> 'Hi!'
1125
+ params[:splat] #=> 'bar/baz'
1126
+ end
1127
+ ```
1128
+
1129
+ `after`-фильтры выполняются после каждого запроса в том же контексте
1130
+ и могут изменять как запрос, так и ответ на него. Переменные
1131
+ экземпляра, установленные в `before`-фильтрах и маршрутах, будут доступны в
1132
+ `after`-фильтрах:
1133
+
1134
+ ```ruby
1135
+ after do
1136
+ puts response.status
1137
+ end
1138
+ ```
1139
+
1140
+ Заметьте: если вы используете метод `body`, а не просто возвращаете строку из
1141
+ маршрута, то тело ответа не будет доступно в `after`-фильтрах, так как оно
1142
+ будет сгенерировано позднее.
1143
+
1144
+ Фильтры могут использовать шаблоны URL и будут интерпретированы, только если
1145
+ путь запроса совпадет с этим шаблоном:
1146
+
1147
+ ```ruby
1148
+ before '/protected/*' do
1149
+ authenticate!
1150
+ end
1151
+
1152
+ after '/create/:slug' do |slug|
1153
+ session[:last_slug] = slug
1154
+ end
1155
+ ```
1156
+
1157
+ Как и маршруты, фильтры могут использовать условия:
1158
+
1159
+ ```ruby
1160
+ before :agent => /Songbird/ do
1161
+ # ...
1162
+ end
1163
+
1164
+ after '/blog/*', :host_name => 'example.com' do
1165
+ # ...
1166
+ end
1167
+ ```
1168
+
1169
+ ## Методы-помощники
1170
+
1171
+ Используйте метод `helpers`, чтобы определить методы-помощники, которые в
1172
+ дальнейшем можно будет использовать в обработчиках маршрутов и шаблонах:
1173
+
1174
+ ```ruby
1175
+ helpers do
1176
+ def bar(name)
1177
+ "#{name}bar"
1178
+ end
1179
+ end
1180
+
1181
+ get '/:name' do
1182
+ bar(params[:name])
1183
+ end
1184
+ ```
1185
+
1186
+ Также методы-помощники могут быть заданы в отдельных модулях:
1187
+
1188
+ ```ruby
1189
+ module FooUtils
1190
+ def foo(name) "#{name}foo" end
1191
+ end
1192
+
1193
+ module BarUtils
1194
+ def bar(name) "#{name}bar" end
1195
+ end
1196
+
1197
+ helpers FooUtils, BarUtils
1198
+ ```
1199
+
1200
+ Эффект равносилен включению модулей в класс приложения.
1201
+
1202
+ ### Использование сессий
1203
+
1204
+ Сессия используется, чтобы сохранять состояние между запросами. Если эта опция
1205
+ включена, то у вас будет один хеш сессии на одну пользовательскую сессию:
1206
+
1207
+ ```ruby
1208
+ enable :sessions
1209
+
1210
+ get '/' do
1211
+ "value = " << session[:value].inspect
1212
+ end
1213
+
1214
+ get '/:value' do
1215
+ session[:value] = params[:value]
1216
+ end
1217
+ ```
1218
+
1219
+ Заметьте, что при использовании `enable :sessions` все данные сохраняются в
1220
+ куках (cookies). Это может быть не совсем то, что вы хотите (например,
1221
+ сохранение больших объемов данных увеличит ваш трафик). В таком случае вы
1222
+ можете использовать альтернативную Rack "прослойку" (middleware), реализующую
1223
+ механизм сессий. Для этого *не надо* вызывать `enable :sessions`, вместо этого
1224
+ следует подключить ее так же, как и любую другую "прослойку":
1225
+
1226
+ ```ruby
1227
+ use Rack::Session::Pool, :expire_after => 2592000
1228
+
1229
+ get '/' do
1230
+ "value = " << session[:value].inspect
1231
+ end
1232
+
1233
+ get '/:value' do
1234
+ session[:value] = params[:value]
1235
+ end
1236
+ ```
1237
+
1238
+ Для повышения безопасности данные сессии в куках подписываются секретным
1239
+ ключом. Секретный ключ генерируется Sinatra. Тем не менее, так как этот ключ
1240
+ будет меняться с каждым запуском приложения, вы, возможно, захотите установить
1241
+ ключ вручную, чтобы у всех экземпляров вашего приложения был один и тот же
1242
+ ключ:
1243
+
1244
+ ```ruby
1245
+ set :session_secret, 'super secret'
1246
+ ```
1247
+
1248
+ Если вы хотите больше настроек для сессий, вы можете задать их, передав хеш
1249
+ опций в параметр `sessions`:
1250
+
1251
+ ```ruby
1252
+ set :sessions, :domain => 'foo.com'
1253
+ ```
1254
+
1255
+ Чтобы сделать сессию доступной другим приложениям, размещенным на поддоменах
1256
+ foo.com, добавьте *.* перед доменом:
1257
+
1258
+ ``` ruby
1259
+ set :sessions, :domain => '.foo.com'
1260
+ ```
1261
+
1262
+ ### Прерывание
1263
+
1264
+ Чтобы незамедлительно прервать обработку запроса внутри фильтра или маршрута,
1265
+ используйте:
1266
+
1267
+ ```ruby
1268
+ halt
1269
+ ```
1270
+
1271
+ Можно также указать статус при прерывании:
1272
+
1273
+ ```ruby
1274
+ halt 410
1275
+ ```
1276
+
1277
+ Тело:
1278
+
1279
+ ```ruby
1280
+ halt 'this will be the body'
1281
+ ```
1282
+
1283
+ И то, и другое:
1284
+
1285
+ ```ruby
1286
+ halt 401, 'go away!'
1287
+ ```
1288
+
1289
+ Можно указать заголовки:
1290
+
1291
+ ```ruby
1292
+ halt 402, {'Content-Type' => 'text/plain'}, 'revenge'
1293
+ ```
1294
+
1295
+ И, конечно, можно использовать шаблоны с `halt`:
1296
+
1297
+ ```ruby
1298
+ halt erb(:error)
1299
+ ```
1300
+
1301
+ ### Передача
1302
+
1303
+ Маршрут может передать обработку запроса следующему совпадающему маршруту,
1304
+ используя `pass`:
1305
+
1306
+ ```ruby
1307
+ get '/guess/:who' do
1308
+ pass unless params[:who] == 'Frank'
1309
+ 'You got me!'
1310
+ end
1311
+
1312
+ get '/guess/*' do
1313
+ 'You missed!'
1314
+ end
1315
+ ```
1316
+
1317
+ Блок маршрута сразу же прерывается, и контроль переходит к следующему
1318
+ совпадающему маршруту. Если соответствующий маршрут не найден, то ответом на
1319
+ запрос будет 404.
1320
+
1321
+ ### Вызов другого маршрута
1322
+
1323
+ Иногда `pass` не подходит, например, если вы хотите получить результат вызова
1324
+ другого обработчика маршрута. В таком случае просто используйте `call`:
1325
+
1326
+ ```ruby
1327
+ get '/foo' do
1328
+ status, headers, body = call env.merge("PATH_INFO" => '/bar')
1329
+ [status, headers, body.map(&:upcase)]
1330
+ end
1331
+
1332
+ get '/bar' do
1333
+ "bar"
1334
+ end
1335
+ ```
1336
+
1337
+ Заметьте, что в предыдущем примере можно облегчить тестирование и повысить
1338
+ производительность, перенеся `"bar"` в метод-помощник, используемый и в
1339
+ `/foo`, и в `/bar`.
1340
+
1341
+ Если вы хотите, чтобы запрос был отправлен в тот же экземпляр приложения, а не
1342
+ в его копию, используйте `call!` вместо `call`.
1343
+
1344
+ Если хотите узнать больше о `call`, смотрите спецификацию Rack.
1345
+
1346
+ ### Задание тела, кода и заголовков ответа
1347
+
1348
+ Хорошим тоном является установка кода состояния HTTP и тела ответа в
1349
+ возвращаемом значении обработчика маршрута. Тем не менее, в некоторых
1350
+ ситуациях вам, возможно, понадобится задать тело ответа в произвольной точке
1351
+ потока исполнения. Вы можете сделать это с помощью метода-помощника `body`.
1352
+ Если вы задействуете метод `body`, то вы можете использовать его и в
1353
+ дальнейшем, чтобы получить доступ к телу ответа.
1354
+
1355
+ ```ruby
1356
+ get '/foo' do
1357
+ body "bar"
1358
+ end
1359
+
1360
+ after do
1361
+ puts body
1362
+ end
1363
+ ```
1364
+
1365
+ Также можно передать блок в метод `body`, который затем будет вызван
1366
+ обработчиком Rack (такой подход может быть использован для реализации
1367
+ поточного ответа, см. "Возвращаемые значения").
1368
+
1369
+ Аналогично вы можете установить код ответа и его заголовки:
1370
+
1371
+ ```ruby
1372
+ get '/foo' do
1373
+ status 418
1374
+ headers \
1375
+ "Allow" => "BREW, POST, GET, PROPFIND, WHEN",
1376
+ "Refresh" => "Refresh: 20; http://www.ietf.org/rfc/rfc2324.txt"
1377
+ body "I'm a tea pot!"
1378
+ end
1379
+ ```
1380
+
1381
+ Как и `body`, методы `headers` и `status`, вызванные без аргументов,
1382
+ возвращают свои текущие значения.
1383
+
1384
+ ### Стриминг ответов
1385
+
1386
+ Иногда требуется начать отправлять данные клиенту прямо в процессе
1387
+ генерирования частей этих данных. В особых случаях требуется постоянно
1388
+ отправлять данные до тех пор, пока клиент не закроет соединение. Вы можете
1389
+ использовать метод `stream` вместо написания собственных "оберток".
1390
+
1391
+ ```ruby
1392
+ get '/' do
1393
+ stream do |out|
1394
+ out << "It's gonna be legen -\n"
1395
+ sleep 0.5
1396
+ out << " (wait for it) \n"
1397
+ sleep 1
1398
+ out << "- dary!\n"
1399
+ end
1400
+ end
1401
+ ```
1402
+
1403
+ Что позволяет вам реализовать стриминговые API,
1404
+ [Server Sent Events](http://dev.w3.org/html5/eventsource/),
1405
+ и может служить основой для [WebSockets](http://en.wikipedia.org/wiki/WebSocket).
1406
+ Также такой подход можно использовать для увеличения производительности в случае,
1407
+ когда какая-то часть контента зависит от медленного ресурса.
1408
+
1409
+ Заметьте, что возможности стриминга, особенно количество одновременно
1410
+ обслуживаемых запросов, очень сильно зависят от используемого веб-сервера.
1411
+ Некоторые серверы, например, WEBRick, могут и вовсе не поддерживать стриминг.
1412
+ Если сервер не поддерживает стриминг, то все данные будут отправлены за один
1413
+ раз сразу после того, как блок, переданный в `stream`, завершится. Стриминг
1414
+ вообще не работает при использовании Shotgun.
1415
+
1416
+ Если метод используется с параметром `keep_open`, то он не будет вызывать
1417
+ `close` у объекта потока, что позволит вам закрыть его позже в любом другом
1418
+ месте. Это работает только с событийными серверами, например, с Thin и
1419
+ Rainbows. Другие же серверы все равно будут закрывать поток:
1420
+
1421
+ ```ruby
1422
+ # long polling
1423
+
1424
+ set :server, :thin
1425
+ connections = []
1426
+
1427
+ get '/subscribe' do
1428
+ # регистрация клиента
1429
+ stream(:keep_open) { |out| connections << out }
1430
+
1431
+ # удаление "мертвых клиентов"
1432
+ connections.reject!(&:closed?)
1433
+
1434
+ # допуск
1435
+ "subscribed"
1436
+ end
1437
+
1438
+ post '/message' do
1439
+ connections.each do |out|
1440
+ # уведомить клиента о новом сообщении
1441
+ out << params[:message] << "\n"
1442
+
1443
+ # указать клиенту на необходимость снова соединиться
1444
+ out.close
1445
+ end
1446
+
1447
+ # допуск
1448
+ "message received"
1449
+ end
1450
+ ```
1451
+
1452
+ ### Логирование
1453
+
1454
+ В области видимости запроса метод `logger` предоставляет доступ к экземпляру
1455
+ `Logger`:
1456
+
1457
+ ```ruby
1458
+ get '/' do
1459
+ logger.info "loading data"
1460
+ # ...
1461
+ end
1462
+ ```
1463
+
1464
+ Этот логер автоматически учитывает ваши настройки логирования в Rack. Если
1465
+ логирование выключено, то этот метод вернет пустой (dummy) объект, поэтому вы
1466
+ можете смело использовать его в маршрутах и фильтрах.
1467
+
1468
+ Заметьте, что логирование включено по умолчанию только для
1469
+ `Sinatra::Application`, а если ваше приложение — подкласс `Sinatra::Base`, то
1470
+ вы, наверное, захотите включить его вручную:
1471
+
1472
+ ```ruby
1473
+ class MyApp < Sinatra::Base
1474
+ configure :production, :development do
1475
+ enable :logging
1476
+ end
1477
+ end
1478
+ ```
1479
+
1480
+ Чтобы избежать использования любой логирующей "прослойки", задайте опции
1481
+ `logging` значение `nil`. Тем не менее, не забывайте, что в такой ситуации
1482
+ `logger` вернет `nil`. Чаще всего так делают, когда задают свой собственный
1483
+ логер. Sinatra будет использовать то, что находится в `env['rack.logger']`.
1484
+
1485
+ ### Mime-типы
1486
+
1487
+ Когда вы используете `send_file` или статические файлы, у вас могут быть
1488
+ mime-типы, которые Sinatra не понимает по умолчанию. Используйте `mime_type`
1489
+ для их регистрации по расширению файла:
1490
+
1491
+ ```ruby
1492
+ configure do
1493
+ mime_type :foo, 'text/foo'
1494
+ end
1495
+ ```
1496
+
1497
+ Вы также можете использовать это в `content_type` методе-помощнике:
1498
+
1499
+ ```ruby
1500
+ get '/' do
1501
+ content_type :foo
1502
+ "foo foo foo"
1503
+ end
1504
+ ```
1505
+
1506
+ ### Генерирование URL
1507
+
1508
+ Чтобы сформировать URL, вам следует использовать метод `url`, например, в Haml:
1509
+
1510
+ ```ruby
1511
+ %a{:href => url('/foo')} foo
1512
+ ```
1513
+
1514
+ Этот метод учитывает обратные прокси и маршрутизаторы Rack, если они
1515
+ присутствуют.
1516
+
1517
+ Наряду с `url` вы можете использовать `to` (смотрите пример ниже).
1518
+
1519
+ ### Перенаправление (редирект)
1520
+
1521
+ Вы можете перенаправить браузер пользователя с помощью метода `redirect`:
1522
+
1523
+ ```ruby
1524
+ get '/foo' do
1525
+ redirect to('/bar')
1526
+ end
1527
+ ```
1528
+
1529
+ Любые дополнительные параметры используются по аналогии с аргументами метода
1530
+ `halt`:
1531
+
1532
+ ```ruby
1533
+ redirect to('/bar'), 303
1534
+ redirect 'http://google.com', 'wrong place, buddy'
1535
+ ```
1536
+
1537
+ Вы также можете перенаправить пользователя обратно, на страницу, с которой он
1538
+ пришел, с помощью `redirect back`:
1539
+
1540
+ ```ruby
1541
+ get '/foo' do
1542
+ "<a href='/bar'>do something</a>"
1543
+ end
1544
+
1545
+ get '/bar' do
1546
+ do_something
1547
+ redirect back
1548
+ end
1549
+ ```
1550
+
1551
+ Чтобы передать какие-либо параметры вместе с перенаправлением, либо добавьте
1552
+ их в строку запроса:
1553
+
1554
+ ```ruby
1555
+ redirect to('/bar?sum=42')
1556
+ ```
1557
+
1558
+ либо используйте сессию:
1559
+
1560
+ ```ruby
1561
+ enable :sessions
1562
+
1563
+ get '/foo' do
1564
+ session[:secret] = 'foo'
1565
+ redirect to('/bar')
1566
+ end
1567
+
1568
+ get '/bar' do
1569
+ session[:secret]
1570
+ end
1571
+ ```
1572
+
1573
+ ### Управление кэшированием
1574
+
1575
+ Установка корректных заголовков — основа правильного HTTP кэширования.
1576
+
1577
+ Вы можете легко выставить заголовок Cache-Control таким образом:
1578
+
1579
+ ```ruby
1580
+ get '/' do
1581
+ cache_control :public
1582
+ "cache it!"
1583
+ end
1584
+ ```
1585
+
1586
+ Совет: задавайте кэширование в `before`-фильтре:
1587
+
1588
+ ```ruby
1589
+ before do
1590
+ cache_control :public, :must_revalidate, :max_age => 60
1591
+ end
1592
+ ```
1593
+
1594
+ Если вы используете метод `expires` для задания соответствующего заголовка, то
1595
+ `Cache-Control` будет выставлен автоматически:
1596
+
1597
+ ```ruby
1598
+ before do
1599
+ expires 500, :public, :must_revalidate
1600
+ end
1601
+ ```
1602
+
1603
+ Чтобы как следует использовать кэширование, вам следует подумать об
1604
+ использовании `etag` или `last_modified`. Рекомендуется использовать эти
1605
+ методы-помощники *до* выполнения ресурсоемких вычислений, так как они
1606
+ немедленно отправят ответ клиенту, если текущая версия уже есть в их кэше:
1607
+
1608
+ ```ruby
1609
+ get '/article/:id' do
1610
+ @article = Article.find params[:id]
1611
+ last_modified @article.updated_at
1612
+ etag @article.sha1
1613
+ erb :article
1614
+ end
1615
+ ```
1616
+
1617
+ Также вы можете использовать
1618
+ [weak ETag](http://en.wikipedia.org/wiki/HTTP_ETag#Strong_and_weak_validation):
1619
+
1620
+ ```ruby
1621
+ etag @article.sha1, :weak
1622
+ ```
1623
+
1624
+ Эти методы-помощники не станут ничего кэшировать для вас, но они дадут
1625
+ необходимую информацию для вашего кэша. Если вы ищете легкое решение для
1626
+ кэширования, попробуйте [rack-cache](https://github.com/rtomayko/rack-cache):
1627
+
1628
+ ```ruby
1629
+ require 'rack/cache'
1630
+ require 'sinatra'
1631
+
1632
+ use Rack::Cache
1633
+
1634
+ get '/' do
1635
+ cache_control :public, :max_age => 36000
1636
+ sleep 5
1637
+ "hello"
1638
+ end
1639
+ ```
1640
+
1641
+ Используйте опцию `:static_cache_control` (см. ниже), чтобы добавить заголовок
1642
+ `Cache-Control` к статическим файлам.
1643
+
1644
+ В соответствии с RFC 2616 ваше приложение должно вести себя по-разному, когда
1645
+ заголовки If-Match или If-None-Match имеют значение `*`, в зависимости от
1646
+ того, существует или нет запрашиваемый ресурс. Sinatra предполагает, что
1647
+ ресурсы, к которым обращаются с помощью безопасных (GET) и идемпотентных (PUT)
1648
+ методов, уже существуют, а остальные ресурсы (к которым обращаются, например,
1649
+ с помощью POST) считает новыми. Вы можете изменить данное поведение с помощью
1650
+ опции `:new_resource`:
1651
+
1652
+ ```ruby
1653
+ get '/create' do
1654
+ etag '', :new_resource => true
1655
+ Article.create
1656
+ erb :new_article
1657
+ end
1658
+ ```
1659
+
1660
+ Если вы хотите использовать weak ETag, задайте опцию `:kind`:
1661
+
1662
+ ```ruby
1663
+ etag '', :new_resource => true, :kind => :weak
1664
+ ```
1665
+
1666
+ ### Отправка файлов
1667
+
1668
+ Для отправки файлов пользователю вы можете использовать метод `send_file`:
1669
+
1670
+ ```ruby
1671
+ get '/' do
1672
+ send_file 'foo.png'
1673
+ end
1674
+ ```
1675
+
1676
+ Этот метод имеет несколько опций:
1677
+
1678
+ ```ruby
1679
+ send_file 'foo.png', :type => :jpg
1680
+ ```
1681
+
1682
+ Возможные опции:
1683
+
1684
+ <dl>
1685
+ <dt>filename</dt>
1686
+ <dd>имя файла, по умолчанию: реальное имя файла.</dd>
1687
+
1688
+ <dt>last_modified</dt>
1689
+ <dd>значение для заголовка Last-Modified, по умолчанию: mtime (время
1690
+ изменения) файла.</dd>
1691
+
1692
+ <dt>type</dt>
1693
+ <dd>тип файла, по умолчанию: определяется по расширению файла.</dd>
1694
+
1695
+ <dt>disposition</dt>
1696
+ <dd>используется для заголовка Content-Disposition, возможные значения: <tt>nil</tt>
1697
+ (по умолчанию), <tt>:attachment</tt> и <tt>:inline</tt>.</dd>
1698
+
1699
+ <dt>length</dt>
1700
+ <dd>значения для заголовка Content-Length, по умолчанию: размер файла.</dd>
1701
+
1702
+ <dt>status</dt>
1703
+ <dd>Код ответа. Полезно, когда отдается статический файл в качестве страницы с
1704
+ сообщением об ошибке.</dd>
1705
+ </dl>
1706
+
1707
+ Этот метод будет использовать возможности Rack сервера для отправки файлов,
1708
+ если они доступны, в противном случае будет напрямую отдавать файл из Ruby
1709
+ процесса. Метод `send_file` также обеспечивает автоматическую обработку
1710
+ частичных (range) запросов с помощью Sinatra.
1711
+
1712
+ ### Доступ к объекту запроса
1713
+
1714
+ Объект входящего запроса доступен на уровне обработки запроса (в фильтрах,
1715
+ маршрутах, обработчиках ошибок) с помощью `request` метода:
1716
+
1717
+ ```ruby
1718
+ # приложение запущено на http://example.com/example
1719
+ get '/foo' do
1720
+ t = %w[text/css text/html application/javascript]
1721
+ request.accept # ['text/html', '*/*']
1722
+ request.accept? 'text/xml' # true
1723
+ request.preferred_type(t) # 'text/html'
1724
+ request.body # тело запроса, посланное клиентом (см. ниже)
1725
+ request.scheme # "http"
1726
+ request.script_name # "/example"
1727
+ request.path_info # "/foo"
1728
+ request.port # 80
1729
+ request.request_method # "GET"
1730
+ request.query_string # ""
1731
+ request.content_length # длина тела запроса
1732
+ request.media_type # медиатип тела запроса
1733
+ request.host # "example.com"
1734
+ request.get? # true (есть аналоги для других методов HTTP)
1735
+ request.form_data? # false
1736
+ request["some_param"] # значение параметра some_param. Шорткат для хеша params
1737
+ request.referrer # источник запроса клиента либо '/'
1738
+ request.user_agent # user agent (используется для :agent условия)
1739
+ request.cookies # хеш, содержащий cookies браузера
1740
+ request.xhr? # является ли запрос ajax запросом?
1741
+ request.url # "http://example.com/example/foo"
1742
+ request.path # "/example/foo"
1743
+ request.ip # IP-адрес клиента
1744
+ request.secure? # false (true, если запрос сделан через SSL)
1745
+ request.forwarded? # true (если сервер работает за обратным прокси)
1746
+ request.env # "сырой" env хеш, полученный Rack
1747
+ end
1748
+ ```
1749
+
1750
+ Некоторые опции, такие как `script_name` или `path_info`, доступны для
1751
+ изменения:
1752
+
1753
+ ```ruby
1754
+ before { request.path_info = "/" }
1755
+
1756
+ get "/" do
1757
+ "all requests end up here"
1758
+ end
1759
+ ```
1760
+
1761
+ `request.body` является IO или StringIO объектом:
1762
+
1763
+ ```ruby
1764
+ post "/api" do
1765
+ request.body.rewind # в случае, если кто-то уже прочитал тело запроса
1766
+ data = JSON.parse request.body.read
1767
+ "Hello #{data['name']}!"
1768
+ end
1769
+ ```
1770
+
1771
+ ### Вложения
1772
+
1773
+ Вы можете использовать метод `attachment`, чтобы сказать браузеру, что ответ
1774
+ сервера должен быть сохранен на диск, а не отображен:
1775
+
1776
+ ```ruby
1777
+ get '/' do
1778
+ attachment
1779
+ "store it!"
1780
+ end
1781
+ ```
1782
+
1783
+ Вы также можете указать имя файла:
1784
+
1785
+ ```ruby
1786
+ get '/' do
1787
+ attachment "info.txt"
1788
+ "store it!"
1789
+ end
1790
+ ```
1791
+
1792
+ ### Работа со временем и датами
1793
+
1794
+ Sinatra предлагает метод-помощник `time_for`, который из заданного значения
1795
+ создает объект Time. Он также может конвертировать `DateTime`, `Date` и
1796
+ подобные классы:
1797
+
1798
+ ```ruby
1799
+ get '/' do
1800
+ pass if Time.now > time_for('Dec 23, 2012')
1801
+ "still time"
1802
+ end
1803
+ ```
1804
+
1805
+ Этот метод используется внутри Sinatra методами `expires`, `last_modified` и
1806
+ им подобными. Поэтому вы легко можете расширить функционал этих методов,
1807
+ переопределив `time_for` в своем приложении:
1808
+
1809
+ ```ruby
1810
+ helpers do
1811
+ def time_for(value)
1812
+ case value
1813
+ when :yesterday then Time.now - 24*60*60
1814
+ when :tomorrow then Time.now + 24*60*60
1815
+ else super
1816
+ end
1817
+ end
1818
+ end
1819
+
1820
+ get '/' do
1821
+ last_modified :yesterday
1822
+ expires :tomorrow
1823
+ "hello"
1824
+ end
1825
+ ```
1826
+
1827
+ ### Поиск шаблонов
1828
+
1829
+ Для поиска шаблонов и их последующего рендеринга используется метод
1830
+ `find_template`:
1831
+
1832
+ ```ruby
1833
+ find_template settings.views, 'foo', Tilt[:haml] do |file|
1834
+ puts "could be #{file}"
1835
+ end
1836
+ ```
1837
+
1838
+ Это не слишком полезный пример. Зато полезен тот факт, что вы можете
1839
+ переопределить этот метод, чтобы использовать свой собственный механизм
1840
+ поиска. Например, если вы хотите, чтобы можно было использовать несколько
1841
+ директорий с шаблонами:
1842
+
1843
+ ```ruby
1844
+ set :views, ['views', 'templates']
1845
+
1846
+ helpers do
1847
+ def find_template(views, name, engine, &block)
1848
+ Array(views).each { |v| super(v, name, engine, &block) }
1849
+ end
1850
+ end
1851
+ ```
1852
+
1853
+ Другой пример, в котором используются разные директории для движков
1854
+ рендеринга:
1855
+
1856
+ ```ruby
1857
+ set :views, :sass => 'views/sass', :haml => 'templates', :default => 'views'
1858
+
1859
+ helpers do
1860
+ def find_template(views, name, engine, &block)
1861
+ _, folder = views.detect { |k,v| engine == Tilt[k] }
1862
+ folder ||= views[:default]
1863
+ super(folder, name, engine, &block)
1864
+ end
1865
+ end
1866
+ ```
1867
+
1868
+ Вы можете легко вынести этот код в расширение и поделиться им с остальными!
1869
+
1870
+ Заметьте, что `find_template` не проверяет, существует ли файл на самом деле,
1871
+ а вызывает заданный блок для всех возможных путей. Дело тут не в
1872
+ производительности, дело в том, что `render` вызовет `break`, как только файл
1873
+ не будет найден. Содержимое и местонахождение шаблонов будет закэшировано,
1874
+ если приложение запущено не в режиме разработки (`set :environment,
1875
+ :development`). Вы должны помнить об этих нюансах, если пишите по-настоящему
1876
+ "сумасшедший" метод.
1877
+
1878
+ ## Конфигурация
1879
+
1880
+ Этот блок исполняется один раз при старте в любом окружении, режиме
1881
+ (environment):
1882
+
1883
+ ```ruby
1884
+ configure do
1885
+ # задание одной опции
1886
+ set :option, 'value'
1887
+
1888
+ # устанавливаем несколько опций
1889
+ set :a => 1, :b => 2
1890
+
1891
+ # то же самое, что и `set :option, true`
1892
+ enable :option
1893
+
1894
+ # то же самое, что и `set :option, false`
1895
+ disable :option
1896
+
1897
+ # у вас могут быть "динамические" опции с блоками
1898
+ set(:css_dir) { File.join(views, 'css') }
1899
+ end
1900
+ ```
1901
+
1902
+ Будет запущено, когда окружение (RACK_ENV переменная) `:production`:
1903
+
1904
+ ```ruby
1905
+ configure :production do
1906
+ ...
1907
+ end
1908
+ ```
1909
+
1910
+ Будет запущено, когда окружение `:production` или `:test`:
1911
+
1912
+ ```ruby
1913
+ configure :production, :test do
1914
+ ...
1915
+ end
1916
+ ```
1917
+
1918
+ Вы можете получить доступ к этим опциям с помощью `settings`:
1919
+
1920
+ ```ruby
1921
+ configure do
1922
+ set :foo, 'bar'
1923
+ end
1924
+
1925
+ get '/' do
1926
+ settings.foo? # => true
1927
+ settings.foo # => 'bar'
1928
+ ...
1929
+ end
1930
+ ```
1931
+
1932
+ ### Настройка защиты от атак
1933
+
1934
+ Sinatra использует
1935
+ [Rack::Protection](https://github.com/rkh/rack-protection#readme) для защиты
1936
+ приложения от простых атак. Вы можете легко выключить эту защиту (что сделает
1937
+ ваше приложение чрезвычайно уязвимым):
1938
+
1939
+ ```ruby
1940
+ disable :protection
1941
+ ```
1942
+
1943
+ Чтобы пропустить какой-либо уровень защиты, передайте хеш опций в параметр
1944
+ `protection`:
1945
+
1946
+ ```ruby
1947
+ set :protection, :except => :path_traversal
1948
+ ```
1949
+
1950
+ Вы также можете отключить сразу несколько уровней защиты:
1951
+
1952
+ ```ruby
1953
+ set :protection, :except => [:path_traversal, :session_hijacking]
1954
+ ```
1955
+
1956
+ ### Доступные настройки
1957
+
1958
+ <dl>
1959
+ <dt>absolute_redirects</dt>
1960
+ <dd>
1961
+ если отключено, то Sinatra будет позволять использование относительных
1962
+ перенаправлений, но при этом перестанет соответствовать RFC 2616 (HTTP
1963
+ 1.1), который разрешает только абсолютные перенаправления.
1964
+ </dd>
1965
+ <dd>
1966
+ Включайте эту опцию, если ваше приложение работает за обратным прокси,
1967
+ который настроен не совсем корректно. Обратите внимание, метод <tt>url</tt> все
1968
+ равно будет генерировать абсолютные URL, если вы не передадите <tt>false</tt>
1969
+ вторым аргументом.
1970
+ </dd>
1971
+ <dd>Отключено по умолчанию.</dd>
1972
+
1973
+ <dt>add_charsets</dt>
1974
+ <dd>
1975
+ mime-типы, к которым метод <tt>content_type</tt> будет автоматически добавлять
1976
+ информацию о кодировке. Вам следует добавлять значения к этой опции
1977
+ вместо ее переопределения: <tt>settings.add_charsets &lt;&lt; "application/foobar"</tt>
1978
+ </dd>
1979
+
1980
+ <dt>app_file</dt>
1981
+ <dd>
1982
+ путь к главному файлу приложения, используется для нахождения корневой
1983
+ директории проекта, директорий с шаблонами и статическими файлами,
1984
+ вложенных шаблонов.
1985
+ </dd>
1986
+
1987
+ <dt>bind</dt>
1988
+ <dd>
1989
+ используемый IP-адрес (по умолчанию: 0.0.0.0). Используется только
1990
+ встроенным сервером.
1991
+ </dd>
1992
+
1993
+ <dt>default_encoding</dt>
1994
+ <dd>кодировка, если неизвестна (по умолчанию: <tt>"utf-8"</tt>).</dd>
1995
+
1996
+ <dt>dump_errors</dt>
1997
+ <dd>отображать ошибки в логе.</dd>
1998
+
1999
+ <dt>environment</dt>
2000
+ <dd>
2001
+ текущее окружение, по умолчанию, значение <tt>ENV['RACK_ENV']</tt> или
2002
+ <tt>"development"</tt>, если <tt>ENV['RACK_ENV']</tt> недоступна.
2003
+ </dd>
2004
+
2005
+ <dt>logging</dt>
2006
+ <dd>использовать логер.</dd>
2007
+
2008
+ <dt>lock</dt>
2009
+ <dd>
2010
+ создает блокировку для каждого запроса, которая гарантирует обработку
2011
+ только одного запроса в текущий момент времени в Ruby процессе.
2012
+ </dd>
2013
+ <dd>
2014
+ Включайте, если ваше приложение не потоко-безопасно (thread-safe).
2015
+ Отключено по умолчанию.</dd>
2016
+
2017
+ <dt>method_override</dt>
2018
+ <dd>
2019
+ использовать "магический" параметр <tt>_method</tt>, для поддержки
2020
+ PUT/DELETE форм в браузерах, которые не поддерживают эти методы.
2021
+ </dd>
2022
+
2023
+ <dt>port</dt>
2024
+ <dd>
2025
+ порт, на котором будет работать сервер.
2026
+ Используется только встроенным сервером.
2027
+ </dd>
2028
+
2029
+ <dt>prefixed_redirects</dt>
2030
+ <dd>
2031
+ добавлять или нет параметр <tt>request.script_name</tt> к редиректам, если не
2032
+ задан абсолютный путь. Таким образом, <tt>redirect '/foo'</tt> будет вести себя
2033
+ как <tt>redirect to('/foo')</tt>. Отключено по умолчанию.
2034
+ </dd>
2035
+
2036
+ <dt>protection</dt>
2037
+ <dd>включена или нет защита от атак. Смотрите секцию выше.</dd>
2038
+
2039
+ <dt>public_dir</dt>
2040
+ <dd>Алиас для <tt>public_folder</tt>.</dd>
2041
+
2042
+ <dt>public_folder</dt>
2043
+ <dd>
2044
+ путь к директории, откуда будут раздаваться статические файлы.
2045
+ Используется, только если включена раздача статических файлов
2046
+ (см. опцию <tt>static</tt> ниже).
2047
+ </dd>
2048
+
2049
+ <dt>reload_templates</dt>
2050
+ <dd>
2051
+ перезагружать или нет шаблоны на каждый запрос. Включено в режиме
2052
+ разработки.
2053
+ </dd>
2054
+
2055
+ <dt>root</dt>
2056
+ <dd>путь к корневой директории проекта.</dd>
2057
+
2058
+ <dt>raise_errors</dt>
2059
+ <dd>
2060
+ выбрасывать исключения (будет останавливать приложение).
2061
+ По умолчанию включено только в окружении <tt>test</tt>.
2062
+ </dd>
2063
+
2064
+ <dt>run</dt>
2065
+ <dd>
2066
+ если включено, Sinatra будет самостоятельно запускать веб-сервер. Не
2067
+ включайте, если используете rackup или аналогичные средства.
2068
+ </dd>
2069
+
2070
+ <dt>running</dt>
2071
+ <dd>работает ли сейчас встроенный сервер? Не меняйте эту опцию!</dd>
2072
+
2073
+ <dt>server</dt>
2074
+ <dd>
2075
+ сервер или список серверов, которые следует использовать в качестве
2076
+ встроенного сервера. По умолчанию: <tt>['thin', 'mongrel', 'webrick']</tt>, порядок
2077
+ задает приоритет.</dd>
2078
+
2079
+ <dt>sessions</dt>
2080
+ <dd>
2081
+ включить сессии на основе кук (cookie) на базе <tt>Rack::Session::Cookie</tt>.
2082
+ Смотрите секцию "Использование сессий" выше.
2083
+ </dd>
2084
+
2085
+ <dt>show_exceptions</dt>
2086
+ <dd>
2087
+ показывать исключения/стек вызовов (stack trace) в браузере. По умолчанию
2088
+ включено только в окружении <tt>development</tt>.
2089
+ </dd>
2090
+ <dd>
2091
+ Может быть установлено в
2092
+ <tt>:after_handler</tt> для запуска специфичной для приложения обработки ошибок,
2093
+ перед показом трассировки стека в браузере.
2094
+ </dd>
2095
+
2096
+ <dt>static</dt>
2097
+ <dd>должна ли Sinatra осуществлять раздачу статических файлов.</dd>
2098
+ <dd>Отключите, когда используете какой-либо веб-сервер для этой цели.</dd>
2099
+ <dd>Отключение значительно улучшит производительность приложения.</dd>
2100
+ <dd>По умолчанию включено в классических и отключено в модульных приложениях.</dd>
2101
+
2102
+ <dt>static_cache_control</dt>
2103
+ <dd>
2104
+ когда Sinatra отдает статические файлы, используйте эту опцию, чтобы
2105
+ добавить им заголовок <tt>Cache-Control</tt>. Для этого используется
2106
+ метод-помощник <tt>cache_control</tt>. По умолчанию отключено.
2107
+ </dd>
2108
+ <dd>
2109
+ Используйте массив, когда надо задать несколько значений:
2110
+ <tt>set :static_cache_control, [:public, :max_age => 300]</tt>
2111
+ </dd>
2112
+
2113
+ <dt>threaded</dt>
2114
+ <dd>
2115
+ если включено, то Thin будет использовать <tt>EventMachine.defer</tt> для
2116
+ обработки запросов.
2117
+ </dd>
2118
+
2119
+ <dt>traps</dt>
2120
+ <dd>должна ли Синатра обрабатывать системные сигналы или нет.</tt></dd>
2121
+
2122
+ <dt>views</dt>
2123
+ <dd>путь к директории с шаблонами.</dd>
2124
+ </dl>
2125
+
2126
+ ## Режим, окружение
2127
+
2128
+ Есть 3 предопределенных режима, окружения: `"development"`, `"production"` и
2129
+ `"test"`. Режим может быть задан через переменную окружения `RACK_ENV`.
2130
+ Значение по умолчанию — `"development"`. В этом режиме работы все шаблоны
2131
+ перезагружаются между запросами. А также задаются специальные обработчики
2132
+ `not_found` и `error`, чтобы вы могли увидеть стек вызовов. В окружениях
2133
+ `"production"` и `"test"` шаблоны по умолчанию кэшируются.
2134
+
2135
+ Для запуска приложения в определенном окружении используйте ключ `-e`
2136
+
2137
+ ```
2138
+ ruby my_app.rb -e [ENVIRONMENT]
2139
+ ```
2140
+
2141
+ Вы можете использовать предопределенные методы `development?`, `test?` и
2142
+ +production?, чтобы определить текущее окружение.
2143
+
2144
+ ## Обработка ошибок
2145
+
2146
+ Обработчики ошибок исполняются в том же контексте, что и маршруты, и
2147
+ `before`-фильтры, а это означает, что всякие прелести вроде `haml`, `erb`,
2148
+ `halt` и т.д. доступны и им.
2149
+
2150
+ ### Not Found
2151
+
2152
+ Когда выброшено исключение `Sinatra::NotFound`, или кодом ответа является 404,
2153
+ то будет вызван `not_found` обработчик:
2154
+
2155
+ ```ruby
2156
+ not_found do
2157
+ 'This is nowhere to be found.'
2158
+ end
2159
+ ```
2160
+
2161
+ ### Ошибки
2162
+
2163
+ Обработчик ошибок `error` будет вызван, когда исключение выброшено из блока
2164
+ маршрута, либо из фильтра. Объект-исключение доступен как переменная
2165
+ `sinatra.error` в Rack:
2166
+
2167
+ ```ruby
2168
+ error do
2169
+ 'Sorry there was a nasty error - ' + env['sinatra.error'].name
2170
+ end
2171
+ ```
2172
+
2173
+ Конкретные ошибки:
2174
+
2175
+ ```ruby
2176
+ error MyCustomError do
2177
+ 'So what happened was...' + env['sinatra.error'].message
2178
+ end
2179
+ ```
2180
+
2181
+ Тогда, если это произошло:
2182
+
2183
+ ```ruby
2184
+ get '/' do
2185
+ raise MyCustomError, 'something bad'
2186
+ end
2187
+ ```
2188
+
2189
+ То вы получите:
2190
+
2191
+ ```
2192
+ So what happened was... something bad
2193
+ ```
2194
+
2195
+ Также вы можете установить обработчик ошибок для кода состояния HTTP:
2196
+
2197
+ ```ruby
2198
+ error 403 do
2199
+ 'Access forbidden'
2200
+ end
2201
+
2202
+ get '/secret' do
2203
+ 403
2204
+ end
2205
+ ```
2206
+
2207
+ Либо набора кодов:
2208
+
2209
+ ```ruby
2210
+ error 400..510 do
2211
+ 'Boom'
2212
+ end
2213
+ ```
2214
+
2215
+ Sinatra устанавливает специальные `not_found` и `error` обработчики, когда
2216
+ приложение запущено в режиме разработки (окружение `:development`).
2217
+
2218
+ ## Rack "прослойки"
2219
+
2220
+ Sinatra использует [Rack](http://rack.rubyforge.org/), минимальный стандартный
2221
+ интерфейс для веб-фреймворков на Ruby. Одной из самых интересных для
2222
+ разработчиков возможностей Rack является поддержка "прослоек" ("middleware") —
2223
+ компонентов, находящихся "между" сервером и вашим приложением, которые
2224
+ отслеживают и/или манипулируют HTTP запросами/ответами для предоставления
2225
+ различной функциональности.
2226
+
2227
+ В Sinatra очень просто использовать такие "прослойки" с помощью метода `use`:
2228
+
2229
+ ```ruby
2230
+ require 'sinatra'
2231
+ require 'my_custom_middleware'
2232
+
2233
+ use Rack::Lint
2234
+ use MyCustomMiddleware
2235
+
2236
+ get '/hello' do
2237
+ 'Hello World'
2238
+ end
2239
+ ```
2240
+
2241
+ Семантика `use` идентична той, что определена для
2242
+ [Rack::Builder](http://rack.rubyforge.org/doc/classes/Rack/Builder.html) DSL
2243
+ (чаще всего используется в rackup файлах). Например, метод `use` принимает как
2244
+ множественные переменные, так и блоки:
2245
+
2246
+ ```ruby
2247
+ use Rack::Auth::Basic do |username, password|
2248
+ username == 'admin' && password == 'secret'
2249
+ end
2250
+ ```
2251
+
2252
+ Rack распространяется с различными стандартными "прослойками" для логирования,
2253
+ отладки, маршрутизации URL, аутентификации, обработки сессий. Sinatra
2254
+ использует многие из этих компонентов автоматически, основываясь на
2255
+ конфигурации, чтобы вам не приходилось подключать (`use`) их вручную.
2256
+
2257
+ Вы можете найти полезные прослойки в
2258
+ [rack](https://github.com/rack/rack/tree/master/lib/rack),
2259
+ [rack-contrib](https://github.com/rack/rack-contrib#readme),
2260
+ или в
2261
+ [Rack wiki](https://github.com/rack/rack/wiki/List-of-Middleware).
2262
+
2263
+ ## Тестирование
2264
+
2265
+ Тесты для Sinatra приложений могут быть написаны с помощью библиотек,
2266
+ фреймворков, поддерживающих тестирование Rack.
2267
+ [Rack::Test](http://rdoc.info/github/brynary/rack-test/master/frames)
2268
+ рекомендован:
2269
+
2270
+ ```ruby
2271
+ require 'my_sinatra_app'
2272
+ require 'test/unit'
2273
+ require 'rack/test'
2274
+
2275
+ class MyAppTest < Test::Unit::TestCase
2276
+ include Rack::Test::Methods
2277
+
2278
+ def app
2279
+ Sinatra::Application
2280
+ end
2281
+
2282
+ def test_my_default
2283
+ get '/'
2284
+ assert_equal 'Hello World!', last_response.body
2285
+ end
2286
+
2287
+ def test_with_params
2288
+ get '/meet', :name => 'Frank'
2289
+ assert_equal 'Hello Frank!', last_response.body
2290
+ end
2291
+
2292
+ def test_with_rack_env
2293
+ get '/', {}, 'HTTP_USER_AGENT' => 'Songbird'
2294
+ assert_equal "You're using Songbird!", last_response.body
2295
+ end
2296
+ end
2297
+ ```
2298
+
2299
+ ## Sinatra::Base — "прослойки", библиотеки и модульные приложения
2300
+
2301
+ Описание своего приложения самым простейшим способом (с помощью DSL верхнего
2302
+ уровня, классический стиль) отлично работает для крохотных приложений. В таких
2303
+ случаях используется конфигурация, рассчитанная на микро-приложения
2304
+ (единственный файл приложения, `./public` и `./views` директории, логирование,
2305
+ страница информации об исключении и т.д.). Тем не менее, такой метод имеет
2306
+ множество недостатков при создании компонентов, таких как Rack middleware
2307
+ ("прослоек"), Rails metal, простых библиотек с серверными компонентами,
2308
+ расширений Sinatra. И тут на помощь приходит `Sinatra::Base`:
2309
+
2310
+ ```ruby
2311
+ require 'sinatra/base'
2312
+
2313
+ class MyApp < Sinatra::Base
2314
+ set :sessions, true
2315
+ set :foo, 'bar'
2316
+
2317
+ get '/' do
2318
+ 'Hello world!'
2319
+ end
2320
+ end
2321
+ ```
2322
+
2323
+ Методы, доступные `Sinatra::Base` подклассам идентичны тем, что доступны
2324
+ приложениям в DSL верхнего уровня. Большинство таких приложений могут быть
2325
+ конвертированы в `Sinatra::Base` компоненты с помощью двух модификаций:
2326
+
2327
+ * Вы должны подключать `sinatra/base` вместо `sinatra`, иначе все методы,
2328
+ предоставляемые Sinatra, будут импортированы в глобальное пространство
2329
+ имен.
2330
+ * Поместите все маршруты, обработчики ошибок, фильтры и опции в подкласс
2331
+ `Sinatra::Base`.
2332
+
2333
+ `Sinatra::Base` — это чистый лист. Большинство опций, включая встроенный
2334
+ сервер, по умолчанию отключены. Смотрите
2335
+ [Опции и конфигурация](http://www.sinatrarb.com/configuration.html)
2336
+ для детальной информации об опциях и их поведении.
2337
+
2338
+ ### Модульные приложения против классических
2339
+
2340
+ Вопреки всеобщему убеждению, в классическом стиле (самом простом) нет ничего
2341
+ плохого. Если этот стиль подходит вашему приложению, вы не обязаны
2342
+ переписывать его в модульное приложение.
2343
+
2344
+ Основным недостатком классического стиля является тот факт, что у вас может
2345
+ быть только одно приложение Sinatra на один процесс Ruby. Если вы планируете
2346
+ использовать больше, переключайтесь на модульный стиль. Вы можете смело
2347
+ смешивать модульный и классический стили.
2348
+
2349
+ Переходя с одного стиля на другой, примите во внимание следующие изменения в
2350
+ настройках:
2351
+
2352
+ Опция Классический Модульный
2353
+
2354
+ app_file файл с приложением файл с подклассом Sinatra::Base
2355
+ run $0 == app_file false
2356
+ logging true false
2357
+ method_override true false
2358
+ inline_templates true false
2359
+ static true false
2360
+
2361
+ ### Запуск модульных приложений
2362
+
2363
+ Есть два общепринятых способа запускать модульные приложения: запуск напрямую
2364
+ с помощью `run!`:
2365
+
2366
+ ```ruby
2367
+ # my_app.rb
2368
+ require 'sinatra/base'
2369
+
2370
+ class MyApp < Sinatra::Base
2371
+ # ... здесь код приложения ...
2372
+
2373
+ # запускаем сервер, если исполняется текущий файл
2374
+ run! if app_file == $0
2375
+ end
2376
+ ```
2377
+
2378
+ Затем:
2379
+
2380
+ ```
2381
+ ruby my_app.rb
2382
+ ```
2383
+
2384
+ Или с помощью конфигурационного файла `config.ru`, который позволяет
2385
+ использовать любой Rack-совместимый сервер приложений.
2386
+
2387
+ ```ruby
2388
+ # config.ru
2389
+ require './my_app'
2390
+ run MyApp
2391
+ ```
2392
+
2393
+ Запускаем:
2394
+
2395
+ ```
2396
+ rackup -p 4567
2397
+ ```
2398
+
2399
+ ### Запуск классических приложений с config.ru
2400
+
2401
+ Файл приложения:
2402
+
2403
+ ```ruby
2404
+ # app.rb
2405
+ require 'sinatra'
2406
+
2407
+ get '/' do
2408
+ 'Hello world!'
2409
+ end
2410
+ ```
2411
+
2412
+ И соответствующий `config.ru`:
2413
+
2414
+ ```ruby
2415
+ require './app'
2416
+ run Sinatra::Application
2417
+ ```
2418
+
2419
+ ### Когда использовать config.ru?
2420
+
2421
+ Вот несколько причин, по которым вы, возможно, захотите использовать
2422
+ `config.ru`:
2423
+
2424
+ * вы хотите разворачивать свое приложение на различных Rack-совместимых
2425
+ серверах (Passenger, Unicorn, Heroku, ...);
2426
+ * вы хотите использовать более одного подкласса `Sinatra::Base`;
2427
+ * вы хотите использовать Sinatra только в качестве "прослойки" Rack.
2428
+
2429
+ **Совсем необязательно переходить на использование `config.ru` лишь потому,
2430
+ что вы стали использовать модульный стиль приложения. И необязательно
2431
+ использовать модульный стиль, чтобы запускать приложение с помощью
2432
+ `config.ru`.**
2433
+
2434
+ ### Использование Sinatra в качестве "прослойки"
2435
+
2436
+ Не только сама Sinatra может использовать "прослойки" Rack, но и любое Sinatra
2437
+ приложение само может быть добавлено к любому Rack endpoint в качестве
2438
+ "прослойки". Этим endpoint (конечной точкой) может быть другое Sinatra
2439
+ приложение, или приложение, основанное на Rack (Rails/Ramaze/Camping/...):
2440
+
2441
+ ```ruby
2442
+ require 'sinatra/base'
2443
+
2444
+ class LoginScreen < Sinatra::Base
2445
+ enable :sessions
2446
+
2447
+ get('/login') { haml :login }
2448
+
2449
+ post('/login') do
2450
+ if params[:name] == 'admin' && params[:password] == 'admin'
2451
+ session['user_name'] = params[:name]
2452
+ else
2453
+ redirect '/login'
2454
+ end
2455
+ end
2456
+ end
2457
+
2458
+ class MyApp < Sinatra::Base
2459
+ # "прослойка" будет запущена перед фильтрами
2460
+ use LoginScreen
2461
+
2462
+ before do
2463
+ unless session['user_name']
2464
+ halt "Access denied, please <a href='/login'>login</a>."
2465
+ end
2466
+ end
2467
+
2468
+ get('/') { "Hello #{session['user_name']}." }
2469
+ end
2470
+ ```
2471
+
2472
+ ### Создание приложений "на лету"
2473
+
2474
+ Иногда требуется создавать Sinatra приложения "на лету" (например, из другого
2475
+ приложения). Это возможно с помощью `Sinatra.new`:
2476
+
2477
+ ```ruby
2478
+ require 'sinatra/base'
2479
+ my_app = Sinatra.new { get('/') { "hi" } }
2480
+ my_app.run!
2481
+ ```
2482
+
2483
+ Этот метод может принимать аргументом приложение, от которого следует
2484
+ наследоваться:
2485
+
2486
+ ```ruby
2487
+ # config.ru
2488
+ require 'sinatra/base'
2489
+
2490
+ controller = Sinatra.new do
2491
+ enable :logging
2492
+ helpers MyHelpers
2493
+ end
2494
+
2495
+ map('/a') do
2496
+ run Sinatra.new(controller) { get('/') { 'a' } }
2497
+ end
2498
+
2499
+ map('/b') do
2500
+ run Sinatra.new(controller) { get('/') { 'b' } }
2501
+ end
2502
+ ```
2503
+
2504
+ Это особенно полезно для тестирования расширений Sinatra и при использовании
2505
+ Sinatra внутри вашей библиотеки.
2506
+
2507
+ Благодаря этому, использовать Sinatra как "прослойку" очень просто:
2508
+
2509
+ ```ruby
2510
+ require 'sinatra/base'
2511
+
2512
+ use Sinatra do
2513
+ get('/') { ... }
2514
+ end
2515
+
2516
+ run RailsProject::Application
2517
+ ```
2518
+
2519
+ ## Области видимости и привязка
2520
+
2521
+ Текущая область видимости определяет методы и переменные, доступные в данный
2522
+ момент.
2523
+
2524
+ ### Область видимости приложения / класса
2525
+
2526
+ Любое Sinatra приложение соответствует подклассу `Sinatra::Base`. Если вы
2527
+ используете DSL верхнего уровня (`require 'sinatra'`), то этим классом будет
2528
+ `Sinatra::Application`, иначе это будет подкласс, который вы создали вручную.
2529
+ На уровне класса вам будут доступны такие методы, как `get` или `before`, но
2530
+ вы не сможете получить доступ к объектам `request` или `session`, так как
2531
+ существует только один класс приложения для всех запросов.
2532
+
2533
+ Опции, созданные с помощью `set`, являются методами уровня класса:
2534
+
2535
+ ```ruby
2536
+ class MyApp < Sinatra::Base
2537
+ # Я в области видимости приложения!
2538
+ set :foo, 42
2539
+ foo # => 42
2540
+
2541
+ get '/foo' do
2542
+ # Я больше не в области видимости приложения!
2543
+ end
2544
+ end
2545
+ ```
2546
+
2547
+ У вас будет область видимости приложения внутри:
2548
+
2549
+ * тела вашего класса приложения;
2550
+ * методов, определенных расширениями;
2551
+ * блока, переданного в `helpers`;
2552
+ * блоков, использованных как значения для `set`;
2553
+ * блока, переданного в `Sinatra.new`.
2554
+
2555
+ Вы можете получить доступ к объекту области видимости (классу приложения)
2556
+ следующими способами:
2557
+
2558
+ * через объект, переданный блокам конфигурации (`configure { |c| ... }`);
2559
+ * `settings` внутри области видимости запроса.
2560
+
2561
+ ### Область видимости запроса/экземпляра
2562
+
2563
+ Для каждого входящего запроса будет создан новый экземпляр вашего приложения,
2564
+ и все блоки обработчика будут запущены в этом контексте. В этой области
2565
+ видимости вам доступны `request` и `session` объекты, вызовы методов
2566
+ рендеринга, такие как `erb` или `haml`. Вы можете получить доступ к области
2567
+ видимости приложения из контекста запроса, используя метод-помощник
2568
+ `settings`:
2569
+
2570
+ ```ruby
2571
+ class MyApp < Sinatra::Base
2572
+ # Я в области видимости приложения!
2573
+ get '/define_route/:name' do
2574
+ # Область видимости запроса '/define_route/:name'
2575
+ @value = 42
2576
+
2577
+ settings.get("/#{params[:name]}") do
2578
+ # Область видимости запроса "/#{params[:name]}"
2579
+ @value # => nil (другой запрос)
2580
+ end
2581
+
2582
+ "Route defined!"
2583
+ end
2584
+ end
2585
+ ```
2586
+
2587
+ У вас будет область видимости запроса в:
2588
+
2589
+ * get/head/post/put/delete/options блоках;
2590
+ * before/after фильтрах;
2591
+ * методах-помощниках;
2592
+ * шаблонах/отображениях.
2593
+
2594
+ ### Область видимости делегирования
2595
+
2596
+ Область видимости делегирования просто перенаправляет методы в область
2597
+ видимости класса. Однако, она не полностью ведет себя как область видимости
2598
+ класса, так как у вас нет привязки к классу. Только методы, явно помеченные
2599
+ для делегирования, будут доступны, а переменных/состояний области видимости
2600
+ класса не будет (иначе говоря, у вас будет другой `self` объект). Вы можете
2601
+ непосредственно добавить методы делегирования, используя
2602
+ `Sinatra::Delegator.delegate :method_name`.
2603
+
2604
+ У вас будет контекст делегирования внутри:
2605
+
2606
+ * привязки верхнего уровня, если вы сделали `require 'sinatra'`;
2607
+ * объекта, расширенного с помощью `Sinatra::Delegator`.
2608
+
2609
+ Посмотрите сами в код: вот
2610
+ [примесь Sinatra::Delegator](https://github.com/sinatra/sinatra/blob/ca06364/lib/sinatra/base.rb#L1609-1633)
2611
+ [расширяет главный объект](https://github.com/sinatra/sinatra/blob/ca06364/lib/sinatra/main.rb#L28-30).
2612
+
2613
+ ## Командная строка
2614
+
2615
+ Sinatra приложения могут быть запущены напрямую:
2616
+
2617
+ ```
2618
+ ruby myapp.rb [-h] [-x] [-e ENVIRONMENT] [-p PORT] [-o HOST] [-s HANDLER]
2619
+ ```
2620
+
2621
+ Опции включают:
2622
+
2623
+ ```
2624
+ -h # раздел помощи
2625
+ -p # указание порта (по умолчанию 4567)
2626
+ -o # указание хоста (по умолчанию 0.0.0.0)
2627
+ -e # указание окружения, режима (по умолчанию development)
2628
+ -s # указание rack сервера/обработчика (по умолчанию thin)
2629
+ -x # включить мьютекс-блокировку (по умолчанию выключена)
2630
+ ```
2631
+
2632
+ ## Системные требования
2633
+
2634
+ Следующие версии Ruby официально поддерживаются:
2635
+
2636
+ <dl>
2637
+ <dt>Ruby 1.8.7</dt>
2638
+ <dd>1.8.7 полностью поддерживается, тем не менее, если вас ничто не держит на
2639
+ этой версии, рекомендуем обновиться до 1.9.2 или перейти на JRuby или
2640
+ Rubinius. Поддержка 1.8.7 не будет прекращена до выхода Sinatra 2.0 и Ruby
2641
+ 2.0, разве что в случае релиза 1.8.8 (что маловероятно). Но даже тогда,
2642
+ возможно, поддержка не будет прекращена. <b>Ruby 1.8.6 больше не
2643
+ поддерживается.</b> Если вы хотите использовать 1.8.6, откатитесь до Sinatra
2644
+ 1.2, которая будет получать все исправления ошибок до тех пор, пока не
2645
+ будет выпущена Sinatra 1.4.0.</dd>
2646
+
2647
+ <dt>Ruby 1.9.2</dt>
2648
+ <dd>1.9.2 полностью поддерживается и рекомендована к использованию.
2649
+ Не используйте 1.9.2p0,
2650
+ известно, что эта версия очень нестабильна при использовании Sinatra. Эта
2651
+ версия будет поддерживаться по крайней мере до выхода Ruby 1.9.4/2.0, а
2652
+ поддержка последней версии 1.9 будет осуществляться до тех пор, пока она
2653
+ поддерживается командой разработчиков Ruby.</dd>
2654
+
2655
+ <dt>Ruby 1.9.3</dt>
2656
+ <dd>1.9.3 полностью поддерживается. Заметьте, что переход на 1.9.3 с
2657
+ ранних версий сделает недействительными все сессии.</dd>
2658
+
2659
+ <dt>Rubinius</dt>
2660
+ <dd>Rubinius официально поддерживается (Rubinius &gt;= 1.2.4), всё, включая все
2661
+ языки шаблонов, работает. Предстоящий релиз 2.0 также поддерживается.</dd>
2662
+
2663
+ <dt>JRuby</dt>
2664
+ <dd>JRuby официально поддерживается (JRuby &gt;= 1.6.5). Нет никаких проблем с
2665
+ использованием альтернативных шаблонов. Тем не менее, если вы выбираете
2666
+ JRuby, то, пожалуйста, посмотрите на JRuby Rack-серверы, так как Thin не
2667
+ поддерживается полностью на JRuby. Поддержка расширений на C в JRuby все
2668
+ еще экспериментальная, что на данный момент затрагивает только RDiscount,
2669
+ Redcarpet и RedCloth.</dd>
2670
+ </dl>
2671
+
2672
+ Мы также следим за предстоящими к выходу версиями Ruby.
2673
+
2674
+ Следующие реализации Ruby не поддерживаются официально, но известно, что на
2675
+ них запускается Sinatra:
2676
+
2677
+ * старые версии JRuby и Rubinius;
2678
+ * Ruby Enterprise Edition;
2679
+ * MacRuby, Maglev, IronRuby;
2680
+ * Ruby 1.9.0 и 1.9.1 (настоятельно не рекомендуются к использованию).
2681
+
2682
+ То, что версия официально не поддерживается, означает, что, если что-то не
2683
+ работает на этой версии, а на поддерживаемой работает — это не наша проблема,
2684
+ а их.
2685
+
2686
+ Мы также запускаем наши CI-тесты на версии Ruby, находящейся в разработке
2687
+ (предстоящей 2.0.0), и на 1.9.4, но мы не можем ничего гарантировать, так как
2688
+ они находятся в разработке. Предполагается, что 1.9.4p0 и 2.0.0p0 будут
2689
+ поддерживаться.
2690
+
2691
+ Sinatra должна работать на любой операционной системе, в которой есть одна из
2692
+ указанных выше версий Ruby.
2693
+
2694
+ Пока невозможно запустить Sinatra на Cardinal, SmallRuby, BlueRuby и на любой
2695
+ версии Ruby до 1.8.7.
2696
+
2697
+ ## На острие
2698
+
2699
+ Если вы хотите использовать самый последний код Sinatra, не бойтесь запускать
2700
+ свое приложение вместе с кодом из master ветки Sinatra, она весьма стабильна.
2701
+
2702
+ Мы также время от времени выпускаем предварительные версии, так что вы можете
2703
+ делать так:
2704
+
2705
+ ```
2706
+ gem install sinatra --pre
2707
+ ```
2708
+
2709
+ Чтобы воспользоваться некоторыми самыми последними возможностями.
2710
+
2711
+ ### С помощью Bundler
2712
+
2713
+ Если вы хотите запускать свое приложение с последней версией Sinatra, то
2714
+ рекомендуем использовать [Bundler](http://gembundler.com/).
2715
+
2716
+ Сначала установите Bundler, если у вас его еще нет:
2717
+
2718
+ ```
2719
+ gem install bundler
2720
+ ```
2721
+
2722
+ Затем создайте файл `Gemfile` в директории вашего проекта:
2723
+
2724
+ ```ruby
2725
+ source :rubygems
2726
+ gem 'sinatra', :git => "git://github.com/sinatra/sinatra.git"
2727
+
2728
+ # другие зависимости
2729
+ gem 'haml' # например, если используете haml
2730
+ gem 'activerecord', '~> 3.0' # может быть, вам нужен и ActiveRecord 3.x
2731
+ ```
2732
+
2733
+ Обратите внимание, вам нужно будет указывать все зависимости вашего приложения
2734
+ в этом файле. Однако, непосредственные зависимости Sinatra (Rack и Tilt)
2735
+ Bundler автоматически скачает и добавит.
2736
+
2737
+ Теперь вы можете запускать свое приложение так:
2738
+
2739
+ ```
2740
+ bundle exec ruby myapp.rb
2741
+ ```
2742
+
2743
+ ### Вручную
2744
+
2745
+ Создайте локальный клон репозитория и запускайте свое приложение с
2746
+ `sinatra/lib` директорией в `$LOAD_PATH`:
2747
+
2748
+ ```
2749
+ cd myapp
2750
+ git clone git://github.com/sinatra/sinatra.git
2751
+ ruby -Isinatra/lib myapp.rb
2752
+ ```
2753
+
2754
+ Чтобы обновить исходники Sinatra:
2755
+
2756
+ ```
2757
+ cd myapp/sinatra
2758
+ git pull
2759
+ ```
2760
+
2761
+ ### Установка глобально
2762
+
2763
+ Вы можете самостоятельно собрать gem:
2764
+
2765
+ ```
2766
+ git clone git://github.com/sinatra/sinatra.git
2767
+ cd sinatra
2768
+ rake sinatra.gemspec
2769
+ rake install
2770
+ ```
2771
+
2772
+ Если вы устанавливаете пакеты (gem) от пользователя root, то вашим последним
2773
+ шагом должна быть команда
2774
+
2775
+ ```
2776
+ sudo rake install
2777
+ ```
2778
+
2779
+ ## Версии
2780
+
2781
+ Sinatra использует [Semantic Versioning](http://semver.org/), SemVer и
2782
+ SemVerTag.
2783
+
2784
+ ## Дальнейшее чтение
2785
+
2786
+ * [Веб-сайт проекта](http://www.sinatrarb.com/) — Дополнительная
2787
+ документация, новости и ссылки на другие ресурсы.
2788
+ * [Участие в проекте](http://www.sinatrarb.com/contributing) — Обнаружили
2789
+ баг? Нужна помощь? Написали патч?
2790
+ * [Слежение за проблемами/ошибками](http://github.com/sinatra/sinatra/issues)
2791
+ * [Twitter](http://twitter.com/sinatra)
2792
+ * [Группы рассылки](http://groups.google.com/group/sinatrarb/topics)
2793
+ * [#sinatra](irc://chat.freenode.net/#sinatra) на http://freenode.net
2794
+ * [Sinatra Book](http://sinatra-book.gittr.com) учебник и сборник рецептов
2795
+ * [Sinatra Recipes](http://recipes.sinatrarb.com/) сборник рецептов
2796
+ * API документация к [последнему релизу](http://rubydoc.info/gems/sinatra)
2797
+ или [текущему HEAD](http://rubydoc.info/github/sinatra/sinatra) на
2798
+ http://rubydoc.info
2799
+ * [Сервер непрерывной интеграции](http://travis-ci.org/sinatra/sinatra)