2010-10-26 21:57:10 +00:00
= Sinatra
2011-06-15 07:52:31 +00:00
<i>Внимание: Этот документ является переводом английской версии и может быть устаревшим</i>
2010-10-26 21:57:10 +00:00
2011-03-23 23:32:42 +00:00
Sinatra — это предметно-ориентированный каркас (DSL) для быстрого создания функциональных веб-приложений на Ruby:
2010-10-26 21:57:10 +00:00
# myapp.rb
require 'sinatra'
get '/' do
'Hello world!'
end
2011-03-23 23:32:42 +00:00
Установите gem:
2010-10-26 21:57:10 +00:00
gem install sinatra
2011-03-23 23:32:42 +00:00
и запустите приложение с помощью:
2010-10-26 21:57:10 +00:00
ruby -rubygems myapp.rb
2011-03-23 23:32:42 +00:00
Результат можно увидеть: http://localhost:4567
2010-10-26 21:57:10 +00:00
2011-03-23 23:32:42 +00:00
Рекомендуется также установить thin, сделать это можно командой: <tt>gem install thin</tt>.
2011-03-24 10:44:00 +00:00
Thin - это более производительный и функциональный сервер для разработки приложений на Sinatra.
2011-03-19 13:20:32 +00:00
2010-10-29 13:55:07 +00:00
== Маршруты
2010-10-26 21:57:10 +00:00
2011-03-23 23:32:42 +00:00
В Sinatra маршрут — это пара: <HTTP метод> и <шаблон URL>.
Каждый маршрут ассоциирован с блоком кода, исполняемого внутри, пример:
2010-10-26 21:57:10 +00:00
get '/' do
.. что-то показать ..
end
post '/' do
.. что-то создать ..
end
put '/' do
2011-03-19 13:20:32 +00:00
.. что-то заменить ..
end
patch '/' do
.. что-то изменить ..
2010-10-26 21:57:10 +00:00
end
delete '/' do
.. что-то удалить ..
end
2010-12-20 11:21:07 +00:00
options '/' do
.. что-то ответить ..
end
2011-06-13 11:48:28 +00:00
Маршруты сверяются с запросом в порядке очередности их записи в файле приложения. По умолчанию
будет вызван первый совпавший с запросом маршрут.
2010-10-26 21:57:10 +00:00
2010-10-29 13:55:07 +00:00
Шаблоны маршрутов могут включать в себя параметры доступные в
2010-10-26 21:57:10 +00:00
<tt>params</tt> xэше :
get '/hello/:name' do
2010-10-29 13:55:07 +00:00
# соответствует "GET /hello/foo" и "GET /hello/bar",
2010-10-26 21:57:10 +00:00
# где params[:name] 'foo' или 'bar'
"Hello #{params[:name]}!"
end
2010-10-29 13:55:07 +00:00
Можно также использовать именные параметры в переменных блоков:
2010-10-26 21:57:10 +00:00
get '/hello/:name' do |n|
"Hello #{n}!"
end
2011-03-23 23:32:42 +00:00
Шаблоны маршрутов также могут включать splat (или '*' маску, обозначающую любой символ) параметры доступные
в массиве <tt>params[:splat]</tt>:
2010-10-26 21:57:10 +00:00
get '/say/*/to/*' do
2010-10-29 13:55:07 +00:00
# соответствует /say/hello/to/world
2010-10-26 21:57:10 +00:00
params[:splat] # => ["hello", "world"]
end
get '/download/*.*' do
2010-10-29 13:55:07 +00:00
# соответствует /download/path/to/file.xml
2010-10-26 21:57:10 +00:00
params[:splat] # => ["path/to/file", "xml"]
end
2011-06-13 11:48:28 +00:00
Или с параметрами блока:
get '/download/*.*' do |path, ext|
[path, ext] # => ["path/to/file", "xml"]
end
2011-03-23 23:32:42 +00:00
Маршруты также могут содержать регулярные выражения:
2010-10-26 21:57:10 +00:00
get %r{/hello/([\w]+)} do
"Hello, #{params[:captures].first}!"
end
2010-10-29 13:55:07 +00:00
Или с параметром блока:
2010-10-26 21:57:10 +00:00
get %r{/hello/([\w]+)} do |c|
"Hello, #{c}!"
end
=== Условия
2010-10-29 13:55:07 +00:00
Маршруты могут включать различные условия совпадений, такие как user agent:
2010-10-26 21:57:10 +00:00
get '/foo', :agent => /Songbird (\d\.\d)[\d\/]*?/ do
"You're using Songbird version #{params[:agent][0]}"
end
get '/foo' do
2011-01-14 08:57:04 +00:00
# соответствует non-songbird браузерам
2010-10-26 21:57:10 +00:00
end
Другими доступными условиями являются +host_name+ и +provides+:
get '/', :host_name => /^admin\./ do
"Admin Area, Access denied!"
end
get '/', :provides => 'html' do
haml :index
end
get '/', :provides => ['rss', 'atom', 'xml'] do
builder :feed
end
2011-03-23 23:32:42 +00:00
Вы можете задать собственные условия:
2010-10-26 21:57:10 +00:00
set(:probability) { |value| condition { rand <= value } }
get '/win_a_car', :probability => 0.1 do
"You won!"
end
get '/win_a_car' do
2010-10-29 13:55:07 +00:00
"Sorry, you lost."
2010-10-26 21:57:10 +00:00
end
=== Возвращаемые значения
2010-10-29 13:55:07 +00:00
Возвращаемое значение блока маршрута ограничивается телом ответа, которое будет передано HTTP клиенту,
2011-03-24 10:44:00 +00:00
или следующей "прослойкой" (middleware) в Rack стеке. Чаще всего это строка, как в примерах выше.
2010-10-29 14:24:21 +00:00
Н о и другие значения также приемлемы.
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
Вы можете вернуть любой объект, который будет либо корректным Rack ответом, объектом Rack body,
либо кодом состояния HTTP:
2010-10-26 21:57:10 +00:00
2011-03-24 10:44:00 +00:00
* массив с тремя переменными: <tt>[status (Fixnum), headers (Hash), response body (должен отвечать на #each)]</tt>;
* массив с двумя переменными: <tt>[status (Fixnum), response body (должен отвечать на #each)]</tt>;
* объект, отвечающий на <tt>#each</tt>, который передает только строковые типы данных в этот блок;
* Fixnum, представляющий код состояния HTTP.
2010-10-26 21:57:10 +00:00
2011-03-24 10:44:00 +00:00
Таким образом, мы легко можем создать поточный пример:
2010-10-26 21:57:10 +00:00
class Stream
def each
100.times { |i| yield "#{i}\n" }
end
end
get('/') { Stream.new }
2011-03-19 13:20:32 +00:00
=== Собственные детекторы совпадений для маршрутов
Как показано выше, Sinatra поставляется с о встроенной поддержкой строк и
2011-03-23 23:32:42 +00:00
регулярных выражений в качестве шаблонов URL. Н о и это еще не все. Вы можете
2011-03-19 13:20:32 +00:00
легко определить свои собственные детекторы совпадений (matchers) для маршрутов:
class AllButPattern
Match = Struct.new(:captures)
def initialize(except)
@except = except
@captures = Match.new([])
end
def match(str)
@captures unless @except === str
end
end
def all_but(pattern)
AllButPattern.new(pattern)
end
get all_but("/index") do
# ...
end
2011-03-23 23:32:42 +00:00
Заметьте, что предыдущий пример возможно чересчур сложен, он также может быть представлен как:
2011-03-19 13:20:32 +00:00
get // do
pass if request.path_info == "/index"
# ...
end
Или с использованием негативного просмотра вперед:
get %r{^(?!/index$)} do
# ...
end
2011-03-24 10:44:00 +00:00
== Статические файлы
2010-10-26 21:57:10 +00:00
2011-03-24 10:44:00 +00:00
Статические файлы отдаются из <tt>./public</tt> директории. Вы можете указать другое место,
2011-06-15 22:24:27 +00:00
указав е г о через опцию <tt>:public_folder</tt>:
2010-10-26 21:57:10 +00:00
2011-06-15 22:24:27 +00:00
set :public_folder, File.dirname(__FILE__) + '/static'
2010-10-26 21:57:10 +00:00
2010-10-29 13:55:07 +00:00
Учтите, что имя директории с о статическими файлами не включено в URL. Например, файл
2010-10-26 21:57:10 +00:00
<tt>./public/css/style.css</tt> будет доступен как
<tt>http://example.com/css/style.css</tt>.
2011-06-13 11:48:28 +00:00
Используйте опцию <tt>:static_cache_control</tt> (см. ниже), чтобы
добавить заголовок <tt>Cache-Control</tt>.
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
== Представления / Шаблоны
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
Каждый шаблонизатор представлен своим собственным методом. Эти методы
попросту возвращают строку:
2010-10-26 21:57:10 +00:00
get '/' do
2011-06-13 11:48:28 +00:00
erb :index
2010-10-26 21:57:10 +00:00
end
2011-06-13 11:48:28 +00:00
Отобразит <tt>views/index.erb</tt>.
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
Вместо имени шаблона вы так же можете передавать непосредственно само
содержимое шаблона
2010-10-26 21:57:10 +00:00
get '/' do
2011-06-13 11:48:28 +00:00
code = "<%= Time.now >"
erb code
2010-10-26 21:57:10 +00:00
end
2011-06-13 11:48:28 +00:00
Эти методы принимают второй аргумент, хеш с опциями:
2010-10-26 21:57:10 +00:00
get '/' do
2011-06-13 11:48:28 +00:00
erb :index, :layout => :post
2010-10-26 21:57:10 +00:00
end
2011-06-13 11:48:28 +00:00
Отобразит <tt>views/index.erb</tt>, вложенным в
<tt>views/post.erb</tt> (по умолчанию: <tt>views/layout.erb</tt>, если существует).
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
Любые опции, не понимаемые Sinatra, будут переданы в шаблонизатор
2010-10-26 21:57:10 +00:00
get '/' do
2011-06-13 11:48:28 +00:00
haml :index, :format => :html5
2010-10-26 21:57:10 +00:00
end
2011-06-13 11:48:28 +00:00
Вы также можете задавать опции для шаблонизаторов в общем:
2011-01-14 09:15:32 +00:00
2011-06-13 11:48:28 +00:00
set :haml, :format => :html5
2011-01-14 09:15:32 +00:00
get '/' do
2011-06-13 11:48:28 +00:00
haml :index
2011-01-14 09:15:32 +00:00
end
2011-06-13 11:48:28 +00:00
Опции, переданные в метод, переопределяют опции, заданные с помощью
+set+.
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
Доступные опции:
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
[locals]
Список локальных переменных, передаваемых в документ.
Например: <tt>erb "<%= foo %>", :locals => {:foo => "bar"}</tt>
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
[default_encoding]
Кодировка, которую следует использовать, если не удалось определить
оригинальную. По умолчанию: <tt>settings.default_encoding</tt>.
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
[views]
Директория с шаблонами. По умолчанию: <tt>settings.views</tt>.
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
[layout]
Использовать или нет лэйаут (+true+ или +false+). Если же значение Symbol,
то указывает, какой шаблон использовать в качестве лэйаута. Например:
<tt>erb :index, :layout => !request.xhr?</tt>
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
[content_type]
Content-Type отображенного шаблона. По умолчанию: задается шаблонизатором.
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
[scope]
Область видимости, в которой рендерятся шаблоны. По умолчанию: экземпляр
2011-06-15 07:52:31 +00:00
приложения. Если вы измените эту опцию, то переменные экземпляра и
2011-06-13 11:48:28 +00:00
методы-помощники станут недоступными в ваших шаблонах.
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
[layout_engine]
Шаблонизатор, который следует использовать для отображения лэйаута. Полезная
опция для шаблонизаторов, в которых нет никакой поддержки лэйаутов. По
умолчанию: тот же шаблонизатор, что используется и для самого шаблона.
Пример: <tt>set :rdoc, :layout_engine => :erb</tt>
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
По умолчанию считается, что шаблоны находятся в директории <tt>./views</tt>.
Чтобы использовать другую директорию с шаблонами:
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
set :views, settings.root + '/templates'
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
Важное замечание: вы всегда должны ссылаться на шаблоны с помощью символов
(Symbol), даже когда они в поддиректории (в этом случае используйте
<tt>:'subdir/template'</tt>). Вы должны использовать символы, потому что
иначе шаблонизаторы попросту отображают любые строки, переданные им.
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
=== Доступные шаблонизаторы
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
Некоторые языки шаблонов имеют несколько реализаций. Чтобы указать, какую
реализацию использовать, вам следует просто подключить нужную
библиотеку:
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
require 'rdiscount' # или require 'bluecloth'
get('/') { markdown :index }
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
=== Haml шаблоны
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
Зависимости:: {haml}[http://haml-lang.com/]
Расширения файлов:: <tt>.haml</tt>
Пример:: <tt>haml :index, :format => :html5</tt>
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
=== Erb шаблоны
2010-10-26 21:57:10 +00:00
2011-06-13 12:03:34 +00:00
Зависимости:: {erubis}[http://www.kuwata-lab.com/erubis/] или erb (включен в Ruby)
Расширения файлов:: <tt>.erb</tt>, <tt>.rhtml</tt> or <tt>.erubis</tt> (только Erubis)
2011-06-13 11:48:28 +00:00
Пример:: <tt>erb :index</tt>
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
=== Builder шаблоны
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
Зависимости:: {builder}[http://builder.rubyforge.org/]
Расширения файлов:: <tt>.builder</tt>
Пример:: <tt>builder { |xml| xml.em "hi" }</tt>
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
Блок также используется и для встроенных шаблонов (см. пример).
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
=== Nokogiri шаблоны
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
Зависимости:: {nokogiri}[http://nokogiri.org/]
Расширения файлов:: <tt>.nokogiri</tt>
Пример:: <tt>nokogiri { |xml| xml.em "hi" }</tt>
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
Блок также используется и для встроенных шаблонов (см. пример).
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
=== Sass шаблоны
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
Зависимости:: {sass}[http://sass-lang.com/]
Расширения файлов:: <tt>.sass</tt>
Пример:: <tt>sass :stylesheet, :style => :expanded</tt>
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
=== SCSS шаблоны
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
Зависимости:: {sass}[http://sass-lang.com/]
Расширения файлов:: <tt>.scss</tt>
Пример:: <tt>scss :stylesheet, :style => :expanded</tt>
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
=== Less шаблоны
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
Зависимости:: {less}[http://www.lesscss.org/]
Расширения файлов:: <tt>.less</tt>
Пример:: <tt>less :stylesheet</tt>
2010-10-26 21:57:10 +00:00
=== Liquid шаблоны
2011-06-13 11:48:28 +00:00
Зависимости:: {liquid}[http://www.liquidmarkup.org/]
Расширения файлов:: <tt>.liquid</tt>
Пример:: <tt>liquid :index, :locals => { :key => 'value' }</tt>
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
Так как в Liquid шаблонах невозможно вызывать методы из Ruby (кроме yield), то
вы почти всегда будете передавать в шаблон локальные переменные.
2010-10-26 21:57:10 +00:00
=== Markdown шаблоны
2011-06-13 12:03:34 +00:00
Зависимости:: {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/]
2011-06-13 11:48:28 +00:00
Расширения файлов:: <tt>.markdown</tt>, <tt>.mkd</tt> and <tt>.md</tt>
Пример:: <tt>markdown :index, :layout_engine => :erb</tt>
2010-10-26 21:57:10 +00:00
2011-01-14 09:23:06 +00:00
В Markdown невозможно вызывать методы или передавать локальные переменные.
2011-06-13 11:48:28 +00:00
Следовательно, вам, скорее всего, придется использовать этот шаблон совместно
с другим шаблонизатором:
2010-10-26 21:57:10 +00:00
erb :overview, :locals => { :text => markdown(:introduction) }
2011-01-14 09:23:06 +00:00
Заметьте, что вы можете вызывать метод +markdown+ из других шаблонов:
2010-10-26 21:57:10 +00:00
%h1 Hello From Haml!
%p= markdown(:greetings)
2011-06-13 11:48:28 +00:00
Вы не можете вызывать Ruby из Markdown, соответственно, вы не можете
использовать лэйауты на Markdown. Тем не менее, есть возможность использовать
один шаблонизатор для отображения шаблона, а другой для лэйаута с помощью
опции <tt>:layout_engine</tt>.
2011-01-14 09:23:06 +00:00
2010-10-26 21:57:10 +00:00
=== Textile шаблоны
2011-06-13 11:48:28 +00:00
Зависимости:: {RedCloth}[http://redcloth.org/]
Расширения файлов:: <tt>.textile</tt>
Пример:: <tt>textile :index, :layout_engine => :erb</tt>
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
В Textile невозможно вызывать методы или передавать локальные переменные.
Следовательно, вам, скорее всего, придется использовать этот шаблон совместно с
другим шаблонизатором:
2010-10-26 21:57:10 +00:00
erb :overview, :locals => { :text => textile(:introduction) }
2011-01-14 09:28:47 +00:00
Заметьте, что вы можете вызывать метод +textile+ из других шаблонов:
2010-10-26 21:57:10 +00:00
%h1 Hello From Haml!
%p= textile(:greetings)
2011-06-13 11:48:28 +00:00
Вы не можете вызывать Ruby из Textile, соответственно, вы не можете
использовать лэйауты на Textile. Тем не менее, есть возможность использовать
один шаблонизатор для отображения шаблона, а другой для лэйаута с помощью
опции <tt>:layout_engine</tt>.
2011-01-17 14:14:18 +00:00
2010-10-26 21:57:10 +00:00
=== RDoc шаблоны
2011-06-13 11:48:28 +00:00
Зависимости:: {rdoc}[http://rdoc.rubyforge.org/]
Расширения файлов:: <tt>.rdoc</tt>
Пример:: <tt>textile :README, :layout_engine => :erb</tt>
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
В RDoc невозможно вызывать методы или передавать локальные переменные.
Следовательно, вам, скорее всего, придется использовать этот шаблон совместно с
другим шаблонизатором:
2010-10-26 21:57:10 +00:00
erb :overview, :locals => { :text => rdoc(:introduction) }
2011-01-14 09:28:47 +00:00
Заметьте, что вы можете вызывать метод +rdoc+ из других шаблонов:
2010-10-26 21:57:10 +00:00
%h1 Hello From Haml!
%p= rdoc(:greetings)
2011-06-13 11:48:28 +00:00
Вы не можете вызывать Ruby из RDoc, соответственно, вы не можете
использовать лэйауты на RDoc. Тем не менее, есть возможность использовать
один шаблонизатор для отображения шаблона, а другой для лэйаута с помощью
опции <tt>:layout_engine</tt>.
2011-01-17 14:14:18 +00:00
2010-10-26 21:57:10 +00:00
=== Radius шаблоны
2011-06-13 11:48:28 +00:00
Зависимости:: {radius}[http://radius.rubyforge.org/]
Расширения файлов:: <tt>.radius</tt>
Пример:: <tt>radius :index, :locals => { :key => 'value' }</tt>
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
Так как в Radius шаблонах невозможно вызывать методы из Ruby напрямую, то
вы почти всегда будете передавать в шаблон локальные переменные.
2010-10-26 21:57:10 +00:00
=== Markaby шаблоны
2011-06-13 11:48:28 +00:00
Зависимости:: {markaby}[http://markaby.github.com/]
Расширения файлов:: <tt>.mab</tt>
Пример:: <tt>markaby { h1 "Welcome!" }</tt>
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
Блок также используется и для встроенных шаблонов (см. пример).
2010-12-20 11:21:07 +00:00
2010-11-05 12:59:49 +00:00
=== Slim шаблоны
2011-06-13 11:48:28 +00:00
Зависимости:: {slim}[http://slim-lang.com/]
Расширения файлов:: <tt>.slim</tt>
Пример:: <tt>slim :index</tt>
2010-11-05 12:59:49 +00:00
2011-04-15 09:51:35 +00:00
=== Creole шаблоны
2011-06-13 11:48:28 +00:00
Зависимости:: {creole}[https://github.com/minad/creole]
Расширения файлов:: <tt>.creole</tt>
Пример:: <tt>creole :wiki, :layout_engine => :erb</tt>
2011-04-15 09:51:35 +00:00
2011-06-13 11:48:28 +00:00
В Creole невозможно вызывать методы или передавать локальные переменные.
Следовательно, вам, скорее всего, придется использовать этот шаблон совместно с
другим шаблонизатором:
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
erb :overview, :locals => { :text => creole(:introduction) }
2011-01-14 14:07:44 +00:00
2011-06-13 11:48:28 +00:00
Заметьте, что вы можете вызывать метод +creole+ из других шаблонов:
2011-01-14 14:07:44 +00:00
2011-06-13 11:48:28 +00:00
%h1 Hello From Haml!
%p= creole(:greetings)
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
Вы не можете вызывать Ruby из Creole, соответственно, вы не можете
использовать лэйауты на Creole. Тем не менее, есть возможность использовать
один шаблонизатор для отображения шаблона, а другой для лэйаута с помощью
опции <tt>:layout_engine</tt>.
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
=== CoffeeScript шаблоны
2010-10-26 21:57:10 +00:00
2011-06-13 12:03:34 +00:00
Зависимости:: {coffee-script}[https://github.com/josh/ruby-coffee-script] и {способ запускать javascript}[https://github.com/sstephenson/execjs/blob/master/README.md#readme]
2011-06-13 11:48:28 +00:00
Расширения файлов:: <tt>.coffee</tt>
Пример:: <tt>coffee :index</tt>
2010-10-26 21:57:10 +00:00
2011-01-17 14:21:48 +00:00
=== Встроенные шаблоны
2010-10-26 21:57:10 +00:00
get '/' do
haml '%div.title Hello World'
end
2011-06-13 11:48:28 +00:00
Отобразит встроенный шаблон, переданный строкой.
2010-10-26 21:57:10 +00:00
=== Доступ к переменным в шаблонах
2011-01-17 14:14:18 +00:00
Шаблоны интерпретируются в том же контексте, что и обработчики маршрутов. Переменные экземпляра,
установленные в процессе обработки маршрутов, будут доступны напрямую в шаблонах:
2010-10-26 21:57:10 +00:00
get '/:id' do
@foo = Foo.find(params[:id])
haml '%h1= @foo.name'
end
2010-10-29 13:55:07 +00:00
Либо установите их через хеш локальных переменных:
2010-10-26 21:57:10 +00:00
get '/:id' do
foo = Foo.find(params[:id])
2011-06-13 11:48:28 +00:00
haml '%h1= bar.name', :locals => { :bar => foo }
2010-10-26 21:57:10 +00:00
end
2011-03-24 10:44:00 +00:00
Это обычный подход, когда шаблоны рендерятся как части других шаблонов.
2010-10-26 21:57:10 +00:00
2010-10-29 13:55:07 +00:00
=== Вложенные шаблоны
2010-10-26 21:57:10 +00:00
2011-03-23 23:32:42 +00:00
Шаблоны также могут быть определены в конце исходного файла:
2010-10-26 21:57:10 +00:00
require 'sinatra'
get '/' do
haml :index
end
__END__
@@ layout
%html
= yield
@@ index
%div.title Hello world!!!!!
2011-03-24 10:44:00 +00:00
Заметьте: вложенные шаблоны, определенные в исходном файле, который подключила Sinatra, будут
2010-10-29 13:55:07 +00:00
автоматически загружены. Вызовите <tt>enable :inline_templates</tt> напрямую, если у вас вложенные
2010-10-26 21:57:10 +00:00
шаблоны в других файлах.
=== Именные шаблоны
2011-03-23 23:32:42 +00:00
Шаблоны также могут быть определены при помощи <tt>template</tt> метода:
2010-10-26 21:57:10 +00:00
template :layout do
"%html\n =yield\n"
end
template :index do
'%div.title Hello World!'
end
get '/' do
haml :index
end
2011-03-24 10:44:00 +00:00
Если шаблон с именем "layout" существует, то он будет использоваться каждый раз
2011-06-13 11:48:28 +00:00
при рендеринге. Вы можете отключать лэйаут в каждом конкретном случае с помощью
<tt>:layout => false</tt> или отключить е г о для всего приложения, например, так:
<tt>set :haml, :layout => false</tt>:
2010-10-26 21:57:10 +00:00
get '/' do
haml :index, :layout => !request.xhr?
end
2011-01-17 14:34:02 +00:00
=== Привязка файловых расширений
2011-03-24 10:44:00 +00:00
Чтобы связать расширение файла с движком рендеринга, используйте
2011-01-17 14:34:02 +00:00
<tt>Tilt.register</tt>. Например, если вы хотите использовать расширение +tt+
для шаблонов Textile:
Tilt.register :tt, Tilt[:textile]
2011-01-18 13:17:54 +00:00
=== Добавление собственного движка рендеринга
2011-01-17 14:38:30 +00:00
2011-01-18 13:17:54 +00:00
Сначала зарегистрируйте свой движок в Tilt, затем создайте метод, отвечающий за отрисовку:
2011-01-17 14:38:30 +00:00
Tilt.register :myat, MyAwesomeTemplateEngine
helpers do
def myat(*args) render(:myat, *args) end
end
get '/' do
myat :index
end
2011-03-23 23:32:42 +00:00
Отобразит <tt>./views/index.myat</tt>. Чтобы узнать больше о Tilt,
2011-01-17 14:38:30 +00:00
смотрите https://github.com/rtomayko/tilt
2010-10-26 21:57:10 +00:00
== Фильтры
2011-03-19 13:20:32 +00:00
+before+-фильтры выполняются перед каждым запросом в том же контексте, что и маршруты. Фильтры могут изменять
2010-10-29 13:55:07 +00:00
как запрос, так и ответ на него. Переменные экземпляра, установленные в фильтрах, доступны в маршрутах и шаблонах:
2010-10-26 21:57:10 +00:00
before do
@note = 'Hi!'
request.path_info = '/foo/bar/baz'
end
get '/foo/*' do
@note #=> 'Hi!'
params[:splat] #=> 'bar/baz'
end
2011-03-19 13:20:32 +00:00
+after+-фильтры выполняются после каждого запроса в том же контексте, что и пути. Фильтры могут изменять
как запрос, так и ответ на него. Переменные экземпляра, установленные в +before+-фильтрах и маршрутах,
будут доступны в +after+-фильтрах:
2010-10-26 21:57:10 +00:00
after do
puts response.status
end
2011-03-19 13:20:32 +00:00
Заметьте: если вы используете метод +body+, а не просто возвращаете строку из
2011-03-23 23:32:42 +00:00
маршрута, то тело ответа не будет доступно в +after+-фильтрах, так как оно будет сгенерировано позднее.
2011-03-19 13:20:32 +00:00
2011-03-23 23:32:42 +00:00
Фильтры могут использовать шаблоны URL и будут интерпретированы только если путь запроса совпадет с этим шаблоном:
2010-10-26 21:57:10 +00:00
before '/protected/*' do
authenticate!
end
after '/create/:slug' do |slug|
session[:last_slug] = slug
end
2010-12-20 11:21:07 +00:00
Как и маршруты, фильтры могут использовать условия:
before :agent => /Songbird/ do
# ...
end
after '/blog/*', :host_name => 'example.com' do
# ...
end
2011-03-19 13:20:32 +00:00
== Методы-помощники
Используйте метод <tt>helpers</tt>, чтобы определить методы-помощники, которые
в дальнейшем можно будет использовать в обработчиках маршрутов и шаблонах:
helpers do
def bar(name)
"#{name}bar"
end
end
get '/:name' do
bar(params[:name])
end
=== Использование сессий
Сессия используется, чтобы сохранять состояние между запросами. Если эта опция
2011-06-15 07:52:31 +00:00
включена, то у вас будет один хеш сессии на одну пользовательскую сессию:
2011-03-19 13:20:32 +00:00
enable :sessions
get '/' do
"value = " << session[:value].inspect
end
get '/:value' do
session[:value] = params[:value]
end
Заметьте, что при использовании <tt>enable :sessions</tt> все данные
2011-03-24 10:44:00 +00:00
сохраняются в cookies. Это может быть не совсем то, что вы хотите (например,
2011-03-19 13:20:32 +00:00
сохранение больших объемов данных увеличит ваш трафик). В таком случае вы
можете использовать альтернативную Rack "прослойку" (middleware), реализующую
механизм сессий. Для этого *не надо* вызывать <tt>enable :sessions</tt>,
2011-06-15 07:52:31 +00:00
вместо этого следует подключить е е так же, как и любую другую "прослойку":
2011-03-19 13:20:32 +00:00
use Rack::Session::Pool, :expire_after => 2592000
get '/' do
"value = " << session[:value].inspect
end
get '/:value' do
session[:value] = params[:value]
end
Для повышения безопасности данные сессии в куках подписываются секретным
ключом. Секретный ключ генерируется Sinatra. Тем не менее, так как этот
ключ будет меняться с каждым запуском приложения, вы, возможно, захотите
установить ключ вручную, чтобы у всех экземпляров вашего приложения
2011-06-15 07:52:31 +00:00
был один и тот же ключ:
2011-03-19 13:20:32 +00:00
set :session_secret, 'super secret'
2011-06-15 07:52:31 +00:00
Если вы хотите больше настроек для сессий, вы можете задать их, передав хеш опций в параметр +sessions+:
2011-03-19 13:20:32 +00:00
set :sessions, :domain => 'foo.com'
=== Прерывание
2010-10-26 21:57:10 +00:00
2010-10-29 14:24:21 +00:00
Чтобы незамедлительно прервать обработку запроса внутри фильтра или маршрута, используйте:
2010-10-26 21:57:10 +00:00
halt
Можно также указать статус при прерывании:
halt 410
2010-10-29 13:55:07 +00:00
Тело:
2010-10-26 21:57:10 +00:00
halt 'this will be the body'
2010-10-29 13:55:07 +00:00
И то, и другое:
2010-10-26 21:57:10 +00:00
halt 401, 'go away!'
Можно указать заголовки:
halt 402, {'Content-Type' => 'text/plain'}, 'revenge'
2011-03-19 13:20:32 +00:00
И, конечно, можно использовать шаблоны с +halt+:
halt erb(:error)
=== Передача
2010-10-26 21:57:10 +00:00
2010-10-29 13:55:07 +00:00
Маршрут может передать обработку запроса следующему совпадающему маршруту, используя <tt>pass</tt>:
2010-10-26 21:57:10 +00:00
get '/guess/:who' do
pass unless params[:who] == 'Frank'
'You got me!'
end
get '/guess/*' do
'You missed!'
end
2010-10-29 13:55:07 +00:00
Блок маршрута сразу же прерывается, и контроль переходит к следующему совпадающему маршруту.
Если соответствующий маршрут не найден, то ответом на запрос будет 404.
2010-10-26 21:57:10 +00:00
2011-03-19 13:20:32 +00:00
=== Вызов другого маршрута
Иногда +pass+ не подходит, например, если вы хотите получить результат
вызова другого обработчика маршрута. В таком случае просто используйте +call+:
get '/foo' do
2011-04-17 10:43:22 +00:00
status, headers, body = call env.merge("PATH_INFO" => '/bar')
2011-04-17 10:56:03 +00:00
[status, headers, body.map(&:upcase)]
2011-03-19 13:20:32 +00:00
end
get '/bar' do
"bar"
end
Заметьте, что в предыдущем примере можно облегчить тестирование и повысить
производительность, перенеся <tt>"bar"</tt> в метод-помощник, используемый
и в <tt>/foo</tt>, и в <tt>/bar</tt>.
Если вы хотите, чтобы запрос был отправлен в тот же экземпляр приложения, а не
в е г о копию, используйте <tt>call!</tt> вместо <tt>call</tt>.
Если хотите узнать больше о <tt>call</tt>, смотрите спецификацию Rack.
=== Задание тела, кода и заголовков ответа
Хорошим тоном является установка кода состояния HTTP и тела ответа в возвращаемом
значении обработчика маршрута. Тем не менее, в некоторых ситуациях вам, возможно,
понадобится задать тело ответа в произвольной точке потока исполнения. Вы можете
сделать это с помощью метода-помощника +body+. Если вы задействуете метод +body+,
то вы можете использовать е г о и в дальнейшем, чтобы получить доступ к телу ответа.
get '/foo' do
body "bar"
end
after do
puts body
end
Также можно передать блок в метод +body+, который затем будет вызван
обработчиком Rack (такой подход может быть использован для реализации поточного
ответа, см. "Возвращаемые значения").
Аналогично вы можете установить код ответа и е г о заголовки:
get '/foo' do
status 418
headers \
"Allow" => "BREW, POST, GET, PROPFIND, WHEN"
"Refresh" => "Refresh: 20; http://www.ietf.org/rfc/rfc2324.txt"
body "I'm a tea pot!"
end
Как и +body+, методы +headers+ и +status+, вызванные без аргументов, возвращают
свои текущие значения.
2011-03-24 10:44:00 +00:00
=== Логирование
2011-03-23 14:56:51 +00:00
В области видимости запроса метод +logger+ предоставляет доступ к экземпляру +Logger+:
get '/' do
logger.info "loading data"
# ...
end
2011-03-24 10:44:00 +00:00
Этот логер автоматически учитывает ваши настройки логирования в Rack. Если
логирование выключено, то этот метод вернет пустой (dummy) объект, поэтому вы можете
2011-03-23 14:56:51 +00:00
смело использовать е г о в маршрутах и фильтрах.
2011-03-24 10:44:00 +00:00
Заметьте, что логирование включено по умолчанию только для <tt>Sinatra::Application</tt>,
2011-03-23 23:32:42 +00:00
а если ваше приложение -- подкласс <tt>Sinatra::Base</tt>, то вы, наверное, захотите включить
2011-03-23 14:56:51 +00:00
е г о вручную:
class MyApp < Sinatra::Base
configure(:production, :development) do
enable :logging
end
end
2011-03-19 13:20:32 +00:00
=== Mime-типы
Когда вы используете <tt>send_file</tt> или статические файлы, у вас могут быть mime-типы, которые Sinatra
не понимает по умолчанию. Используйте +mime_type+ для их регистрации по расширению файла:
2011-06-13 11:48:28 +00:00
configure do
mime_type :foo, 'text/foo'
end
2011-03-19 13:20:32 +00:00
2011-03-23 23:32:42 +00:00
Вы также можете использовать это в +content_type+ методе-помощнике:
2011-03-19 13:20:32 +00:00
get '/' do
content_type :foo
"foo foo foo"
end
=== Генерирование URL
Чтобы сформировать URL вам следует использовать метод +url+, например, в Haml:
%a{:href => url('/foo')} foo
Этот метод учитывает обратные прокси и маршрутизаторы Rack, если они присутствуют.
Наряду с +url+ вы можете использовать +to+ (смотрите пример ниже).
=== Перенаправление (редирект)
Вы можете перенаправить браузер пользователя с помощью метода +redirect+:
get '/foo' do
redirect to('/bar')
end
Любые дополнительные параметры используются по аналогии с аргументами метода +halt+:
redirect to('/bar'), 303
redirect 'http://google.com', 'wrong place, buddy'
Вы также можете перенаправить пользователя обратно, на страницу с которой он пришел,
с помощью <tt>redirect back</tt>:
get '/foo' do
"<a href='/bar'>do something</a>"
end
get '/bar' do
do_something
redirect back
end
Чтобы передать какие-либо параметры вместе с перенаправлением, либо добавьте их в строку запроса:
redirect to('/bar?sum=42')
2011-06-15 07:52:31 +00:00
либо используйте сессию:
2011-03-19 13:20:32 +00:00
enable :session
get '/foo' do
session[:secret] = 'foo'
redirect to('/bar')
end
get '/bar' do
session[:secret]
end
=== Управление кэшированием
Установка корректных заголовков — основа правильного HTTP кэширования.
Вы можете легко выставить заголовок Cache-Control таким образом:
get '/' do
cache_control :public
"cache it!"
end
Совет: задавайте кэширование в +before+-фильтре:
before do
cache_control :public, :must_revalidate, :max_age => 60
end
Если вы используете метод +expires+ для задания соответствующего заголовка,
то <tt>Cache-Control</tt> будет выставлен автоматически:
before do
expires 500, :public, :must_revalidate
end
2011-06-15 07:52:31 +00:00
Чтобы как следует использовать кэширование, вам следует подумать о б использовании
2011-03-24 10:44:00 +00:00
+etag+ и +last_modified+. Рекомендуется использовать эти методы-помощники *до*
2011-06-15 07:52:31 +00:00
выполнения ресурсоемких вычислений, так как они немедленно отправят ответ клиенту,
2011-03-24 10:44:00 +00:00
если текущая версия уже есть в их кэше:
2011-03-19 13:20:32 +00:00
get '/article/:id' do
@article = Article.find params[:id]
last_modified @article.updated_at
etag @article.sha1
erb :article
end
2011-03-24 10:44:00 +00:00
Также вы можете использовать
2011-03-19 13:20:32 +00:00
{weak ETag}[http://en.wikipedia.org/wiki/HTTP_ETag#Strong_and_weak_validation]:
etag @article.sha1, :weak
Эти методы-помощники не станут ничего кэшировать для вас, но они дадут
необходимую информацию для вашего кэша. Если вы ищите легкое решение для
кэширования, попробуйте {rack-cache}[http://rtomayko.github.com/rack-cache/]:
2011-03-24 10:44:00 +00:00
require 'rack/cache'
require 'sinatra'
2011-03-19 13:20:32 +00:00
use Rack::Cache
get '/' do
cache_control :public, :max_age => 36000
sleep 5
"hello"
end
2011-06-13 11:48:28 +00:00
Используйте опцию <tt>:static_cache_control</tt> (см. ниже), чтобы
добавить заголовок <tt>Cache-Control</tt> к статическим файлам.
2011-03-19 13:20:32 +00:00
=== Отправка файлов
Для отправки файлов пользователю вы можете использовать метод <tt>send_file</tt>:
get '/' do
send_file 'foo.png'
end
Этот метод имеет несколько опций:
send_file 'foo.png', :type => :jpg
Возможные опции:
[filename]
имя файла, по умолчанию: реальное имя файла.
[last_modified]
значение для заголовка Last-Modified, по умолчанию: mtime (время изменения) файла.
[type]
2011-03-23 23:32:42 +00:00
тип файла, по умолчанию: предполагается по расширению файла.
2011-03-19 13:20:32 +00:00
[disposition]
используется для заголовка Content-Disposition, возможные значения:
+nil+ (по умолчанию), <tt>:attachment</tt> и <tt>:inline</tt>.
[length]
значения для заголовка Content-Length, по умолчанию: размер файла.
Этот метод будет использовать возможности Rack сервера для отправки файлов, если они
доступны, а в противном случае, будет напрямую отдавать файл из Ruby процесса.
Метод <tt>send_file</tt> также обеспечивает автоматическую обработку частичных (range)
запросов с помощью Sinatra.
2010-10-26 21:57:10 +00:00
2011-03-23 23:32:42 +00:00
=== Доступ к объекту запроса
2011-03-19 13:20:32 +00:00
Объект входящего запроса доступен на уровне обработки запроса (в фильтрах, маршрутах,
обработчиках ошибок) с помощью <tt>request</tt> метода:
2010-10-26 21:57:10 +00:00
# приложение запущено на http://example.com/example
get '/foo' do
2011-06-13 11:48:28 +00:00
t = %w[text/css text/html application/javascript]
request.accept # ['text/html', '*/*']
request.accept? 'text/xml' # true
request.preferred_type(t) # 'text/html'
request.body # тело запроса, посланное клиентом (см. ниже)
request.scheme # "http"
request.script_name # "/example"
request.path_info # "/foo"
request.port # 80
request.request_method # "GET"
request.query_string # ""
request.content_length # длина тела запроса
request.media_type # медиатип тела запроса
request.host # "example.com"
request.get? # true (есть аналоги для других методов HTTP)
request.form_data? # false
request["SOME_HEADER"] # значение заголовка SOME_HEADER
request.referrer # источник запроса клиента либо '/'
request.user_agent # user agent (используется для :agent условия)
request.cookies # хеш, содержащий cookies браузера
request.xhr? # является ли запрос ajax запросом?
request.url # "http://example.com/example/foo"
request.path # "/example/foo"
request.ip # IP-адрес клиента
request.secure? # false (true, если запрос сделан через SSL)
request.forwarded? # true (если сервер работает за обратным прокси)
request.env # "сырой" env хеш, полученный Rack
2010-10-26 21:57:10 +00:00
end
2011-03-23 23:32:42 +00:00
Некоторые опции, такие как <tt>script_name</tt> или <tt>path_info</tt> доступны для изменения:
2010-10-26 21:57:10 +00:00
before { request.path_info = "/" }
get "/" do
"all requests end up here"
end
2010-10-29 13:55:07 +00:00
<tt>request.body</tt> является IO или StringIO объектом:
2010-10-26 21:57:10 +00:00
post "/api" do
2010-10-29 13:55:07 +00:00
request.body.rewind # в случае, если кто-то уже прочитал тело запроса
2010-10-26 21:57:10 +00:00
data = JSON.parse request.body.read
"Hello #{data['name']}!"
end
2011-03-19 13:20:32 +00:00
=== Вложения
Вы можете использовать метод +attachment+, чтобы сказать браузеру, что ответ
сервера должен быть сохранен на диск, а не отображен:
get '/' do
attachment
"store it!"
end
2011-03-23 23:32:42 +00:00
Вы также можете указать имя файла:
2011-03-19 13:20:32 +00:00
get '/' do
attachment "info.txt"
"store it!"
end
=== Поиск шаблонов
Для поиска шаблонов и их последующего рендеринга используется метод <tt>find_template</tt>:
find_template settings.views, 'foo', Tilt[:haml] do |file|
puts "could be #{file}"
end
2011-06-15 07:52:31 +00:00
Это не слишком полезный пример. Зато полезен тот факт, что вы можете переопределить
2011-03-19 13:20:32 +00:00
этот метод, чтобы использовать свой собственный механизм поиска. Например, если вы
хотите, чтобы можно было использовать несколько директорий с шаблонами:
set :views, ['views', 'templates']
helpers do
def find_template(views, name, engine, &block)
Array(views).each { |v| super(v, name, engine, &block) }
end
end
Другой пример, в котором используются разные директории для движков рендеринга:
set :views, :sass => 'views/sass', :haml => 'templates', :default => 'views'
helpers do
def find_template(views, name, engine, &block)
_, folder = views.detect { |k,v| engine == Tilt[k] }
folder ||= views[:default]
super(folder, name, engine, &block)
end
end
Вы можете легко вынести этот код в расширение и поделиться им с остальными!
2011-06-15 07:52:31 +00:00
Заметьте, что <tt>find_template</tt> не проверяет, существует ли файл на самом деле,
2011-03-19 13:20:32 +00:00
а вызывает заданный блок для всех возможных путей. Дело тут не в производительности,
дело в том, что +render+ вызовет +break+, как только файл не будет найден.
Содержимое и местонахождение шаблонов будет закэшировано, если приложение запущено не
2011-03-24 10:44:00 +00:00
в режиме разработки (set :environment, :development). Вы должны помнить о б этих нюансах,
2011-06-15 07:52:31 +00:00
если пишите по-настоящему "сумасшедший" метод.
2011-03-19 13:20:32 +00:00
2010-10-26 21:57:10 +00:00
== Конфигурация
2010-10-29 13:55:07 +00:00
Этот блок исполняется один раз при старте в любом окружении, режиме (environment):
2010-10-26 21:57:10 +00:00
configure do
2011-03-19 13:20:32 +00:00
# задание одной опции
set :option, 'value'
# устанавливаем несколько опций
set :a => 1, :b => 2
# то же самое, что и `set :option, true`
enable :option
# то же самое, что и `set :option, false`
disable :option
# у вас могут быть "динамические" опции с блоками
set(:css_dir) { File.join(views, 'css') }
2010-10-26 21:57:10 +00:00
end
2011-03-19 13:20:32 +00:00
Будет запущено, когда окружение (RACK_ENV переменная) <tt>:production</tt>:
2010-10-26 21:57:10 +00:00
configure :production do
...
end
2010-10-29 13:55:07 +00:00
Будет запущено, когда окружение <tt>:production</tt> или <tt>:test</tt>:
2010-10-26 21:57:10 +00:00
configure :production, :test do
...
end
2011-03-19 13:20:32 +00:00
Вы можете получить доступ к этим опциям с помощью <tt>settings</tt>:
configure do
set :foo, 'bar'
end
get '/' do
settings.foo? # => true
settings.foo # => 'bar'
...
end
=== Доступные настройки
2011-06-13 11:48:28 +00:00
[absolute_redirects] если отключено, то Sinatra будет позволять использование
2011-06-15 07:52:31 +00:00
относительных перенаправлений, но при этом перестанет
2011-06-13 11:48:28 +00:00
соответствовать RFC 2616 (HTTP 1.1), который разрешает только
абсолютные перенаправления.
2011-03-19 13:20:32 +00:00
2011-06-13 11:48:28 +00:00
Включайте эту опцию, если ваше приложение работает за обратным прокси,
который настроен не совсем корректно. Обратите внимание, метод +url+
все равно будет генерировать абсолютные URL, если вы не передадите
+false+ вторым аргументом.
2011-03-19 13:20:32 +00:00
2011-06-13 11:48:28 +00:00
Отключено по умолчанию.
2011-03-19 13:20:32 +00:00
2011-06-13 11:48:28 +00:00
[add_charsets] mime-типы, к которым метод <tt>content_type</tt> будет автоматически
добавлять информацию о кодировке.
2011-03-19 13:20:32 +00:00
2011-06-13 11:48:28 +00:00
Вам следует добавлять значения к этой опции вместо е е переопределения:
2011-03-19 13:20:32 +00:00
2011-06-13 11:48:28 +00:00
settings.add_charsets << "application/foobar"
2011-03-19 13:20:32 +00:00
2011-06-13 11:48:28 +00:00
[app_file] главный файл приложения, используется для определения корневой директории
проекта, директорий с шаблонами и статическими файлами, вложенных шаблонов.
2011-03-19 13:20:32 +00:00
2011-06-13 11:48:28 +00:00
[bind] используемый IP-адрес (по умолчанию: 0.0.0.0). Используется только
встроенным сервером.
2011-03-19 13:20:32 +00:00
2011-06-13 11:48:28 +00:00
[default_encoding] кодировка, если неизвестна (по умолчанию: <tt>"utf-8"</tt>).
2011-03-19 13:20:32 +00:00
2011-06-13 11:48:28 +00:00
[dump_errors] отображать ошибки в логе.
2011-03-19 13:20:32 +00:00
2011-06-13 11:48:28 +00:00
[environment] текущее окружение, по умолчанию, значение <tt>ENV['RACK_ENV']</tt>
или <tt>"development"</tt>, если <tt>ENV['RACK_ENV']</tt> не доступна.
2011-03-19 13:20:32 +00:00
2011-06-13 11:48:28 +00:00
[logging] использовать логер.
2011-03-19 13:20:32 +00:00
2011-06-13 11:48:28 +00:00
[lock] создает блокировку для каждого запроса, которая гарантирует обработку
только одного запроса в текущий момент времени в Ruby процессе.
2011-03-19 13:20:32 +00:00
2011-06-13 11:48:28 +00:00
Включайте, если ваше приложение не потоко-безопасно (thread-safe).
Отключено по умолчанию.
2011-03-19 13:20:32 +00:00
2011-06-13 11:48:28 +00:00
[method_override] использовать "магический" параметр <tt>_method</tt>, чтобы позволить
использование PUT/DELETE форм в браузерах, которые не поддерживают
эти методы.
2011-03-19 13:20:32 +00:00
2011-06-13 11:48:28 +00:00
[port] порт, на котором будет работать сервер. Используется только
встроенным сервером.
2011-03-19 13:20:32 +00:00
2011-06-13 11:48:28 +00:00
[prefixed_redirects] добавлять или нет параметр <tt>request.script_name</tt> к редиректам,
если не задан абсолютный путь. Таким образом, <tt>redirect '/foo'</tt>
будет вести себя как <tt>redirect to('/foo')</tt>. Отключено по умолчанию.
2011-03-19 13:20:32 +00:00
2011-06-15 22:24:27 +00:00
[public_folder] директория, откуда будут раздаваться статические файлы.
2011-03-19 13:20:32 +00:00
2011-06-13 11:48:28 +00:00
[reload_templates] перезагружать или нет шаблоны на каждый запрос.
Включено в режиме разработки.
2011-03-19 13:20:32 +00:00
2011-06-13 11:48:28 +00:00
[root] корневая директория проекта.
2011-03-19 13:20:32 +00:00
2011-06-13 11:48:28 +00:00
[raise_errors] выбрасывать исключения (будет останавливать приложение).
2011-03-19 13:20:32 +00:00
2011-06-13 11:48:28 +00:00
[run] если включено, Sinatra будет самостоятельно запускать веб-сервер.
Н е включайте, если используете rackup или аналогичные средства.
2011-03-19 13:20:32 +00:00
2011-06-13 11:48:28 +00:00
[running] работает ли сейчас встроенный сервер?
Н е меняйте эту опцию!
2011-03-19 13:20:32 +00:00
2011-06-13 11:48:28 +00:00
[server] сервер или список серверов, которые следует использовать в качестве
встроенного сервера. По умолчанию: ['thin', 'mongrel', 'webrick'],
порядок задает приоритет.
2011-03-19 13:20:32 +00:00
2011-06-13 11:48:28 +00:00
[sessions] включить сессии на основе кук (cookie).
2011-03-19 13:20:32 +00:00
2011-06-13 11:48:28 +00:00
[show_exceptions] показывать исключения/стек вызовов (stack trace) в браузере.
2011-03-19 13:20:32 +00:00
2011-06-13 11:48:28 +00:00
[static] должна ли Sinatra осуществлять раздачу статических файлов.
Отключите, когда используете какой-либо веб-сервер для этой цели.
Отключение значительно улучшит производительность приложения.
По умолчанию включено в классических и отключено в модульных
приложениях.
[static_cache_control] Когда Sinatra отдает статические файлы, используйте эту опцию,
чтобы добавить им заголовок <tt>Cache-Control</tt>. Для этого
используется метод-помощник +cache_control+. По умолчанию отключено.
Используйте массив, когда надо задать несколько значений:
<tt>set :static_cache_control, [:public, :max_age => 300]</tt>
2011-03-19 13:20:32 +00:00
[views] директория с шаблонами.
2010-10-26 21:57:10 +00:00
== Обработка ошибок
2011-06-15 07:52:31 +00:00
Обработчики ошибок исполняются в том же контексте, что и маршруты, и +before+-фильтры, а это означает, что всякие
2010-10-29 13:55:07 +00:00
прелести вроде <tt>haml</tt>, <tt>erb</tt>, <tt>halt</tt> и т.д. доступны и им.
2010-10-26 21:57:10 +00:00
2011-03-24 10:44:00 +00:00
=== Not Found
2010-10-26 21:57:10 +00:00
2011-03-23 23:32:42 +00:00
Когда выброшено исключение <tt>Sinatra::NotFound</tt>, или кодом ответа является 404,
2010-10-29 13:55:07 +00:00
то будет вызван <tt>not_found</tt> обработчик:
2010-10-26 21:57:10 +00:00
not_found do
'This is nowhere to be found.'
end
2010-10-29 13:55:07 +00:00
=== Ошибки
2010-10-26 21:57:10 +00:00
2011-03-23 23:32:42 +00:00
Обработчик ошибок +error+ будет вызван, когда исключение выброшено из блока маршрута, либо из фильтра.
2010-10-29 13:55:07 +00:00
Объект-исключение доступен как переменная <tt>sinatra.error</tt> в Rack:
2010-10-26 21:57:10 +00:00
error do
'Sorry there was a nasty error - ' + env['sinatra.error'].name
end
Частные ошибки:
error MyCustomError do
2011-04-17 10:43:22 +00:00
'So what happened was...' + env['sinatra.error'].message
2010-10-26 21:57:10 +00:00
end
Тогда, если это произошло:
get '/' do
raise MyCustomError, 'something bad'
end
Т о вы получите:
So what happened was... something bad
2010-10-29 13:55:07 +00:00
Также вы можете установить обработчик ошибок для кода состояния HTTP:
2010-10-26 21:57:10 +00:00
error 403 do
'Access forbidden'
end
get '/secret' do
403
end
Либо набора кодов:
error 400..510 do
'Boom'
end
2011-03-23 23:32:42 +00:00
Sinatra устанавливает специальные <tt>not_found</tt> и <tt>error</tt> обработчики, когда приложение запущено в режиме
2010-10-29 13:55:07 +00:00
разработки (окружение <tt>:development</tt>).
2010-10-26 21:57:10 +00:00
2011-01-14 09:05:42 +00:00
== Rack "прослойки"
2010-10-26 21:57:10 +00:00
Sinatra использует Rack[http://rack.rubyforge.org/], минимальный стандартный
2010-10-29 13:55:07 +00:00
интерфейс для веб-фреймворков на Ruby. Одной из самых интересных для разработчиков возможностей Rack
2011-01-14 09:05:42 +00:00
является поддержка "прослоек" ("middleware") — компонентов,
2011-03-23 23:32:42 +00:00
находящихся "между" сервером и вашим приложением, которые отслеживают и/или манипулируют
2010-10-29 13:55:07 +00:00
HTTP запросами/ответами для предоставления различной функциональности.
2010-10-26 21:57:10 +00:00
2011-01-14 09:05:42 +00:00
В Sinatra очень просто использовать такие "прослойки" с помощью метода +use+:
2010-10-26 21:57:10 +00:00
require 'sinatra'
require 'my_custom_middleware'
use Rack::Lint
use MyCustomMiddleware
get '/hello' do
'Hello World'
end
2010-10-29 13:55:07 +00:00
Семантика +use+ идентична той, что определена для
2010-10-26 21:57:10 +00:00
Rack::Builder[http://rack.rubyforge.org/doc/classes/Rack/Builder.html] DSL
2011-06-15 07:52:31 +00:00
(чаще всего используется в rackup файлах). Например, метод +use+ принимает
как множественные переменные, так и блоки:
2010-10-26 21:57:10 +00:00
use Rack::Auth::Basic do |username, password|
username == 'admin' && password == 'secret'
end
2011-01-14 09:05:42 +00:00
Rack распространяется с различными стандартными "прослойками"
2011-03-24 10:44:00 +00:00
для логирования, отладки, маршрутизации URL, аутентификации, обработки сессий. Sinatra использует
2010-10-29 14:24:21 +00:00
многие из этих компонентов автоматически, основываясь на конфигурации, чтобы вам не приходилось
2011-03-23 23:32:42 +00:00
подключать (+use+) их вручную.
2010-10-26 21:57:10 +00:00
2011-06-13 11:48:28 +00:00
Вы можете найти полезные прослойки в
{rack}[https://github.com/rack/rack/tree/master/lib/rack],
{rack-contrib}[https://github.com/rack/rack-contrib#readme],
{CodeRack}[http://coderack.org/] или в
{Rack wiki}[https://github.com/rack/rack/wiki/List-of-Middleware].
2010-10-26 21:57:10 +00:00
== Тестирование
2010-10-29 13:55:07 +00:00
Тесты для Sinatra приложений могут быть написаны с помощью библиотек, фреймворков, поддерживающих
2011-06-13 11:48:28 +00:00
тестирование Rack. {Rack::Test}[http://rdoc.info/github/brynary/rack-test/master/frames] рекомендован:
2010-10-26 21:57:10 +00:00
require 'my_sinatra_app'
require 'test/unit'
require 'rack/test'
class MyAppTest < Test::Unit::TestCase
include Rack::Test::Methods
def app
Sinatra::Application
end
def test_my_default
get '/'
assert_equal 'Hello World!', last_response.body
end
def test_with_params
get '/meet', :name => 'Frank'
assert_equal 'Hello Frank!', last_response.body
end
def test_with_rack_env
get '/', {}, 'HTTP_USER_AGENT' => 'Songbird'
assert_equal "You're using Songbird!", last_response.body
end
end
2011-01-14 09:05:42 +00:00
== Sinatra::Base — "прослойки", библиотеки и модульные приложения
2010-10-26 21:57:10 +00:00
2011-06-15 07:52:31 +00:00
Описание своего приложения самым простейшим способом (с помощью DSL верхнего уровня,
как в примерах выше) отлично работает для крохотных приложений. Тем не менее,
такой метод имеет множество недостатков при создании компонентов, таких как
Rack middleware ("прослоек"), Rails metal, простых библиотек с серверными компонентами,
расширений Sinatra.
2011-03-24 10:44:00 +00:00
DSL верхнего уровня "загрязняет" пространство имен <tt>Object</tt> и подразумевает стиль конфигурации
2011-06-13 11:48:28 +00:00
микро-приложения (например, единый файл приложения, <tt>./public</tt> и
<tt>./views</tt> директории, логирование, страницу деталей о б исключениях
и т.д.). И тут на помощь приходит <tt>Sinatra::Base</tt>:
2010-10-26 21:57:10 +00:00
require 'sinatra/base'
class MyApp < Sinatra::Base
set :sessions, true
set :foo, 'bar'
get '/' do
'Hello world!'
end
end
2011-06-13 11:48:28 +00:00
Методы, доступные <tt>Sinatra::Base</tt> подклассам идентичны тем, что доступны
2010-10-29 13:55:07 +00:00
в DSL верхнего уровня. Большинство приложений верхнего уровня могут быть
2011-06-13 11:48:28 +00:00
конвертированы в <tt>Sinatra::Base</tt> компоненты с помощью двух модификаций:
2010-10-26 21:57:10 +00:00
2011-03-19 13:20:32 +00:00
* Вы должны подключать <tt>sinatra/base</tt> вместо +sinatra+,
2011-06-15 07:52:31 +00:00
иначе все методы, предоставляемые Sinatra, будут импортированы в глобальное пространство имен.
2011-06-13 11:48:28 +00:00
* Поместите все маршруты, обработчики ошибок, фильтры и опции в подкласс <tt>Sinatra::Base</tt>.
2010-10-26 21:57:10 +00:00
2010-10-29 13:55:07 +00:00
<tt>Sinatra::Base</tt> — это чистый лист. Большинство опций, включая встроенный сервер, по умолчанию отключены.
2011-06-15 07:52:31 +00:00
Смотрите {Опции и конфигурация}[http://www.sinatrarb.com/configuration.html] для детальной информации
2010-10-29 13:55:07 +00:00
о б опциях и их поведении.
2010-10-26 21:57:10 +00:00
2011-03-19 13:20:32 +00:00
=== Модульные приложения против классических
2011-06-15 07:52:31 +00:00
Вопреки всеобщему убеждению, в классическом стиле (самом простом) нет ничего плохого.
2011-03-19 13:20:32 +00:00
Если этот стиль подходит вашему приложению, вы не обязаны переписывать е г о в модульное
приложение.
У классического стиля есть всего два недостатка относительно модульного:
2011-06-15 07:52:31 +00:00
* У вас может быть только одно приложение Sinatra на один Ruby процесс. Если вы планируете
2011-03-19 13:20:32 +00:00
использовать больше, то переключайтесь на модульный стиль.
* Приложения, использующие классический стиль, добавляют методы к Object. Если вы
2011-06-15 07:52:31 +00:00
планируете поставлять свое приложение в виде библиотеки/gem, то переходите
2011-03-19 13:20:32 +00:00
на модульный стиль.
Н е существует причин, по которым вы не могли бы смешивать модульный и классический стили.
Переходя с одного стиля на другой, примите во внимание следующие изменения в настройках:
Опция Классический Модульный
2011-06-13 11:48:28 +00:00
app_file файл с приложением файл с подклассом Sinatra::Base
2011-03-19 13:20:32 +00:00
run $0 == app_file false
logging true false
method_override true false
inline_templates true false
2011-06-13 11:48:28 +00:00
static true false
2011-03-19 13:20:32 +00:00
2011-01-14 08:57:04 +00:00
=== Запуск модульных приложений
Есть два общепринятых способа запускать модульные приложения: запуск напрямую с помощью <tt>run!</tt>:
# my_app.rb
require 'sinatra/base'
class MyApp < Sinatra::Base
# ... здесь код приложения ...
# запускаем сервер, если исполняется текущий файл
run! if app_file == $0
end
И запускаем с помощью:
ruby my_app.rb
Или с помощью конфигурационного файла <tt>config.ru</tt>, который позволяет использовать любой
Rack-совместимый сервер приложений.
# config.ru
2011-06-01 09:52:09 +00:00
require './my_app'
2011-01-14 08:57:04 +00:00
run MyApp
Запускаем:
rackup -p 4567
2011-03-19 13:20:32 +00:00
=== Запуск классических приложений с config.ru
2011-01-14 08:57:04 +00:00
Файл приложения:
# app.rb
require 'sinatra'
get '/' do
'Hello world!'
end
И соответствующий <tt>config.ru</tt>:
2011-06-01 09:52:09 +00:00
require './app'
2011-01-14 08:57:04 +00:00
run Sinatra::Application
=== Когда использовать config.ru?
Вот несколько причин, по которым вы, возможно, захотите использовать <tt>config.ru</tt>:
* вы хотите разворачивать свое приложение на различных Rack-совместимых серверах (Passenger, Unicorn,
2011-03-24 10:44:00 +00:00
Heroku, ...);
* вы хотите использовать более одного подкласса <tt>Sinatra::Base</tt>;
2011-01-14 09:05:42 +00:00
* вы хотите использовать Sinatra только в качестве "прослойки" Rack.
2011-01-14 08:57:04 +00:00
<b>Совсем необязательно переходить на использование <tt>config.ru</tt> лишь потому, что вы стали
использовать модульный стиль приложения. И необязательно использовать модульный стиль, чтобы
запускать приложение с помощью <tt>config.ru</tt>.</b>
2011-01-14 09:05:42 +00:00
=== Использование Sinatra в качестве "прослойки"
2010-10-26 21:57:10 +00:00
2011-06-15 07:52:31 +00:00
Н е только сама Sinatra может использовать "прослойки" Rack, но и любое Sinatra приложение
2011-03-24 10:44:00 +00:00
само может быть добавлено к любому Rack endpoint в качестве "прослойки". Этим endpoint (конечной точкой)
2011-03-19 13:20:32 +00:00
может быть другое Sinatra приложение, или приложение, основанное на Rack (Rails/Ramaze/Camping/...):
2010-10-26 21:57:10 +00:00
require 'sinatra/base'
class LoginScreen < Sinatra::Base
2010-11-07 08:49:23 +00:00
enable :sessions
2010-10-26 21:57:10 +00:00
get('/login') { haml :login }
post('/login') do
2011-06-13 11:48:28 +00:00
if params[:name] == 'admin' && params[:password] == 'admin'
2010-10-26 21:57:10 +00:00
session['user_name'] = params[:name]
else
redirect '/login'
end
end
end
class MyApp < Sinatra::Base
2011-01-14 09:05:42 +00:00
# "прослойка" будет запущена перед фильтрами
2010-10-26 21:57:10 +00:00
use LoginScreen
before do
unless session['user_name']
halt "Access denied, please <a href='/login'>login</a>."
end
end
get('/') { "Hello #{session['user_name']}." }
end
2011-06-13 11:48:28 +00:00
=== Создание приложений "на лету"
Иногда требуется создавать Sinatra приложения "на лету" (например,
из другого приложения). Это возможно с помощью <tt>Sinatra.new</tt>:
require 'sinatra/base'
my_app = Sinatra.new { get('/') { "hi" } }
my_app.run!
Этот метод может принимать аргументом приложение, от которого
следует наследоваться:
2011-07-01 23:55:08 +00:00
# config.ru
2011-06-13 11:48:28 +00:00
require 'sinatra/base'
controller = Sinatra.new do
enable :logging
helpers MyHelpers
end
map('/a') do
run Sinatra.new(controller) { get('/') { 'a' } }
end
map('/b') do
run Sinatra.new(controller) { get('/') { 'b' } }
end
Это особенно полезно для тестирования расширений Sinatra и при
использовании Sinatra внутри вашей библиотеки.
Благодаря этому, использовать Sinatra как "прослойку" очень просто:
require 'sinatra/base'
use Sinatra do
get('/') { ... }
end
run RailsProject::Application
2010-10-29 13:55:07 +00:00
== Области видимости и привязка
2010-10-26 21:57:10 +00:00
2010-10-29 14:24:21 +00:00
Текущая область видимости определяет методы и переменные, доступные
2010-10-26 21:57:10 +00:00
в данный момент.
=== Область видимости приложения / класса
2011-06-13 11:48:28 +00:00
Любое Sinatra приложение соответствует подклассу <tt>Sinatra::Base</tt>. Если вы
2011-03-23 23:32:42 +00:00
используете DSL верхнего уровня (<tt>require 'sinatra'</tt>), то этим классом будет
2011-06-13 11:48:28 +00:00
<tt>Sinatra::Application</tt>, иначе это будет подкласс, который вы создали вручную.
2011-03-19 13:20:32 +00:00
Н а уровне класса вам будут доступны такие методы, как +get+ или +before+, но вы
2011-06-15 07:52:31 +00:00
не сможете получить доступ к объектам +request+ или +session+, так как существует
2011-03-19 13:20:32 +00:00
только один класс приложения для всех запросов.
2010-10-26 21:57:10 +00:00
2011-03-19 13:20:32 +00:00
Опции, созданные с помощью +set+, являются методами уровня класса:
2010-10-26 21:57:10 +00:00
2010-11-10 19:15:51 +00:00
class MyApp < Sinatra::Base
2010-10-26 21:57:10 +00:00
# Я в области видимости приложения!
set :foo, 42
foo # => 42
get '/foo' do
# Я больше не в области видимости приложения!
end
end
У вас будет область видимости приложения внутри:
2011-03-24 10:44:00 +00:00
* тела вашего класса приложения;
* методов, определенных расширениями;
* блока, переданного в +helpers+;
2011-06-13 11:48:28 +00:00
* блоков, использованных как значения для +set+;
* блока, переданного в <tt>Sinatra.new</tt>.
2010-10-26 21:57:10 +00:00
2010-10-29 13:55:07 +00:00
Вы можете получить доступ к объекту области видимости (классу приложения) следующими способами:
2010-10-26 21:57:10 +00:00
2011-03-24 10:44:00 +00:00
* через объект, переданный блокам конфигурации (<tt>configure { |c| ... }</tt>);
* +settings+ внутри области видимости запроса.
2010-10-26 21:57:10 +00:00
=== Область видимости запроса/экземпляра
2010-10-29 13:55:07 +00:00
Для каждого входящего запроса будет создан новый экземпляр вашего приложения,
и все блоки обработчика будут запущены в этом контексте. В этой области
2011-03-19 13:20:32 +00:00
видимости вам доступны +request+ и +session+ объекты, вызовы методов
рендеринга, такие как +erb+ или +haml+. Вы можете получить доступ к
2011-03-24 10:44:00 +00:00
области видимости приложения из контекста запроса, используя метод-помощник +settings+:
2010-10-26 21:57:10 +00:00
2010-11-10 19:15:51 +00:00
class MyApp < Sinatra::Base
2010-10-26 21:57:10 +00:00
# Я в области видимости приложения!
get '/define_route/:name' do
# Область видимости запроса '/define_route/:name'
@value = 42
settings.get("/#{params[:name]}") do
# Область видимости запроса "/#{params[:name]}"
@value # => nil (другой запрос)
end
"Route defined!"
end
end
2011-06-15 07:52:31 +00:00
У вас будет область видимости запроса в:
2010-10-26 21:57:10 +00:00
2011-06-15 07:52:31 +00:00
* get/head/post/put/delete/options блоках;
2011-03-24 10:44:00 +00:00
* before/after фильтрах;
* методах-помощниках;
* шаблонах/отображениях.
2010-10-26 21:57:10 +00:00
2010-10-29 13:55:07 +00:00
=== Область видимости делегирования
2010-10-26 21:57:10 +00:00
2010-10-29 14:24:21 +00:00
Область видимости делегирования просто перенаправляет методы в область видимости класса.
2011-06-15 07:52:31 +00:00
Однако, она не полностью ведет себя как область видимости класса, так как у вас нет
привязки к классу. Только методы, явно помеченные для делегирования, будут доступны,
а переменных/состояний области видимости класса не будет (иначе говоря,
у вас будет другой +self+ объект). Вы можете
2010-10-29 13:55:07 +00:00
непосредственно добавить методы делегирования, используя
2010-10-26 21:57:10 +00:00
<tt>Sinatra::Delegator.delegate :method_name</tt>.
У вас будет контекст делегирования внутри:
2011-03-24 10:44:00 +00:00
* привязки верхнего уровня, если вы сделали <tt>require 'sinatra'</tt>;
* объекта, расширенного с помощью <tt>Sinatra::Delegator</tt>.
2010-10-26 21:57:10 +00:00
2010-10-29 13:55:07 +00:00
Посмотрите сами в код: тут
2010-10-26 21:57:10 +00:00
{Sinatra::Delegator примесь}[http://github.com/sinatra/sinatra/blob/ceac46f0bc129a6e994a06100aa854f606fe5992/lib/sinatra/base.rb#L1128]
2010-10-29 13:55:07 +00:00
будет {включена в глобальное пространство имен}[http://github.com/sinatra/sinatra/blob/ceac46f0bc129a6e994a06100aa854f606fe5992/lib/sinatra/main.rb#L28].
2010-10-26 21:57:10 +00:00
== Командная строка
Sinatra приложения могут быть запущены напрямую:
ruby myapp.rb [-h] [-x] [-e ENVIRONMENT] [-p PORT] [-o HOST] [-s HANDLER]
Опции включают:
2011-03-24 10:44:00 +00:00
-h # раздел помощи
-p # указание порта (по умолчанию 4567)
-o # указание хоста (по умолчанию 0.0.0.0)
-e # указание окружения, режима (по умолчанию development)
-s # указание rack сервера/обработчика (по умолчанию thin)
2011-03-23 23:32:42 +00:00
-x # включить мьютекс-блокировку (по умолчанию выключена)
2010-10-26 21:57:10 +00:00
2011-03-19 13:20:32 +00:00
== Системные требования
Следующие версии Ruby официально поддерживаются:
[ Ruby 1.8.7 ]
1.8.7 полностью поддерживается, тем не менее, если вас ничто не держит на
этой версии, рекомендуем обновиться до 1.9.2 или перейти на JRuby или Rubinius.
[ Ruby 1.9.2 ]
2011-03-23 23:32:42 +00:00
1.9.2 поддерживается и рекомендована к использованию. Заметьте, что Radius и Markaby
2011-03-19 13:20:32 +00:00
пока несовместимы с 1.9.2. Н е используйте 1.9.2p0, известно, что эта
2011-06-15 07:52:31 +00:00
версия весьма нестабильна при использовании Sinatra.
2011-03-19 13:20:32 +00:00
[ Rubinius ]
2011-03-24 10:44:00 +00:00
Rubinius официально поддерживается (Rubinius >= 1.2.3), всё, включая все
2011-03-19 13:20:32 +00:00
языки шаблонов, работает.
[ JRuby ]
2011-05-17 09:40:14 +00:00
JRuby официально поддерживается (JRuby >= 1.6.1). Нет никаких проблем с
2011-03-19 13:20:32 +00:00
использованием альтернативных шаблонов. Тем не менее, если вы выбираете
JRuby, то, пожалуйста, посмотрите на JRuby Rack-сервера, так как Thin не
поддерживается полностью на JRuby. Поддержка расширений на C в JRuby все
2011-06-13 11:48:28 +00:00
еще экспериментальная, что на данный момент затрагивает только RDiscount и
Redcarpet.
2011-03-19 13:20:32 +00:00
2011-06-13 11:48:28 +00:00
<b>Ruby 1.8.6 больше не поддерживается.</b> Если вы хотите запускать свое
приложение на 1.8.6, откатитесь до Sinatra 1.2, которая будет получать все
исправления ошибок до тех пор, пока не будет выпущена Sinatra 1.4.0
2011-03-19 13:20:32 +00:00
2011-03-24 10:44:00 +00:00
Мы также следим за предстоящими к выходу версиями Ruby.
2011-03-19 13:20:32 +00:00
Следующие реализации Ruby не поддерживаются официально, но известно, что на
них запускается Sinatra:
2011-03-24 10:44:00 +00:00
* старые версии JRuby и Rubinius;
* MacRuby, Maglev, IronRuby;
* Ruby 1.9.0 и 1.9.1;
* Ruby 1.8.6 с помощью {backports}[https://github.com/marcandre/backports/#readme].
2011-03-19 13:20:32 +00:00
Т о , что версия официально не поддерживается, означает, что, если что-то не
2011-03-23 23:32:42 +00:00
работает на этой версии, а на поддерживаемой работает - это не наша проблема, а их.
2011-03-19 13:20:32 +00:00
2011-06-15 07:52:31 +00:00
Мы также запускаем наши CI-тесты на последней версии Ruby (предстоящей 1.9.3),
2011-03-19 13:20:32 +00:00
но мы не можем ничего гарантировать, так как она постоянно развивается.
Предполагается, что 1.9.3p0 будет поддерживаться.
2011-03-23 23:32:42 +00:00
Sinatra должна работать на любой операционной системе, в которой есть одна из указанных выше версий Ruby.
2011-03-19 13:20:32 +00:00
2010-10-29 13:55:07 +00:00
== Н а острие
2010-10-26 21:57:10 +00:00
2011-01-18 12:44:43 +00:00
Если вы хотите использовать самый последний код Sinatra, не бойтесь запускать
2011-06-15 07:52:31 +00:00
свое приложение вместе с кодом из master ветки Sinatra, она весьма стабильна.
2011-01-18 12:44:43 +00:00
Мы также время от времени выпускаем предварительные версии, так что вы можете делать так:
gem install sinatra --pre
2011-03-24 10:44:00 +00:00
Чтобы воспользоваться некоторыми самыми последними возможностями.
2011-01-18 12:44:43 +00:00
2011-01-18 12:29:04 +00:00
=== С помощью Bundler
Если вы хотите запускать свое приложение с последней версией Sinatra, то
рекомендуем использовать {Bundler}[http://gembundler.com/].
Сначала установите Bundler, если у вас е г о еще нет:
gem install bundler
Затем создайте файл +Gemfile+ в директории вашего проекта:
source :rubygems
gem 'sinatra', :git => "git://github.com/sinatra/sinatra.git"
# другие зависимости
gem 'haml' # например, если используете haml
gem 'activerecord', '~> 3.0' # может быть, вам нужен и ActiveRecord 3.x
Обратите внимание, вам нужно будет указывать все зависимости вашего приложения
в этом файле. Однако, непосредственные зависимости Sinatra (Rack и Tilt) Bundler
автоматически скачает и добавит.
2011-03-23 23:32:42 +00:00
Теперь вы можете запускать свое приложение так:
2011-01-18 12:29:04 +00:00
bundle exec ruby myapp.rb
=== Вручную
2011-01-18 12:44:43 +00:00
Создайте локальный клон репозитория и запускайте свое приложение с <tt>sinatra/lib</tt>
2011-03-19 13:20:32 +00:00
директорией в <tt>$LOAD_PATH</tt>:
2010-10-26 21:57:10 +00:00
cd myapp
git clone git://github.com/sinatra/sinatra.git
ruby -Isinatra/lib myapp.rb
2010-10-29 13:55:07 +00:00
Чтобы обновить исходники Sinatra:
2010-10-26 21:57:10 +00:00
2011-01-18 12:30:39 +00:00
cd myapp/sinatra
2010-10-26 21:57:10 +00:00
git pull
2011-01-18 12:44:43 +00:00
=== Установка глобально
Вы можете самостоятельно собрать gem:
git clone git://github.com/sinatra/sinatra.git
cd sinatra
rake sinatra.gemspec
rake install
2011-06-15 07:52:31 +00:00
Если вы устанавливаете пакеты (gem) от пользователя root, то вашим следующим шагом должна быть команда
2011-01-18 12:44:43 +00:00
sudo rake install
2011-03-19 13:20:32 +00:00
== Версии
Sinatra использует {Semantic Versioning}[http://semver.org/], SemVer и
SemVerTag.
2011-01-17 14:46:10 +00:00
== Дальнейшее чтение
2010-10-26 21:57:10 +00:00
2011-03-24 10:44:00 +00:00
* {В е б -сайт проекта}[http://www.sinatrarb.com/] - Дополнительная документация,
2010-10-26 21:57:10 +00:00
новости и ссылки на другие ресурсы.
2011-03-24 10:44:00 +00:00
* {Участие в проекте}[http://www.sinatrarb.com/contributing] - Обнаружили б а г ? Нужна помощь? Написали патч?
* {Слежение за проблемами/ошибками}[http://github.com/sinatra/sinatra/issues]
2010-10-26 21:57:10 +00:00
* {Twitter}[http://twitter.com/sinatra]
2011-03-24 10:44:00 +00:00
* {Группы рассылки}[http://groups.google.com/group/sinatrarb/topics]
2011-06-13 11:48:28 +00:00
* {IRC: #sinatra}[irc://chat.freenode.net/#sinatra] на http://freenode.net
* {Sinatra Book}[http://sinatra-book.gittr.com] учебник и сборник рецептов
* {Sinatra Book Contrib}[http://sinatra-book-contrib.com/] сборник рецептов
* API документация к {последнему релизу}[http://rubydoc.info/gems/sinatra]
или {текущему HEAD}[http://rubydoc.info/github/sinatra/sinatra] на
http://rubydoc.info