sinatra 1.3.6 → 1.4.0.a
Sign up to get free protection for your applications and to get access to all the features.
Potentially problematic release.
This version of sinatra might be problematic. Click here for more details.
- data/CHANGES +96 -22
- data/Gemfile +11 -3
- data/README.de.md +2590 -0
- data/README.es.rdoc +66 -38
- data/README.fr.md +2630 -0
- data/README.hu.rdoc +3 -2
- data/README.jp.rdoc +16 -3
- data/README.ko.rdoc +11 -5
- data/README.md +2699 -0
- data/README.pt-br.rdoc +152 -21
- data/README.pt-pt.rdoc +3 -2
- data/README.ru.md +2724 -0
- data/README.zh.rdoc +3 -3
- data/Rakefile +3 -4
- data/examples/chat.rb +3 -3
- data/lib/sinatra/base.rb +433 -247
- data/lib/sinatra/main.rb +4 -2
- data/lib/sinatra/showexceptions.rb +6 -1
- data/lib/sinatra/version.rb +1 -1
- data/test/base_test.rb +21 -9
- data/test/builder_test.rb +15 -19
- data/test/coffee_test.rb +4 -6
- data/test/compile_test.rb +154 -0
- data/test/contest.rb +4 -6
- data/test/creole_test.rb +5 -5
- data/test/delegator_test.rb +1 -3
- data/test/erb_test.rb +32 -20
- data/test/extensions_test.rb +1 -3
- data/test/filter_test.rb +65 -56
- data/test/haml_test.rb +34 -26
- data/test/helpers_test.rb +331 -221
- data/test/integration_helper.rb +8 -0
- data/test/integration_test.rb +3 -1
- data/test/less_test.rb +10 -8
- data/test/liquid_test.rb +22 -4
- data/test/mapped_error_test.rb +122 -96
- data/test/markaby_test.rb +5 -5
- data/test/markdown_test.rb +5 -5
- data/test/middleware_test.rb +3 -3
- data/test/nokogiri_test.rb +4 -6
- data/test/rabl_test.rb +89 -0
- data/test/radius_test.rb +4 -4
- data/test/rdoc_test.rb +7 -7
- data/test/readme_test.rb +14 -30
- data/test/request_test.rb +15 -0
- data/test/response_test.rb +3 -4
- data/test/result_test.rb +11 -33
- data/test/route_added_hook_test.rb +10 -10
- data/test/routing_test.rb +123 -1
- data/test/sass_test.rb +26 -26
- data/test/scss_test.rb +16 -16
- data/test/server_test.rb +2 -2
- data/test/settings_test.rb +48 -4
- data/test/sinatra_test.rb +2 -7
- data/test/slim_test.rb +37 -23
- data/test/static_test.rb +56 -15
- data/test/streaming_test.rb +11 -2
- data/test/templates_test.rb +117 -45
- data/test/textile_test.rb +9 -9
- data/test/views/hello.rabl +2 -0
- data/test/views/hello.wlang +1 -0
- data/test/views/hello.yajl +1 -0
- data/test/views/layout2.rabl +3 -0
- data/test/views/layout2.wlang +2 -0
- data/test/wlang_test.rb +87 -0
- data/test/yajl_test.rb +86 -0
- metadata +27 -17
- data/README.de.rdoc +0 -2097
- data/README.fr.rdoc +0 -2036
- data/README.rdoc +0 -2017
- data/README.ru.rdoc +0 -1785
data/README.es.rdoc
CHANGED
@@ -1,8 +1,9 @@
|
|
1
1
|
= Sinatra
|
2
2
|
<i>Atención: Este documento es una traducción de la versión en inglés y puede estar desactualizado.</i>
|
3
3
|
|
4
|
-
Sinatra es un
|
5
|
-
|
4
|
+
Sinatra es un
|
5
|
+
{DSL}[http://es.wikipedia.org/wiki/Lenguaje_específico_del_dominio] para
|
6
|
+
crear aplicaciones web rápidamente en Ruby con un mínimo esfuerzo:
|
6
7
|
|
7
8
|
# miapp.rb
|
8
9
|
require 'sinatra'
|
@@ -14,7 +15,7 @@ esfuerzo:
|
|
14
15
|
Instalá la gem y ejecutá la aplicación con:
|
15
16
|
|
16
17
|
gem install sinatra
|
17
|
-
ruby
|
18
|
+
ruby miapp.rb
|
18
19
|
|
19
20
|
Podés verla en: http://localhost:4567
|
20
21
|
|
@@ -415,7 +416,7 @@ plantilla Liquid, casi siempre vas a querer pasarle locales.
|
|
415
416
|
=== Plantillas Markdown
|
416
417
|
|
417
418
|
Dependencias:: {rdiscount}[https://github.com/rtomayko/rdiscount],
|
418
|
-
{redcarpet}[https://github.com/
|
419
|
+
{redcarpet}[https://github.com/vmg/redcarpet],
|
419
420
|
{bluecloth}[http://deveiate.org/projects/BlueCloth],
|
420
421
|
{kramdown}[http://kramdown.rubyforge.org/] *o*
|
421
422
|
{maruku}[http://maruku.rubyforge.org/]
|
@@ -496,6 +497,12 @@ Ejemplos:: <tt>markaby { h1 "Bienvenido!" }</tt>
|
|
496
497
|
|
497
498
|
Además, acepta un bloque con la definición de la plantilla (ver el ejemplo).
|
498
499
|
|
500
|
+
=== Plantillas RABL
|
501
|
+
|
502
|
+
Dependencias:: {rabl}[https://github.com/nesquena/rabl]
|
503
|
+
Extensiones de Archivo:: <tt>.rabl</tt>
|
504
|
+
Ejemplo:: <tt>rabl :index</tt>
|
505
|
+
|
499
506
|
=== Plantillas Slim
|
500
507
|
|
501
508
|
Dependencias:: {slim}[http://slim-lang.com/]
|
@@ -530,6 +537,30 @@ Dependencias:: {coffee-script}[https://github.com/josh/ruby-coffee-s
|
|
530
537
|
Extensiones de Archivo:: <tt>.coffee</tt>
|
531
538
|
Ejemplo:: <tt>coffee :index</tt>
|
532
539
|
|
540
|
+
=== Plantillas Yajl
|
541
|
+
|
542
|
+
Dependencias:: {yajl-ruby}[https://github.com/brianmario/yajl-ruby]
|
543
|
+
Extensiones de Archivo:: <tt>.yajl</tt>
|
544
|
+
Ejemplo:: <tt>yajl :index, :locals => { :key => 'qux' }, :callback => 'present', :variable => 'resource'</tt>
|
545
|
+
|
546
|
+
El contenido de La plantilla se evalúa como código Ruby, y la variable +json+ es convertida a JSON mediante <tt>#to_json</tt>.
|
547
|
+
|
548
|
+
json = { :foo => 'bar' }
|
549
|
+
json[:baz] = key
|
550
|
+
|
551
|
+
Las opciones <tt>:callback</tt> y <tt>:variable</tt> se pueden utilizar para decorar el objeto renderizado:
|
552
|
+
|
553
|
+
var resource = {"foo":"bar","baz":"qux"}; present(resource);
|
554
|
+
|
555
|
+
=== Plantillas WLang
|
556
|
+
|
557
|
+
Dependencias:: {wlang}[https://github.com/blambeau/wlang/]
|
558
|
+
Extensiones de Archivo:: <tt>.wlang</tt>
|
559
|
+
Ejemplo:: <tt>wlang :index, :locals => { :clave => 'valor' }</tt>
|
560
|
+
|
561
|
+
Como no vas a poder llamar a métodos de Ruby (excepto por +yield+) desde una
|
562
|
+
plantilla WLang, casi siempre vas a querer pasarle locales.
|
563
|
+
|
533
564
|
=== Plantillas Embebidas
|
534
565
|
|
535
566
|
get '/' do
|
@@ -1059,7 +1090,7 @@ También es posible usar una
|
|
1059
1090
|
Estos helpers no van a cachear nada por vos, sino que van a facilitar la
|
1060
1091
|
información necesaria para poder hacerlo. Si estás buscando soluciones rápidas
|
1061
1092
|
de cacheo con proxys inversos, mirá
|
1062
|
-
{rack-cache}[
|
1093
|
+
{rack-cache}[https://github.com/rtomayko/rack-cache]:
|
1063
1094
|
|
1064
1095
|
require "rack/cache"
|
1065
1096
|
require "sinatra"
|
@@ -1125,6 +1156,10 @@ Estas opciones son:
|
|
1125
1156
|
[length]
|
1126
1157
|
encabezado Content-Length, por defecto toma el tamaño del archivo.
|
1127
1158
|
|
1159
|
+
[status]
|
1160
|
+
código de estado devuelto. Resulta útil al enviar un archivo estático como una
|
1161
|
+
página de error.
|
1162
|
+
|
1128
1163
|
Si el Rack handler lo soporta, se intentará no transmitir directamente desde el
|
1129
1164
|
proceso de Ruby. Si usás este método, Sinatra se va a encargar automáticamente
|
1130
1165
|
peticiones de rango.
|
@@ -1403,6 +1438,9 @@ O varias:
|
|
1403
1438
|
sección sobre la configuración de protección de ataques
|
1404
1439
|
más arriba.
|
1405
1440
|
|
1441
|
+
[public_dir] alias para <tt>public_folder</tt>, que se encuentra a
|
1442
|
+
continuación.
|
1443
|
+
|
1406
1444
|
[public_folder] path del directorio desde donde se sirven los archivos
|
1407
1445
|
públicos. Solo se utiliza cuando se sirven archivos
|
1408
1446
|
estáticos (ver la opción <tt>static</tt>). Si no
|
@@ -1623,10 +1661,10 @@ Definir tu aplicación en el top-level funciona bien para micro-aplicaciones
|
|
1623
1661
|
pero trae inconvenientes considerables a la hora de construir componentes
|
1624
1662
|
reutilizables como Rack middleware, Rails metal, simple librerías con un
|
1625
1663
|
componente de servidor, o incluso extensiones de Sinatra. El DSL de top-level
|
1626
|
-
|
1627
|
-
|
1628
|
-
|
1629
|
-
|
1664
|
+
asume una configuración apropiada para micro-aplicaciones (por ejemplo, un
|
1665
|
+
único archivo de aplicación, los directorios <tt>./public</tt> y
|
1666
|
+
<tt>./views</tt>, logging, página con detalles de excepción, etc.). Ahí es
|
1667
|
+
donde <tt>Sinatra::Base</tt> entra en el juego:
|
1630
1668
|
|
1631
1669
|
require 'sinatra/base'
|
1632
1670
|
|
@@ -1660,20 +1698,14 @@ para detalles sobre las opciones disponibles y su comportamiento.
|
|
1660
1698
|
Contrariamente a la creencia popular, no hay nada de malo con el estilo clásico.
|
1661
1699
|
Si se ajusta a tu aplicación, no es necesario que la cambies a una modular.
|
1662
1700
|
|
1663
|
-
|
1664
|
-
|
1665
|
-
|
1666
|
-
|
1667
|
-
|
1668
|
-
* El estilo clásico contamina Object con métodos delegadores - si tenés
|
1669
|
-
planificado empaquetar tu aplicación en una librería/gem, cambiá al estilo
|
1670
|
-
modular.
|
1671
|
-
|
1672
|
-
No hay ninguna razón por la cuál no puedas mezclar los estilos modular y
|
1673
|
-
clásico.
|
1701
|
+
Las desventaja de usar el estilo clásico en lugar del modular consiste en que
|
1702
|
+
solamente podés tener una aplicación Sinatra por proceso Ruby. Si tenés
|
1703
|
+
planificado usar más, cambiá al estilo modular. Al mismo tiempo, tené en
|
1704
|
+
cuenta que no hay ninguna razón por la cuál no puedas mezclar los estilos
|
1705
|
+
clásico y modular.
|
1674
1706
|
|
1675
|
-
|
1676
|
-
|
1707
|
+
A continuación se detallan las diferencias (sutiles) entre las configuraciones
|
1708
|
+
de ambos estilos:
|
1677
1709
|
|
1678
1710
|
Configuración Clásica Modular
|
1679
1711
|
|
@@ -1904,8 +1936,8 @@ Tenés la ligadura al ámbito de delegación dentro de:
|
|
1904
1936
|
* Un objeto extendido con el mixin <tt>Sinatra::Delegator</tt>
|
1905
1937
|
|
1906
1938
|
Pegale una mirada al código: acá está el
|
1907
|
-
{Sinatra::Delegator mixin}[
|
1908
|
-
que
|
1939
|
+
{Sinatra::Delegator mixin}[https://github.com/sinatra/sinatra/blob/ca06364/lib/sinatra/base.rb#L1609-1633]
|
1940
|
+
que {extiende el objeto main}[https://github.com/sinatra/sinatra/blob/ca06364/lib/sinatra/main.rb#L28-30].
|
1909
1941
|
|
1910
1942
|
== Línea de Comandos
|
1911
1943
|
|
@@ -1938,31 +1970,27 @@ Las siguientes versiones de Ruby son soportadas oficialmente:
|
|
1938
1970
|
ya no se corregirán errores por más que se reciban reportes de los mismos.
|
1939
1971
|
|
1940
1972
|
[ Ruby 1.9.2 ]
|
1941
|
-
1.9.2 es soportado y recomendado.
|
1942
|
-
|
1943
|
-
|
1944
|
-
|
1945
|
-
última versión de la serie 1.9 se mantendrá mientras lo haga el core team de
|
1946
|
-
Ruby.
|
1973
|
+
1.9.2 es soportado y recomendado. No usés 1.9.2p0, porque se producen fallos
|
1974
|
+
de segmentación cuando se ejecuta Sinatra. El soporte se mantendrá al menos
|
1975
|
+
hasta que se libere la versión 1.9.4/2.0 de Ruby. El soporte para la última
|
1976
|
+
versión de la serie 1.9 se mantendrá mientras lo haga el core team de Ruby.
|
1947
1977
|
|
1948
1978
|
[ Ruby 1.9.3 ]
|
1949
|
-
1.9.3 es soportado
|
1950
|
-
|
1951
|
-
en producción. Es importante notar que el cambio desde una versión anterior a
|
1952
|
-
1.9.3 va a invalidar todas las sesiones.
|
1979
|
+
1.9.3 es soportado y recomendado. Tené en cuenta que el cambio a 1.9.3 desde
|
1980
|
+
una versión anterior va a invalidar todas las sesiones.
|
1953
1981
|
|
1954
1982
|
[ Rubinius ]
|
1955
1983
|
Rubinius es soportado oficialmente (Rubinius >= 1.2.4). Todo funciona
|
1956
1984
|
correctamente, incluyendo los lenguajes de plantillas. La próxima versión,
|
1957
|
-
2.0, también es soportada.
|
1985
|
+
2.0, también es soportada, incluyendo el modo 1.9.
|
1958
1986
|
|
1959
1987
|
[ JRuby ]
|
1960
|
-
JRuby es soportado oficialmente (JRuby >= 1.6.
|
1988
|
+
JRuby es soportado oficialmente (JRuby >= 1.6.7). No se conocen problemas
|
1961
1989
|
con librerías de plantillas de terceras partes. Sin embargo, si elegís usar
|
1962
1990
|
JRuby, deberías examinar sus Rack handlers porque el servidor web Thin no es
|
1963
1991
|
soportado completamente. El soporte de JRuby para extensiones C se encuentra
|
1964
1992
|
en una etapa experimental, sin embargo, de momento solamente RDiscount,
|
1965
|
-
Redcarpet y
|
1993
|
+
Redcarpet, RedCloth y Yajl, así como Thin y Mongrel se ven afectadas.
|
1966
1994
|
|
1967
1995
|
Siempre le prestamos atención a las nuevas versiones de Ruby.
|
1968
1996
|
|
@@ -2075,4 +2103,4 @@ siguiendo las especificaciones SemVer y SemVerTag.
|
|
2075
2103
|
{última versión liberada}[http://rubydoc.info/gems/sinatra] o para la
|
2076
2104
|
{rama de desarrollo actual}[http://rubydoc.info/github/sinatra/sinatra]
|
2077
2105
|
en http://rubydoc.info/
|
2078
|
-
* {Servidor de
|
2106
|
+
* {Servidor de CI}[http://travis-ci.org/sinatra/sinatra]
|
data/README.fr.md
ADDED
@@ -0,0 +1,2630 @@
|
|
1
|
+
# Sinatra
|
2
|
+
*Attention : Ce document correspond à la traduction de la version anglaise et
|
3
|
+
il n'est peut être plus à jour.*
|
4
|
+
|
5
|
+
Sinatra est un [DSL](http://fr.wikipedia.org/wiki/Langage_dédié) pour
|
6
|
+
créer rapidement et facilement des applications web en Ruby :
|
7
|
+
|
8
|
+
```ruby
|
9
|
+
# mon_application.rb
|
10
|
+
require 'sinatra'
|
11
|
+
|
12
|
+
get '/' do
|
13
|
+
'Bonjour le monde !'
|
14
|
+
end
|
15
|
+
```
|
16
|
+
|
17
|
+
Installez la gem et lancez avec :
|
18
|
+
|
19
|
+
```bash
|
20
|
+
$ gem install sinatra
|
21
|
+
$ ruby mon_application.rb
|
22
|
+
```
|
23
|
+
|
24
|
+
Le résultat est visible sur : http://localhost:4567
|
25
|
+
|
26
|
+
Il est recommandé d'exécuter également `gem install thin`, pour que
|
27
|
+
Sinatra utilise le server Thin quand il est disponible.
|
28
|
+
|
29
|
+
## Routes
|
30
|
+
|
31
|
+
Dans Sinatra, une route est une méthode HTTP couplée à un masque (pattern)
|
32
|
+
URL. Chaque route est associée à un bloc :
|
33
|
+
|
34
|
+
```ruby
|
35
|
+
get '/' do
|
36
|
+
.. montrer quelque chose ..
|
37
|
+
end
|
38
|
+
|
39
|
+
post '/' do
|
40
|
+
.. créer quelque chose ..
|
41
|
+
end
|
42
|
+
|
43
|
+
put '/' do
|
44
|
+
.. remplacer quelque chose ..
|
45
|
+
end
|
46
|
+
|
47
|
+
patch '/' do
|
48
|
+
.. changer quelque chose ..
|
49
|
+
end
|
50
|
+
|
51
|
+
delete '/' do
|
52
|
+
.. effacer quelque chose ..
|
53
|
+
end
|
54
|
+
|
55
|
+
options '/' do
|
56
|
+
.. apaiser quelquechose ..
|
57
|
+
end
|
58
|
+
```
|
59
|
+
|
60
|
+
Les routes sont évaluées dans l'ordre où elles ont été définies. La première
|
61
|
+
route qui correspond à la requête est appelée.
|
62
|
+
|
63
|
+
Les masques peuvent inclure des paramètres nommés, accessibles par
|
64
|
+
l'intermédiaire du hash `params` :
|
65
|
+
|
66
|
+
```ruby
|
67
|
+
get '/bonjour/:nom' do
|
68
|
+
# répond aux requêtes "GET /bonjour/foo" et "GET /bonjour/bar"
|
69
|
+
# params[:nom] est 'foo' ou 'bar'
|
70
|
+
"Bonjour #{params[:nom]} !"
|
71
|
+
end
|
72
|
+
```
|
73
|
+
|
74
|
+
Vous pouvez aussi accéder aux paramètres nommés directement grâce aux
|
75
|
+
paramètres du bloc comme ceci :
|
76
|
+
|
77
|
+
```ruby
|
78
|
+
get '/bonjour/:nom' do |n|
|
79
|
+
"Bonjour #{n} !"
|
80
|
+
end
|
81
|
+
```
|
82
|
+
|
83
|
+
Une route peut contenir un splat (caractère joker), accessible par
|
84
|
+
l'intermédiaire du tableau `params[:splat]` :
|
85
|
+
|
86
|
+
```ruby
|
87
|
+
get '/dire/*/a/*' do
|
88
|
+
# répond à /dire/bonjour/a/monde
|
89
|
+
params[:splat] # => ["bonjour", "monde"]
|
90
|
+
end
|
91
|
+
|
92
|
+
get '/telecharger/*.*' do
|
93
|
+
# répond à /telecharger/chemin/vers/fichier.xml
|
94
|
+
params[:splat] # => ["chemin/vers/fichier", "xml"]
|
95
|
+
end
|
96
|
+
```
|
97
|
+
|
98
|
+
Ou par l'intermédiaire des paramètres du bloc :
|
99
|
+
|
100
|
+
```ruby
|
101
|
+
get '/telecharger/*.*' do |chemin, ext|
|
102
|
+
[chemin, ext] # => ["path/to/file", "xml"]
|
103
|
+
end
|
104
|
+
```
|
105
|
+
|
106
|
+
Une route peut aussi être définie par une expression régulière :
|
107
|
+
|
108
|
+
```ruby
|
109
|
+
get %r{/bonjour/([\w]+)} do
|
110
|
+
"Bonjour, #{params[:captures].first} !"
|
111
|
+
end
|
112
|
+
```
|
113
|
+
|
114
|
+
Là encore on peut utiliser les paramètres de bloc :
|
115
|
+
|
116
|
+
```ruby
|
117
|
+
get %r{/bonjour/([\w]+)} do |c|
|
118
|
+
"Bonjour, #{c} !"
|
119
|
+
end
|
120
|
+
```
|
121
|
+
|
122
|
+
Les routes peuvent aussi comporter des paramètres optionnels :
|
123
|
+
|
124
|
+
```ruby
|
125
|
+
get '/posts.?:format?' do
|
126
|
+
# répond à "GET /posts" et aussi à "GET /posts.json", "GET /posts.xml" etc...
|
127
|
+
end
|
128
|
+
```
|
129
|
+
|
130
|
+
A ce propos, à moins d'avoir désactivé la protection contre les attaques par
|
131
|
+
"path transversal" (voir plus loin), l'URL demandée peut avoir été modifiée
|
132
|
+
avant d'être comparée à vos routes.
|
133
|
+
|
134
|
+
### Conditions
|
135
|
+
|
136
|
+
Les routes peuvent définir toutes sortes de conditions, comme par exemple le
|
137
|
+
"user agent" :
|
138
|
+
|
139
|
+
```ruby
|
140
|
+
get '/foo', :agent => /Songbird (\d\.\d)[\d\/]*?/ do
|
141
|
+
"Vous utilisez Songbird version #{params[:agent][0]}"
|
142
|
+
end
|
143
|
+
|
144
|
+
get '/foo' do
|
145
|
+
# Correspond à tous les autres navigateurs
|
146
|
+
end
|
147
|
+
```
|
148
|
+
|
149
|
+
Les autres conditions disponibles sont `host_name` et `provides` :
|
150
|
+
|
151
|
+
```ruby
|
152
|
+
get '/', :host_name => /^admin\./ do
|
153
|
+
"Zone Administrateur, Accès refusé !"
|
154
|
+
end
|
155
|
+
|
156
|
+
get '/', :provides => 'html' do
|
157
|
+
haml :index
|
158
|
+
end
|
159
|
+
|
160
|
+
get '/', :provides => ['rss', 'atom', 'xml'] do
|
161
|
+
builder :feed
|
162
|
+
end
|
163
|
+
```
|
164
|
+
|
165
|
+
Vous pouvez facilement définir vos propres conditions :
|
166
|
+
|
167
|
+
```ruby
|
168
|
+
set(:probability) { |value| condition { rand <= value } }
|
169
|
+
|
170
|
+
get '/gagner_une_voiture', :probability => 0.1 do
|
171
|
+
"Vous avez gagné !"
|
172
|
+
end
|
173
|
+
|
174
|
+
get '/gagner_une_voiture' do
|
175
|
+
"Désolé, vous avez perdu."
|
176
|
+
end
|
177
|
+
```
|
178
|
+
|
179
|
+
Utilisez un splat (caractère joker) dans le cas d'une condition qui prend
|
180
|
+
plusieurs valeurs :
|
181
|
+
|
182
|
+
```ruby
|
183
|
+
set(:auth) do |*roles| # <- ici on utilise un splat
|
184
|
+
condition do
|
185
|
+
unless logged_in? && roles.any? {|role| current_user.in_role? role }
|
186
|
+
redirect "/login/", 303
|
187
|
+
end
|
188
|
+
end
|
189
|
+
end
|
190
|
+
|
191
|
+
get "/mon/compte/", :auth => [:user, :admin] do
|
192
|
+
"Informations sur votre compte"
|
193
|
+
end
|
194
|
+
|
195
|
+
get "/reserve/aux/admins/", :auth => :admin do
|
196
|
+
"Seuls les administrateurs sont acceptés ici !"
|
197
|
+
end
|
198
|
+
```
|
199
|
+
|
200
|
+
### Valeurs de retour
|
201
|
+
|
202
|
+
La valeur renvoyée par le bloc correspondant à une route constitue le corps de
|
203
|
+
la réponse qui sera transmise au client HTTP ou du moins au prochain middleware
|
204
|
+
dans la pile Rack. Le plus souvent, il s'agit d'une chaîne de caractères,
|
205
|
+
comme dans les exemples précédents. Cependant, d'autres valeurs sont
|
206
|
+
acceptées.
|
207
|
+
|
208
|
+
Vous pouvez renvoyer n'importe quel objet qu'il s'agisse d'une réponse Rack
|
209
|
+
valide, d'un corps de réponse Rack ou d'un code statut HTTP :
|
210
|
+
|
211
|
+
* Un tableau de 3 éléments : `[code statut (Fixnum), entêtes (Hash), corps
|
212
|
+
de la réponse (répondant à #each)]`
|
213
|
+
* Un tableau de 2 élements : `[code statut (Fixnum), corps de la réponse
|
214
|
+
(répondant à #each)]`
|
215
|
+
* Un objet qui répond à `#each` et qui ne transmet que des chaînes de
|
216
|
+
caractères au bloc fourni
|
217
|
+
* Un Fixnum représentant le code statut
|
218
|
+
|
219
|
+
Avec cela, on peut facilement implémenter un streaming par exemple :
|
220
|
+
|
221
|
+
```ruby
|
222
|
+
class Stream
|
223
|
+
def each
|
224
|
+
100.times { |i| yield "#{i}\n" }
|
225
|
+
end
|
226
|
+
end
|
227
|
+
|
228
|
+
get('/') { Stream.new }
|
229
|
+
```
|
230
|
+
|
231
|
+
Vous pouvez aussi utiliser le helper `stream` (présenté un peu plus loin) pour
|
232
|
+
éviter la surcharge et intégrer le traitement relatif au streaming dans le bloc
|
233
|
+
de code de la route.
|
234
|
+
|
235
|
+
### Masques de route spécifiques
|
236
|
+
|
237
|
+
Comme cela a été vu auparavant, Sinatra offre la possibilité d'utiliser des
|
238
|
+
masques sous forme de chaines de caractères ou des expressions régulières
|
239
|
+
pour définir les routes. Mais il est possible de faire bien plus. Vous pouvez
|
240
|
+
facilement définir vos propres masques :
|
241
|
+
|
242
|
+
```ruby
|
243
|
+
class MasqueToutSauf
|
244
|
+
Masque = Struct.new(:captures)
|
245
|
+
|
246
|
+
def initialize(except)
|
247
|
+
@except = except
|
248
|
+
@captures = Masque.new([])
|
249
|
+
end
|
250
|
+
|
251
|
+
def match(str)
|
252
|
+
@caputres unless @except === str
|
253
|
+
end
|
254
|
+
end
|
255
|
+
|
256
|
+
def tout_sauf(masque)
|
257
|
+
MasqueToutSauf.new(masque)
|
258
|
+
end
|
259
|
+
|
260
|
+
get tout_sauf("/index") do
|
261
|
+
# ...
|
262
|
+
end
|
263
|
+
```
|
264
|
+
|
265
|
+
Notez que l'exemple ci-dessus est bien trop compliqué et que le même résultat
|
266
|
+
peut être obtenu avec :
|
267
|
+
|
268
|
+
```ruby
|
269
|
+
get // do
|
270
|
+
pass if request.path_info == "/index"
|
271
|
+
# ...
|
272
|
+
end
|
273
|
+
```
|
274
|
+
|
275
|
+
Ou bien en utilisant la forme négative :
|
276
|
+
|
277
|
+
```ruby
|
278
|
+
get %r{^(?!/index$)} do
|
279
|
+
# ...
|
280
|
+
end
|
281
|
+
```
|
282
|
+
|
283
|
+
## Fichiers statiques
|
284
|
+
|
285
|
+
Les fichiers du dossier `./public` sont servis de façon statique. Vous
|
286
|
+
avez la possibilité d'utiliser un autre répertoire en définissant le paramètre
|
287
|
+
`:public_folder` :
|
288
|
+
|
289
|
+
```ruby
|
290
|
+
set :public_folder, File.dirname(__FILE__) + '/statique'
|
291
|
+
```
|
292
|
+
|
293
|
+
Notez que le nom du dossier public n'apparait pas dans l'URL. Le fichier
|
294
|
+
`./public/css/style.css` sera appelé via l'URL :
|
295
|
+
`http://exemple.com/css/style.css`.
|
296
|
+
|
297
|
+
Utilisez le paramètre `:static_cache_control` pour ajouter l'information
|
298
|
+
d'en-tête <tt>Cache-Control</tt> (voir plus loin).
|
299
|
+
|
300
|
+
## Vues / Templates
|
301
|
+
|
302
|
+
Chaqie langage de template est disponible via sa propre méthode de rendu,
|
303
|
+
lesquelles renvoient tout simplement une chaîne de caractères.
|
304
|
+
|
305
|
+
```ruby
|
306
|
+
get '/' do
|
307
|
+
erb :index
|
308
|
+
end
|
309
|
+
```
|
310
|
+
|
311
|
+
Ceci effectue le rendu de la vue `views/index.erb`.
|
312
|
+
|
313
|
+
Plutôt que d'utiliser le nom d'un template, vous pouvez directement passer
|
314
|
+
le contenu du template :
|
315
|
+
|
316
|
+
```ruby
|
317
|
+
get '/' do
|
318
|
+
code = "<%= Time.now %>"
|
319
|
+
erb code
|
320
|
+
end
|
321
|
+
```
|
322
|
+
|
323
|
+
Les méthodes de templates acceptent un second paramètre, un hash d'options :
|
324
|
+
|
325
|
+
```ruby
|
326
|
+
get '/' do
|
327
|
+
erb :index, :layout => :post
|
328
|
+
end
|
329
|
+
```
|
330
|
+
|
331
|
+
Ceci effectuera le rendu de la vue `views/index.erb` en l'intégrant
|
332
|
+
au *layout* `views/post.erb` (les vues Erb sont intégrées par défaut
|
333
|
+
au *layout* `views/layout.erb` quand ce fichier existe).
|
334
|
+
|
335
|
+
Toute option que Sinatra ne comprend pas sera passée au moteur de rendu :
|
336
|
+
|
337
|
+
```ruby
|
338
|
+
get '/' do
|
339
|
+
haml :index, :format => :html5
|
340
|
+
end
|
341
|
+
```
|
342
|
+
|
343
|
+
Vous pouvez également définir des options par langage de template de façon
|
344
|
+
générale :
|
345
|
+
|
346
|
+
```ruby
|
347
|
+
set :haml, :format => html5
|
348
|
+
|
349
|
+
get '/' do
|
350
|
+
haml :index
|
351
|
+
end
|
352
|
+
```
|
353
|
+
|
354
|
+
Les options passées à la méthode de rendu prennent le pas sur les options
|
355
|
+
définies au moyen de `set`.
|
356
|
+
|
357
|
+
Options disponibles :
|
358
|
+
|
359
|
+
**locals**
|
360
|
+
Liste de variables locales passées au document. Pratique pour les vues
|
361
|
+
partielles.
|
362
|
+
Exemple : `erb "<%= foo %>", :locals => {:foo => "bar"}`.
|
363
|
+
|
364
|
+
**default_encoding**
|
365
|
+
Encodage de caractères à utiliser en cas d'incertitude. Par défaut, c'est
|
366
|
+
`settings.default_encoding`.
|
367
|
+
|
368
|
+
**views**
|
369
|
+
Dossier de vues dans lequel chercher les templates. Par défaut
|
370
|
+
`settings.views`.
|
371
|
+
|
372
|
+
**layout**
|
373
|
+
S'il faut ou non utiliser un +layout+ (+true+ or +false+). Indique le
|
374
|
+
template à utiliser lorsque c'est un symbole. Exemple : `erb :index,
|
375
|
+
:layout => !request.xhr?`.
|
376
|
+
|
377
|
+
**content_type**
|
378
|
+
Content-Type que le template produit, dépend par défaut du langage de
|
379
|
+
template.
|
380
|
+
|
381
|
+
**scope**
|
382
|
+
Contexte sous lequel effectuer le rendu du template. Par défaut il s'agit
|
383
|
+
de l'instance de l'application. Si vous changez cela, les variables
|
384
|
+
d'instance et les méthodes utilitaires ne seront pas disponibles.
|
385
|
+
|
386
|
+
**layout_engine**
|
387
|
+
Moteur de rendu à utiliser pour le +layout+. Utile pour les langages ne
|
388
|
+
supportant pas les +layouts+. Il s'agit par défaut du moteur utilisé pour
|
389
|
+
le rendu du template. Exemple : `set :rdoc, :layout_engine => :erb`
|
390
|
+
|
391
|
+
Les templates sont supposés se trouver directement dans le dossier
|
392
|
+
`./views`. Pour utiliser un dossier de vues différent :
|
393
|
+
|
394
|
+
```ruby
|
395
|
+
set :views, settings.root + '/templates'
|
396
|
+
```
|
397
|
+
|
398
|
+
Il est important de se souvenir que les templates sont toujours référencés
|
399
|
+
sous forme de symboles, même lorsqu'ils sont dans un sous-répertoire (dans
|
400
|
+
ce cas, utilisez `:'sous_repertoire/template'`). Il faut utiliser
|
401
|
+
un symbole car les méthodes de rendu évaluent le contenu des chaînes de
|
402
|
+
caractères au lieu de les considérer comme un chemin vers un fichier.
|
403
|
+
|
404
|
+
### Langages de template disponibles
|
405
|
+
|
406
|
+
Certains langages ont plusieurs implémentations. Pour préciser l'implémentation
|
407
|
+
à utiliser (et garantir l'aspect thread-safe), vous devez simplement l'avoir
|
408
|
+
chargée au préalable :
|
409
|
+
|
410
|
+
```ruby
|
411
|
+
require 'rdiscount' # ou require 'bluecloth'
|
412
|
+
get('/') { markdown :index }
|
413
|
+
```
|
414
|
+
|
415
|
+
### Templates Haml
|
416
|
+
|
417
|
+
<table>
|
418
|
+
<tr>
|
419
|
+
<td>Dépendances</td>
|
420
|
+
<td><a href="http://haml.info/">haml</a></td>
|
421
|
+
</tr>
|
422
|
+
<tr>
|
423
|
+
<td>Extensions de fichier</td>
|
424
|
+
<td><tt>.haml</tt></td>
|
425
|
+
</tr>
|
426
|
+
<tr>
|
427
|
+
<td>Exemple</td>
|
428
|
+
<td><tt>haml :index, :format => :html5</tt></td>
|
429
|
+
</tr>
|
430
|
+
</table>
|
431
|
+
|
432
|
+
### Templates Erb
|
433
|
+
|
434
|
+
<table>
|
435
|
+
<tr>
|
436
|
+
<td>Dépendances</td>
|
437
|
+
<td><a href="http://www.kuwata-lab.com/erubis/">erubis</a> ou erb (inclus avec Ruby)</td>
|
438
|
+
</tr>
|
439
|
+
<tr>
|
440
|
+
<td>Extensions de fichier</td>
|
441
|
+
<td><tt>.erb</tt>, <tt>.rhtml</tt> ou <tt>.erubis</tt> (Erubis seulement)</td>
|
442
|
+
</tr>
|
443
|
+
<tr>
|
444
|
+
<td>Exemple</td>
|
445
|
+
<td><tt>erb :index</tt></td>
|
446
|
+
</tr>
|
447
|
+
</table>
|
448
|
+
|
449
|
+
### Templates Builder
|
450
|
+
|
451
|
+
<table>
|
452
|
+
<tr>
|
453
|
+
<td>Dépendances</td>
|
454
|
+
<td><a href="http://builder.rubyforge.org/">builder</a></td>
|
455
|
+
</tr>
|
456
|
+
<tr>
|
457
|
+
<td>Extensions de fichier</td>
|
458
|
+
<td><tt>.builder</tt></td>
|
459
|
+
</tr>
|
460
|
+
<tr>
|
461
|
+
<td>Exemple</td>
|
462
|
+
<td><tt>builder { |xml| xml.em "salut" }</tt></td>
|
463
|
+
</tr>
|
464
|
+
</table>
|
465
|
+
|
466
|
+
Ce moteur accepte également un bloc pour des templates en ligne (voir
|
467
|
+
exemple).
|
468
|
+
|
469
|
+
### Templates Nokogiri
|
470
|
+
|
471
|
+
<table>
|
472
|
+
<tr>
|
473
|
+
<td>Dépendances</td>
|
474
|
+
<td><a href="http://nokogiri.org/">nokogiri</a></td>
|
475
|
+
</tr>
|
476
|
+
<tr>
|
477
|
+
<td>Extensions de fichier</td>
|
478
|
+
<td><tt>.nokogiri</tt></td>
|
479
|
+
</tr>
|
480
|
+
<tr>
|
481
|
+
<td>Exemple</td>
|
482
|
+
<td><tt>nokogiri { |xml| xml.em "salut" }</p>
|
483
|
+
</td>
|
484
|
+
</tr>
|
485
|
+
</table>
|
486
|
+
|
487
|
+
Ce moteur accepte également un bloc pour des templates en ligne (voir
|
488
|
+
exemple).
|
489
|
+
|
490
|
+
### Templates Sass
|
491
|
+
|
492
|
+
<table>
|
493
|
+
<tr>
|
494
|
+
<td>Dépendances</td>
|
495
|
+
<td><a href="http://sass-lang.com/">sass</a></td>
|
496
|
+
</tr>
|
497
|
+
<tr>
|
498
|
+
<td>Extensions de fichier</td>
|
499
|
+
<td><tt>.sass</tt></td>
|
500
|
+
</tr>
|
501
|
+
<tr>
|
502
|
+
<td>Exemple</td>
|
503
|
+
<td><tt>sass :stylesheet, :style => :expanded</tt></td>
|
504
|
+
</tr>
|
505
|
+
</table>
|
506
|
+
|
507
|
+
### Templates SCSS
|
508
|
+
|
509
|
+
<table>
|
510
|
+
<tr>
|
511
|
+
<td>Dépendances</td>
|
512
|
+
<td><a href="http://sass-lang.com/">sass</a></td>
|
513
|
+
</tr>
|
514
|
+
<tr>
|
515
|
+
<td>Extensions de fichier</td>
|
516
|
+
<td><tt>.scss</tt></td>
|
517
|
+
</tr>
|
518
|
+
<tr>
|
519
|
+
<td>Exemple</td>
|
520
|
+
<td><tt>scss :stylesheet, :style => :expanded</tt></p>
|
521
|
+
</td>
|
522
|
+
</tr>
|
523
|
+
</table>
|
524
|
+
|
525
|
+
### Templates Less
|
526
|
+
|
527
|
+
<table>
|
528
|
+
<tr>
|
529
|
+
<td>Dépendances</td>
|
530
|
+
<td><a href="http://www.lesscss.org/">less</a></td>
|
531
|
+
</tr>
|
532
|
+
<tr>
|
533
|
+
<td>Extensions de fichier</td>
|
534
|
+
<td><tt>.less</tt></td>
|
535
|
+
</tr>
|
536
|
+
<tr>
|
537
|
+
<td>Exemple</td>
|
538
|
+
<td><tt>less :stylesheet</tt>
|
539
|
+
</td>
|
540
|
+
</tr>
|
541
|
+
</table>
|
542
|
+
|
543
|
+
### Templates Liquid
|
544
|
+
|
545
|
+
<table>
|
546
|
+
<tr>
|
547
|
+
<td>Dépendances</td>
|
548
|
+
<td><a href="http://www.liquidmarkup.org/">liquid</a></td>
|
549
|
+
</tr>
|
550
|
+
<tr>
|
551
|
+
<td>Extensions de fichier</td>
|
552
|
+
<td><tt>.liquid</tt></td>
|
553
|
+
</tr>
|
554
|
+
<tr>
|
555
|
+
<td>Exemple</td>
|
556
|
+
<td><tt>liquid :index, :locals => { :key => 'value' }</tt></td>
|
557
|
+
</tr>
|
558
|
+
</table>
|
559
|
+
|
560
|
+
Comme vous ne pouvez appeler de méthodes Ruby (autres que `yield`)
|
561
|
+
dans un template Liquid, vous aurez sûrement à lui passer des variables
|
562
|
+
locales.
|
563
|
+
|
564
|
+
### Templates Markdown
|
565
|
+
|
566
|
+
<table>
|
567
|
+
<tr>
|
568
|
+
<td><p>Dépendances</p></td>
|
569
|
+
<td><a href="https://github.com/rtomayko/rdiscount">rdiscount</a>, <a href="https://github.com/vmg/redcarpet">redcarpet</a>, <a href="http://deveiate.org/projects/BlueCloth">bluecloth</a>, <a href="http://kramdown.rubyforge.org/">kramdown</a> *ou* <a href="http://maruku.rubyforge.org/">maruku</a></td>
|
570
|
+
</tr>
|
571
|
+
|
572
|
+
<tr>
|
573
|
+
<td>Extensions de fichier</td>
|
574
|
+
<td><tt>.markdown</tt>, <tt>.mkd</tt> et <tt>.md</tt></td>
|
575
|
+
</tr>
|
576
|
+
<tr>
|
577
|
+
<td>Exemple</td>
|
578
|
+
<td><tt>markdown :index, :layout_engine => :erb</tt></td>
|
579
|
+
</tr>
|
580
|
+
</table>
|
581
|
+
|
582
|
+
Il n’est pas possible d’appeler des méthodes depuis markdown, ni de
|
583
|
+
lui passer des variables locales. Par conséquent, il sera souvent utilisé
|
584
|
+
en combinaison avec un autre moteur de rendu :
|
585
|
+
|
586
|
+
```ruby
|
587
|
+
erb :overview, :locals => { :text => markdown(:introduction) }
|
588
|
+
```
|
589
|
+
|
590
|
+
Notez que vous pouvez également appeler la méthode `markdown` au
|
591
|
+
sein d’autres templates :
|
592
|
+
|
593
|
+
```ruby
|
594
|
+
%h1 Hello From Haml !
|
595
|
+
%p= markdown(:greetings)
|
596
|
+
```
|
597
|
+
|
598
|
+
Comme vous ne pouvez pas appeler de Ruby au sein de Markdown, vous ne
|
599
|
+
pouvez pas utiliser de layouts écrits en Markdown. Toutefois, il
|
600
|
+
est possible d’utiliser un moteur de rendu différent pour le template et
|
601
|
+
pour le layout en utilisant l’option `:layout_engine`.
|
602
|
+
|
603
|
+
### Templates Textile
|
604
|
+
|
605
|
+
<table>
|
606
|
+
<tr>
|
607
|
+
<td>Dépendances</td>
|
608
|
+
<td><a href="http://redcloth.org/">RedCloth</a></td>
|
609
|
+
</tr>
|
610
|
+
<tr>
|
611
|
+
<td>Extensions de fichier</td>
|
612
|
+
<td><tt>.textile</tt></td>
|
613
|
+
</tr>
|
614
|
+
<tr>
|
615
|
+
<td>Exemple</td>
|
616
|
+
<td><tt>textile :index, :layout_engine => :erb</tt></td>
|
617
|
+
</tr>
|
618
|
+
</table>
|
619
|
+
|
620
|
+
Il n’est pas possible d’appeler des méthodes depuis textile, ni de lui
|
621
|
+
passer des variables locales. Par conséquent, il sera souvent utilisé en
|
622
|
+
combinaison avec un autre moteur de rendu :
|
623
|
+
|
624
|
+
```ruby
|
625
|
+
erb :overview, :locals => { :text => textile(:introduction) }
|
626
|
+
```
|
627
|
+
|
628
|
+
Notez que vous pouvez également appeler la méthode `textile` au
|
629
|
+
sein d’autres templates :
|
630
|
+
|
631
|
+
```ruby
|
632
|
+
%h1 Hello From Haml !
|
633
|
+
%p= textile(:greetings)
|
634
|
+
```
|
635
|
+
|
636
|
+
Comme vous ne pouvez pas appeler de Ruby au sein de Textile, vous ne pouvez
|
637
|
+
pas utiliser de layouts écrits en Textile. Toutefois, il est
|
638
|
+
possible d’utiliser un moteur de rendu différent pour le template et
|
639
|
+
pour le layout en utilisant l’option `:layout_engine`.
|
640
|
+
|
641
|
+
### Templates RDoc
|
642
|
+
|
643
|
+
<table>
|
644
|
+
<tr>
|
645
|
+
<td>Dépendances</td>
|
646
|
+
<td><a href="http://rdoc.rubyforge.org/">rdoc</a></td>
|
647
|
+
</tr>
|
648
|
+
<tr>
|
649
|
+
<td>Extensions de fichier</td>
|
650
|
+
<td><tt>.rdoc</tt></td>
|
651
|
+
</tr>
|
652
|
+
<tr>
|
653
|
+
<td>Exemple</td>
|
654
|
+
<td><tt>rdoc :README, :layout_engine => :erb</tt></td>
|
655
|
+
</tr>
|
656
|
+
</table>
|
657
|
+
|
658
|
+
Il n’est pas possible d’appeler des méthodes depuis rdoc, ni de lui
|
659
|
+
passer des variables locales. Par conséquent, il sera souvent utilisé en
|
660
|
+
combinaison avec un autre moteur de rendu :
|
661
|
+
|
662
|
+
```ruby
|
663
|
+
erb :overview, :locals => { :text => rdoc(:introduction) }
|
664
|
+
```
|
665
|
+
|
666
|
+
Notez que vous pouvez également appeler la méthode `rdoc` au sein
|
667
|
+
d’autres templates :
|
668
|
+
|
669
|
+
```ruby
|
670
|
+
%h1 Hello From Haml !
|
671
|
+
%p= rdoc(:greetings)
|
672
|
+
```
|
673
|
+
|
674
|
+
Comme vous ne pouvez pas appeler de Ruby au sein de RDoc, vous ne pouvez
|
675
|
+
pas utiliser de layouts écrits en RDoc. Toutefois, il est
|
676
|
+
possible d’utiliser un moteur de rendu différent pour le template et
|
677
|
+
pour le layout en utilisant l’option `:layout_engine`.
|
678
|
+
|
679
|
+
### Templates Radius
|
680
|
+
<table>
|
681
|
+
<tr>
|
682
|
+
<td>Dépendances</td>
|
683
|
+
<td><a href="http://radius.rubyforge.org/">radius</a></td>
|
684
|
+
</tr>
|
685
|
+
<tr>
|
686
|
+
<td>Extensions de fichier</td>
|
687
|
+
<td><tt>.radius</tt></td>
|
688
|
+
</tr>
|
689
|
+
<tr>
|
690
|
+
<td>Exemple</td>
|
691
|
+
<td><tt>radius :index, :locals => { :key => 'value' }</tt></td>
|
692
|
+
</tr>
|
693
|
+
</table>
|
694
|
+
|
695
|
+
Comme vous ne pouvez pas appeler de méthodes Ruby depuis un template
|
696
|
+
Radius, vous aurez sûrement à lui passer des variables locales.
|
697
|
+
|
698
|
+
### Templates Markaby
|
699
|
+
|
700
|
+
<table>
|
701
|
+
<tr>
|
702
|
+
<td>Dépendances</td>
|
703
|
+
<td><a href="http://markaby.github.com/">markaby</a></td>
|
704
|
+
</tr>
|
705
|
+
<tr>
|
706
|
+
<td>Extensions de fichier</td>
|
707
|
+
<td><tt>.mab</tt></td>
|
708
|
+
</tr>
|
709
|
+
<tr>
|
710
|
+
<td>Exemple</td>
|
711
|
+
<td><tt>markaby { h1 "Bienvenue !" }</tt></td>
|
712
|
+
</tr>
|
713
|
+
</table>
|
714
|
+
|
715
|
+
Ce moteur accepte également un bloc pour des templates en ligne (voir
|
716
|
+
exemple).
|
717
|
+
|
718
|
+
### Templates RABL
|
719
|
+
|
720
|
+
<table>
|
721
|
+
<tr>
|
722
|
+
<td>Dépendances</td>
|
723
|
+
<td><a href="https://github.com/nesquena/rabl">rabl</a></td>
|
724
|
+
</tr>
|
725
|
+
<tr>
|
726
|
+
<td>Extensions de fichier</td>
|
727
|
+
<td><tt>.rabl</tt></td>
|
728
|
+
</tr>
|
729
|
+
<tr>
|
730
|
+
<td>Exemple</td>
|
731
|
+
<td><tt>rabl :index</tt></td>
|
732
|
+
</tr>
|
733
|
+
</table>
|
734
|
+
|
735
|
+
### Templates Slim
|
736
|
+
|
737
|
+
<table>
|
738
|
+
<tr>
|
739
|
+
<td>Dépendances</td>
|
740
|
+
<td><a href="http://slim-lang.com/">slim</a></td>
|
741
|
+
</tr>
|
742
|
+
<tr>
|
743
|
+
<td>Extensions de fichier</td>
|
744
|
+
<td><tt>.slim</tt></td>
|
745
|
+
</tr>
|
746
|
+
<tr>
|
747
|
+
<td>Exemple</td>
|
748
|
+
<td><tt>slim :index</tt></td>
|
749
|
+
</tr>
|
750
|
+
</table>
|
751
|
+
|
752
|
+
### Templates Creole
|
753
|
+
|
754
|
+
<table>
|
755
|
+
<tr>
|
756
|
+
<td>Dépendances</td>
|
757
|
+
<td><a href="https://github.com/minad/creole">creole</a></td>
|
758
|
+
</tr>
|
759
|
+
<tr>
|
760
|
+
<td>Extensions de fichier</td>
|
761
|
+
<td><tt>.creole</tt></td>
|
762
|
+
</tr>
|
763
|
+
<tr>
|
764
|
+
<td>Exemple</td>
|
765
|
+
<td><tt>creole :wiki, :layout_engine => :erb</tt></td>
|
766
|
+
</tr>
|
767
|
+
</table>
|
768
|
+
|
769
|
+
Il n'est pas possible d'appeler des méthodes depuis markdown, ni de lui
|
770
|
+
passer des variables locales. Par conséquent, il sera souvent utilisé en
|
771
|
+
combinaison avec un autre moteur de rendu :
|
772
|
+
|
773
|
+
```ruby
|
774
|
+
erb :overview, :locals => { :text => markdown(:introduction) }
|
775
|
+
```
|
776
|
+
|
777
|
+
Notez que vous pouvez également appeler la méthode +markdown+ au sein d'autres
|
778
|
+
templates :
|
779
|
+
|
780
|
+
```ruby
|
781
|
+
%h1 Hello From Haml !
|
782
|
+
%p= markdown(:greetings)
|
783
|
+
```
|
784
|
+
|
785
|
+
Comme vous ne pouvez pas appeler de Ruby au sein de Markdown, vous ne pouvez
|
786
|
+
pas utiliser de +layouts+ écrits en Markdown. Toutefois, il est possible
|
787
|
+
d'utiliser un moteur de rendu différent pour le template et pour le +layout+
|
788
|
+
en utilisant l'option `:layout_engine`.
|
789
|
+
|
790
|
+
### Templates CoffeeScript
|
791
|
+
|
792
|
+
<table>
|
793
|
+
<tr>
|
794
|
+
<td>Dépendances</td>
|
795
|
+
<td><a href="https://github.com/josh/ruby-coffee-script">coffee-script</a> et un [moyen d'exécuter javascript](https://github.com/sstephenson/execjs/blob/master/README.md#readme)</td>
|
796
|
+
</tr>
|
797
|
+
<tr>
|
798
|
+
<td>Extensions de fichier</td>
|
799
|
+
<td><tt>.coffee</tt></td>
|
800
|
+
</tr>
|
801
|
+
<tr>
|
802
|
+
<td>Exemple</td>
|
803
|
+
<td><tt>coffee :index</tt></td>
|
804
|
+
</tr>
|
805
|
+
</table>
|
806
|
+
|
807
|
+
### Templates Yajl
|
808
|
+
|
809
|
+
<table>
|
810
|
+
<tr>
|
811
|
+
<td>Dépendances</td>
|
812
|
+
<td><a href="https://github.com/brianmario/yajl-ruby">yajl-ruby</a></td>
|
813
|
+
</tr>
|
814
|
+
<tr>
|
815
|
+
<td>Extensions de fichier</td>
|
816
|
+
<td><tt>.yajl</tt></td>
|
817
|
+
</tr>
|
818
|
+
<tr>
|
819
|
+
<td>Exemple</td>
|
820
|
+
<td><tt>yajl :index, :locals => { :key => 'qux' }, :callback => 'present', :variable => 'resource'</tt></p>
|
821
|
+
</td>
|
822
|
+
</tr>
|
823
|
+
</table>
|
824
|
+
|
825
|
+
Le source du template est évalué en tant que chaine Ruby, puis la
|
826
|
+
variable json obtenue est convertie avec #to_json.
|
827
|
+
|
828
|
+
```ruby
|
829
|
+
json = { :foo => 'bar' }
|
830
|
+
json[:baz] = key
|
831
|
+
```
|
832
|
+
|
833
|
+
Les options `:callback` et `:variable` peuvent être utilisées pour décorer l’objet retourné.
|
834
|
+
|
835
|
+
```
|
836
|
+
var resource = {"foo":"bar","baz":"qux"}; present(resource);</pre>
|
837
|
+
```
|
838
|
+
|
839
|
+
### Templates WLang
|
840
|
+
|
841
|
+
<table>
|
842
|
+
<tr>
|
843
|
+
<td>Dependency</td>
|
844
|
+
<td><a href="https://github.com/blambeau/wlang/">wlang</a></td>
|
845
|
+
</tr>
|
846
|
+
<tr>
|
847
|
+
<td>File Extensions</td>
|
848
|
+
<td><tt>.wlang</tt></td>
|
849
|
+
</tr>
|
850
|
+
<tr>
|
851
|
+
<td>Example</td>
|
852
|
+
<td><tt>wlang :index, :locals => { :key => 'value' }</tt></td>
|
853
|
+
</tr>
|
854
|
+
</table>
|
855
|
+
|
856
|
+
L’appel de code ruby au sein des templates n’est pas idiomatique en wlang. L’écriture de templates sans logique est encouragé, via le passage de variables locales. Il est néanmoins possible d’écrire un layout en wlang et d’y utiliser `yield`.
|
857
|
+
|
858
|
+
### Templates embarqués
|
859
|
+
|
860
|
+
```ruby
|
861
|
+
get '/' do
|
862
|
+
haml '%div.title Bonjour le monde'
|
863
|
+
end
|
864
|
+
```
|
865
|
+
|
866
|
+
Générera le code du template spécifié dans la chaîne de caractères.
|
867
|
+
|
868
|
+
### Accéder aux variables dans un Template
|
869
|
+
|
870
|
+
Un template est évalué dans le même contexte que l'endroit d'où il a été
|
871
|
+
appelé (gestionnaire de route). Les variables d'instance déclarées dans le
|
872
|
+
gestionnaire de route sont directement accessibles dans le template :
|
873
|
+
|
874
|
+
```ruby
|
875
|
+
get '/:id' do
|
876
|
+
@foo = Foo.find(params[:id])
|
877
|
+
haml '%h1= @foo.nom'
|
878
|
+
end
|
879
|
+
```
|
880
|
+
|
881
|
+
Alternativement, on peut passer un hash contenant des variables locales :
|
882
|
+
|
883
|
+
```ruby
|
884
|
+
get '/:id' do
|
885
|
+
foo = Foo.find(params[:id])
|
886
|
+
haml '%h1= foo.nom', :locals => { :foo => foo }
|
887
|
+
end
|
888
|
+
```
|
889
|
+
|
890
|
+
Ceci est généralement utilisé lorsque l'on veut utiliser un template comme
|
891
|
+
partiel (depuis un autre template) et qu'il est donc nécessaire d'adapter les
|
892
|
+
noms de variables.
|
893
|
+
|
894
|
+
### Templates dans le fichier source
|
895
|
+
|
896
|
+
Des templates peuvent être définis dans le fichier source comme ceci :
|
897
|
+
|
898
|
+
```ruby
|
899
|
+
require 'sinatra'
|
900
|
+
|
901
|
+
get '/' do
|
902
|
+
haml :index
|
903
|
+
end
|
904
|
+
|
905
|
+
__END__
|
906
|
+
|
907
|
+
@@ layout
|
908
|
+
%html
|
909
|
+
= yield
|
910
|
+
|
911
|
+
@@ index
|
912
|
+
%div.title Bonjour le monde !
|
913
|
+
```
|
914
|
+
|
915
|
+
NOTE : Les templates du fichier source qui contient `require 'sinatra'`
|
916
|
+
sont automatiquement chargés. Si vous avez des templates dans d'autres
|
917
|
+
fichiers source, il faut explicitement les déclarer avec
|
918
|
+
`enable :inline_templates`.
|
919
|
+
|
920
|
+
### Templates nommés
|
921
|
+
|
922
|
+
Les templates peuvent aussi être définis grâce à la méthode de haut niveau `template` :
|
923
|
+
|
924
|
+
```ruby
|
925
|
+
template :layout do
|
926
|
+
"%html\n =yield\n"
|
927
|
+
end
|
928
|
+
|
929
|
+
template :index do
|
930
|
+
'%div.title Bonjour le monde !'
|
931
|
+
end
|
932
|
+
|
933
|
+
get '/' do
|
934
|
+
haml :index
|
935
|
+
end
|
936
|
+
```
|
937
|
+
|
938
|
+
Si un template nommé "layout" existe, il sera utilisé à chaque fois qu'un
|
939
|
+
template sera affiché. Vous pouvez désactivez les layouts au cas par cas en
|
940
|
+
passant `:layout => false` ou bien les désactiver par défaut au moyen
|
941
|
+
de `set :haml, :layout => false` :
|
942
|
+
|
943
|
+
```ruby
|
944
|
+
get '/' do
|
945
|
+
haml :index, :layout => !request.xhr?
|
946
|
+
end
|
947
|
+
```
|
948
|
+
|
949
|
+
### Associer des extensions de fichier
|
950
|
+
|
951
|
+
Pour associer une extension de fichier avec un moteur de rendu, utilisez
|
952
|
+
`Tilt.register`. Par exemple, si vous désirez utiliser l'extension
|
953
|
+
de fichier `tt` pour les templates Textile, vous pouvez faire comme suit :
|
954
|
+
|
955
|
+
```ruby
|
956
|
+
Tilt.register :tt, Tilt[:textile]
|
957
|
+
```
|
958
|
+
|
959
|
+
### Ajouter son propre moteur de rendu
|
960
|
+
|
961
|
+
En premier lieu, déclarez votre moteur de rendu avec Tilt, ensuite créez
|
962
|
+
votre méthode de rendu :
|
963
|
+
|
964
|
+
```ruby
|
965
|
+
Tilt.register :monmoteur, MonMerveilleurMoteurDeRendu
|
966
|
+
|
967
|
+
helpers do
|
968
|
+
def monmoteur(*args) render(:monmoteur, *args) end
|
969
|
+
end
|
970
|
+
|
971
|
+
get '/' do
|
972
|
+
monmoteur :index
|
973
|
+
end
|
974
|
+
```
|
975
|
+
|
976
|
+
Utilisera `./views/index.monmoteur`. Voir [le dépôt Github](https://github.com/rtomayko/tilt) pour en savoir plus sur Tilt.
|
977
|
+
|
978
|
+
## Filtres
|
979
|
+
|
980
|
+
Les filtres before sont exécutés avant chaque requête, dans le même contexte
|
981
|
+
que les routes, et permettent de modifier la requête et sa réponse. Les
|
982
|
+
variables d'instance déclarées dans les filtres sont accessibles au niveau
|
983
|
+
des routes et des templates :
|
984
|
+
|
985
|
+
```ruby
|
986
|
+
before do
|
987
|
+
@note = 'Coucou !'
|
988
|
+
request.path_info = '/foo/bar/baz'
|
989
|
+
end
|
990
|
+
|
991
|
+
get '/foo/*' do
|
992
|
+
@note #=> 'Coucou !'
|
993
|
+
params[:splat] #=> 'bar/baz'
|
994
|
+
end
|
995
|
+
```
|
996
|
+
|
997
|
+
Les filtres after sont exécutés après chaque requête à l'intérieur du même
|
998
|
+
contexte et permettent de modifier la requête et sa réponse. Les variables
|
999
|
+
d'instance déclarées dans les filtres before ou les routes sont accessibles
|
1000
|
+
au niveau des filtres after :
|
1001
|
+
|
1002
|
+
```ruby
|
1003
|
+
after do
|
1004
|
+
puts response.status
|
1005
|
+
end
|
1006
|
+
```
|
1007
|
+
|
1008
|
+
Note : Le corps de la réponse n'est pas disponible au niveau du filtre after
|
1009
|
+
car il ne sera généré que plus tard (sauf dans le cas où vous utilisez la
|
1010
|
+
méthode +body+ au lieu de simplement renvoyer une chaine depuis vos routes).
|
1011
|
+
|
1012
|
+
Les filtres peuvent être associés à un masque, ce qui permet de limiter leur
|
1013
|
+
exécution aux cas où la requête correspond à ce masque :
|
1014
|
+
|
1015
|
+
```ruby
|
1016
|
+
before '/secret/*' do
|
1017
|
+
authentification!
|
1018
|
+
end
|
1019
|
+
|
1020
|
+
after '/faire/:travail' do |travail|
|
1021
|
+
session[:dernier_travail] = travail
|
1022
|
+
end
|
1023
|
+
```
|
1024
|
+
|
1025
|
+
Tout comme les routes, les filtres acceptent également des conditions :
|
1026
|
+
|
1027
|
+
```ruby
|
1028
|
+
before :agent => /Songbird/ do
|
1029
|
+
# ...
|
1030
|
+
end
|
1031
|
+
|
1032
|
+
after '/blog/*', :host_name => 'example.com' do
|
1033
|
+
# ...
|
1034
|
+
end
|
1035
|
+
```
|
1036
|
+
|
1037
|
+
## Helpers
|
1038
|
+
|
1039
|
+
Utilisez la méthode de haut niveau `helpers` pour définir des routines
|
1040
|
+
qui seront accessibles dans vos gestionnaires de route et dans vos templates :
|
1041
|
+
|
1042
|
+
```ruby
|
1043
|
+
helpers do
|
1044
|
+
def bar(nom)
|
1045
|
+
"#{nom}bar"
|
1046
|
+
end
|
1047
|
+
end
|
1048
|
+
|
1049
|
+
get '/:nom' do
|
1050
|
+
bar(params[:nom])
|
1051
|
+
end
|
1052
|
+
```
|
1053
|
+
|
1054
|
+
Vous pouvez aussi définir les méthodes helper dans un module séparé :
|
1055
|
+
|
1056
|
+
```ruby
|
1057
|
+
module FooUtils
|
1058
|
+
def foo(nom) "#{nom}foo" end
|
1059
|
+
end
|
1060
|
+
|
1061
|
+
module BarUtils
|
1062
|
+
def bar(nom) "#{nom}bar" end
|
1063
|
+
end
|
1064
|
+
|
1065
|
+
helpers FooUtils, BarUtils
|
1066
|
+
```
|
1067
|
+
|
1068
|
+
Cela a le même résultat que d'inclure les modules dans la classe de
|
1069
|
+
l'application.
|
1070
|
+
|
1071
|
+
### Utiliser les sessions
|
1072
|
+
|
1073
|
+
Une session est utilisée pour conserver un état entre les requêtes. Une fois
|
1074
|
+
activées, vous avez un +hash+ de session par session utilisateur :
|
1075
|
+
|
1076
|
+
```ruby
|
1077
|
+
enable :sessions
|
1078
|
+
|
1079
|
+
get '/' do
|
1080
|
+
"valeur = " << session[:valeur].inspect
|
1081
|
+
end
|
1082
|
+
|
1083
|
+
get '/:value' do
|
1084
|
+
session[:valeur] = params[:valeur]
|
1085
|
+
end
|
1086
|
+
```
|
1087
|
+
|
1088
|
+
Notez que <tt>enable :sessions</tt> enregistre en fait toutes les données dans
|
1089
|
+
un +cookie+. Ce n'est pas toujours ce que vous voulez (enregistrer beaucoup de
|
1090
|
+
données va augmenter le traffic par exemple). Vous pouvez utiliser n'importe
|
1091
|
+
quel +middleware+ Rack de session afin d'éviter cela. N'utiliser *pas*
|
1092
|
+
<tt>enable :sessions</tt> dans ce cas mais charger le +middleware+ de votre
|
1093
|
+
choix comme vous le feriez pour n'importe quel autre +middleware+ :
|
1094
|
+
|
1095
|
+
```ruby
|
1096
|
+
use Rack::Session::Pool, :expire_after => 2592000
|
1097
|
+
|
1098
|
+
get '/' do
|
1099
|
+
"valeur = " << session[:valeur].inspect
|
1100
|
+
end
|
1101
|
+
|
1102
|
+
get '/:value' do
|
1103
|
+
session[:valeur] = params[:valeur]
|
1104
|
+
end
|
1105
|
+
```
|
1106
|
+
|
1107
|
+
Pour renforcer la sécurité, les données de session dans le cookie sont signées
|
1108
|
+
avec une clé secrète de session. Une clé secrète est générée pour vous au
|
1109
|
+
hasard par Sinatra. Toutefois, comme cette clé change à chaque démarrage de
|
1110
|
+
votre application, vous pouvez définir cette clé vous-même afin que toutes
|
1111
|
+
les instances de votre application la partage :
|
1112
|
+
|
1113
|
+
```ruby
|
1114
|
+
set :session_secret, 'super secret'
|
1115
|
+
```
|
1116
|
+
|
1117
|
+
Si vous souhaitez avoir plus de contrôle, vous pouvez également enregistrer un
|
1118
|
+
+hash+ avec des options lors de la configuration de `sessions` :
|
1119
|
+
|
1120
|
+
```ruby
|
1121
|
+
set :sessions, :domain => 'foo.com'
|
1122
|
+
```
|
1123
|
+
|
1124
|
+
### Halt
|
1125
|
+
|
1126
|
+
Pour arrêter immédiatement la requête dans un filtre ou un gestionnaire de
|
1127
|
+
route :
|
1128
|
+
|
1129
|
+
```ruby
|
1130
|
+
halt
|
1131
|
+
```
|
1132
|
+
|
1133
|
+
Vous pouvez aussi passer le code retour ...
|
1134
|
+
|
1135
|
+
```ruby
|
1136
|
+
halt 410
|
1137
|
+
```
|
1138
|
+
|
1139
|
+
Ou le texte ...
|
1140
|
+
|
1141
|
+
```ruby
|
1142
|
+
halt 'Ceci est le texte'
|
1143
|
+
```
|
1144
|
+
|
1145
|
+
Ou les deux ...
|
1146
|
+
|
1147
|
+
```ruby
|
1148
|
+
halt 401, 'Partez !'
|
1149
|
+
```
|
1150
|
+
|
1151
|
+
Ainsi que les entêtes ...
|
1152
|
+
|
1153
|
+
```ruby
|
1154
|
+
halt 402, {'Content-Type' => 'text/plain'}, 'revanche'
|
1155
|
+
```
|
1156
|
+
|
1157
|
+
Bien sûr il est possible de combiner un template avec `halt` :
|
1158
|
+
|
1159
|
+
```ruby
|
1160
|
+
halt erb(:erreur)
|
1161
|
+
```
|
1162
|
+
|
1163
|
+
### Passer
|
1164
|
+
|
1165
|
+
Une route peut passer le relais aux autres routes qui correspondent également
|
1166
|
+
avec `pass` :
|
1167
|
+
|
1168
|
+
```ruby
|
1169
|
+
get '/devine/:qui' do
|
1170
|
+
pass unless params[:qui] == 'Frank'
|
1171
|
+
"Tu m'as eu !"
|
1172
|
+
end
|
1173
|
+
|
1174
|
+
get '/devine/*' do
|
1175
|
+
'Manqué !'
|
1176
|
+
end
|
1177
|
+
```
|
1178
|
+
|
1179
|
+
On sort donc immédiatement de ce gestionnaire et on continue à chercher,
|
1180
|
+
dans les masques suivants, le prochain qui correspond à la requête.
|
1181
|
+
Si aucun des masques suivants ne correspond, un code 404 est retourné.
|
1182
|
+
|
1183
|
+
### Déclencher une autre route
|
1184
|
+
|
1185
|
+
Parfois, +pass+ n'est pas ce que vous recherchez, au lieu de cela vous
|
1186
|
+
souhaitez obtenir le résultat d'une autre route. Pour cela, utilisez
|
1187
|
+
simplement call :
|
1188
|
+
|
1189
|
+
```ruby
|
1190
|
+
get '/foo' do
|
1191
|
+
status, headers, body = call env.merge("PATH_INFO" => '/bar')
|
1192
|
+
[status, headers, body.map(&:upcase)]
|
1193
|
+
end
|
1194
|
+
|
1195
|
+
get '/bar' do
|
1196
|
+
"bar"
|
1197
|
+
end
|
1198
|
+
```
|
1199
|
+
|
1200
|
+
Notez que dans l'exemple ci-dessus, vous faciliterez les tests et améliorerez
|
1201
|
+
la performance en déplaçant simplement `"bar"` dans un helper
|
1202
|
+
utilisé à la fois par `/foo` et `/bar`.
|
1203
|
+
|
1204
|
+
Si vous souhiatez que la requête soit envoyée à la même instance de
|
1205
|
+
l'application plutôt qu'à une copie, utilisez `call!` au lieu de
|
1206
|
+
`call`.
|
1207
|
+
|
1208
|
+
Lisez la spécification Rack si vous souhaitez en savoir plus sur
|
1209
|
+
`call`.
|
1210
|
+
|
1211
|
+
### Définir le corps, le code retour et les entêtes
|
1212
|
+
|
1213
|
+
Il est possible et recommandé de définir le code retour et le corps de la
|
1214
|
+
réponse au moyen de la valeur de retour d'un bloc définissant une route.
|
1215
|
+
Quoiqu'il en soit, dans certains cas vous pourriez avoir besoin de définir
|
1216
|
+
le coprs de la réponse à un moment arbitraire de l'exécution. Vous pouvez le
|
1217
|
+
faire au moyen de la méthode +body+. Si vous faites ainsi, vous pouvez alors
|
1218
|
+
utiliser cette même méthode pour accéder au corps de la réponse :
|
1219
|
+
|
1220
|
+
```ruby
|
1221
|
+
get '/foo' do
|
1222
|
+
body "bar"
|
1223
|
+
end
|
1224
|
+
|
1225
|
+
after do
|
1226
|
+
puts body
|
1227
|
+
end
|
1228
|
+
```
|
1229
|
+
|
1230
|
+
Il est également possible de passer un bloc à `body`, qui sera exécuté par le
|
1231
|
+
gestionnaire Rack (ceci peut être utilisé pour implémenter un streaming,
|
1232
|
+
voir "Valeurs de retour").
|
1233
|
+
|
1234
|
+
Pareillement au corps de la réponse, vous pouvez également définir le code
|
1235
|
+
retour et les entêtes :
|
1236
|
+
|
1237
|
+
```ruby
|
1238
|
+
get '/foo' do
|
1239
|
+
status 418
|
1240
|
+
headers \
|
1241
|
+
"Allow" => "BREW, POST, GET, PROPFIND, WHEN",
|
1242
|
+
"Refresh" => "Refresh: 20; http://www.ietf.org/rfc/rfc2324.txt"
|
1243
|
+
body "Je suis une théière !"
|
1244
|
+
end
|
1245
|
+
```
|
1246
|
+
|
1247
|
+
Comme `body` `headers` et `status` peuvent être utilisés sans arguments
|
1248
|
+
pour accéder à leurs valeurs.
|
1249
|
+
|
1250
|
+
### Faire du streaming
|
1251
|
+
|
1252
|
+
Il y a des cas où vous voulez commencer à renvoyer des données pendant que
|
1253
|
+
vous êtes en train de générer le reste de la réponse. Dans les cas les plus
|
1254
|
+
extrèmes, vous souhaitez continuer à envoyer des données tant que le client
|
1255
|
+
n'abandonne pas la connection. Vous pouvez alors utiliser le helper `stream`
|
1256
|
+
pour éviter de créer votre propre système :
|
1257
|
+
|
1258
|
+
```ruby
|
1259
|
+
get '/' do
|
1260
|
+
stream do |out|
|
1261
|
+
out << "Ca va être hallu -\n"
|
1262
|
+
sleep 0.5
|
1263
|
+
out << " (attends la suite) \n"
|
1264
|
+
sleep 1
|
1265
|
+
out << "- cinant !\n"
|
1266
|
+
end
|
1267
|
+
end
|
1268
|
+
```
|
1269
|
+
|
1270
|
+
Cela permet d'implémenter des API de streaming ou de
|
1271
|
+
[Server Sent Events](http://dev.w3.org/html5/eventsource/) et peut servir de
|
1272
|
+
base pour des [WebSockets](http://en.wikipedia.org/wiki/WebSocket). Vous
|
1273
|
+
pouvez aussi l'employer pour augmenter le débit quand une partie du contenu
|
1274
|
+
provient d'une resource lente.
|
1275
|
+
|
1276
|
+
Le fonctionnement du streaming, notamment le nombre de requêtes simultanées,
|
1277
|
+
dépend énormément du serveur web utilisé. Certains ne prennent pas du tout en
|
1278
|
+
charge le streaming (WEBRick par exemple). Lorsque le serveur ne gère pas le
|
1279
|
+
streaming, la partie body de la réponse sera envoyée au client en une seule
|
1280
|
+
fois, après que l'exécution du bloc passé au helper +stream+ sera terminée. Le
|
1281
|
+
streaming ne fonctionne pas du tout avec Shotgun.
|
1282
|
+
|
1283
|
+
En utilisant le helper +stream+ avec le paramètre +keep_open+, il n'appelera
|
1284
|
+
pas la méthode +close+ du flux, vous laissant la possibilité de le fermer à
|
1285
|
+
tout moment au cours de l'exécution. Ceci ne fonctionne qu'avec les serveurs
|
1286
|
+
evented (ie non threadés) tels que Thin et Rainbows. Les autres serveurs
|
1287
|
+
fermeront malgré tout le flux :
|
1288
|
+
|
1289
|
+
```ruby
|
1290
|
+
set :server, :thin
|
1291
|
+
connections = []
|
1292
|
+
|
1293
|
+
get '/' do
|
1294
|
+
# conserve le flux ouvert
|
1295
|
+
stream(:keep_open) { |out| connections << out }
|
1296
|
+
end
|
1297
|
+
|
1298
|
+
post '/' do
|
1299
|
+
# écrit dans tous les flux ouverts
|
1300
|
+
connections.each { |out| out << params[:message] << "\n" }
|
1301
|
+
"message sent"
|
1302
|
+
end
|
1303
|
+
```
|
1304
|
+
|
1305
|
+
### Journalisation (Logging)
|
1306
|
+
|
1307
|
+
Dans le contexte de la requête, la méthode utilitaire +logger+ expose une
|
1308
|
+
instance de +logger+ :
|
1309
|
+
|
1310
|
+
```ruby
|
1311
|
+
get '/' do
|
1312
|
+
logger.info "chargement des données"
|
1313
|
+
# ...
|
1314
|
+
end
|
1315
|
+
```
|
1316
|
+
|
1317
|
+
Ce logger va automatiquement prendre en compte les paramètres de
|
1318
|
+
configuration pour la journalisation de votre gestionnaire Rack. Si la
|
1319
|
+
journalisation est désactivée, cette méthode renverra un objet factice et
|
1320
|
+
vous n'avez pas à vous en inquiéter dans vos routes en le filtrant.
|
1321
|
+
|
1322
|
+
Notez que la journalisation est seulement activée par défaut pour
|
1323
|
+
`Sinatra::Application`, donc si vous héritez de `>Sinatra::Base`,
|
1324
|
+
vous aurez à l'activer vous-même :
|
1325
|
+
|
1326
|
+
```ruby
|
1327
|
+
class MonApp < Sinatra::Base
|
1328
|
+
configure :production, :development do
|
1329
|
+
enable :logging
|
1330
|
+
end
|
1331
|
+
end
|
1332
|
+
```
|
1333
|
+
|
1334
|
+
Si vous souhaitez utiliser votre propre logger, vous devez définir le paramètre
|
1335
|
+
`logging` à `nil` pour être certain qu'aucun middleware de logging ne sera
|
1336
|
+
installé (notez toutefois que +logger+ renverra alors +nil+). Dans ce cas,
|
1337
|
+
Sinatra utilisera ce qui sera présent dans `env['rack.logger']`.
|
1338
|
+
|
1339
|
+
### Types Mime
|
1340
|
+
|
1341
|
+
Quand vous utilisez `send_file` ou des fichiers statiques, vous
|
1342
|
+
pouvez rencontrer des types mime que Sinatra ne connaît pas. Utilisez
|
1343
|
+
`mime_type` pour les déclarer par extension de fichier :
|
1344
|
+
|
1345
|
+
```ruby
|
1346
|
+
configure do
|
1347
|
+
mime_type :foo, 'text/foo'
|
1348
|
+
end
|
1349
|
+
```
|
1350
|
+
|
1351
|
+
Vous pouvez également les utiliser avec la méthode `content_type` :
|
1352
|
+
|
1353
|
+
```ruby
|
1354
|
+
get '/' do
|
1355
|
+
content_type :foo
|
1356
|
+
"foo foo foo"
|
1357
|
+
end
|
1358
|
+
```
|
1359
|
+
|
1360
|
+
### Former des URLs
|
1361
|
+
|
1362
|
+
Pour former des URLs, vous devriez utiliser la méthode +url+, par exemple en
|
1363
|
+
Haml :
|
1364
|
+
|
1365
|
+
```ruby
|
1366
|
+
%a{:href => url('/foo')} foo
|
1367
|
+
```
|
1368
|
+
|
1369
|
+
Cela prend en compte les proxy inverse et les routeurs Rack, s'ils existent.
|
1370
|
+
|
1371
|
+
Cette méthode est également disponible sous l'alias +to+ (voir ci-dessous
|
1372
|
+
pour un exemple).
|
1373
|
+
|
1374
|
+
### Redirection du navigateur
|
1375
|
+
|
1376
|
+
Vous pouvez déclencher une redirection du navigateur avec la méthode
|
1377
|
+
`redirect` :
|
1378
|
+
|
1379
|
+
```ruby
|
1380
|
+
get '/foo' do
|
1381
|
+
redirect to('/bar')
|
1382
|
+
end
|
1383
|
+
```
|
1384
|
+
|
1385
|
+
Tout paramètre additionnel est géré comme des arguments pour la méthode
|
1386
|
+
`halt` :
|
1387
|
+
|
1388
|
+
```ruby
|
1389
|
+
redirect to('/bar'), 303
|
1390
|
+
redirect 'http://google.com', 'mauvais endroit mon pote'
|
1391
|
+
```
|
1392
|
+
|
1393
|
+
Vous pouvez aussi rediriger vers la page dont l'utilisateur venait au moyen de
|
1394
|
+
`redirect back` :
|
1395
|
+
|
1396
|
+
```ruby
|
1397
|
+
get '/foo' do
|
1398
|
+
"<a href='/bar'>faire quelque chose</a>"
|
1399
|
+
end
|
1400
|
+
|
1401
|
+
get '/bar' do
|
1402
|
+
faire_quelque_chose
|
1403
|
+
redirect back
|
1404
|
+
end
|
1405
|
+
```
|
1406
|
+
|
1407
|
+
Pour passer des arguments à une redirection, ajoutez-les soit à la requête :
|
1408
|
+
|
1409
|
+
```ruby
|
1410
|
+
redirect to('/bar?sum=42')
|
1411
|
+
```
|
1412
|
+
|
1413
|
+
Ou bien utilisez une session :
|
1414
|
+
|
1415
|
+
```ruby
|
1416
|
+
enable :sessions
|
1417
|
+
|
1418
|
+
get '/foo' do
|
1419
|
+
session[:secret] = 'foo'
|
1420
|
+
redirect to('/bar')
|
1421
|
+
end
|
1422
|
+
|
1423
|
+
get '/bar' do
|
1424
|
+
session[:secret]
|
1425
|
+
end
|
1426
|
+
```
|
1427
|
+
|
1428
|
+
### Contrôle du cache
|
1429
|
+
|
1430
|
+
Définir correctement vos entêtes à la base pour un bon cache HTTP.
|
1431
|
+
|
1432
|
+
Vous pouvez facilement définir l'entête Cache-Control de la manière suivante :
|
1433
|
+
|
1434
|
+
```ruby
|
1435
|
+
get '/' do
|
1436
|
+
cache_control :public
|
1437
|
+
"met le en cache !"
|
1438
|
+
end
|
1439
|
+
```
|
1440
|
+
|
1441
|
+
Conseil de pro : définir le cache dans un filtre +before+ :
|
1442
|
+
|
1443
|
+
```ruby
|
1444
|
+
before do
|
1445
|
+
cache_control :public, :must_revalidate, :max_age => 60
|
1446
|
+
end
|
1447
|
+
```
|
1448
|
+
|
1449
|
+
Si vous utilisez la méthode +expires+ pour définir l'entête correspondant,
|
1450
|
+
`Cache-Control` sera alors défini automatiquement :
|
1451
|
+
|
1452
|
+
```ruby
|
1453
|
+
before do
|
1454
|
+
expires 500, :public, :must_revalidate
|
1455
|
+
end
|
1456
|
+
```
|
1457
|
+
|
1458
|
+
Pour utiliser correctement les caches, vous devriez utiliser +etag+ ou
|
1459
|
+
+last_modified+. Il est recommandé d'utiliser ces méthodes *avant* de faire
|
1460
|
+
d'importantes modifications, car elles vont immédiatement déclencher la réponse
|
1461
|
+
si le client a déjà la version courante dans son cache :
|
1462
|
+
|
1463
|
+
```ruby
|
1464
|
+
get '/article/:id' do
|
1465
|
+
@article = Article.find params[:id]
|
1466
|
+
last_modified @article.updated_at
|
1467
|
+
etag @article.sha1
|
1468
|
+
erb :article
|
1469
|
+
end
|
1470
|
+
```
|
1471
|
+
|
1472
|
+
Il est également possible d'utiliser un
|
1473
|
+
[weak ETag](http://en.wikipedia.org/wiki/HTTP_ETag#Strong_and_weak_validation) :
|
1474
|
+
|
1475
|
+
```ruby
|
1476
|
+
etag @article.sha1, :weak
|
1477
|
+
```
|
1478
|
+
|
1479
|
+
Ces méthodes ne sont pas chargées de mettre des données en cache, mais elles
|
1480
|
+
fournissent les informations nécessaires pour votre cache. Si vous êtes à la
|
1481
|
+
recherche de solutions rapides pour un reverse-proxy de cache, essayez
|
1482
|
+
[rack-cache](https://github.com/rtomayko/rack-cache) :
|
1483
|
+
|
1484
|
+
```ruby
|
1485
|
+
require "rack/cache"
|
1486
|
+
require "sinatra"
|
1487
|
+
|
1488
|
+
use Rack::Cache
|
1489
|
+
|
1490
|
+
get '/' do
|
1491
|
+
cache_control :public, :max_age => 36000
|
1492
|
+
sleep 5
|
1493
|
+
"hello"
|
1494
|
+
end
|
1495
|
+
```
|
1496
|
+
|
1497
|
+
Utilisez le paramètre `:static_cache_control` pour ajouter l'information
|
1498
|
+
d'en-tête `Cache-Control` (voir plus loin).
|
1499
|
+
|
1500
|
+
D'après la RFC 2616, votre application devrait se comporter différement lorsque
|
1501
|
+
l'en-tête If-Match ou If-None-Match est défini à `*` en tenant compte du
|
1502
|
+
fait que la resource demandée existe déjà ou pas. Sinatra considère que les
|
1503
|
+
requêtes portant sur des resources sûres (tel que get) ou idempotentes (tel que
|
1504
|
+
put) existent déjà et pour les autres resources (par exemple dans le cas
|
1505
|
+
de requêtes post) qu'il s'agit de nouvelles resources. Vous pouvez modifier ce
|
1506
|
+
comportement en passant une option `:new_resource` :
|
1507
|
+
|
1508
|
+
```ruby
|
1509
|
+
get '/create' do
|
1510
|
+
etag '', :new_resource => true
|
1511
|
+
Article.create
|
1512
|
+
erb :new_article
|
1513
|
+
end
|
1514
|
+
```
|
1515
|
+
|
1516
|
+
Si vous souhaitez utilisez un ETag faible, utilisez l'option <tt>:kind</tt> :
|
1517
|
+
|
1518
|
+
```
|
1519
|
+
etag '', :new_resource => true, :kind => :weak
|
1520
|
+
```
|
1521
|
+
|
1522
|
+
### Envoyer des fichiers
|
1523
|
+
|
1524
|
+
Pour envoyer des fichiers, vous pouvez utiliser la méthode
|
1525
|
+
`send_file` :
|
1526
|
+
|
1527
|
+
```ruby
|
1528
|
+
get '/' do
|
1529
|
+
send_file 'foo.png'
|
1530
|
+
end
|
1531
|
+
```
|
1532
|
+
|
1533
|
+
Quelques options sont également acceptées :
|
1534
|
+
|
1535
|
+
```ruby
|
1536
|
+
send_file 'foo.png', :type => :jpg
|
1537
|
+
```
|
1538
|
+
|
1539
|
+
Les options sont :
|
1540
|
+
|
1541
|
+
<dl>
|
1542
|
+
<dt>filename</dt>
|
1543
|
+
<dd>
|
1544
|
+
le nom du fichier dans la réponse, par défaut le nom du fichier envoyé.
|
1545
|
+
</dd>
|
1546
|
+
|
1547
|
+
<dt>last_modified</dt>
|
1548
|
+
<dd>valeur pour l’entête Last-Modified, par défaut la date de modification
|
1549
|
+
du fichier</dd>
|
1550
|
+
|
1551
|
+
<dt>type</dt>
|
1552
|
+
<dd>type de contenu à utiliser, deviné à partir de l’extension de fichier
|
1553
|
+
si absent</dd>
|
1554
|
+
|
1555
|
+
<dt>disposition</dt>
|
1556
|
+
<dd>utilisé pour Content-Disposition, les valuers possibles étant :
|
1557
|
+
`nil` (par défaut), `:attachment` et `:inline`</dd>
|
1558
|
+
|
1559
|
+
<dt>length</dt>
|
1560
|
+
<dd>entête Content-Length, par défaut la taille du fichier</dd>
|
1561
|
+
|
1562
|
+
<dt>status</dt>
|
1563
|
+
<dd>code état à renvoyer. Utile quand un fichier statique sert de page
|
1564
|
+
d’erreur.</dd>
|
1565
|
+
</dl>
|
1566
|
+
|
1567
|
+
Si le gestionnaire Rack le supporte, d'autres moyens que le +streaming+ via le
|
1568
|
+
processus Ruby seront utilisés. Si vous utilisez cette méthode, Sinatra gérera
|
1569
|
+
automatiquement les requêtes de type +range+.
|
1570
|
+
|
1571
|
+
### Accéder à l'objet requête
|
1572
|
+
|
1573
|
+
L'objet correspondant à la requête envoyée peut être récupéré dans le contexte
|
1574
|
+
de la requête (filtres, routes, gestionnaires d'erreur) au moyen de la méthode
|
1575
|
+
+request+ :
|
1576
|
+
|
1577
|
+
```ruby
|
1578
|
+
# application tournant à l'adresse http://exemple.com/exemple
|
1579
|
+
get '/foo' do
|
1580
|
+
t = %w[text/css text/html application/javascript]
|
1581
|
+
request.accept # ['text/html', '*/*']
|
1582
|
+
request.accept? 'text/xml' # true
|
1583
|
+
request.preferred_type(t) # 'text/html'
|
1584
|
+
request.body # corps de la requête envoyée par le client
|
1585
|
+
# (voir ci-dessous)
|
1586
|
+
request.scheme # "http"
|
1587
|
+
request.script_name # "/exemple"
|
1588
|
+
request.path_info # "/foo"
|
1589
|
+
request.port # 80
|
1590
|
+
request.request_method # "GET"
|
1591
|
+
request.query_string # ""
|
1592
|
+
request.content_length # taille de request.body
|
1593
|
+
request.media_type # type de média pour request.body
|
1594
|
+
request.host # "exemple.com"
|
1595
|
+
request.get? # true (méthodes similaires pour les autres
|
1596
|
+
# verbes HTTP)
|
1597
|
+
request.form_data? # false
|
1598
|
+
request["UN_ENTETE"] # valeur de l'entête UN_ENTETE
|
1599
|
+
request.referer # référant du client ou '/'
|
1600
|
+
request.user_agent # user agent (utilisé par la condition :agent)
|
1601
|
+
request.cookies # tableau contenant les cookies du navigateur
|
1602
|
+
request.xhr? # requête AJAX ?
|
1603
|
+
request.url # "http://exemple.com/exemple/foo"
|
1604
|
+
request.path # "/exemple/foo"
|
1605
|
+
request.ip # adresse IP du client
|
1606
|
+
request.secure? # false
|
1607
|
+
request.forwarded? # vrai (si on est derrière un proxy inverse)
|
1608
|
+
request.env # tableau brut de l'environnement fourni par
|
1609
|
+
# Rack
|
1610
|
+
end
|
1611
|
+
```
|
1612
|
+
|
1613
|
+
Certaines options, telles que `script_name` ou `path_info`
|
1614
|
+
peuvent également être modifiées :
|
1615
|
+
|
1616
|
+
```ruby
|
1617
|
+
before { request.path_info = "/" }
|
1618
|
+
|
1619
|
+
get "/" do
|
1620
|
+
"toutes les requêtes arrivent ici"
|
1621
|
+
end
|
1622
|
+
```
|
1623
|
+
|
1624
|
+
`request.body` est un objet IO ou StringIO :
|
1625
|
+
|
1626
|
+
```ruby
|
1627
|
+
post "/api" do
|
1628
|
+
request.body.rewind # au cas où il a déjà été lu
|
1629
|
+
donnees = JSON.parse request.body.read
|
1630
|
+
"Bonjour #{donnees['nom']} !"
|
1631
|
+
end
|
1632
|
+
```
|
1633
|
+
|
1634
|
+
### Fichiers joints
|
1635
|
+
|
1636
|
+
Vous pouvez utiliser la méthode +attachment+ pour indiquer au navigateur que
|
1637
|
+
la réponse devrait être stockée sur le disque plutôt qu'affichée :
|
1638
|
+
|
1639
|
+
|
1640
|
+
```ruby
|
1641
|
+
get '/' do
|
1642
|
+
attachment
|
1643
|
+
"enregistre-le !"
|
1644
|
+
end
|
1645
|
+
```
|
1646
|
+
|
1647
|
+
Vous pouvez également lui passer un nom de fichier :
|
1648
|
+
|
1649
|
+
```ruby
|
1650
|
+
get '/' do
|
1651
|
+
attachment "info.txt"
|
1652
|
+
"enregistre-le !"
|
1653
|
+
end
|
1654
|
+
```
|
1655
|
+
|
1656
|
+
### Gérer Date et Time
|
1657
|
+
|
1658
|
+
Sinatra fourni un helper +time_for+ pour convertir une valeur donnée en
|
1659
|
+
objet `Time`. Il peut aussi faire la conversion à partir d'objets +DateTime+,
|
1660
|
+
`Date` ou de classes similaires :
|
1661
|
+
|
1662
|
+
```ruby
|
1663
|
+
get '/' do
|
1664
|
+
pass if Time.now > time_for('Dec 23, 2012')
|
1665
|
+
"encore temps"
|
1666
|
+
end
|
1667
|
+
```
|
1668
|
+
|
1669
|
+
Cette méthode est utilisée en interne par +expires+, +last_modified+ et
|
1670
|
+
consorts. Par conséquent, vous pouvez très facilement étendre le
|
1671
|
+
fonctionnement de ces méthodes en surchargeant le helper +time_for+ dans
|
1672
|
+
votre application :
|
1673
|
+
|
1674
|
+
```ruby
|
1675
|
+
helpers do
|
1676
|
+
def time_for(value)
|
1677
|
+
case value
|
1678
|
+
when :yesterday then Time.now - 24*60*60
|
1679
|
+
when :tomorrow then Time.now + 24*60*60
|
1680
|
+
else super
|
1681
|
+
end
|
1682
|
+
end
|
1683
|
+
end
|
1684
|
+
|
1685
|
+
get '/' do
|
1686
|
+
last_modified :yesterday
|
1687
|
+
expires :tomorrow
|
1688
|
+
"salut"
|
1689
|
+
end
|
1690
|
+
```
|
1691
|
+
|
1692
|
+
### Chercher les fichiers de templates
|
1693
|
+
|
1694
|
+
La méthode `find_template` est utilisée pour trouver les fichiers de
|
1695
|
+
templates à générer :
|
1696
|
+
|
1697
|
+
```ruby
|
1698
|
+
find_template settings.views, 'foo', Tilt[:haml] do |file|
|
1699
|
+
puts "pourrait être #{file}"
|
1700
|
+
end
|
1701
|
+
```
|
1702
|
+
|
1703
|
+
Ce n'est pas très utilise. En revanche, il est utile de pouvoir surcharger
|
1704
|
+
cette méthode afin de définir son propre mécanisme de recherche. Par exemple,
|
1705
|
+
vous pouvez utiliser plus d'un répertoire de vues :
|
1706
|
+
|
1707
|
+
```ruby
|
1708
|
+
set :views, ['views', 'templates']
|
1709
|
+
|
1710
|
+
helpers do
|
1711
|
+
def find_template(views, name, engine, &block)
|
1712
|
+
Array(views).each { |v| super(v, name, engine, &block) }
|
1713
|
+
end
|
1714
|
+
end
|
1715
|
+
```
|
1716
|
+
|
1717
|
+
Un autre exemple est d'utiliser des répertoires différents pour des moteurs
|
1718
|
+
de rendu différents :
|
1719
|
+
|
1720
|
+
```ruby
|
1721
|
+
set :views, :sass => 'views/sass', :haml => 'templates', :default => 'views'
|
1722
|
+
|
1723
|
+
helpers do
|
1724
|
+
def find_template(views, name, engine, &block)
|
1725
|
+
_, folder = views.detect { |k,v| engine == Tilt[k] }
|
1726
|
+
folder ||= views[:default]
|
1727
|
+
super(folder, name, engine, &block)
|
1728
|
+
end
|
1729
|
+
end
|
1730
|
+
```
|
1731
|
+
|
1732
|
+
Vous pouvez également écrire cela dans une extension et la partager avec
|
1733
|
+
d'autres !
|
1734
|
+
|
1735
|
+
Notez que `find_template` ne vérifie pas que le fichier existe mais
|
1736
|
+
va plutôt exécuter le bloc pour tous les chemins possibles. Cela n'induit pas
|
1737
|
+
un problème de performance dans le sens où `render` va utiliser +break+ dès
|
1738
|
+
qu'un fichier est trouvé. De plus, l'emplacement des templates (et leur
|
1739
|
+
contenu) est mis en cache si vous n'êtes pas en mode développement. Vous
|
1740
|
+
devriez garder cela en tête si vous écrivez une méthode vraiment dingue.
|
1741
|
+
|
1742
|
+
## Configuration
|
1743
|
+
|
1744
|
+
Lancé une seule fois au démarrage de tous les environnements :
|
1745
|
+
|
1746
|
+
```ruby
|
1747
|
+
configure do
|
1748
|
+
# définir un paramètre
|
1749
|
+
set :option, 'value'
|
1750
|
+
|
1751
|
+
# définir plusieurs paramètre
|
1752
|
+
set :a => 1, :b => 2
|
1753
|
+
|
1754
|
+
# identique à "set :option, true"
|
1755
|
+
enable :option
|
1756
|
+
|
1757
|
+
# identique à "set :option, false""
|
1758
|
+
disable :option
|
1759
|
+
|
1760
|
+
# vous pouvez également avoir des paramètres dynamiques avec des blocs
|
1761
|
+
set(:css_dir) { File.join(views, 'css') }
|
1762
|
+
end
|
1763
|
+
```
|
1764
|
+
|
1765
|
+
Lancé si l'environnement (variable d'environnement RACK_ENV) est défini comme
|
1766
|
+
`:production` :
|
1767
|
+
|
1768
|
+
configure :production do
|
1769
|
+
...
|
1770
|
+
end
|
1771
|
+
|
1772
|
+
Lancé si l'environnement est `:production` ou
|
1773
|
+
`:test` :
|
1774
|
+
|
1775
|
+
configure :production, :test do
|
1776
|
+
...
|
1777
|
+
end
|
1778
|
+
|
1779
|
+
Vous pouvez accéder à ces paramètres via `settings` :
|
1780
|
+
|
1781
|
+
```
|
1782
|
+
configure do
|
1783
|
+
set :foo, 'bar'
|
1784
|
+
end
|
1785
|
+
|
1786
|
+
get '/' do
|
1787
|
+
settings.foo? # => true
|
1788
|
+
settings.foo # => 'bar'
|
1789
|
+
...
|
1790
|
+
end
|
1791
|
+
```
|
1792
|
+
|
1793
|
+
### Se protéger des attaques
|
1794
|
+
|
1795
|
+
Sinatra utilise [Rack::Protection](https://github.com/rkh/rack-protection#readme)
|
1796
|
+
pour protéger votre application contre les principales attaques opportunistes.
|
1797
|
+
Vous pouvez très simplement désactiver cette fonctionnalité (ce qui exposera
|
1798
|
+
votre application à beaucoup de vulnerabilités courantes) :
|
1799
|
+
|
1800
|
+
```ruby
|
1801
|
+
disable :protection
|
1802
|
+
```
|
1803
|
+
|
1804
|
+
Pour désactiver seulement un type de protection, vous pouvez définir `protection`
|
1805
|
+
avec un hash d'options :
|
1806
|
+
|
1807
|
+
```ruby
|
1808
|
+
set :protection, :except => :path_traversal
|
1809
|
+
```
|
1810
|
+
|
1811
|
+
Vous pouvez également lui passer un tableau pour désactiver plusieurs types de
|
1812
|
+
protection :
|
1813
|
+
|
1814
|
+
```ruby
|
1815
|
+
set :protection, :except => [:path_traversal, :session_hijacking]
|
1816
|
+
```
|
1817
|
+
|
1818
|
+
### Paramètres disponibles
|
1819
|
+
|
1820
|
+
<dl>
|
1821
|
+
<dt>absolute_redirects</dt>
|
1822
|
+
<dd>Si désactivé, Sinatra permettra les redirections relatives. Toutefois,
|
1823
|
+
Sinatra ne sera plus conforme à la RFC 2616 (HTTP 1.1), qui n’autorise
|
1824
|
+
que les redirections absolues.</p>
|
1825
|
+
|
1826
|
+
Activez si votre application tourne derrière un proxy inverse qui n’a
|
1827
|
+
pas été correctement configuré. Notez que la méthode <tt>url</tt>
|
1828
|
+
continuera de produire des URLs absolues, sauf si vous lui passez
|
1829
|
+
<tt>false</tt> comme second argument.</p>
|
1830
|
+
|
1831
|
+
<p>Désactivé par défaut.</p></dd>
|
1832
|
+
|
1833
|
+
<dt>add_charsets</dt>
|
1834
|
+
<dd><p>types mime pour lesquels la méthode <tt>content_type</tt> va
|
1835
|
+
automatiquement ajouter l’information du <tt>charset</tt>.</p>
|
1836
|
+
|
1837
|
+
<p>Vous devriez lui ajouter des valeurs plutôt que de l’écraser :</p>
|
1838
|
+
|
1839
|
+
<pre>settings.add_charsets >> "application/foobar"</pre></dd>
|
1840
|
+
|
1841
|
+
<dt>app_file</dt>
|
1842
|
+
<dd><p>chemin pour le fichier de l’application principale, utilisé pour
|
1843
|
+
détecter la racine du projet, les dossiers public et vues, et les
|
1844
|
+
templates en ligne.</p></dd>
|
1845
|
+
|
1846
|
+
<dt>bind</dt>
|
1847
|
+
<dd>adresse IP sur laquelle se brancher (par défaut : 0.0.0.0). Utiliser
|
1848
|
+
seulement pour le serveur intégré.</dd>
|
1849
|
+
|
1850
|
+
<dt>default_encoding</dt>
|
1851
|
+
<dd>encodage à utiliser si inconnu (par défaut <tt>"utf-8"</tt>)</dd>
|
1852
|
+
|
1853
|
+
<dt>dump_errors</dt>
|
1854
|
+
<dd>afficher les erreurs dans le <tt>log</tt>.
|
1855
|
+
</dd>
|
1856
|
+
|
1857
|
+
<dt>environment</dt>
|
1858
|
+
<dd>environnement courant, par défaut <tt>ENV['RACK_ENV']</tt>, ou
|
1859
|
+
<tt>"development"</tt> si absent.</dd>
|
1860
|
+
|
1861
|
+
<dt>logging</dt>
|
1862
|
+
<dd>utiliser le <tt>logger</tt>.</dd>
|
1863
|
+
|
1864
|
+
<dt>lock</dt>
|
1865
|
+
<dd><p>Place un <tt>lock</tt> autour de chaque requête, n’exécutant donc
|
1866
|
+
qu’une seule requête par processus Ruby.</p>
|
1867
|
+
|
1868
|
+
<p>Activé si votre application n’est pas <tt>thread-safe</tt>. Désactivé
|
1869
|
+
par défaut.</p></dd>
|
1870
|
+
|
1871
|
+
<dt>method_override</dt>
|
1872
|
+
<dd>utilise la magie de <tt>_method</tt> afin de permettre des formulaires
|
1873
|
+
put/delete dans des navigateurs qui ne le permettent pas.
|
1874
|
+
|
1875
|
+
</dd>
|
1876
|
+
<dt>port</dt>
|
1877
|
+
<dd>port à écouter. Utiliser seulement pour le serveur intégré.</dd>
|
1878
|
+
|
1879
|
+
<dt>prefixed_redirects</dt>
|
1880
|
+
<dd>si oui ou non <tt>request.script_name</tt> doit être inséré dans les
|
1881
|
+
redirections si un chemin non absolu est utilisé. Ainsi, <tt>redirect
|
1882
|
+
'/foo'</tt> se comportera comme <tt>redirect to('/foo')</tt>. Désactivé
|
1883
|
+
par défaut.</dd>
|
1884
|
+
|
1885
|
+
<dt>protection</dt>
|
1886
|
+
<dd>défini s’il faut activer ou non la protection contre les attaques web.
|
1887
|
+
Voir la section protection précédente.</dd>
|
1888
|
+
|
1889
|
+
<dt>public_dir</dt>
|
1890
|
+
<dd>alias pour <tt>public_folder</tt>. Voir ci-dessous.</dd>
|
1891
|
+
|
1892
|
+
<dt>public_folder</dt>
|
1893
|
+
<dd>chemin pour le dossier à partir duquel les fichiers publics sont servis.
|
1894
|
+
Utilisé seulement si les fichiers statiques doivent être servis (voir le
|
1895
|
+
paramètre <tt>static</tt>). Si non défini, il découle du paramètre
|
1896
|
+
<tt>app_file</tt>.</dd>
|
1897
|
+
|
1898
|
+
<dt>reload_templates</dt>
|
1899
|
+
<dd>si oui ou non les templates doivent être rechargés entre les requêtes.
|
1900
|
+
Activé en mode développement.</dd>
|
1901
|
+
|
1902
|
+
<dt>root</dt>
|
1903
|
+
<dd>chemin pour le dossier racine du projet. Si non défini, il découle du
|
1904
|
+
paramètre <tt>app_file</tt>.</dd>
|
1905
|
+
|
1906
|
+
<dt>raise_errors</dt>
|
1907
|
+
<dd>soulever les erreurs (ce qui arrêtera l’application). Désactivé par
|
1908
|
+
défaut sauf lorsque <tt>environment</tt> est défini à
|
1909
|
+
<tt>"test"</tt>.</dd>
|
1910
|
+
|
1911
|
+
<dt>run</dt>
|
1912
|
+
<dd>si activé, Sinatra s’occupera de démarrer le serveur, ne pas activer si
|
1913
|
+
vous utiliser rackup ou autres.</dd>
|
1914
|
+
|
1915
|
+
<dt>running</dt>
|
1916
|
+
<dd>est-ce que le serveur intégré est en marche ? ne changez pas ce
|
1917
|
+
paramètre !</dd>
|
1918
|
+
|
1919
|
+
<dt>server</dt>
|
1920
|
+
<dd>serveur ou liste de serveurs à utiliser pour le serveur intégré. Par
|
1921
|
+
défaut [‘thin’, ‘mongrel’, ‘webrick’], l’ordre indiquant la
|
1922
|
+
priorité.</dd>
|
1923
|
+
|
1924
|
+
<dt>sessions</dt>
|
1925
|
+
<dd>active le support des sessions basées sur les cookies, en utilisant
|
1926
|
+
<tt>Rack::Session::Cookie</tt>. Reportez-vous à la section ‘Utiliser les
|
1927
|
+
sessions’ pour plus d’informations.</dd>
|
1928
|
+
|
1929
|
+
<dt>show_exceptions</dt>
|
1930
|
+
<dd>affiche la trace de l’erreur dans le navigateur lorsqu’une exception se
|
1931
|
+
produit. Désactivé par défaut sauf lorsque <tt>environment</tt> est
|
1932
|
+
défini à <tt>"development"</tt>.</dd>
|
1933
|
+
|
1934
|
+
<dt>static</dt>
|
1935
|
+
<dd>Si oui ou non Sinatra doit s’occuper de servir les fichiers statiques.
|
1936
|
+
Désactivez si vous utilisez un serveur capable de le gérer lui même. Le
|
1937
|
+
désactiver augmentera la performance. Activé par défaut pour le style
|
1938
|
+
classique, désactivé pour le style modulaire.</dd>
|
1939
|
+
|
1940
|
+
<dt>static_cache_control</dt>
|
1941
|
+
<dd>A définir quand Sinatra rend des fichiers statiques pour ajouter les
|
1942
|
+
en-têtes <tt>Cache-Control</tt>. Utilise le helper <tt>cache_control</tt>.
|
1943
|
+
Désactivé par défaut. Utiliser un array explicite pour définir des
|
1944
|
+
plusieurs valeurs : <tt>set :static_cache_control, [:public, :max_age =>
|
1945
|
+
300]</tt></dd>
|
1946
|
+
|
1947
|
+
<dt>threaded</dt>
|
1948
|
+
<dd>à définir à <tt>true</tt> pour indiquer à Thin d’utiliser
|
1949
|
+
<tt>EventMachine.defer</tt> pour traiter la requête.</dd>
|
1950
|
+
|
1951
|
+
<dt>views</dt>
|
1952
|
+
<dd>chemin pour le dossier des vues. Si non défini, il découle du paramètre
|
1953
|
+
<tt>app_file</tt>.</dd>
|
1954
|
+
</dl>
|
1955
|
+
|
1956
|
+
## Environements
|
1957
|
+
|
1958
|
+
Il existe trois environnements prédéfinis : `"development"`,
|
1959
|
+
`"production"` et `"test"`. Les environements peuvent être
|
1960
|
+
sélectionné via la variable d'environnement +RACK_ENV+. Sa valeur par défaut
|
1961
|
+
est `"development"`. Dans ce mode, tous les templates sont rechargés à
|
1962
|
+
chaque requête. Des handlers spécifiques pour `not_found` et
|
1963
|
+
`error` sont installés pour vous permettre d'avoir une pile de trace
|
1964
|
+
dans votre navigateur. En mode `"production"` et `"test"` les
|
1965
|
+
templates sont mis en cache par défaut.
|
1966
|
+
|
1967
|
+
Pour exécuter votre application dans un environnement différent, utilisez
|
1968
|
+
l'option `-e` de Ruby :
|
1969
|
+
|
1970
|
+
```bash
|
1971
|
+
$ ruby mon_application.rb -e [ENVIRONMENT]
|
1972
|
+
```
|
1973
|
+
|
1974
|
+
Vous pouvez utiliser une des méthodes +development?+, +test?+ et +production?+
|
1975
|
+
pour déterminer quel est l'environnement en cours.
|
1976
|
+
|
1977
|
+
## Gérer les erreurs
|
1978
|
+
|
1979
|
+
Les gestionnaires d'erreur s'exécutent dans le même contexte que les routes ou
|
1980
|
+
les filtres, ce qui veut dire que vous avez accès (entre autres) aux bons
|
1981
|
+
vieux `haml`, `erb`, `halt`, etc.
|
1982
|
+
|
1983
|
+
### NotFound
|
1984
|
+
|
1985
|
+
Quand une exception <tt>Sinatra::NotFound</tt> est soulevée, ou que le code
|
1986
|
+
retour est 404, le gestionnaire <tt>not_found</tt> est invoqué :
|
1987
|
+
|
1988
|
+
```ruby
|
1989
|
+
not_found do
|
1990
|
+
'Pas moyen de trouver ce que vous cherchez'
|
1991
|
+
end
|
1992
|
+
```
|
1993
|
+
|
1994
|
+
### Error
|
1995
|
+
|
1996
|
+
Le gestionnaire +error+ est invoqué à chaque fois qu'une exception est
|
1997
|
+
soulevée dans une route ou un filtre. L'objet exception est accessible via la
|
1998
|
+
variable Rack `sinatra.error` :
|
1999
|
+
|
2000
|
+
```ruby
|
2001
|
+
error do
|
2002
|
+
'Désolé mais une méchante erreur est survenue - ' + env['sinatra.error'].name
|
2003
|
+
end
|
2004
|
+
```
|
2005
|
+
|
2006
|
+
Erreur sur mesure :
|
2007
|
+
|
2008
|
+
```ruby
|
2009
|
+
error MonErreurSurMesure do
|
2010
|
+
'Donc il est arrivé ceci...' + env['sinatra.error'].message
|
2011
|
+
end
|
2012
|
+
```
|
2013
|
+
|
2014
|
+
Donc si ceci arrive :
|
2015
|
+
|
2016
|
+
```ruby
|
2017
|
+
get '/' do
|
2018
|
+
raise MonErreurSurMesure, 'quelque chose de mal'
|
2019
|
+
end
|
2020
|
+
```
|
2021
|
+
|
2022
|
+
Vous obtenez ça :
|
2023
|
+
|
2024
|
+
Donc il est arrivé ceci... quelque chose de mal
|
2025
|
+
|
2026
|
+
Alternativement, vous pouvez avoir un gestionnaire d'erreur associé à un code
|
2027
|
+
particulier :
|
2028
|
+
|
2029
|
+
```ruby
|
2030
|
+
error 403 do
|
2031
|
+
'Accès interdit'
|
2032
|
+
end
|
2033
|
+
|
2034
|
+
get '/secret' do
|
2035
|
+
403
|
2036
|
+
end
|
2037
|
+
```
|
2038
|
+
|
2039
|
+
Ou un intervalle :
|
2040
|
+
|
2041
|
+
```ruby
|
2042
|
+
error 400..510 do
|
2043
|
+
'Boom'
|
2044
|
+
end
|
2045
|
+
```
|
2046
|
+
|
2047
|
+
Sinatra installe pour vous quelques gestionnaires `not_found` et
|
2048
|
+
`error` génériques lorsque vous êtes en environnement
|
2049
|
+
`development`.
|
2050
|
+
|
2051
|
+
## Les Middlewares Rack
|
2052
|
+
|
2053
|
+
Sinatra tourne avec [Rack](http://rack.rubyforge.org/), une interface standard
|
2054
|
+
et minimale pour les web frameworks Ruby. Un des points forts de Rack est le
|
2055
|
+
support de ce que l'on appelle des "middlewares" -- composant qui vient se
|
2056
|
+
situer entre le serveur et votre application, et dont le but est de
|
2057
|
+
visualiser/manipuler la requête/réponse HTTP, et d'offrir diverses
|
2058
|
+
fonctionnalités classiques.
|
2059
|
+
|
2060
|
+
Sinatra permet de construire facilement des middlewares Rack via la méthode de
|
2061
|
+
haut niveau +use+ :
|
2062
|
+
|
2063
|
+
```ruby
|
2064
|
+
require 'sinatra'
|
2065
|
+
require 'mon_middleware_perso'
|
2066
|
+
|
2067
|
+
use Rack::Lint
|
2068
|
+
use MonMiddlewarePerso
|
2069
|
+
|
2070
|
+
get '/bonjour' do
|
2071
|
+
'Bonjour le monde'
|
2072
|
+
end
|
2073
|
+
```
|
2074
|
+
|
2075
|
+
La sémantique de +use+ est identique à celle définie dans le DSL de
|
2076
|
+
[Rack::Builder](http://rack.rubyforge.org/doc/classes/Rack/Builder.html)
|
2077
|
+
(le plus souvent utilisé dans un fichier rackup). Par exemple, la méthode
|
2078
|
+
+use+ accepte divers arguments ainsi que des blocs :
|
2079
|
+
|
2080
|
+
```
|
2081
|
+
use Rack::Auth::Basic do |login, password|
|
2082
|
+
login == 'admin' && password == 'secret'
|
2083
|
+
end
|
2084
|
+
```
|
2085
|
+
|
2086
|
+
Rack est distribué avec une bonne variété de middlewares standards pour les
|
2087
|
+
logs, débuguer, faire du routage URL, de l'authentification, gérer des
|
2088
|
+
sessions. Sinatra utilise beaucoup de ces composants automatiquement via la
|
2089
|
+
configuration, donc pour ceux-ci vous n'aurez pas à utiliser la méthode `use`.
|
2090
|
+
|
2091
|
+
## Tester
|
2092
|
+
|
2093
|
+
Les tests pour Sinatra peuvent être écrit avec n'importe quelle bibliothèque
|
2094
|
+
basée sur Rack. [Rack::Test](http://gitrdoc.com/brynary/rack-test) est
|
2095
|
+
recommandé :
|
2096
|
+
|
2097
|
+
```ruby
|
2098
|
+
require 'mon_application_sinatra'
|
2099
|
+
require 'test/unit'
|
2100
|
+
require 'rack/test'
|
2101
|
+
|
2102
|
+
class MonTest < Test::Unit::TestCase
|
2103
|
+
include Rack::Test::Methods
|
2104
|
+
|
2105
|
+
def app
|
2106
|
+
Sinatra::Application
|
2107
|
+
end
|
2108
|
+
|
2109
|
+
def test_ma_racine
|
2110
|
+
get '/'
|
2111
|
+
assert_equal 'Bonjour le monde !', last_response.body
|
2112
|
+
end
|
2113
|
+
|
2114
|
+
def test_avec_des_parametres
|
2115
|
+
get '/rencontrer', :name => 'Frank'
|
2116
|
+
assert_equal 'Salut Frank !', last_response.body
|
2117
|
+
end
|
2118
|
+
|
2119
|
+
def test_avec_rack_env
|
2120
|
+
get '/', {}, 'HTTP_USER_AGENT' => 'Songbird'
|
2121
|
+
assert_equal "Vous utilisez Songbird !", last_response.body
|
2122
|
+
end
|
2123
|
+
end
|
2124
|
+
```
|
2125
|
+
|
2126
|
+
## Sinatra::Base - Les Middlewares, Bibliothèques, et Applications Modulaires
|
2127
|
+
|
2128
|
+
Définir votre application au niveau supérieur fonctionne bien dans le cas des
|
2129
|
+
micro-applications mais présente pas mal d'inconvénients pour créer des
|
2130
|
+
composants réutilisables sous forme de middlewares Rack, de Rails metal, de
|
2131
|
+
simples librairies avec un composant serveur ou même d'extensions Sinatra. Le
|
2132
|
+
niveau supérieur suppose une configuration dans le style des micro-applications
|
2133
|
+
(une application d'un seul fichier, des répertoires `./public` et
|
2134
|
+
`./views`, des logs, une page d'erreur, etc...). C'est là que
|
2135
|
+
`Sinatra::Base` prend tout son intérêt :
|
2136
|
+
|
2137
|
+
```ruby
|
2138
|
+
require 'sinatra/base'
|
2139
|
+
|
2140
|
+
class MonApplication < Sinatra::Base
|
2141
|
+
set :sessions, true
|
2142
|
+
set :foo, 'bar'
|
2143
|
+
|
2144
|
+
get '/' do
|
2145
|
+
'Bonjour le monde !'
|
2146
|
+
end
|
2147
|
+
end
|
2148
|
+
```
|
2149
|
+
|
2150
|
+
Les méthodes de la classe `Sinatra::Base` sont parfaitement identiques à
|
2151
|
+
celles disponibles via le DSL de haut niveau. Il suffit de deux modifications
|
2152
|
+
pour transformer la plupart des applications de haut niveau en un composant
|
2153
|
+
`Sinatra::Base` :
|
2154
|
+
|
2155
|
+
* Votre fichier doit charger `sinatra/base` au lieu de `sinatra`, sinon toutes
|
2156
|
+
les méthodes du DSL Sinatra seront importées dans l'espace de nom principal.
|
2157
|
+
* Les gestionnaires de routes, la gestion d'erreur, les filtres et les options
|
2158
|
+
doivent être placés dans une classe héritant de `Sinatra::Base`.
|
2159
|
+
|
2160
|
+
`Sinatra::Base` est une page blanche. La plupart des options sont
|
2161
|
+
désactivées par défaut, y compris le serveur intégré. Reportez-vous à
|
2162
|
+
[Options et Configuration](http://sinatra.github.com/configuration.html)
|
2163
|
+
pour plus d'informations sur les options et leur fonctionnement.
|
2164
|
+
|
2165
|
+
### Style modulaire vs. style classique
|
2166
|
+
|
2167
|
+
Contrairement aux idées reçues, il n'y a rien de mal à utiliser le style
|
2168
|
+
classique. Si c'est ce qui convient pour votre application, vous n'avez pas
|
2169
|
+
aucune raison de passer à une application modulaire.
|
2170
|
+
|
2171
|
+
Le principal inconvénient du style classique sur le style modulaire est que vous
|
2172
|
+
ne pouvez avoir qu'une application Ruby par processus Ruby. Si vous pensez en
|
2173
|
+
utiliser plus, passez au style modulaire. Et rien ne vous empêche de mixer style
|
2174
|
+
classique et style modulaire.
|
2175
|
+
|
2176
|
+
Si vous passez d'un style à l'autre, souvenez-vous des quelques différences
|
2177
|
+
mineures en ce qui concerne les paramètres par défaut :
|
2178
|
+
|
2179
|
+
Paramètre Classique Modulaire
|
2180
|
+
|
2181
|
+
app_file fichier chargeant sinatra fichier héritant de Sinatra::Base
|
2182
|
+
run $0 == app_file false
|
2183
|
+
logging true false
|
2184
|
+
method_override true false
|
2185
|
+
inline_templates true false
|
2186
|
+
static true false
|
2187
|
+
|
2188
|
+
### Servir une application modulaire
|
2189
|
+
|
2190
|
+
Il y a deux façons de faire pour démarrer une application modulaire, démarrez
|
2191
|
+
avec `run!` :
|
2192
|
+
|
2193
|
+
```ruby
|
2194
|
+
# my_app.rb
|
2195
|
+
require 'sinatra/base'
|
2196
|
+
|
2197
|
+
class MyApp < Sinatra::Base
|
2198
|
+
# ... code de l'application ici ...
|
2199
|
+
|
2200
|
+
# démarre le serveur si ce fichier est directement exécuté
|
2201
|
+
run! if app_file == $0
|
2202
|
+
end
|
2203
|
+
```
|
2204
|
+
|
2205
|
+
Démarrez ensuite avec :
|
2206
|
+
|
2207
|
+
```bash
|
2208
|
+
$ ruby my_app.rb
|
2209
|
+
```
|
2210
|
+
|
2211
|
+
Ou alors avec un fichier `config.ru`, qui permet d'utiliser n'importe
|
2212
|
+
quel gestionnaire Rack :
|
2213
|
+
|
2214
|
+
```ruby
|
2215
|
+
# config.ru
|
2216
|
+
require './my_app'
|
2217
|
+
run MyApp
|
2218
|
+
```
|
2219
|
+
|
2220
|
+
Exécutez :
|
2221
|
+
|
2222
|
+
```bash
|
2223
|
+
$ rackup -p 4567
|
2224
|
+
```
|
2225
|
+
|
2226
|
+
### Utiliser une application de style classique avec un fichier config.ru
|
2227
|
+
|
2228
|
+
Ecrivez votre application :
|
2229
|
+
|
2230
|
+
```ruby
|
2231
|
+
# app.rb
|
2232
|
+
require 'sinatra'
|
2233
|
+
|
2234
|
+
get '/' do
|
2235
|
+
'Bonjour le monde !'
|
2236
|
+
end
|
2237
|
+
```
|
2238
|
+
|
2239
|
+
Et un fichier `config.ru` correspondant :
|
2240
|
+
|
2241
|
+
```ruby
|
2242
|
+
require './app'
|
2243
|
+
run Sinatra::Application
|
2244
|
+
```
|
2245
|
+
|
2246
|
+
### Quand utiliser un fichier config.ru ?
|
2247
|
+
|
2248
|
+
Quelques cas où vous devriez utiliser un fichier `config.ru` :
|
2249
|
+
|
2250
|
+
* Vous souhaitez déployer avec un autre gestionnaire Rack (Passenger, Unicorn,
|
2251
|
+
Heroku, ...).
|
2252
|
+
* Vous souhaitez utiliser plus d'une sous-classe de `Sinatra::Base`.
|
2253
|
+
* Vous voulez utiliser Sinatra comme un middleware, non en tant que
|
2254
|
+
endpoint.
|
2255
|
+
|
2256
|
+
**Il n'est pas nécessaire de passer par un fichier `config.ru` pour la
|
2257
|
+
seule raison que vous êtes passé au style modulaire, et vous n'avez pas besoin
|
2258
|
+
de passer au style modulaire pour utiliser un fichier `config.ru`.**
|
2259
|
+
|
2260
|
+
### Utiliser Sinatra comme Middleware
|
2261
|
+
|
2262
|
+
Non seulement Sinatra peut utiliser d'autres middlewares Rack, il peut
|
2263
|
+
également être à son tour utilisé au-dessus de n'importe quel endpoint Rack
|
2264
|
+
en tant que middleware. Ce endpoint peut très bien être une autre
|
2265
|
+
application Sinatra, ou n'importe quelle application basée sur Rack
|
2266
|
+
(Rails/Ramaze/Camping/...) :
|
2267
|
+
|
2268
|
+
```ruby
|
2269
|
+
require 'sinatra/base'
|
2270
|
+
|
2271
|
+
class EcranDeConnexion < Sinatra::Base
|
2272
|
+
enable :sessions
|
2273
|
+
|
2274
|
+
get('/connexion') { haml :connexion }
|
2275
|
+
|
2276
|
+
post('/connexion') do
|
2277
|
+
if params[:nom] = 'admin' && params[:motdepasse] = 'admin'
|
2278
|
+
session['nom_utilisateur'] = params[:nom]
|
2279
|
+
else
|
2280
|
+
redirect '/connexion'
|
2281
|
+
end
|
2282
|
+
end
|
2283
|
+
end
|
2284
|
+
|
2285
|
+
class MonApp < Sinatra::Base
|
2286
|
+
# le middleware sera appelé avant les filtres
|
2287
|
+
use EcranDeConnexion
|
2288
|
+
|
2289
|
+
before do
|
2290
|
+
unless session['nom_utilisateur']
|
2291
|
+
halt "Accès refusé, merci de vous <a href='/connexion'>connecter</a>."
|
2292
|
+
end
|
2293
|
+
end
|
2294
|
+
|
2295
|
+
get('/') { "Bonjour #{session['nom_utilisateur']}." }
|
2296
|
+
end
|
2297
|
+
```
|
2298
|
+
|
2299
|
+
### Création dynamique d'applications
|
2300
|
+
|
2301
|
+
Il se peut que vous ayez besoin de créer une nouvelle application à l'exécution
|
2302
|
+
sans avoir à les assigner à une constante, vous pouvez le faire grâce à
|
2303
|
+
`Sinatra.new` :
|
2304
|
+
|
2305
|
+
```ruby
|
2306
|
+
require 'sinatra/base'
|
2307
|
+
mon_app = Sinatra.new { get('/') { "salut" } }
|
2308
|
+
mon_app.run!
|
2309
|
+
```
|
2310
|
+
|
2311
|
+
L'application dont elle hérite peut être passé en argument optionnel :
|
2312
|
+
|
2313
|
+
```ruby
|
2314
|
+
# config.ru
|
2315
|
+
require 'sinatra/base'
|
2316
|
+
|
2317
|
+
controleur = Sinatra.new do
|
2318
|
+
enable :logging
|
2319
|
+
helpers MyHelpers
|
2320
|
+
end
|
2321
|
+
|
2322
|
+
map('/a') do
|
2323
|
+
run Sinatra.new(controleur) { get('/') { 'a' } }
|
2324
|
+
end
|
2325
|
+
|
2326
|
+
map('/b') do
|
2327
|
+
run Sinatra.new(controleur) { get('/') { 'b' } }
|
2328
|
+
end
|
2329
|
+
```
|
2330
|
+
|
2331
|
+
C'est notamment utile pour tester des extensions à Sinatra ou bien pour
|
2332
|
+
utiliser Sinatra dans votre propre bibliothèque.
|
2333
|
+
|
2334
|
+
Cela permet également d'utiliser très facilement Sinatra comme middleware :
|
2335
|
+
|
2336
|
+
```ruby
|
2337
|
+
require 'sinatra/base'
|
2338
|
+
|
2339
|
+
use Sinatra do
|
2340
|
+
get('/') { ... }
|
2341
|
+
end
|
2342
|
+
|
2343
|
+
run RailsProject::Application
|
2344
|
+
```
|
2345
|
+
|
2346
|
+
## Contextes et Binding
|
2347
|
+
|
2348
|
+
Le contexte dans lequel vous êtes détermine les méthodes et variables
|
2349
|
+
disponibles.
|
2350
|
+
|
2351
|
+
### Contexte de l'application/classe
|
2352
|
+
|
2353
|
+
Toute application Sinatra correspond à une sous-classe de `Sinatra::Base`.
|
2354
|
+
Si vous utilisez le DSL haut niveau (`require 'sinatra'`), alors cette
|
2355
|
+
classe est `Sinatra::Application`, sinon il s'agit de la sous-classe que
|
2356
|
+
vous avez définie. Dans le contexte de la classe, vous avez accès aux méthodes
|
2357
|
+
telles que `get` ou `before`, mais vous n'avez pas accès aux objets +request+
|
2358
|
+
ou +session+ car c'est la même classe d'application qui traitera toutes les
|
2359
|
+
requêtes.
|
2360
|
+
|
2361
|
+
Les options définies au moyen de +set+ deviennent des méthodes de classe :
|
2362
|
+
|
2363
|
+
```ruby
|
2364
|
+
class MonApp < Sinatra::Base
|
2365
|
+
# Eh, je suis dans le contexte de l'application !
|
2366
|
+
set :foo, 42
|
2367
|
+
foo # => 42
|
2368
|
+
|
2369
|
+
get '/foo' do
|
2370
|
+
# Eh, je ne suis plus dans le contexte de l'application !
|
2371
|
+
end
|
2372
|
+
end
|
2373
|
+
```
|
2374
|
+
|
2375
|
+
Vous avez le binding du contexte de l'application dans :
|
2376
|
+
|
2377
|
+
* Le corps de la classe d'application
|
2378
|
+
* Les méthodes définies par les extensions
|
2379
|
+
* Le bloc passé à `helpers`
|
2380
|
+
* Les procs/blocs utilisés comme argument pour `set`
|
2381
|
+
* Le bloc passé à `Sinatra.new`
|
2382
|
+
|
2383
|
+
Vous pouvez atteindre ce contexte (donc la classe) de la façon suivante :
|
2384
|
+
|
2385
|
+
* Via l'objet passé dans les blocs `configure` (`configure { |c| ... }`)
|
2386
|
+
* En utilisant `settings` dans le contexte de la requête
|
2387
|
+
|
2388
|
+
### Contexte de la requête/instance
|
2389
|
+
|
2390
|
+
Pour tout traitement d'une requête, une nouvelle instance de votre classe
|
2391
|
+
d'application est créée et tous vos gestionnaires sont exécutés dans ce
|
2392
|
+
contexte. Dans ce dernier, vous pouvez accéder aux objets `request` et
|
2393
|
+
`session` et faire appel aux fonctions de rendu telles que `erb` ou `haml`.
|
2394
|
+
Vous pouvez accéder au contexte de l'application depuis le contexte de la
|
2395
|
+
requête au moyen de `settings` :
|
2396
|
+
|
2397
|
+
```ruby
|
2398
|
+
class MonApp < Sinatra::Base
|
2399
|
+
# Eh, je suis dans le contexte de l'application !
|
2400
|
+
get '/ajouter_route/:nom' do
|
2401
|
+
# Contexte de la requête pour '/ajouter_route/:nom'
|
2402
|
+
@value = 42
|
2403
|
+
|
2404
|
+
settings.get("/#{params[:nom]}") do
|
2405
|
+
# Contexte de la requête pour "/#{params[:nom]}"
|
2406
|
+
@value # => nil (on est pas au sein de la même requête)
|
2407
|
+
end
|
2408
|
+
|
2409
|
+
"Route ajoutée !"
|
2410
|
+
end
|
2411
|
+
end
|
2412
|
+
```
|
2413
|
+
|
2414
|
+
Vous avez le binding du contexte de la requête dans :
|
2415
|
+
|
2416
|
+
* les blocs get/head/post/put/delete/options
|
2417
|
+
* les filtres before/after
|
2418
|
+
* les méthodes utilitaires (définies au moyen de `helpers`)
|
2419
|
+
* les vues/templates
|
2420
|
+
|
2421
|
+
### Le contexte de délégation
|
2422
|
+
|
2423
|
+
Le contexte de délégation se contente de transmettre les appels de méthodes au
|
2424
|
+
contexte de classe. Toutefois, il ne se comporte pas à 100% comme le contexte
|
2425
|
+
de classe car vous n'avez pas le binding de la classe : seules les méthodes
|
2426
|
+
spécifiquement déclarées pour délégation sont disponibles et il n'est pas
|
2427
|
+
possible de partager des variables/états avec le contexte de classe
|
2428
|
+
(comprenez : `self` n'est pas le même). Vous pouvez ajouter des délégation de
|
2429
|
+
méthodes en appelant `Sinatra::Delegator.delegate :method_name`.
|
2430
|
+
|
2431
|
+
Vous avez le binding du contexte de délégation dans :
|
2432
|
+
|
2433
|
+
* Le binding de haut niveau, si vous avez utilisé `require "sinatra"`
|
2434
|
+
* Un objet qui inclut le module `Sinatra::Delegator`
|
2435
|
+
|
2436
|
+
Jetez un oeil pour vous faire une idée : voici le
|
2437
|
+
[mixin Sinatra::Delegator](https://github.com/sinatra/sinatra/blob/ca06364/lib/sinatra/base.rb#L1609-1633)
|
2438
|
+
qui [étend l'objet principal](https://github.com/sinatra/sinatra/blob/ca06364/lib/sinatra/main.rb#L28-30).
|
2439
|
+
|
2440
|
+
## Ligne de commande
|
2441
|
+
|
2442
|
+
Les applications Sinatra peuvent être lancées directement :
|
2443
|
+
|
2444
|
+
```ruby
|
2445
|
+
$ ruby mon_application.rb [-h] [-x] [-e ENVIRONNEMENT] [-p PORT] [-o HOTE] [-s SERVEUR]
|
2446
|
+
```
|
2447
|
+
|
2448
|
+
Les options sont :
|
2449
|
+
|
2450
|
+
```
|
2451
|
+
-h # aide
|
2452
|
+
-p # déclare le port (4567 par défaut)
|
2453
|
+
-o # déclare l'hôte (0.0.0.0 par défaut)
|
2454
|
+
-e # déclare l'environnement (+development+ par défaut)
|
2455
|
+
-s # déclare le serveur/gestionnaire à utiliser (thin par défaut)
|
2456
|
+
-x # active le mutex lock (off par défaut)
|
2457
|
+
```
|
2458
|
+
|
2459
|
+
## Configuration nécessaire
|
2460
|
+
|
2461
|
+
Les versions suivantes de Ruby sont officiellement supportées :
|
2462
|
+
|
2463
|
+
<dl>
|
2464
|
+
<dt>Ruby 1.8.7</dt>
|
2465
|
+
<dd>1.8.7 est complètement supporté, toutefois si rien ne vous en empêche,
|
2466
|
+
nous vous recommandons de passer à 1.9.2 ou bien de passer à JRuby ou
|
2467
|
+
Rubinius. Le support de Ruby 1.8.7 ne sera pas supprimé avant la sortie de
|
2468
|
+
Sinatra 2.0 et de Ruby 2.0, à moins qu’un improbable Ruby 1.8.8
|
2469
|
+
apparaisse. Et même dans ce cas, nous pourrions continuer à le supporter.
|
2470
|
+
**Ruby 1.8.6 n’est plus supporté**. Si vous souhaitez utiliser la
|
2471
|
+
version 1.8.6, vous devez revenir à Sinatra 1.2 qui continuera à recevoir
|
2472
|
+
des corrections de bugs tant que Sinatra 1.4.0 ne sera pas livré.</dd>
|
2473
|
+
|
2474
|
+
<dt>Ruby 1.9.2</dt>
|
2475
|
+
<dd>1.9.2 est totalement supporté et recommandé. N’utilisez pas 1.9.2p0 car
|
2476
|
+
il provoque des erreurs de segmentation à l’exécution de Sinatra. Son
|
2477
|
+
support continuera au minimum jusqu’à la sortie de Ruby 1.9.4/2.0 et le
|
2478
|
+
support de la dernière version 1.9 se poursuivra aussi longtemps que la
|
2479
|
+
core team de Ruby la supportera.</dd>
|
2480
|
+
|
2481
|
+
<dt>Ruby 1.9.3</dt>
|
2482
|
+
<dd>1.9.3 est totalement supporté et recommandé. Nous vous rappelons que
|
2483
|
+
passer à 1.9.3 depuis une version précédente annulera toutes les
|
2484
|
+
sessions.</dd>
|
2485
|
+
|
2486
|
+
|
2487
|
+
<dt>Rubinius</dt>
|
2488
|
+
<dd>Rubinius est officiellement supporté (Rubinius <= 1.2.4), tout
|
2489
|
+
fonctionne, y compris tous les langages de template. La version 2.0 à
|
2490
|
+
venir est également supportée.</dd>
|
2491
|
+
|
2492
|
+
<dt>JRuby</dt>
|
2493
|
+
<dd>JRuby est officiellement supporté (JRuby <= 1.6.5). Aucune anomalie
|
2494
|
+
avec des bibliothèques de templates tierces ne sont connues. Toutefois, si
|
2495
|
+
vous choisissez JRuby, alors tournez vous vers des gestionnaires Rack JRuby
|
2496
|
+
car le serveur Thin n’est pas complètement supporté par JRuby. Le
|
2497
|
+
support des extensions C dans JRuby est encore expérimental, ce qui
|
2498
|
+
n’affecte que RDiscount, Redcarpet and RedCloth pour l’instant.</dd>
|
2499
|
+
</dl>
|
2500
|
+
|
2501
|
+
Nous gardons également un oeil sur les versions Ruby à venir.
|
2502
|
+
|
2503
|
+
Les implémentations Ruby suivantes ne sont pas officiellement supportées mais
|
2504
|
+
sont malgré tout connues pour permettre de faire fonctionner Sinatra :
|
2505
|
+
|
2506
|
+
* Versions plus anciennes de JRuby et Rubinius
|
2507
|
+
* Ruby Enterprise Edition
|
2508
|
+
* MacRuby, Maglev, IronRuby
|
2509
|
+
* Ruby 1.9.0 et 1.9.1 (mais nous déconseillons leur utilisation)
|
2510
|
+
|
2511
|
+
Le fait de ne pas être officiellement supporté signifie que si quelque chose
|
2512
|
+
ne fonctionne pas uniquement sur cette plateforme alors c'est un problème de la
|
2513
|
+
plateforme et pas un bug de Sinatra.
|
2514
|
+
|
2515
|
+
Nous lançons également notre intégration continue (CI) avec ruby-head (la
|
2516
|
+
future 2.0.0) et la branche 1.9.4, mais étant donné les évolutions continuelles,
|
2517
|
+
nous ne pouvont rien garantir, si ce n'est que les versions 1.9.4p0 et 2.0.0p0
|
2518
|
+
seront supportées.
|
2519
|
+
|
2520
|
+
Sinatra devrait fonctionner sur n'importe quel système d'exploitation
|
2521
|
+
supportant l'implémentation Ruby choisie.
|
2522
|
+
|
2523
|
+
Il n'est pas possible d'utiliser Sinatra sur Cardinal, SmallRuby, Blueuby ou
|
2524
|
+
toute version de Ruby antérieure à 1.8.7 à l'heure actuelle.
|
2525
|
+
|
2526
|
+
## Essuyer les plâtres
|
2527
|
+
|
2528
|
+
Si vous voulez utiliser la toute dernière version de Sinatra, n'ayez pas peur
|
2529
|
+
de faire tourner votre application sur la branche master, cela devrait être
|
2530
|
+
stable.
|
2531
|
+
|
2532
|
+
Nous publions également une gem de +prerelease+ de temps en temps que vous
|
2533
|
+
pouvez installer comme suit :
|
2534
|
+
|
2535
|
+
```ruby
|
2536
|
+
$ gem install sinatra --pre
|
2537
|
+
```
|
2538
|
+
|
2539
|
+
afin d'avoir les toutes dernières fonctionnalités.
|
2540
|
+
|
2541
|
+
### Avec Bundler
|
2542
|
+
|
2543
|
+
Si vous voulez faire tourner votre application avec le tout dernier
|
2544
|
+
Sinatra, [Bundler](http://gembundler.com/) est recommandé.
|
2545
|
+
|
2546
|
+
Tout d'abord, installer bundler si vous ne l'avez pas :
|
2547
|
+
|
2548
|
+
```bash
|
2549
|
+
$ gem install bundler
|
2550
|
+
```
|
2551
|
+
|
2552
|
+
Ensuite, dans le dossier de votre projet, créez un fichier +Gemfile+ :
|
2553
|
+
|
2554
|
+
```ruby
|
2555
|
+
source :rubygems
|
2556
|
+
gem 'sinatra', :git => "git://github.com/sinatra/sinatra.git"
|
2557
|
+
|
2558
|
+
# autres dépendances
|
2559
|
+
gem 'haml' # par exemple, si vous utilisez haml
|
2560
|
+
gem 'activerecord', '~> 3.0' # peut-être que vous avez également besoin
|
2561
|
+
# de ActiveRecord 3.x
|
2562
|
+
```
|
2563
|
+
|
2564
|
+
Notez que vous aurez à lister toutes les dépendances de votre application dans
|
2565
|
+
ce fichier. Les dépendances directes de Sinatra (Rack et Tilt) seront
|
2566
|
+
automatiquement téléchargées et ajoutées par Bundler.
|
2567
|
+
|
2568
|
+
Maintenant, vous pouvez faire tourner votre application de la façon suivante :
|
2569
|
+
|
2570
|
+
```bash
|
2571
|
+
$ bundle exec ruby myapp.rb
|
2572
|
+
```
|
2573
|
+
|
2574
|
+
### Faites le vous-même
|
2575
|
+
|
2576
|
+
Créez un clone local et démarrez votre application avec le dossier
|
2577
|
+
`sinatra/lib` dans le `$LOAD_PATH` :
|
2578
|
+
|
2579
|
+
```bash
|
2580
|
+
$ cd myapp
|
2581
|
+
$ git clone git://github.com/sinatra/sinatra.git
|
2582
|
+
$ ruby -Isinatra/lib myapp.rb
|
2583
|
+
|
2584
|
+
A l'avenir, pour mettre à jour le code source de Sinatra :
|
2585
|
+
|
2586
|
+
```bash
|
2587
|
+
$ cd myapp/sinatra
|
2588
|
+
$ git pull
|
2589
|
+
```
|
2590
|
+
|
2591
|
+
### Installez globalement
|
2592
|
+
|
2593
|
+
Vous pouvez construire la gem vous-même :
|
2594
|
+
|
2595
|
+
```bash
|
2596
|
+
$ git clone git://github.com/sinatra/sinatra.git
|
2597
|
+
$ cd sinatra
|
2598
|
+
$ rake sinatra.gemspec
|
2599
|
+
$ rake install
|
2600
|
+
```
|
2601
|
+
|
2602
|
+
Si vous installez les gems en tant que +root+, la dernière étape sera :
|
2603
|
+
|
2604
|
+
```bash
|
2605
|
+
$ sudo rake install
|
2606
|
+
```
|
2607
|
+
|
2608
|
+
## Versions
|
2609
|
+
|
2610
|
+
Sinatra se conforme aux (versions sémantiques)[http://semver.org/], aussi bien
|
2611
|
+
SemVer que SemVerTag.
|
2612
|
+
|
2613
|
+
## Mais encore
|
2614
|
+
|
2615
|
+
* [Site internet](http://www.sinatrarb.com/) - Plus de documentation,
|
2616
|
+
de news, et des liens vers d'autres ressources.
|
2617
|
+
* [Contribuer](http://www.sinatrarb.com/contributing) - Vous avez trouvé un
|
2618
|
+
bug ? Besoin d'aide ? Vous avez un patch ?
|
2619
|
+
* [Suivi des problèmes](http://github.com/sinatra/sinatra/issues)
|
2620
|
+
* [Twitter](http://twitter.com/sinatra)
|
2621
|
+
* [Mailing List])(http://groups.google.com/group/sinatrarb/topics)
|
2622
|
+
* [IRC : #sinatra](irc://chat.freenode.net/#sinatra) sur http://freenode.net
|
2623
|
+
* [IRC : #sinatra](irc://chat.freenode.net/#sinatra) on http://freenode.net
|
2624
|
+
* [Sinatra Book](http://sinatra-book.gittr.com) Tutoriels et recettes
|
2625
|
+
* [Sinatra Recipes](http://recipes.sinatrarb.com/) trucs et astuces rédigés par
|
2626
|
+
la communauté
|
2627
|
+
* Documentation API de la [dernière version](http://rubydoc.info/gems/sinatra)
|
2628
|
+
ou du [HEAD courant](http://rubydoc.info/github/sinatra/sinatra) sur
|
2629
|
+
http://rubydoc.info
|
2630
|
+
* [CI server](http://travis-ci.org/sinatra/sinatra)
|