sinatra下载 - sinatra源代码下载

西纳特拉

Sinatra 是一种 DSL，可以用最少的工作在 Ruby 中快速创建 Web 应用程序：

 # myapp.rb
require 'sinatra'

get '/' do
  'Hello world!'
end

安装所需的 gem：

gem install sinatra rackup puma

并运行：

ruby myapp.rb

查看地址：http://localhost:4567

您更改的代码只有在重新启动服务器后才会生效。每次更改或使用代码重新加载器（例如重新运行或机架卸载器）时，请重新启动服务器。

建议还运行gem install puma ，Sinatra 将选择它（如果可用）。

西纳特拉
- 目录
- 路线
- 状况
- 返回值
- 自定义路由匹配器
- 静态文件
- 视图/模板
  - 文字模板
  - 可用的模板语言
    - 哈姆模板
    - Erb 模板
    - 构建器模板
    - 诺科切模板
    - Sass 模板
    - CSS 模板
    - 液体模板
    - 降价模板
    - RDoc 模板
    - AsciiDoc 模板
    - 马克比模板
    - RABL 模板
    - 超薄模板
    - 亚吉尔模板
  - 访问模板中的变量
  - 具有yield和嵌套布局的模板
  - 内联模板
  - 命名模板
  - 关联文件扩展名
  - 添加您自己的模板引擎
  - 使用自定义逻辑进行模板查找
- 过滤器
- 帮手
  - 使用会话
    - 会话秘密安全
    - 会话配置
    - 选择您自己的会话中间件
  - 停止
  - 通过
  - 触发另一条路线
  - 设置正文、状态代码和标头
  - 流式响应
  - 记录
  - 哑剧类型
  - 生成 URL
  - 浏览器重定向
  - 缓存控制
  - 发送文件
  - 访问请求对象
  - 附件
  - 处理日期和时间
  - 查找模板文件
- 配置
  - 配置攻击防护
  - 可用设置
- 生命周期事件
- 环境
- 错误处理
  - 未找到
  - 错误
- 机架中间件
- 测试
- Sinatra::Base - 中间件、库和模块化应用程序
  - 模块化与经典风格
  - 为模块化应用程序提供服务
  - 使用带有 config.ru 的经典风格应用程序
  - 何时使用 config.ru？
  - 使用 Sinatra 作为中间件
  - 动态应用程序创建
- 范围和约束
  - 应用/类别范围
  - 请求/实例范围
  - 委托范围
- 命令行
  - 多线程
- 要求
- 前沿
  - 带捆绑器
- 版本控制
- 进一步阅读

路线

在 Sinatra 中，路由是与 URL 匹配模式配对的 HTTP 方法。每条路线都与一个块相关联：

 get '/' do
  .. show something ..
end

post '/' do
  .. create something ..
end

put '/' do
  .. replace something ..
end

patch '/' do
  .. modify something ..
end

delete '/' do
  .. annihilate something ..
end

options '/' do
  .. appease something ..
end

link '/' do
  .. affiliate something ..
end

unlink '/' do
  .. separate something ..
end

路由按照定义的顺序进行匹配。调用与请求匹配的第一个路由。

带有尾部斜杠的路由与没有尾部斜杠的路由不同：

 get '/foo' do
  # Does not match "GET /foo/"
end

路由模式可能包括命名参数，可通过params哈希访问：

 get '/hello/:name' do
  # matches "GET /hello/foo" and "GET /hello/bar"
  # params['name'] is 'foo' or 'bar'
  "Hello #{ params [ 'name' ] } !"
end

您还可以通过块参数访问命名参数：

 get '/hello/:name' do | n |
  # matches "GET /hello/foo" and "GET /hello/bar"
  # params['name'] is 'foo' or 'bar'
  # n stores params['name']
  "Hello #{ n } !"
end

路由模式还可以包括 splat （或通配符）参数，可通过params['splat']数组访问：

 get '/say/*/to/*' do
  # matches /say/hello/to/world
  params [ 'splat' ] # => ["hello", "world"]
end

get '/download/*.*' do
  # matches /download/path/to/file.xml
  params [ 'splat' ] # => ["path/to/file", "xml"]
end

或者使用块参数：

 get '/download/*.*' do | path , ext |
  [ path , ext ] # => ["path/to/file", "xml"]
end

正则表达式的路由匹配：

 get / / hello / ([ w ]+)/ do
  "Hello, #{ params [ 'captures' ] . first } !"
end

或者使用块参数：

 get %r{/hello/([ w ]+)} do | c |
  # Matches "GET /meta/hello/world", "GET /hello/world/1234" etc.
  "Hello, #{ c } !"
end

路由模式可能有可选参数：

 get '/posts/:format?' do
  # matches "GET /posts/" and any extension "GET /posts/json", "GET /posts/xml" etc
end

路由还可以使用查询参数：

 get '/posts' do
  # matches "GET /posts?title=foo&author=bar"
  title = params [ 'title' ]
  author = params [ 'author' ]
  # uses title and author variables; query is optional to the /posts route
end

顺便说一句，除非您禁用路径遍历攻击保护（见下文），否则请求路径可能会在与您的路由匹配之前被修改。

您可以通过传入:mustermann_opts哈希来自定义用于给定路由的 Mustermann 选项：

 get 'A/postsz' , :mustermann_opts => { :type => :regexp , :check_anchors => false } do
  # matches /posts exactly, with explicit anchoring
  "If you match an anchored pattern clap your hands!"
end

看起来像是一个条件，但其实不是一个！这些选项将合并到全局:mustermann_opts哈希中，如下所述。

状况

路由可能包含多种匹配条件，例如用户代理：

 get '/foo' , :agent => /Songbird ( d . d )[ d / ]*?/ do
  "You're using Songbird version #{ params [ 'agent' ] [ 0 ] } "
end

get '/foo' do
  # Matches non-songbird browsers
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

provides搜索请求的 Accept 标头。

您可以轻松定义自己的条件：

 set ( :probability ) { | value | condition { rand <= value } }

get '/win_a_car' , :probability => 0.1 do
  "You won!"
end

get '/win_a_car' do
  "Sorry, you lost."
end

对于采用多个值的条件，请使用 splat：

 set ( :auth ) do |* roles |   # <- notice the splat here
  condition do
    unless logged_in? && roles . any? { | role | current_user . in_role? role }
      redirect "/login/" , 303
    end
  end
end

get "/my/account/" , :auth => [ :user , :admin ] do
  "Your Account Details"
end

get "/only/admin/" , :auth => :admin do
  "Only admins are allowed here!"
end

返回值

路由块的返回值至少确定传递到 HTTP 客户端的响应主体或至少确定 Rack 堆栈中的下一个中间件。最常见的是，这是一个字符串，如上面的示例所示。但其他值也被接受。

您可以返回一个对象，该对象可以是有效的 Rack 响应、Rack 主体对象或 HTTP 状态代码：

包含三个元素的数组： [status (Integer), headers (Hash), response body (responds to #each)]
具有两个元素的数组： [status (Integer), response body (responds to #each)]
响应#each的对象，除了字符串之外什么都不传递给给定的块
代表状态码的整数

这样我们就可以轻松实现一个流式传输示例：

 class Stream
  def each
    100 . times { | i | yield " #{ i } n " }
  end
end

get ( '/' ) { Stream . new }

您还可以使用stream辅助方法（如下所述）来减少样板并将流逻辑嵌入到路由中。

自定义路由匹配器

如上所示，Sinatra 内置支持使用字符串模式和正则表达式作为路由匹配。然而，它并不止于此。您可以轻松定义自己的匹配器：

 class AllButPattern
  def initialize ( except )
    @except = except
  end

  def to_pattern ( options )
    return self
  end

  def params ( route )
    return { } unless @except === route
  end
end

def all_but ( pattern )
  AllButPattern . new ( pattern )
end

get all_but ( "/index" ) do
  # ...
end

请注意，上面的示例可能是过度设计的，因为它也可以表示为：

 get /.*/ do
  pass if request . path_info == "/index"
  # ...
end

静态文件

静态文件由./public目录提供。您可以通过设置:public_folder选项来指定不同的位置：

 set :public_folder , __dir__ + '/static'

请注意，公共目录名称不包含在 URL 中。文件./public/css/style.css以http://example.com/css/style.css形式提供。

使用:static_cache_control设置（见下文）添加Cache-Control标头信息。

视图/模板

每种模板语言都通过其自己的渲染方法公开。这些方法只是返回一个字符串：

 get '/' do
  erb :index
end

这将呈现views/index.erb 。

除了模板名称之外，您还可以直接传入模板内容：

 get '/' do
  code = "<%= Time.now %>"
  erb code
end

模板采用第二个参数，即选项哈希：

 get '/' do
  erb :index , :layout => :post
end

这将渲染嵌入在views/post.erb中的views/index.erb （默认为views/layout.erb ，如果存在的话）。

Sinatra 无法理解的任何选项都将传递到模板引擎：

 get '/' do
  haml :index , :format => :html5
end

一般来说，您还可以设置每种模板语言的选项：

 set :haml , :format => :html5

get '/' do
  haml :index
end

传递给 render 方法的选项会覆盖通过set设置的选项。

可用选项：

当地人: 传递给文档的当地人列表。方便使用部分。示例： erb "<%= foo %>", :locals => {:foo => "bar"}
默认编码: 不确定时要使用的字符串编码。默认为settings.default_encoding 。
意见: 查看从中加载模板的文件夹。默认为settings.views 。
布局: 是否使用布局（ true或false ）。如果它是符号，则指定要使用的模板。示例： erb :index, :layout => !request.xhr?
内容类型: 模板生成的内容类型。默认值取决于模板语言。
范围: 渲染模板的范围。默认为应用程序实例。如果更改此设置，实例变量和辅助方法将不可用。
布局引擎: 用于渲染布局的模板引擎。对于不支持布局的语言很有用。默认为用于模板的引擎。示例：设置 :rdoc, :layout_engine => :erb
布局选项: 仅用于渲染布局的特殊选项。示例： set :rdoc, :layout_options => { :views => 'views/layouts' }

假定模板直接位于./views目录下。要使用不同的视图目录：

 set :views , settings . root + '/templates'

要记住的一件重要的事情是，您始终必须使用符号引用模板，即使它们位于子目录中（在本例中，使用： :'subdir/template'或'subdir/template'.to_sym ）。您必须使用符号，因为否则渲染方法将渲染直接传递给它们的任何字符串。

文字模板

 get '/' do
  haml '%div.title Hello World'
end

呈现模板字符串。如果存在与该字符串关联的文件系统路径或行，您可以选择指定:path和:line以获得更清晰的回溯：

 get '/' do
  haml '%div.title Hello World' , :path => 'examples/file.haml' , :line => 3
end

可用的模板语言

有些语言有多种实现。要指定使用什么实现（并且是线程安全的），您应该首先需要它：

 require 'rdiscount'
get ( '/' ) { markdown :index }

哈姆模板

依赖性	哈姆尔
文件扩展名	`.haml`
例子	`哈姆尔：索引，：格式=>：html5`

Erb 模板

依赖性	erubi 或 erb（包含在 Ruby 中）
文件扩展名	`.erb` 、 `.rhtml`或`.erubi` （仅限 Erubi）
例子	`erb :索引`

构建器模板

依赖性	建设者
文件扩展名	`.builder`
例子	`构建器 { \|xml\| xml.em“嗨”}`

它还需要一个内联模板块（参见示例）。

诺科切模板

依赖性	诺科吉里
文件扩展名	`.nokogiri`
例子	`诺科吉里 { \|xml\| xml.em“嗨”}`

它还需要一个内联模板块（参见示例）。

Sass 模板

依赖性	sass 嵌入式
文件扩展名	`.sass`
例子	`sass :stylesheet, :style => :expanded`

CSS 模板

依赖性	sass 嵌入式
文件扩展名	`.scss`
例子	`scss :样式表, :样式 => :扩展`

液体模板

依赖性	液体
文件扩展名	`。液体`
例子	`液体 :index, :locals => { :key => 'value' }`

由于您无法从 Liquid 模板调用 Ruby 方法（ yield除外），因此您几乎总是希望将局部变量传递给它。

降价模板

依赖性	以下任意一项：RDiscount、RedCarpet、kramdown、commonmarker pandoc
文件扩展名	`.markdown` 、 `.mkd`和`.md`
例子	`降价：索引，：layout_engine =>：erb`

无法从 Markdown 调用方法，也无法将本地变量传递给它。因此，您通常会将其与另一个渲染引擎结合使用：

 erb :overview , :locals => { :text => markdown ( :introduction ) }

请注意，您还可以从其他模板中调用markdown方法：

% h1 Hello From Haml!
% p = markdown ( :greetings )

由于您无法从 Markdown 调用 Ruby，因此您无法使用用 Markdown 编写的布局。但是，可以通过传递:layout_engine选项为模板使用除布局之外的其他渲染引擎。

RDoc 模板

依赖性	远程文档
文件扩展名	`.rdoc`
例子	`rdoc：自述文件，：layout_engine =>：erb`

无法从 RDoc 调用方法，也无法将局部变量传递给它。因此，您通常会将其与另一个渲染引擎结合使用：

 erb :overview , :locals => { :text => rdoc ( :introduction ) }

请注意，您还可以从其他模板中调用rdoc方法：

% h1 Hello From Haml!
% p = rdoc ( :greetings )

由于您无法从 RDoc 调用 Ruby，因此您无法使用用 RDoc 编写的布局。但是，可以通过传递:layout_engine选项为模板使用除布局之外的其他渲染引擎。

AsciiDoc 模板

依赖性	阿西多克托
文件扩展名	`.asciidoc` 、 `.adoc`和`.ad`
例子	`asciidoc：自述文件，：layout_engine =>：erb`

由于您无法直接从 AsciiDoc 模板调用 Ruby 方法，因此您几乎总是希望将本地变量传递给它。

马克比模板

依赖性	马尔卡比
文件扩展名	`.mab`
例子	`马克比 { h1“欢迎！” }`

它还需要一个内联模板块（参见示例）。

RABL 模板

依赖性	拉布尔
文件扩展名	`.rabl`
例子	`拉布：索引`

超薄模板

依赖性	斯利姆朗
文件扩展名	`。苗条的`
例子	`苗条：索引`

亚吉尔模板

依赖性	亚吉鲁比
文件扩展名	`.yajl`
例子	`yajl :index, :locals => { :key => 'qux' }, :callback => 'present', :variable => '资源'`

模板源被评估为 Ruby 字符串，并使用#to_json转换生成的 json 变量：

 json = { :foo => 'bar' }
json [ :baz ] = key

:callback和:variable选项可用于装饰渲染对象：

 var resource = { "foo" : "bar" , "baz" : "qux" } ;
present ( resource ) ;

访问模板中的变量

模板在与路由处理程序相同的上下文中进行评估。路由处理程序中设置的实例变量可以通过模板直接访问：

 get '/:id' do
  @foo = Foo . find ( params [ 'id' ] )
  haml '%h1= @foo.name'
end

或者，指定局部变量的显式哈希：

 get '/:id' do
  foo = Foo . find ( params [ 'id' ] )
  haml '%h1= bar.name' , :locals => { :bar => foo }
end

这通常在将模板渲染为其他模板中的部分时使用。

具有`yield`和嵌套布局的模板

布局通常只是一个调用yield的模板。这样的模板可以通过上面描述的:template选项来使用，也可以使用块来呈现，如下所示：

 erb :post , :layout => false do
  erb :index
end

此代码主要相当于erb :index, :layout => :post 。

将块传递给渲染方法对于创建嵌套布局最有用：

 erb :main_layout , :layout => false do
  erb :admin_layout do
    erb :user
  end
end

这也可以通过更少的代码行来完成：

 erb :admin_layout , :layout => :main_layout do
  erb :user
end

目前，以下渲染方法接受块： erb 、 haml 、 liquid 、 slim 。此外，通用render方法接受块。

内联模板

模板可以在源文件末尾定义：

 require 'sinatra'

get '/' do
  haml :index
end

__END__

@@ layout
%html
  != yield

@@ index
%div.title Hello world.

注意：需要 Sinatra 的源文件中定义的内联模板会自动加载。如果其他源文件中有内联模板，请显式enable :inline_templates 。

命名模板

模板也可以使用顶级template方法来定义：

 template :layout do
  "%html n  =yield n "
end

template :index do
  '%div.title Hello World!'
end

get '/' do
  haml :index
end

如果存在名为“layout”的模板，则每次渲染模板时都会使用该模板。您可以通过传递:layout => false单独禁用布局，或者通过set :haml, :layout => false默认禁用它们：

 get '/' do
  haml :index , :layout => ! request . xhr?
end

关联文件扩展名

要将文件扩展名与模板引擎关联，请使用Tilt.register 。例如，如果您想对 Haml 模板使用文件扩展名tt ，您可以执行以下操作：

 Tilt . register Tilt [ :haml ] , :tt

添加您自己的模板引擎

首先，使用 Tilt 注册您的引擎，然后创建一个渲染方法：

 Tilt . register MyAwesomeTemplateEngine , :myat

helpers do
  def myat ( * args ) render ( :myat , * args ) end
end

get '/' do
  myat :index
end

渲染./views/index.myat 。了解有关倾斜的更多信息。

使用自定义逻辑进行模板查找

要实现您自己的模板查找机制，您可以编写自己的#find_template方法：

 configure do
  set :views , [ './views/a' , './views/b' ]
end

def find_template ( views , name , engine , & block )
  Array ( views ) . each do | v |
    super ( v , name , engine , & block )
  end
end

过滤器

Before 过滤器在与路由相同的上下文中的每个请求之前进行评估，并且可以修改请求和响应。过滤器中设置的实例变量可以通过路由和模板访问：

 before do
  @note = 'Hi!'
  request . path_info = '/foo/bar/baz'
end

get '/foo/*' do
  @note #=> 'Hi!'
  params [ 'splat' ] #=> 'bar/baz'
end

After 过滤器在与路由相同的上下文中的每个请求之后进行评估，并且还可以修改请求和响应。在过滤器之前和路由中设置的实例变量可以通过过滤器之后访问：

 after do
  puts response . status
end

注意：除非您使用body方法而不是仅从路由返回 String，否则主体在 after 过滤器中将不可用，因为它是稍后生成的。

过滤器可以选择采用某种模式，从而仅当请求路径与该模式匹配时才对它们进行评估：

 before '/protected/*' do
  authenticate!
end

after '/create/:slug' do | slug |
  session [ :last_slug ] = slug
end

与路由一样，过滤器也采用条件：

 before :agent => /Songbird/ do
  # ...
end

after '/blog/*' , :host_name => 'example.com' do
  # ...
end

帮手

使用顶级helpers方法来定义在路由处理程序和模板中使用的帮助器方法：

展开

sinatra

西纳特拉

目录

路线

状况

返回值

自定义路由匹配器

静态文件

视图/模板

文字模板

可用的模板语言

哈姆模板

Erb 模板

构建器模板

诺科切模板

Sass 模板

CSS 模板

液体模板

降价模板

RDoc 模板

AsciiDoc 模板

马克比模板

RABL 模板

超薄模板

亚吉尔模板

访问模板中的变量

具有yield和嵌套布局的模板

内联模板

命名模板

关联文件扩展名

添加您自己的模板引擎

使用自定义逻辑进行模板查找

过滤器

帮手

具有`yield`和嵌套布局的模板