sinatra 1.4.0.c → 1.4.0.d
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 +11 -1
- data/Gemfile +2 -4
- data/README.de.md +1 -0
- data/README.es.md +2777 -0
- data/{README.hu.rdoc → README.hu.md} +169 -83
- data/README.jp.md +1097 -0
- data/README.ko.md +2483 -0
- data/README.md +8 -0
- data/README.pt-br.md +954 -0
- data/README.pt-pt.md +791 -0
- data/README.zh.md +2136 -0
- data/Rakefile +2 -2
- data/examples/chat.rb +3 -3
- data/lib/sinatra/base.rb +17 -7
- data/lib/sinatra/version.rb +1 -1
- data/sinatra.gemspec +3 -3
- data/test/delegator_test.rb +1 -1
- data/test/helper.rb +8 -0
- data/test/helpers_test.rb +4 -1
- data/test/rdoc_test.rb +2 -2
- data/test/readme_test.rb +10 -0
- data/test/routing_test.rb +1 -1
- metadata +35 -29
- data/README.es.rdoc +0 -2112
- data/README.jp.rdoc +0 -1056
- data/README.ko.rdoc +0 -1932
- data/README.pt-br.rdoc +0 -778
- data/README.pt-pt.rdoc +0 -647
- data/README.zh.rdoc +0 -1816
data/CHANGES
CHANGED
@@ -1,5 +1,7 @@
|
|
1
1
|
= 1.4.0 / Not Yet Released
|
2
2
|
|
3
|
+
* Add support for LINK and UNLINK requests. (Konstantin Haase)
|
4
|
+
|
3
5
|
* Add support for Yajl templates. (Jamie Hodge)
|
4
6
|
|
5
7
|
* Add support for Rabl templates. (Jesse Cooke)
|
@@ -87,7 +89,7 @@
|
|
87
89
|
Alexey Muranov, Konstantin Haase)
|
88
90
|
|
89
91
|
* Convert documentation to Markdown. (Kashyap, Robin Dupret, burningTyger,
|
90
|
-
Vasily Polovnyov)
|
92
|
+
Vasily Polovnyov, Iain Barnett, Giuseppe Capizzi, Neil West)
|
91
93
|
|
92
94
|
* Don't set not_found content type to HTML in development mode with custom
|
93
95
|
not_found handler. (Konstantin Haase)
|
@@ -102,6 +104,14 @@
|
|
102
104
|
|
103
105
|
* Take views option into account for template caching. (Konstantin Haase)
|
104
106
|
|
107
|
+
* Consistent use of `headers` instead of `header` internally. (Patricio Mac Adden)
|
108
|
+
|
109
|
+
* Fix compatibility to RDoc 4. (Bohuslav Kabrda)
|
110
|
+
|
111
|
+
* Make chat example work with latest jQuery. (loveky, Tony Miller)
|
112
|
+
|
113
|
+
* Make tests run without warnings. (Patricio Mac Adden)
|
114
|
+
|
105
115
|
= 1.3.5 / 2013-02-25
|
106
116
|
|
107
117
|
* Fix for RubyGems 2.0 (Uchio KONDO)
|
data/Gemfile
CHANGED
@@ -7,7 +7,7 @@
|
|
7
7
|
# If you have issues with a gem: `bundle install --without-coffee-script`.
|
8
8
|
|
9
9
|
RUBY_ENGINE = 'ruby' unless defined? RUBY_ENGINE
|
10
|
-
source
|
10
|
+
source 'https://rubygems.org' unless ENV['QUICK']
|
11
11
|
gemspec
|
12
12
|
|
13
13
|
gem 'rake'
|
@@ -35,7 +35,7 @@ gem 'erubis'
|
|
35
35
|
gem 'slim', '~> 1.0'
|
36
36
|
gem 'temple', '!= 0.3.3'
|
37
37
|
gem 'coffee-script', '>= 2.0'
|
38
|
-
gem 'rdoc', '~> 3.12'
|
38
|
+
gem 'rdoc', RUBY_VERSION < '1.9' ? '~> 3.12' : '>= 4.0'
|
39
39
|
gem 'kramdown'
|
40
40
|
gem 'maruku'
|
41
41
|
gem 'creole'
|
@@ -61,8 +61,6 @@ end
|
|
61
61
|
|
62
62
|
if RUBY_ENGINE == "ruby" and RUBY_VERSION > '1.9'
|
63
63
|
gem 'less', '~> 2.0'
|
64
|
-
else
|
65
|
-
gem 'less', '~> 1.0'
|
66
64
|
end
|
67
65
|
|
68
66
|
if RUBY_ENGINE != 'jruby' or not ENV['TRAVIS']
|
data/README.de.md
CHANGED
data/README.es.md
ADDED
@@ -0,0 +1,2777 @@
|
|
1
|
+
# Sinatra
|
2
|
+
|
3
|
+
*Atención: Este documento es una traducción de la versión en inglés y puede estar desactualizado.*
|
4
|
+
|
5
|
+
Sinatra es un
|
6
|
+
[DSL](http://es.wikipedia.org/wiki/Lenguaje_específico_del_dominio) para
|
7
|
+
crear aplicaciones web rápidamente en Ruby con un mínimo esfuerzo:
|
8
|
+
|
9
|
+
``` ruby
|
10
|
+
# miapp.rb
|
11
|
+
require 'sinatra'
|
12
|
+
|
13
|
+
get '/' do
|
14
|
+
'Hola mundo!'
|
15
|
+
end
|
16
|
+
```
|
17
|
+
|
18
|
+
Instalá la gem y ejecutá la aplicación con:
|
19
|
+
|
20
|
+
``` shell
|
21
|
+
gem install sinatra
|
22
|
+
ruby miapp.rb
|
23
|
+
```
|
24
|
+
|
25
|
+
Podés verla en: http://localhost:4567
|
26
|
+
|
27
|
+
Es recomendable además ejecutar `gem install thin`, ya que Sinatra lo va
|
28
|
+
a utilizar cuando esté disponible.
|
29
|
+
|
30
|
+
## Rutas
|
31
|
+
|
32
|
+
En Sinatra, una ruta está compuesta por un método HTTP y un patrón de una URL.
|
33
|
+
Cada ruta se asocia con un bloque:
|
34
|
+
|
35
|
+
``` ruby
|
36
|
+
get '/' do
|
37
|
+
.. mostrar algo ..
|
38
|
+
end
|
39
|
+
|
40
|
+
post '/' do
|
41
|
+
.. crear algo ..
|
42
|
+
end
|
43
|
+
|
44
|
+
put '/' do
|
45
|
+
.. reemplazar algo ..
|
46
|
+
end
|
47
|
+
|
48
|
+
patch '/' do
|
49
|
+
.. modificar algo ..
|
50
|
+
end
|
51
|
+
|
52
|
+
delete '/' do
|
53
|
+
.. aniquilar algo ..
|
54
|
+
end
|
55
|
+
|
56
|
+
options '/' do
|
57
|
+
.. informar algo ..
|
58
|
+
end
|
59
|
+
```
|
60
|
+
|
61
|
+
Las rutas son comparadas en el orden en el que son definidas. La primer ruta
|
62
|
+
que coincide con la petición es invocada.
|
63
|
+
|
64
|
+
Los patrones de las rutas pueden incluir parámetros nombrados, accesibles a
|
65
|
+
través de el hash `params`:
|
66
|
+
|
67
|
+
``` ruby
|
68
|
+
get '/hola/:nombre' do
|
69
|
+
# coincide con "GET /hola/foo" y "GET /hola/bar"
|
70
|
+
# params[:nombre] es 'foo' o 'bar'
|
71
|
+
"Hola #{params[:nombre]}!"
|
72
|
+
end
|
73
|
+
```
|
74
|
+
|
75
|
+
También podés acceder a los parámetros nombrados usando parámetros de bloque:
|
76
|
+
|
77
|
+
``` ruby
|
78
|
+
get '/hola/:nombre' do |n|
|
79
|
+
"Hola #{n}!"
|
80
|
+
end
|
81
|
+
```
|
82
|
+
|
83
|
+
Los patrones de ruta también pueden incluir parámetros splat (o wildcard),
|
84
|
+
accesibles a través del arreglo `params[:splat]`:
|
85
|
+
|
86
|
+
``` ruby
|
87
|
+
get '/decir/*/al/*' do
|
88
|
+
# coincide con /decir/hola/al/mundo
|
89
|
+
params[:splat] # => ["hola", "mundo"]
|
90
|
+
end
|
91
|
+
|
92
|
+
get '/descargar/*.*' do
|
93
|
+
# coincide con /descargar/path/al/archivo.xml
|
94
|
+
params[:splat] # => ["path/al/archivo", "xml"]
|
95
|
+
end
|
96
|
+
```
|
97
|
+
|
98
|
+
O, con parámetros de bloque:
|
99
|
+
|
100
|
+
``` ruby
|
101
|
+
get '/descargar/*.*' do |path, ext|
|
102
|
+
[path, ext] # => ["path/al/archivo", "xml"]
|
103
|
+
end
|
104
|
+
```
|
105
|
+
|
106
|
+
Rutas con Expresiones Regulares:
|
107
|
+
|
108
|
+
``` ruby
|
109
|
+
get %r{/hola/([\w]+)} do
|
110
|
+
"Hola, #{params[:captures].first}!"
|
111
|
+
end
|
112
|
+
```
|
113
|
+
|
114
|
+
O con un parámetro de bloque:
|
115
|
+
|
116
|
+
``` ruby
|
117
|
+
get %r{/hola/([\w]+)} do |c|
|
118
|
+
"Hola, #{c}!"
|
119
|
+
end
|
120
|
+
```
|
121
|
+
|
122
|
+
Los patrones de ruta pueden contener parámetros opcionales:
|
123
|
+
|
124
|
+
``` ruby
|
125
|
+
get '/posts.?:formato?' do
|
126
|
+
# coincide con "GET /posts" y además admite cualquier extensión, por
|
127
|
+
# ejemplo, "GET /posts.json", "GET /posts.xml", etc.
|
128
|
+
end
|
129
|
+
```
|
130
|
+
|
131
|
+
A propósito, a menos que desactivés la protección para el ataque *path
|
132
|
+
traversal* (ver más abajo), el path de la petición puede ser modificado
|
133
|
+
antes de que se compare con los de tus rutas.
|
134
|
+
|
135
|
+
## Condiciones
|
136
|
+
|
137
|
+
Las rutas pueden incluir una variedad de condiciones de selección, como por
|
138
|
+
ejemplo el user agent:
|
139
|
+
|
140
|
+
``` ruby
|
141
|
+
get '/foo', :agent => /Songbird (\d\.\d)[\d\/]*?/ do
|
142
|
+
"Estás usando la versión de Songbird #{params[:agent][0]}"
|
143
|
+
end
|
144
|
+
|
145
|
+
get '/foo' do
|
146
|
+
# Coincide con browsers que no sean songbird
|
147
|
+
end
|
148
|
+
```
|
149
|
+
|
150
|
+
Otras condiciones disponibles son `host_name` y `provides`:
|
151
|
+
|
152
|
+
``` ruby
|
153
|
+
get '/', :host_name => /^admin\./ do
|
154
|
+
"Área de Administración, Acceso denegado!"
|
155
|
+
end
|
156
|
+
|
157
|
+
get '/', :provides => 'html' do
|
158
|
+
haml :index
|
159
|
+
end
|
160
|
+
|
161
|
+
get '/', :provides => ['rss', 'atom', 'xml'] do
|
162
|
+
builder :feed
|
163
|
+
end
|
164
|
+
```
|
165
|
+
|
166
|
+
Podés definir tus propias condiciones fácilmente:
|
167
|
+
|
168
|
+
``` ruby
|
169
|
+
set(:probabilidad) { |valor| condition { rand <= valor } }
|
170
|
+
|
171
|
+
get '/gana_un_auto', :probabilidad => 0.1 do
|
172
|
+
"Ganaste!"
|
173
|
+
end
|
174
|
+
|
175
|
+
get '/gana_un_auto' do
|
176
|
+
"Lo siento, perdiste."
|
177
|
+
end
|
178
|
+
```
|
179
|
+
|
180
|
+
Si tu condición acepta más de un argumento, podés pasarle un arreglo. Al
|
181
|
+
definir la condición puede resultarte conveniente utilizar el operador splat en
|
182
|
+
la lista de parámetros:
|
183
|
+
|
184
|
+
``` ruby
|
185
|
+
set(:autorizar) do |*roles| # <- mirá el splat
|
186
|
+
condition do
|
187
|
+
unless sesion_iniciada? && roles.any? {|rol| usuario_actual.tiene_rol? rol }
|
188
|
+
redirect "/iniciar_sesion/", 303
|
189
|
+
end
|
190
|
+
end
|
191
|
+
end
|
192
|
+
|
193
|
+
get "/mi/cuenta/", :autorizar => [:usuario, :administrador] do
|
194
|
+
"Detalles de mi cuenta"
|
195
|
+
end
|
196
|
+
|
197
|
+
get "/solo/administradores/", :autorizar => :administrador do
|
198
|
+
"Únicamente para administradores!"
|
199
|
+
end
|
200
|
+
```
|
201
|
+
|
202
|
+
### Valores de Retorno
|
203
|
+
|
204
|
+
El valor de retorno de un bloque de ruta determina al menos el cuerpo de la
|
205
|
+
respuesta que se le pasa al cliente HTTP o al siguiente middleware en la pila
|
206
|
+
de Rack. Lo más común es que sea un string, como en los ejemplos anteriores.
|
207
|
+
Sin embargo, otros valor también son aceptados.
|
208
|
+
|
209
|
+
Podés devolver cualquier objeto que sea una respuesta Rack válida, un objeto
|
210
|
+
que represente el cuerpo de una respuesta Rack o un código de estado HTTP:
|
211
|
+
|
212
|
+
* Un arreglo con tres elementos: `[estado (Fixnum), cabeceras (Hash), cuerpo de
|
213
|
+
la respuesta (responde a #each)]`
|
214
|
+
* Un arreglo con dos elementos: `[estado (Fixnum), cuerpo de la respuesta
|
215
|
+
(responde a #each)]`
|
216
|
+
* Un objeto que responde a `#each` y que le pasa únicamente strings al bloque
|
217
|
+
dado
|
218
|
+
* Un Fixnum representando el código de estado
|
219
|
+
|
220
|
+
De esa manera podemos, por ejemplo, implementar fácilmente un streaming:
|
221
|
+
|
222
|
+
``` ruby
|
223
|
+
class Stream
|
224
|
+
def each
|
225
|
+
100.times { |i| yield "#{i}\n" }
|
226
|
+
end
|
227
|
+
end
|
228
|
+
|
229
|
+
get('/') { Stream.new }
|
230
|
+
```
|
231
|
+
|
232
|
+
### Comparadores de Rutas Personalizados
|
233
|
+
|
234
|
+
Como se mostró anteriormente, Sinatra permite utilizar Strings y expresiones
|
235
|
+
regulares para definir las rutas. Sin embargo, la cosa no termina ahí. Podés
|
236
|
+
definir tus propios comparadores muy fácilmente:
|
237
|
+
|
238
|
+
``` ruby
|
239
|
+
class PattronCualquieraMenos
|
240
|
+
Match = Struct.new(:captures)
|
241
|
+
|
242
|
+
def initialize(excepto)
|
243
|
+
@excepto = excepto
|
244
|
+
@capturas = Match.new([])
|
245
|
+
end
|
246
|
+
|
247
|
+
def match(str)
|
248
|
+
@capturas unless @excepto === str
|
249
|
+
end
|
250
|
+
end
|
251
|
+
|
252
|
+
def cualquiera_menos(patron)
|
253
|
+
PatronCualquieraMenos.new(patron)
|
254
|
+
end
|
255
|
+
|
256
|
+
get cualquiera_menos("/index") do
|
257
|
+
# ...
|
258
|
+
end
|
259
|
+
```
|
260
|
+
|
261
|
+
Tené en cuenta que el ejemplo anterior es un poco rebuscado. Un resultado
|
262
|
+
similar puede conseguirse más sencillamente:
|
263
|
+
|
264
|
+
``` ruby
|
265
|
+
get // do
|
266
|
+
pass if request.path_info == "/index"
|
267
|
+
# ...
|
268
|
+
end
|
269
|
+
```
|
270
|
+
|
271
|
+
O, usando un lookahead negativo:
|
272
|
+
|
273
|
+
``` ruby
|
274
|
+
get %r{^(?!/index$)} do
|
275
|
+
# ...
|
276
|
+
end
|
277
|
+
```
|
278
|
+
|
279
|
+
### Archivos Estáticos
|
280
|
+
|
281
|
+
Los archivos estáticos son servidos desde el directorio público
|
282
|
+
`./public`. Podés especificar una ubicación diferente ajustando la
|
283
|
+
opción `:public_folder`:
|
284
|
+
|
285
|
+
``` ruby
|
286
|
+
set :public_folder, File.dirname(__FILE__) + '/estaticos'
|
287
|
+
```
|
288
|
+
|
289
|
+
Notá que el nombre del directorio público no está incluido en la URL. Por
|
290
|
+
ejemplo, el archivo `./public/css/style.css` se accede a través de
|
291
|
+
`http://ejemplo.com/css/style.css`.
|
292
|
+
|
293
|
+
Usá la configuración `:static_cache_control` para agregar el encabezado
|
294
|
+
`Cache-Control` (ver la sección de configuración para más detalles).
|
295
|
+
|
296
|
+
### Vistas / Plantillas
|
297
|
+
|
298
|
+
Cada lenguaje de plantilla se expone a través de un método de renderizado que
|
299
|
+
lleva su nombre. Estos métodos simplemente devuelven un string:
|
300
|
+
|
301
|
+
``` ruby
|
302
|
+
get '/' do
|
303
|
+
erb :index
|
304
|
+
end
|
305
|
+
```
|
306
|
+
|
307
|
+
Renderiza `views/index.erb`.
|
308
|
+
|
309
|
+
En lugar del nombre de la plantilla podés proporcionar directamente el
|
310
|
+
contenido de la misma:
|
311
|
+
|
312
|
+
``` ruby
|
313
|
+
get '/' do
|
314
|
+
codigo = "<%= Time.now %>"
|
315
|
+
erb codigo
|
316
|
+
end
|
317
|
+
```
|
318
|
+
|
319
|
+
Los métodos de renderizado, aceptan además un segundo argumento, el hash de
|
320
|
+
opciones:
|
321
|
+
|
322
|
+
``` ruby
|
323
|
+
get '/' do
|
324
|
+
erb :index, :layout => :post
|
325
|
+
end
|
326
|
+
```
|
327
|
+
|
328
|
+
Renderiza `views/index.erb` embebido en `views/post.erb` (por
|
329
|
+
defecto, la plantilla `:index` es embebida en `views/layout.erb` siempre y
|
330
|
+
cuando este último archivo exista).
|
331
|
+
|
332
|
+
Cualquier opción que Sinatra no entienda le será pasada al motor de renderizado
|
333
|
+
de la plantilla:
|
334
|
+
|
335
|
+
``` ruby
|
336
|
+
get '/' do
|
337
|
+
haml :index, :format => :html5
|
338
|
+
end
|
339
|
+
```
|
340
|
+
|
341
|
+
Además podés definir las opciones para un lenguaje de plantillas de forma
|
342
|
+
general:
|
343
|
+
|
344
|
+
``` ruby
|
345
|
+
set :haml, :format => :html5
|
346
|
+
|
347
|
+
get '/' do
|
348
|
+
haml :index
|
349
|
+
end
|
350
|
+
```
|
351
|
+
|
352
|
+
Las opciones pasadas al método de renderizado tienen precedencia sobre las
|
353
|
+
definidas mediante `set`.
|
354
|
+
|
355
|
+
Opciones disponibles:
|
356
|
+
|
357
|
+
<dl>
|
358
|
+
|
359
|
+
<dt>locals</dt>
|
360
|
+
<dd>
|
361
|
+
Lista de variables locales pasadas al documento. Resultan muy útiles cuando
|
362
|
+
se combinan con parciales.
|
363
|
+
Ejemplo: <tt>erb "<%= foo %>", :locals => {:foo => "bar"}</tt>
|
364
|
+
</dd>
|
365
|
+
|
366
|
+
<dt>default_encoding</dt>
|
367
|
+
<dd>
|
368
|
+
Encoding utilizado cuando el de un string es dudoso. Por defecto toma el
|
369
|
+
valor de <tt>settings.default_encoding</tt>.
|
370
|
+
</dd>
|
371
|
+
|
372
|
+
<dt>views</dt>
|
373
|
+
<dd>
|
374
|
+
Directorio desde donde se cargan las vistas. Por defecto toma el valor de
|
375
|
+
<tt>settings.views</tt>.
|
376
|
+
</dd>
|
377
|
+
|
378
|
+
<dt>layout</dt>
|
379
|
+
<dd>
|
380
|
+
Si es <tt>true</tt> o <tt>false</tt> indica que se debe usar, o nó, un layout,
|
381
|
+
respectivamente. También puede ser un símbolo que especifique qué plantilla
|
382
|
+
usar. Ejemplo: <tt>erb :index, :layout => !request.xhr?</tt>
|
383
|
+
</dd>
|
384
|
+
|
385
|
+
<dt>content_type</dt>
|
386
|
+
<dd>
|
387
|
+
Content-Type que produce la plantilla. El valor por defecto depende de cada
|
388
|
+
lenguaje de plantillas.
|
389
|
+
</dd>
|
390
|
+
|
391
|
+
<dt>scope</dt>
|
392
|
+
<dd>
|
393
|
+
Ámbito en el que se renderiza la plantilla. Por defecto utiliza la instancia
|
394
|
+
de la aplicación. Tené en cuenta que si cambiás esta opción las variables de
|
395
|
+
instancia y los helpers van a dejar de estar disponibles.
|
396
|
+
</dd>
|
397
|
+
|
398
|
+
<dt>layout_engine</dt>
|
399
|
+
<dd>
|
400
|
+
Motor de renderizado de plantillas que usa para el layout. Resulta
|
401
|
+
conveniente para lenguajes que no soportan layouts. Por defecto toma el valor
|
402
|
+
del motor usado para renderizar la plantilla.
|
403
|
+
Ejemplo: <tt>set :rdoc, :layout_engine => :erb</tt>
|
404
|
+
</dd>
|
405
|
+
|
406
|
+
<dd>
|
407
|
+
Se asume que las plantillas están ubicadas directamente bajo el directorio
|
408
|
+
<tt>./views</tt>. Para usar un directorio de vistas diferente:
|
409
|
+
<tt>set :views, settings.root + '/plantillas'</tt>
|
410
|
+
</dd>
|
411
|
+
|
412
|
+
<dd>
|
413
|
+
Es importante acordarse que siempre tenés que referenciar a las plantillas con
|
414
|
+
símbolos, incluso cuando se encuentran en un subdirectorio (en este caso
|
415
|
+
tenés que usar: <tt>'subdir/plantilla'</tt>). Tenés que usar un símbolo porque los
|
416
|
+
métodos de renderización van a renderizar directamente cualquier string que se
|
417
|
+
les pase como argumento.
|
418
|
+
</dd>
|
419
|
+
</dl>
|
420
|
+
|
421
|
+
### Lenguajes de Plantillas Disponibles
|
422
|
+
|
423
|
+
Algunos lenguajes tienen varias implementaciones. Para especificar que
|
424
|
+
implementación usar (y para ser thread-safe), deberías requerirla antes de
|
425
|
+
usarla:
|
426
|
+
|
427
|
+
``` ruby
|
428
|
+
require 'rdiscount' # o require 'bluecloth'
|
429
|
+
get('/') { markdown :index }
|
430
|
+
```
|
431
|
+
|
432
|
+
### Plantillas Haml
|
433
|
+
|
434
|
+
<table>
|
435
|
+
<tr>
|
436
|
+
<td>Dependencias</td>
|
437
|
+
<td><a href="http://haml.info/" title="haml">haml</a></td>
|
438
|
+
</tr>
|
439
|
+
<tr>
|
440
|
+
<td>Expresiones de Archivo</td>
|
441
|
+
<td><tt>.haml</tt></td>
|
442
|
+
</tr>
|
443
|
+
<tr>
|
444
|
+
<td>Ejemplo</td>
|
445
|
+
<td><tt>haml :index, :format => :html5</tt></td>
|
446
|
+
</tr>
|
447
|
+
</table>
|
448
|
+
|
449
|
+
### Plantillas Erb
|
450
|
+
|
451
|
+
<table>
|
452
|
+
<tr>
|
453
|
+
<td>Dependencias</td>
|
454
|
+
<td>
|
455
|
+
<a href="http://www.kuwata-lab.com/erubis/" title="erubis">erubis</a>
|
456
|
+
o erb (incluida en Ruby)
|
457
|
+
</td>
|
458
|
+
</tr>
|
459
|
+
<tr>
|
460
|
+
<td>Extensiones de Archivo</td>
|
461
|
+
<td><tt>.erb</tt>, <tt>.rhtml</tt> o <tt>.erubis</tt> (solamente con Erubis)</td>
|
462
|
+
</tr>
|
463
|
+
<tr>
|
464
|
+
<td>Ejemplo</td>
|
465
|
+
<td><tt>erb :index</tt></td>
|
466
|
+
</tr>
|
467
|
+
</table>
|
468
|
+
|
469
|
+
### Plantillas Builder
|
470
|
+
|
471
|
+
<table>
|
472
|
+
<tr>
|
473
|
+
<td>Dependencias</td>
|
474
|
+
<td>
|
475
|
+
<a href="http://builder.rubyforge.org/" title="builder">builder</a>
|
476
|
+
</td>
|
477
|
+
</tr>
|
478
|
+
<tr>
|
479
|
+
<td>Extensiones de Archivo</td>
|
480
|
+
<td><tt>.builder</tt></td>
|
481
|
+
</tr>
|
482
|
+
<tr>
|
483
|
+
<td>Ejemplo</td>
|
484
|
+
<td><tt>builder { |xml| xml.em "hola" }</tt></td>
|
485
|
+
</tr>
|
486
|
+
</table>
|
487
|
+
|
488
|
+
Además, acepta un bloque con la definición de la plantilla (ver el ejemplo).
|
489
|
+
|
490
|
+
### Plantillas Nokogiri
|
491
|
+
|
492
|
+
<table>
|
493
|
+
<tr>
|
494
|
+
<td>Dependencias</td>
|
495
|
+
<td><a href="http://nokogiri.org/" title="nokogiri">nokogiri</a></td>
|
496
|
+
</tr>
|
497
|
+
<tr>
|
498
|
+
<td>Extensiones de Archivo</td>
|
499
|
+
<td><tt>.nokogiri</tt></td>
|
500
|
+
</tr>
|
501
|
+
<tr>
|
502
|
+
<td>Ejemplo</td>
|
503
|
+
<td><tt>nokogiri { |xml| xml.em "hola" }</tt></td>
|
504
|
+
</tr>
|
505
|
+
</table>
|
506
|
+
|
507
|
+
Además, acepta un bloque con la definición de la plantilla (ver el ejemplo).
|
508
|
+
|
509
|
+
### Plantillas Sass
|
510
|
+
|
511
|
+
<table>
|
512
|
+
<tr>
|
513
|
+
<td>Dependencias</td>
|
514
|
+
<td><a href="http://sass-lang.com/" title="sass">sass</a></td>
|
515
|
+
</tr>
|
516
|
+
<tr>
|
517
|
+
<td>Extensiones de Archivo</td>
|
518
|
+
<td><tt>.sass</tt></td>
|
519
|
+
</tr>
|
520
|
+
<tr>
|
521
|
+
<td>Ejemplo</td>
|
522
|
+
<td><tt>sass :stylesheet, :style => :expanded</tt></td>
|
523
|
+
</tr>
|
524
|
+
</table>
|
525
|
+
|
526
|
+
### Plantillas SCSS
|
527
|
+
|
528
|
+
<table>
|
529
|
+
<tr>
|
530
|
+
<td>Dependencias</td>
|
531
|
+
<td><a href="http://sass-lang.com/" title="sass">sass</a></td>
|
532
|
+
</tr>
|
533
|
+
<tr>
|
534
|
+
<td>Extensiones de Archivo</td>
|
535
|
+
<td><tt>.scss</tt></td>
|
536
|
+
</tr>
|
537
|
+
<tr>
|
538
|
+
<td>Ejemplo</td>
|
539
|
+
<td><tt>scss :stylesheet, :style => :expanded</tt></td>
|
540
|
+
</tr>
|
541
|
+
</table>
|
542
|
+
|
543
|
+
### Plantillas Less
|
544
|
+
|
545
|
+
<table>
|
546
|
+
<tr>
|
547
|
+
<td>Dependencias</td>
|
548
|
+
<td><a href="http://www.lesscss.org/" title="less">less</a></td>
|
549
|
+
</tr>
|
550
|
+
<tr>
|
551
|
+
<td>Extensiones de Archivo</td>
|
552
|
+
<td><tt>.less</tt></td>
|
553
|
+
</tr>
|
554
|
+
<tr>
|
555
|
+
<td>Ejemplo</td>
|
556
|
+
<td><tt>less :stylesheet</tt></td>
|
557
|
+
</tr>
|
558
|
+
</table>
|
559
|
+
|
560
|
+
### Plantillas Liquid
|
561
|
+
|
562
|
+
<table>
|
563
|
+
<tr>
|
564
|
+
<td>Dependencias</td>
|
565
|
+
<td><a href="http://www.liquidmarkup.org/" title="liquid">liquid</a></td>
|
566
|
+
</tr>
|
567
|
+
<tr>
|
568
|
+
<td>Extensiones de Archivo</td>
|
569
|
+
<td><tt>.liquid</tt></td>
|
570
|
+
</tr>
|
571
|
+
<tr>
|
572
|
+
<td>Ejemplo</td>
|
573
|
+
<td><tt>liquid :index, :locals => { :clave => 'valor' }</tt></td>
|
574
|
+
</tr>
|
575
|
+
</table>
|
576
|
+
|
577
|
+
Como no vas a poder llamar a métodos de Ruby (excepto por `yield`) desde una
|
578
|
+
plantilla Liquid, casi siempre vas a querer pasarle locales.
|
579
|
+
|
580
|
+
### Plantillas Markdown
|
581
|
+
|
582
|
+
<table>
|
583
|
+
<tr>
|
584
|
+
<td>Dependencias</td>
|
585
|
+
<td>
|
586
|
+
<a href="https://github.com/rtomayko/rdiscount" title="RDiscount">RDiscount</a>,
|
587
|
+
<a href="https://github.com/vmg/redcarpet" title="RedCarpet">RedCarpet</a>,
|
588
|
+
<a href="http://deveiate.org/projects/BlueCloth" title="BlueCloth">BlueCloth</a>,
|
589
|
+
<a href="http://kramdown.rubyforge.org/" title="kramdown">kramdown</a> o
|
590
|
+
<a href="http://maruku.rubyforge.org/" title="maruku">maruku</a>
|
591
|
+
</td>
|
592
|
+
</tr>
|
593
|
+
<tr>
|
594
|
+
<td>Extensiones de Archivo</td>
|
595
|
+
<td><tt>.markdown</tt>, <tt>.mkd</tt> y <tt>.md</tt></td>
|
596
|
+
</tr>
|
597
|
+
<tr>
|
598
|
+
<td>Ejemplo</td>
|
599
|
+
<td><tt>markdown :index, :layout_engine => :erb</tt></td>
|
600
|
+
</tr>
|
601
|
+
</table>
|
602
|
+
|
603
|
+
No es posible llamar métodos desde markdown, ni pasarle locales. Por lo tanto,
|
604
|
+
generalmente vas a usarlo en combinación con otro motor de renderizado:
|
605
|
+
|
606
|
+
``` ruby
|
607
|
+
erb :resumen, :locals => { :texto => markdown(:introduccion) }
|
608
|
+
```
|
609
|
+
|
610
|
+
Tené en cuenta que también podés llamar al método `markdown` desde otras
|
611
|
+
plantillas:
|
612
|
+
|
613
|
+
``` ruby
|
614
|
+
%h1 Hola Desde Haml!
|
615
|
+
%p= markdown(:saludos)
|
616
|
+
```
|
617
|
+
|
618
|
+
Como no podés utilizar Ruby desde Markdown, no podés usar layouts escritos en
|
619
|
+
Markdown. De todos modos, es posible usar un motor de renderizado para el
|
620
|
+
layout distinto al de la plantilla pasando la opción `:layout_engine`.
|
621
|
+
|
622
|
+
### Plantillas Textile
|
623
|
+
|
624
|
+
<table>
|
625
|
+
<tr>
|
626
|
+
<td>Dependencias</td>
|
627
|
+
<td><a href="http://redcloth.org/" title="RedCloth">RedCloth</a></td>
|
628
|
+
</tr>
|
629
|
+
<tr>
|
630
|
+
<td>Extensiones de Archivo</td>
|
631
|
+
<td><tt>.textile</tt></td>
|
632
|
+
</tr>
|
633
|
+
<tr>
|
634
|
+
<td>Ejemplo</td>
|
635
|
+
<td><tt>textile :index, :layout_engine => :erb</tt></td>
|
636
|
+
</tr>
|
637
|
+
</table>
|
638
|
+
|
639
|
+
No es posible llamar métodos desde textile, ni pasarle locales. Por lo tanto,
|
640
|
+
generalmente vas a usarlo en combinación con otro motor de renderizado:
|
641
|
+
|
642
|
+
``` ruby
|
643
|
+
erb :resumen, :locals => { :texto => textile(:introduccion) }
|
644
|
+
```
|
645
|
+
|
646
|
+
Tené en cuenta que también podés llamar al método `textile` desde otras
|
647
|
+
plantillas:
|
648
|
+
|
649
|
+
``` ruby
|
650
|
+
%h1 Hola Desde Haml!
|
651
|
+
%p= textile(:saludos)
|
652
|
+
```
|
653
|
+
|
654
|
+
Como no podés utilizar Ruby desde Textile, no podés usar layouts escritos en
|
655
|
+
Textile. De todos modos, es posible usar un motor de renderizado para el
|
656
|
+
layout distinto al de la plantilla pasando la opción `:layout_engine`.
|
657
|
+
|
658
|
+
### Plantillas RDoc
|
659
|
+
|
660
|
+
<table>
|
661
|
+
<tr>
|
662
|
+
<td>Dependencias</td>
|
663
|
+
<td><a href="http://rdoc.rubyforge.org/" title="RDoc">RDoc</a></td>
|
664
|
+
</tr>
|
665
|
+
<tr>
|
666
|
+
<td>Extensiones de Archivo</td>
|
667
|
+
<td><tt>.rdoc</tt></td>
|
668
|
+
</tr>
|
669
|
+
<tr>
|
670
|
+
<td>Ejemplo</td>
|
671
|
+
<td><tt>rdoc :README, :layout_engine => :erb</tt></td>
|
672
|
+
</tr>
|
673
|
+
</table>
|
674
|
+
|
675
|
+
No es posible llamar métodos desde rdoc, ni pasarle locales. Por lo tanto,
|
676
|
+
generalmente vas a usarlo en combinación con otro motor de renderizado:
|
677
|
+
|
678
|
+
``` ruby
|
679
|
+
erb :resumen, :locals => { :texto => rdoc(:introduccion) }
|
680
|
+
```
|
681
|
+
|
682
|
+
Tené en cuenta que también podés llamar al método `rdoc` desde otras
|
683
|
+
plantillas:
|
684
|
+
|
685
|
+
``` ruby
|
686
|
+
%h1 Hola Desde Haml!
|
687
|
+
%p= rdoc(:saludos)
|
688
|
+
```
|
689
|
+
|
690
|
+
Como no podés utilizar Ruby desde RDoc, no podés usar layouts escritos en RDoc.
|
691
|
+
De todos modos, es posible usar un motor de renderizado para el layout distinto
|
692
|
+
al de la plantilla pasando la opción `:layout_engine`.
|
693
|
+
|
694
|
+
### Plantillas Radius
|
695
|
+
|
696
|
+
<table>
|
697
|
+
<tr>
|
698
|
+
<td>Dependencias</td>
|
699
|
+
<td><a href="http://radius.rubyforge.org/" title="Radius">Radius</a></td>
|
700
|
+
</tr>
|
701
|
+
<tr>
|
702
|
+
<td>Extensiones de Archivo</td>
|
703
|
+
<td><tt>.radius</tt></td>
|
704
|
+
</tr>
|
705
|
+
<tr>
|
706
|
+
<td>Ejemplo</td>
|
707
|
+
<td><tt>radius :index, :locals => { :clave => 'valor' }</tt></td>
|
708
|
+
</tr>
|
709
|
+
</table>
|
710
|
+
|
711
|
+
Como no vas a poder llamar a métodos de Ruby (excepto por `yield`) desde una
|
712
|
+
plantilla Radius, casi siempre vas a querer pasarle locales.
|
713
|
+
|
714
|
+
### Plantillas Markaby
|
715
|
+
|
716
|
+
<table>
|
717
|
+
<tr>
|
718
|
+
<td>Dependencias</td>
|
719
|
+
<td><a href="http://markaby.github.com/" title="Markaby">Markaby</a></td>
|
720
|
+
</tr>
|
721
|
+
<tr>
|
722
|
+
<td>Extensiones de Archivo</td>
|
723
|
+
<td><tt>.mab</tt></td>
|
724
|
+
</tr>
|
725
|
+
<tr>
|
726
|
+
<td>Ejemplo</td>
|
727
|
+
<td><tt>markaby { h1 "Bienvenido!" }</tt></td>
|
728
|
+
</tr>
|
729
|
+
</table>
|
730
|
+
|
731
|
+
Además, acepta un bloque con la definición de la plantilla (ver el ejemplo).
|
732
|
+
|
733
|
+
### Plantillas RABL
|
734
|
+
|
735
|
+
<table>
|
736
|
+
<tr>
|
737
|
+
<td>Dependencias</td>
|
738
|
+
<td><a href="https://github.com/nesquena/rabl" title="Rabl">Rabl</a></td>
|
739
|
+
</tr>
|
740
|
+
<tr>
|
741
|
+
<td>Extensiones de Archivo</td>
|
742
|
+
<td><tt>.rabl</tt></td>
|
743
|
+
</tr>
|
744
|
+
<tr>
|
745
|
+
<td>Ejemplo</td>
|
746
|
+
<td><tt>rabl :index</tt></td>
|
747
|
+
</tr>
|
748
|
+
</table>
|
749
|
+
|
750
|
+
### Plantillas Slim
|
751
|
+
|
752
|
+
<table>
|
753
|
+
<tr>
|
754
|
+
<td>Dependencias</td>
|
755
|
+
<td><a href="http://slim-lang.com/" title="Slim Lang">Slim Lang</a></td>
|
756
|
+
</tr>
|
757
|
+
<tr>
|
758
|
+
<td>Extensiones de Archivo</td>
|
759
|
+
<td><tt>.slim</tt></td>
|
760
|
+
</tr>
|
761
|
+
<tr>
|
762
|
+
<td>Ejemplo</td>
|
763
|
+
<td><tt>slim :index</tt></td>
|
764
|
+
</tr>
|
765
|
+
</table>
|
766
|
+
|
767
|
+
### Plantillas Creole
|
768
|
+
|
769
|
+
<table>
|
770
|
+
<tr>
|
771
|
+
<td>Dependencias</td>
|
772
|
+
<td><a href="https://github.com/minad/creole" title="Creole">Creole</a></td>
|
773
|
+
</tr>
|
774
|
+
<tr>
|
775
|
+
<td>Extensiones de Archivo</td>
|
776
|
+
<td><tt>.creole</tt></td>
|
777
|
+
</tr>
|
778
|
+
<tr>
|
779
|
+
<td>Ejemplo</td>
|
780
|
+
<td><tt>creole :wiki, :layout_engine => :erb</tt></td>
|
781
|
+
</tr>
|
782
|
+
</table>
|
783
|
+
|
784
|
+
No es posible llamar métodos desde creole, ni pasarle locales. Por lo tanto,
|
785
|
+
generalmente vas a usarlo en combinación con otro motor de renderizado:
|
786
|
+
|
787
|
+
``` ruby
|
788
|
+
erb :resumen, :locals => { :texto => cerole(:introduccion) }
|
789
|
+
```
|
790
|
+
|
791
|
+
Tené en cuenta que también podés llamar al método `creole` desde otras
|
792
|
+
plantillas:
|
793
|
+
|
794
|
+
``` ruby
|
795
|
+
%h1 Hola Desde Haml!
|
796
|
+
%p= creole(:saludos)
|
797
|
+
```
|
798
|
+
|
799
|
+
Como no podés utilizar Ruby desde Creole, no podés usar layouts escritos en
|
800
|
+
Creloe. De todos modos, es posible usar un motor de renderizado para el layout
|
801
|
+
distinto al de la plantilla pasando la opción `:layout_engine`.
|
802
|
+
|
803
|
+
### Plantillas CoffeeScript
|
804
|
+
|
805
|
+
<table>
|
806
|
+
<tr>
|
807
|
+
<td>Dependencias</td>
|
808
|
+
<td>
|
809
|
+
<a href="https://github.com/josh/ruby-coffee-script" title="Ruby CoffeeScript">
|
810
|
+
CoffeeScript
|
811
|
+
</a> y un
|
812
|
+
<a href="https://github.com/sstephenson/execjs/blob/master/README.md#readme" title="ExecJS">
|
813
|
+
mecanismo para ejecutar javascript
|
814
|
+
</a>
|
815
|
+
</td>
|
816
|
+
</tr>
|
817
|
+
<tr>
|
818
|
+
<td>Extensiones de Archivo</td>
|
819
|
+
<td><tt>.coffee</tt></td>
|
820
|
+
</tr>
|
821
|
+
<tr>
|
822
|
+
<td>Ejemplo</td>
|
823
|
+
<td><tt>coffee :index</tt></td>
|
824
|
+
</tr>
|
825
|
+
</table>
|
826
|
+
|
827
|
+
### Plantillas Stylus
|
828
|
+
|
829
|
+
<table>
|
830
|
+
<tr>
|
831
|
+
<td>Dependencias</td>
|
832
|
+
<td>
|
833
|
+
<a href="https://github.com/lucasmazza/ruby-stylus" title="Ruby Stylus">
|
834
|
+
Stylus
|
835
|
+
</a> y un
|
836
|
+
<a href="https://github.com/sstephenson/execjs/blob/master/README.md#readme" title="ExecJS">
|
837
|
+
mecanismo para ejecutar javascript
|
838
|
+
</a>
|
839
|
+
</td>
|
840
|
+
</tr>
|
841
|
+
<tr>
|
842
|
+
<td>Extensiones de Archivo</td>
|
843
|
+
<td><tt>.styl</tt></td>
|
844
|
+
</tr>
|
845
|
+
<tr>
|
846
|
+
<td>Ejemplo</td>
|
847
|
+
<td><tt>stylus :index</tt></td>
|
848
|
+
</tr>
|
849
|
+
</table>
|
850
|
+
|
851
|
+
### Plantillas Yajl
|
852
|
+
|
853
|
+
<table>
|
854
|
+
<tr>
|
855
|
+
<td>Dependencias</td>
|
856
|
+
<td><a href="https://github.com/brianmario/yajl-ruby" title="yajl-ruby">yajl-ruby</a></td>
|
857
|
+
</tr>
|
858
|
+
<tr>
|
859
|
+
<td>Extensiones de Archivo</td>
|
860
|
+
<td><tt>.yajl</tt></td>
|
861
|
+
</tr>
|
862
|
+
<tr>
|
863
|
+
<td>Ejemplo</td>
|
864
|
+
<td>
|
865
|
+
<tt>
|
866
|
+
yajl :index,
|
867
|
+
:locals => { :key => 'qux' },
|
868
|
+
:callback => 'present',
|
869
|
+
:variable => 'resource'
|
870
|
+
</tt>
|
871
|
+
</td>
|
872
|
+
</tr>
|
873
|
+
</table>
|
874
|
+
|
875
|
+
|
876
|
+
El contenido de La plantilla se evalúa como código Ruby, y la variable `json` es convertida a JSON mediante `#to_json`.
|
877
|
+
|
878
|
+
``` ruby
|
879
|
+
json = { :foo => 'bar' }
|
880
|
+
json[:baz] = key
|
881
|
+
```
|
882
|
+
|
883
|
+
Las opciones `:callback` y `:variable` se pueden utilizar para decorar el objeto renderizado:
|
884
|
+
|
885
|
+
``` ruby
|
886
|
+
var resource = {"foo":"bar","baz":"qux"}; present(resource);
|
887
|
+
```
|
888
|
+
|
889
|
+
### Plantillas WLang
|
890
|
+
|
891
|
+
<table>
|
892
|
+
<tr>
|
893
|
+
<td>Dependencias</td>
|
894
|
+
<td><a href="https://github.com/blambeau/wlang/" title="wlang">wlang</a></td>
|
895
|
+
</tr>
|
896
|
+
<tr>
|
897
|
+
<td>Extensiones de Archivo</td>
|
898
|
+
<td><tt>.wlang</tt></td>
|
899
|
+
</tr>
|
900
|
+
<tr>
|
901
|
+
<td>Ejemplo</td>
|
902
|
+
<td><tt>wlang :index, :locals => { :clave => 'valor' }</tt></td>
|
903
|
+
</tr>
|
904
|
+
</table>
|
905
|
+
|
906
|
+
Como no vas a poder llamar a métodos de Ruby (excepto por `yield`) desde una
|
907
|
+
plantilla WLang, casi siempre vas a querer pasarle locales.
|
908
|
+
|
909
|
+
### Plantillas Embebidas
|
910
|
+
|
911
|
+
``` ruby
|
912
|
+
get '/' do
|
913
|
+
haml '%div.titulo Hola Mundo'
|
914
|
+
end
|
915
|
+
```
|
916
|
+
|
917
|
+
Renderiza el template embebido en el string.
|
918
|
+
|
919
|
+
### Accediendo a Variables en Plantillas
|
920
|
+
|
921
|
+
Las plantillas son evaluadas dentro del mismo contexto que los manejadores de
|
922
|
+
ruta. Las variables de instancia asignadas en los manejadores de ruta son
|
923
|
+
accesibles directamente por las plantillas:
|
924
|
+
|
925
|
+
``` ruby
|
926
|
+
get '/:id' do
|
927
|
+
@foo = Foo.find(params[:id])
|
928
|
+
haml '%h1= @foo.nombre'
|
929
|
+
end
|
930
|
+
```
|
931
|
+
|
932
|
+
O es posible especificar un Hash de variables locales explícitamente:
|
933
|
+
|
934
|
+
``` ruby
|
935
|
+
get '/:id' do
|
936
|
+
foo = Foo.find(params[:id])
|
937
|
+
haml '%h1= bar.nombre', :locals => { :bar => foo }
|
938
|
+
end
|
939
|
+
```
|
940
|
+
|
941
|
+
Esto es usado típicamente cuando se renderizan plantillas como parciales desde
|
942
|
+
adentro de otras plantillas.
|
943
|
+
|
944
|
+
### Plantillas Inline
|
945
|
+
|
946
|
+
Las plantillas pueden ser definidas al final del archivo fuente:
|
947
|
+
|
948
|
+
``` ruby
|
949
|
+
require 'rubygems'
|
950
|
+
require 'sinatra'
|
951
|
+
|
952
|
+
get '/' do
|
953
|
+
haml :index
|
954
|
+
end
|
955
|
+
|
956
|
+
__END__
|
957
|
+
|
958
|
+
@@ layout
|
959
|
+
%html
|
960
|
+
= yield
|
961
|
+
|
962
|
+
@@ index
|
963
|
+
%div.titulo Hola mundo!!!!!
|
964
|
+
```
|
965
|
+
|
966
|
+
NOTA: únicamente las plantillas inline definidas en el archivo fuente que
|
967
|
+
requiere sinatra son cargadas automáticamente. Llamá `enable
|
968
|
+
:inline_templates` explícitamente si tenés plantillas inline en otros
|
969
|
+
archivos fuente.
|
970
|
+
|
971
|
+
### Plantillas Nombradas
|
972
|
+
|
973
|
+
Las plantillas también pueden ser definidas usando el método top-level
|
974
|
+
`template`:
|
975
|
+
|
976
|
+
``` ruby
|
977
|
+
template :layout do
|
978
|
+
"%html\n =yield\n"
|
979
|
+
end
|
980
|
+
|
981
|
+
template :index do
|
982
|
+
'%div.titulo Hola Mundo!'
|
983
|
+
end
|
984
|
+
|
985
|
+
get '/' do
|
986
|
+
haml :index
|
987
|
+
end
|
988
|
+
```
|
989
|
+
|
990
|
+
Si existe una plantilla con el nombre "layout", va a ser usada cada vez que
|
991
|
+
una plantilla es renderizada. Podés desactivar los layouts individualmente
|
992
|
+
pasando `:layout => false` o globalmente con
|
993
|
+
`set :haml, :layout => false`:
|
994
|
+
|
995
|
+
``` ruby
|
996
|
+
get '/' do
|
997
|
+
haml :index, :layout => !request.xhr?
|
998
|
+
end
|
999
|
+
```
|
1000
|
+
|
1001
|
+
### Asociando Extensiones de Archivo
|
1002
|
+
|
1003
|
+
Para asociar una extensión de archivo con un motor de renderizado, usá
|
1004
|
+
`Tilt.register`. Por ejemplo, si querés usar la extensión `tt` para
|
1005
|
+
las plantillas Textile, podés hacer lo siguiente:
|
1006
|
+
|
1007
|
+
``` ruby
|
1008
|
+
Tilt.register :tt, Tilt[:textile]
|
1009
|
+
```
|
1010
|
+
|
1011
|
+
### Agregando Tu Propio Motor de Renderizado
|
1012
|
+
|
1013
|
+
Primero, registrá tu motor con Tilt, y después, creá tu método de renderizado:
|
1014
|
+
|
1015
|
+
``` ruby
|
1016
|
+
Tilt.register :mipg, MiMotorParaPlantillaGenial
|
1017
|
+
|
1018
|
+
helpers do
|
1019
|
+
def mypg(*args) render(:mypg, *args) end
|
1020
|
+
end
|
1021
|
+
|
1022
|
+
get '/' do
|
1023
|
+
mypg :index
|
1024
|
+
end
|
1025
|
+
```
|
1026
|
+
|
1027
|
+
Renderiza `./views/index.mypg`. Mirá https://github.com/rtomayko/tilt
|
1028
|
+
para aprender más de Tilt.
|
1029
|
+
|
1030
|
+
## Filtros
|
1031
|
+
|
1032
|
+
Los filtros `before` son evaluados antes de cada petición dentro del mismo
|
1033
|
+
contexto que las rutas. Pueden modificar la petición y la respuesta. Las
|
1034
|
+
variables de instancia asignadas en los filtros son accesibles por las rutas y
|
1035
|
+
las plantillas:
|
1036
|
+
|
1037
|
+
``` ruby
|
1038
|
+
before do
|
1039
|
+
@nota = 'Hey!'
|
1040
|
+
request.path_info = '/foo/bar/baz'
|
1041
|
+
end
|
1042
|
+
|
1043
|
+
get '/foo/*' do
|
1044
|
+
@nota #=> 'Hey!'
|
1045
|
+
params[:splat] #=> 'bar/baz'
|
1046
|
+
end
|
1047
|
+
```
|
1048
|
+
|
1049
|
+
Los filtros `after` son evaluados después de cada petición dentro del mismo
|
1050
|
+
contexto y también pueden modificar la petición y la respuesta. Las variables
|
1051
|
+
de instancia asignadas en los filtros `before` y en las rutas son accesibles por
|
1052
|
+
los filtros `after`:
|
1053
|
+
|
1054
|
+
``` ruby
|
1055
|
+
after do
|
1056
|
+
puts response.status
|
1057
|
+
end
|
1058
|
+
```
|
1059
|
+
|
1060
|
+
Nota: A menos que usés el método `body` en lugar de simplemente devolver un
|
1061
|
+
string desde una ruta, el cuerpo de la respuesta no va a estar disponible en
|
1062
|
+
un filtro after, debido a que todavía no se ha generado.
|
1063
|
+
|
1064
|
+
Los filtros aceptan un patrón opcional, que cuando está presente causa que los
|
1065
|
+
mismos sean evaluados únicamente si el path de la petición coincide con ese
|
1066
|
+
patrón:
|
1067
|
+
|
1068
|
+
``` ruby
|
1069
|
+
before '/protegido/*' do
|
1070
|
+
autenticar!
|
1071
|
+
end
|
1072
|
+
|
1073
|
+
after '/crear/:slug' do |slug|
|
1074
|
+
session[:ultimo_slug] = slug
|
1075
|
+
end
|
1076
|
+
```
|
1077
|
+
|
1078
|
+
Al igual que las rutas, los filtros también pueden aceptar condiciones:
|
1079
|
+
|
1080
|
+
``` ruby
|
1081
|
+
before :agent => /Songbird/ do
|
1082
|
+
# ...
|
1083
|
+
end
|
1084
|
+
|
1085
|
+
after '/blog/*', :host_name => 'ejemplo.com' do
|
1086
|
+
# ...
|
1087
|
+
end
|
1088
|
+
```
|
1089
|
+
|
1090
|
+
## Ayudantes
|
1091
|
+
|
1092
|
+
Usá el método top-level *helpers* para definir métodos ayudantes que
|
1093
|
+
pueden ser utilizados dentro de los manejadores de rutas y las plantillas:
|
1094
|
+
|
1095
|
+
``` ruby
|
1096
|
+
helpers do
|
1097
|
+
def bar(nombre)
|
1098
|
+
"#{nombre}bar"
|
1099
|
+
end
|
1100
|
+
end
|
1101
|
+
|
1102
|
+
get '/:nombre' do
|
1103
|
+
bar(params[:nombre])
|
1104
|
+
end
|
1105
|
+
```
|
1106
|
+
|
1107
|
+
Por cuestiones organizativas, puede resultar conveniente organizar los métodos
|
1108
|
+
ayudantes en distintos módulos:
|
1109
|
+
|
1110
|
+
``` ruby
|
1111
|
+
module FooUtils
|
1112
|
+
def foo(nombre) "#{nombre}foo" end
|
1113
|
+
end
|
1114
|
+
|
1115
|
+
module BarUtils
|
1116
|
+
def bar(nombre) "#{nombre}bar" end
|
1117
|
+
end
|
1118
|
+
|
1119
|
+
helpers FooUtils, BarUtils
|
1120
|
+
```
|
1121
|
+
|
1122
|
+
El efecto de utilizar *helpers* de esta manera es el mismo que resulta de
|
1123
|
+
incluir los módulos en la clase de la aplicación.
|
1124
|
+
|
1125
|
+
### Usando Sesiones
|
1126
|
+
|
1127
|
+
Una sesión es usada para mantener el estado a través de distintas peticiones.
|
1128
|
+
Cuando están activadas, tenés un hash de sesión para cada sesión de usuario:
|
1129
|
+
|
1130
|
+
``` ruby
|
1131
|
+
enable :sessions
|
1132
|
+
|
1133
|
+
get '/' do
|
1134
|
+
"valor = " << session[:valor].inspect
|
1135
|
+
end
|
1136
|
+
|
1137
|
+
get '/:valor' do
|
1138
|
+
session[:valor] = params[:valor]
|
1139
|
+
end
|
1140
|
+
```
|
1141
|
+
|
1142
|
+
Tené en cuenta que `enable :sessions` guarda todos los datos en una
|
1143
|
+
cookie, lo que no es siempre deseable (guardar muchos datos va a incrementar
|
1144
|
+
tu tráfico, por citar un ejemplo). Podés usar cualquier middleware Rack para
|
1145
|
+
manejar sesiones, de la misma manera que usarías cualquier otro middleware,
|
1146
|
+
pero con la salvedad de que *no* tenés que llamar a `enable :sessions`:
|
1147
|
+
|
1148
|
+
``` ruby
|
1149
|
+
use Rack::Session::Pool, :expire_after => 2592000
|
1150
|
+
|
1151
|
+
get '/' do
|
1152
|
+
"valor = " << session[:valor].inspect
|
1153
|
+
end
|
1154
|
+
|
1155
|
+
get '/:valor' do
|
1156
|
+
session[:valor] = params[:valor]
|
1157
|
+
end
|
1158
|
+
```
|
1159
|
+
|
1160
|
+
Para incrementar la seguridad, los datos de la sesión almacenados en
|
1161
|
+
la cookie son firmados con un secreto de sesión. Este secreto, es
|
1162
|
+
generado aleatoriamente por Sinatra. De cualquier manera, hay que
|
1163
|
+
tener en cuenta que cada vez que inicies la aplicación se va a generar
|
1164
|
+
uno nuevo. Así, si querés que todas las instancias de tu aplicación
|
1165
|
+
compartan un único secreto, tenés que definirlo vos:
|
1166
|
+
|
1167
|
+
``` ruby
|
1168
|
+
set :session_secret, 'super secreto'
|
1169
|
+
```
|
1170
|
+
|
1171
|
+
Si necesitás una configuración más específica, `sessions` acepta un
|
1172
|
+
Hash con opciones:
|
1173
|
+
|
1174
|
+
``` ruby
|
1175
|
+
set :sessions, :domain => 'foo.com'
|
1176
|
+
```
|
1177
|
+
|
1178
|
+
### Interrupción
|
1179
|
+
|
1180
|
+
Para detener inmediatamente una petición dentro de un filtro o una ruta usá:
|
1181
|
+
|
1182
|
+
``` ruby
|
1183
|
+
halt
|
1184
|
+
```
|
1185
|
+
|
1186
|
+
También podés especificar el estado:
|
1187
|
+
|
1188
|
+
``` ruby
|
1189
|
+
halt 410
|
1190
|
+
```
|
1191
|
+
|
1192
|
+
O el cuerpo:
|
1193
|
+
|
1194
|
+
``` ruby
|
1195
|
+
halt 'esto va a ser el cuerpo'
|
1196
|
+
```
|
1197
|
+
|
1198
|
+
O los dos:
|
1199
|
+
|
1200
|
+
``` ruby
|
1201
|
+
halt 401, 'salí de acá!'
|
1202
|
+
```
|
1203
|
+
|
1204
|
+
Con cabeceras:
|
1205
|
+
|
1206
|
+
``` ruby
|
1207
|
+
halt 402, { 'Content-Type' => 'text/plain' }, 'venganza'
|
1208
|
+
```
|
1209
|
+
|
1210
|
+
Obviamente, es posible utilizar `halt` con una plantilla:
|
1211
|
+
|
1212
|
+
``` ruby
|
1213
|
+
halt erb(:error)
|
1214
|
+
```
|
1215
|
+
|
1216
|
+
### Paso
|
1217
|
+
|
1218
|
+
Una ruta puede pasarle el procesamiento a la siguiente ruta que coincida con
|
1219
|
+
la petición usando `pass`:
|
1220
|
+
|
1221
|
+
``` ruby
|
1222
|
+
get '/adivina/:quien' do
|
1223
|
+
pass unless params[:quien] == 'Franco'
|
1224
|
+
'Adivinaste!'
|
1225
|
+
end
|
1226
|
+
|
1227
|
+
get '/adivina/*' do
|
1228
|
+
'Erraste!'
|
1229
|
+
end
|
1230
|
+
```
|
1231
|
+
|
1232
|
+
Se sale inmediatamente del bloque de la ruta y se le pasa el control a la
|
1233
|
+
siguiente ruta que coincida. Si no coincide ninguna ruta, se devuelve un 404.
|
1234
|
+
|
1235
|
+
### Ejecutando Otra Ruta
|
1236
|
+
|
1237
|
+
Cuando querés obtener el resultado de la llamada a una ruta, `pass` no te va a
|
1238
|
+
servir. Para lograr esto, podés usar `call`:
|
1239
|
+
|
1240
|
+
``` ruby
|
1241
|
+
get '/foo' do
|
1242
|
+
status, headers, body = call env.merge("PATH_INFO" => '/bar')
|
1243
|
+
[status, headers, body.map(&:upcase)]
|
1244
|
+
end
|
1245
|
+
|
1246
|
+
get '/bar' do
|
1247
|
+
"bar"
|
1248
|
+
end
|
1249
|
+
```
|
1250
|
+
|
1251
|
+
Notá que en el ejemplo anterior, es conveniente mover `"bar"` a un
|
1252
|
+
helper, y llamarlo desde `/foo` y `/bar`. Así, vas a simplificar
|
1253
|
+
las pruebas y a mejorar el rendimiento.
|
1254
|
+
|
1255
|
+
Si querés que la petición se envíe a la misma instancia de la aplicación en
|
1256
|
+
lugar de a otra, usá `call!` en lugar de `call`.
|
1257
|
+
|
1258
|
+
En la especificación de Rack podés encontrar más información sobre
|
1259
|
+
`call`.
|
1260
|
+
|
1261
|
+
### Asignando el Código de Estado, los Encabezados y el Cuerpo de una Respuesta
|
1262
|
+
|
1263
|
+
Es posible, y se recomienda, asignar el código de estado y el cuerpo de una
|
1264
|
+
respuesta con el valor de retorno de una ruta. De cualquier manera, en varios
|
1265
|
+
escenarios, puede que sea conveniente asignar el cuerpo en un punto arbitrario
|
1266
|
+
del flujo de ejecución con el método `body`. A partir de ahí, podés usar ese
|
1267
|
+
mismo método para acceder al cuerpo de la respuesta:
|
1268
|
+
|
1269
|
+
``` ruby
|
1270
|
+
get '/foo' do
|
1271
|
+
body "bar"
|
1272
|
+
end
|
1273
|
+
|
1274
|
+
after do
|
1275
|
+
puts body
|
1276
|
+
end
|
1277
|
+
```
|
1278
|
+
|
1279
|
+
También es posible pasarle un bloque a `body`, que será ejecutado por el Rack
|
1280
|
+
handler (podés usar esto para implementar streaming, mirá "Valores de retorno").
|
1281
|
+
|
1282
|
+
De manera similar, también podés asignar el código de estado y encabezados:
|
1283
|
+
|
1284
|
+
``` ruby
|
1285
|
+
get '/foo' do
|
1286
|
+
status 418
|
1287
|
+
headers \
|
1288
|
+
"Allow" => "BREW, POST, GET, PROPFIND, WHEN",
|
1289
|
+
"Refresh" => "Refresh: 20; http://www.ietf.org/rfc/rfc2324.txt"
|
1290
|
+
body "I'm a tea pot!"
|
1291
|
+
end
|
1292
|
+
```
|
1293
|
+
|
1294
|
+
También, al igual que `body`, tanto `status` como `headers` pueden utilizarse
|
1295
|
+
para obtener sus valores cuando no se les pasa argumentos.
|
1296
|
+
|
1297
|
+
### Streaming De Respuestas
|
1298
|
+
|
1299
|
+
A veces vas a querer empezar a enviar la respuesta a pesar de que todavía no
|
1300
|
+
terminaste de generar su cuerpo. También es posible que, en algunos casos,
|
1301
|
+
quieras seguir enviando información hasta que el cliente cierre la conexión.
|
1302
|
+
Cuando esto ocurra, el `stream` helper te va a ser de gran ayuda:
|
1303
|
+
|
1304
|
+
``` ruby
|
1305
|
+
get '/' do
|
1306
|
+
stream do |out|
|
1307
|
+
out << "Esto va a ser legen -\n"
|
1308
|
+
sleep 0.5
|
1309
|
+
out << " (esperalo) \n"
|
1310
|
+
sleep 1
|
1311
|
+
out << "- dario!\n"
|
1312
|
+
end
|
1313
|
+
end
|
1314
|
+
```
|
1315
|
+
|
1316
|
+
Podés implementar APIs de streaming,
|
1317
|
+
[Server-Sent Events](http://dev.w3.org/html5/eventsource/) y puede ser usado
|
1318
|
+
como base para [WebSockets](http://es.wikipedia.org/wiki/WebSockets). También
|
1319
|
+
puede ser usado para incrementar el throughput si solo una parte del contenido
|
1320
|
+
depende de un recurso lento.
|
1321
|
+
|
1322
|
+
Hay que tener en cuenta que el comportamiento del streaming, especialmente el
|
1323
|
+
número de peticiones concurrentes, depende del servidor web utilizado para
|
1324
|
+
servir la aplicación. Puede que algunos servidores, como es el caso de
|
1325
|
+
WEBRick, no soporten streaming directamente, así el cuerpo de la respuesta será
|
1326
|
+
enviado completamente de una vez cuando el bloque pasado a `stream` finalice su
|
1327
|
+
ejecución. Si estás usando Shotgun, el streaming no va a funcionar.
|
1328
|
+
|
1329
|
+
Cuando se pasa `keep_open` como parámetro, no se va a enviar el mensaje
|
1330
|
+
`close` al objeto de stream. Queda en vos cerrarlo en el punto de ejecución
|
1331
|
+
que quieras. Nuevamente, hay que tener en cuenta que este comportamiento es
|
1332
|
+
posible solo en servidores que soporten eventos, como Thin o Rainbows. El
|
1333
|
+
resto de los servidores van a cerrar el stream de todos modos:
|
1334
|
+
|
1335
|
+
``` ruby
|
1336
|
+
set :server, :thin
|
1337
|
+
conexiones = []
|
1338
|
+
|
1339
|
+
get '/' do
|
1340
|
+
# mantenemos abierto el stream
|
1341
|
+
stream(:keep_open) { |salida| conexiones << salida }
|
1342
|
+
end
|
1343
|
+
|
1344
|
+
post '/' do
|
1345
|
+
# escribimos a todos los streams abiertos
|
1346
|
+
conexiones.each { |salida| salida << params[:mensaje] << "\n" }
|
1347
|
+
"mensaje enviado"
|
1348
|
+
end
|
1349
|
+
```
|
1350
|
+
|
1351
|
+
### Log (Registro)
|
1352
|
+
|
1353
|
+
En el ámbito de la petición, el helper `logger` (registrador) expone
|
1354
|
+
una instancia de `Logger`:
|
1355
|
+
|
1356
|
+
``` ruby
|
1357
|
+
get '/' do
|
1358
|
+
logger.info "cargando datos"
|
1359
|
+
# ...
|
1360
|
+
end
|
1361
|
+
```
|
1362
|
+
|
1363
|
+
Este logger tiene en cuenta la configuración de logueo de tu Rack
|
1364
|
+
handler. Si el logueo está desactivado, este método va a devolver un
|
1365
|
+
objeto que se comporta como un logger pero que en realidad no hace
|
1366
|
+
nada. Así, no vas a tener que preocuparte por esta situación.
|
1367
|
+
|
1368
|
+
Tené en cuenta que el logueo está habilitado por defecto únicamente
|
1369
|
+
para `Sinatra::Application`. Si heredaste de
|
1370
|
+
`Sinatra::Base`, probablemente quieras habilitarlo manualmente:
|
1371
|
+
|
1372
|
+
``` ruby
|
1373
|
+
class MiApp < Sinatra::Base
|
1374
|
+
configure :production, :development do
|
1375
|
+
enable :logging
|
1376
|
+
end
|
1377
|
+
end
|
1378
|
+
```
|
1379
|
+
|
1380
|
+
Para evitar que se inicialice cualquier middleware de logging, configurá
|
1381
|
+
`logging` a `nil`. Tené en cuenta que, cuando hagas esto, `logger` va a
|
1382
|
+
devolver `nil`. Un caso común es cuando querés usar tu propio logger. Sinatra
|
1383
|
+
va a usar lo que encuentre en `env['rack.logger']`.
|
1384
|
+
|
1385
|
+
### Tipos Mime
|
1386
|
+
|
1387
|
+
Cuando usás `send_file` o archivos estáticos tal vez tengas tipos mime
|
1388
|
+
que Sinatra no entiende. Usá `mime_type` para registrarlos a través de la
|
1389
|
+
extensión de archivo:
|
1390
|
+
|
1391
|
+
``` ruby
|
1392
|
+
configure do
|
1393
|
+
mime_type :foo, 'text/foo'
|
1394
|
+
end
|
1395
|
+
```
|
1396
|
+
|
1397
|
+
También lo podés usar con el ayudante `content_type`:
|
1398
|
+
|
1399
|
+
``` ruby
|
1400
|
+
get '/' do
|
1401
|
+
content_type :foo
|
1402
|
+
"foo foo foo"
|
1403
|
+
end
|
1404
|
+
```
|
1405
|
+
|
1406
|
+
### Generando URLs
|
1407
|
+
|
1408
|
+
Para generar URLs deberías usar el método `url`. Por ejemplo, en Haml:
|
1409
|
+
|
1410
|
+
``` ruby
|
1411
|
+
%a{:href => url('/foo')} foo
|
1412
|
+
```
|
1413
|
+
|
1414
|
+
Tiene en cuenta proxies inversos y encaminadores de Rack, si están presentes.
|
1415
|
+
|
1416
|
+
Este método también puede invocarse mediante su alias `to` (mirá un ejemplo
|
1417
|
+
a continuación).
|
1418
|
+
|
1419
|
+
### Redirección del Navegador
|
1420
|
+
|
1421
|
+
Podés redireccionar al navegador con el método `redirect`:
|
1422
|
+
|
1423
|
+
``` ruby
|
1424
|
+
get '/foo' do
|
1425
|
+
redirect to('/bar')
|
1426
|
+
end
|
1427
|
+
```
|
1428
|
+
|
1429
|
+
Cualquier parámetro adicional se utiliza de la misma manera que los argumentos
|
1430
|
+
pasados a `halt`:
|
1431
|
+
|
1432
|
+
``` ruby
|
1433
|
+
redirect to('/bar'), 303
|
1434
|
+
redirect 'http://google.com', 'te confundiste de lugar, compañero'
|
1435
|
+
```
|
1436
|
+
|
1437
|
+
También podés redireccionar fácilmente de vuelta hacia la página desde donde
|
1438
|
+
vino el usuario con `redirect back`:
|
1439
|
+
|
1440
|
+
``` ruby
|
1441
|
+
get '/foo' do
|
1442
|
+
"<a href='/bar'>hacer algo</a>"
|
1443
|
+
end
|
1444
|
+
|
1445
|
+
get '/bar' do
|
1446
|
+
hacer_algo
|
1447
|
+
redirect back
|
1448
|
+
end
|
1449
|
+
```
|
1450
|
+
|
1451
|
+
Para pasar argumentos con una redirección, podés agregarlos a la cadena de
|
1452
|
+
búsqueda:
|
1453
|
+
|
1454
|
+
``` ruby
|
1455
|
+
redirect to('/bar?suma=42')
|
1456
|
+
```
|
1457
|
+
|
1458
|
+
O usar una sesión:
|
1459
|
+
|
1460
|
+
``` ruby
|
1461
|
+
enable :sessions
|
1462
|
+
|
1463
|
+
get '/foo' do
|
1464
|
+
session[:secreto] = 'foo'
|
1465
|
+
redirect to('/bar')
|
1466
|
+
end
|
1467
|
+
|
1468
|
+
get '/bar' do
|
1469
|
+
session[:secreto]
|
1470
|
+
end
|
1471
|
+
```
|
1472
|
+
|
1473
|
+
### Cache Control
|
1474
|
+
|
1475
|
+
Asignar tus encabezados correctamente es el cimiento para realizar un cacheo
|
1476
|
+
HTTP correcto.
|
1477
|
+
|
1478
|
+
Podés asignar el encabezado Cache-Control fácilmente:
|
1479
|
+
|
1480
|
+
``` ruby
|
1481
|
+
get '/' do
|
1482
|
+
cache_control :public
|
1483
|
+
"cachealo!"
|
1484
|
+
end
|
1485
|
+
```
|
1486
|
+
|
1487
|
+
Pro tip: configurar el cacheo en un filtro `before`:
|
1488
|
+
|
1489
|
+
``` ruby
|
1490
|
+
before do
|
1491
|
+
cache_control :public, :must_revalidate, :max_age => 60
|
1492
|
+
end
|
1493
|
+
```
|
1494
|
+
|
1495
|
+
Si estás usando el helper `expires` para definir el encabezado correspondiente,
|
1496
|
+
`Cache-Control` se va a definir automáticamente:
|
1497
|
+
|
1498
|
+
``` ruby
|
1499
|
+
before do
|
1500
|
+
expires 500, :public, :must_revalidate
|
1501
|
+
end
|
1502
|
+
```
|
1503
|
+
|
1504
|
+
Para usar cachés adecuadamente, deberías considerar usar `etag` o
|
1505
|
+
`last_modified`. Es recomendable que llames a estos helpers *antes* de hacer
|
1506
|
+
cualquier trabajo pesado, ya que van a enviar la respuesta inmediatamente si
|
1507
|
+
el cliente ya tiene la versión actual en su caché:
|
1508
|
+
|
1509
|
+
``` ruby
|
1510
|
+
get '/articulo/:id' do
|
1511
|
+
@articulo = Articulo.find params[:id]
|
1512
|
+
last_modified @articulo.updated_at
|
1513
|
+
etag @articulo.sha1
|
1514
|
+
erb :articulo
|
1515
|
+
end
|
1516
|
+
```
|
1517
|
+
|
1518
|
+
También es posible usar una
|
1519
|
+
[weak ETag](http://en.wikipedia.org/wiki/HTTP_ETag#Strong_and_weak_validation):
|
1520
|
+
|
1521
|
+
``` ruby
|
1522
|
+
etag @articulo.sha1, :weak
|
1523
|
+
```
|
1524
|
+
|
1525
|
+
Estos helpers no van a cachear nada por vos, sino que van a facilitar la
|
1526
|
+
información necesaria para poder hacerlo. Si estás buscando soluciones rápidas
|
1527
|
+
de cacheo con proxys inversos, mirá
|
1528
|
+
[rack-cache](https://github.com/rtomayko/rack-cache):
|
1529
|
+
|
1530
|
+
``` ruby
|
1531
|
+
require "rack/cache"
|
1532
|
+
require "sinatra"
|
1533
|
+
|
1534
|
+
use Rack::Cache
|
1535
|
+
|
1536
|
+
get '/' do
|
1537
|
+
cache_control :public, :max_age => 36000
|
1538
|
+
sleep 5
|
1539
|
+
"hola"
|
1540
|
+
end
|
1541
|
+
```
|
1542
|
+
|
1543
|
+
Usá la configuración `:static_cache_control` para agregar el encabezado
|
1544
|
+
`Cache-Control` a archivos estáticos (ver la sección de configuración
|
1545
|
+
para más detalles).
|
1546
|
+
|
1547
|
+
De acuerdo con la RFC 2616 tu aplicación debería comportarse diferente si a las
|
1548
|
+
cabeceras If-Match o If-None-Match se le asigna el valor `*` cuando el
|
1549
|
+
recurso solicitado ya existe. Sinatra asume para peticiones seguras (como get)
|
1550
|
+
e idempotentes (como put) que el recurso existe, mientras que para el resto
|
1551
|
+
(como post), que no. Podes cambiar este comportamiento con la opción
|
1552
|
+
`:new_resource`:
|
1553
|
+
|
1554
|
+
``` ruby
|
1555
|
+
get '/crear' do
|
1556
|
+
etag '', :new_resource => true
|
1557
|
+
Articulo.create
|
1558
|
+
erb :nuevo_articulo
|
1559
|
+
end
|
1560
|
+
```
|
1561
|
+
|
1562
|
+
Si querés seguir usando una weak ETag, indicalo con la opción `:kind`:
|
1563
|
+
|
1564
|
+
``` ruby
|
1565
|
+
etag '', :new_resource => true, :kind => :weak
|
1566
|
+
```
|
1567
|
+
|
1568
|
+
### Enviando Archivos
|
1569
|
+
|
1570
|
+
Para enviar archivos, podés usar el método `send_file`:
|
1571
|
+
|
1572
|
+
``` ruby
|
1573
|
+
get '/' do
|
1574
|
+
send_file 'foo.png'
|
1575
|
+
end
|
1576
|
+
```
|
1577
|
+
|
1578
|
+
Además acepta un par de opciones:
|
1579
|
+
|
1580
|
+
``` ruby
|
1581
|
+
send_file 'foo.png', :type => :jpg
|
1582
|
+
```
|
1583
|
+
|
1584
|
+
Estas opciones son:
|
1585
|
+
|
1586
|
+
[filename]
|
1587
|
+
nombre del archivo devuelto, por defecto es el nombre real del archivo.
|
1588
|
+
|
1589
|
+
[last_modified]
|
1590
|
+
valor para el encabezado Last-Modified, por defecto toma el mtime del archivo.
|
1591
|
+
|
1592
|
+
[type]
|
1593
|
+
el content type que se va a utilizar, si no está presente se intenta adivinar
|
1594
|
+
a partir de la extensión del archivo.
|
1595
|
+
|
1596
|
+
[disposition]
|
1597
|
+
se utiliza para el encabezado Content-Disposition, y puede tomar alguno de los
|
1598
|
+
siguientes valores: `nil` (por defecto), `:attachment` e
|
1599
|
+
`:inline`
|
1600
|
+
|
1601
|
+
[length]
|
1602
|
+
encabezado Content-Length, por defecto toma el tamaño del archivo.
|
1603
|
+
|
1604
|
+
[status]
|
1605
|
+
código de estado devuelto. Resulta útil al enviar un archivo estático como una
|
1606
|
+
página de error.
|
1607
|
+
|
1608
|
+
Si el Rack handler lo soporta, se intentará no transmitir directamente desde el
|
1609
|
+
proceso de Ruby. Si usás este método, Sinatra se va a encargar automáticamente
|
1610
|
+
peticiones de rango.
|
1611
|
+
|
1612
|
+
### Accediendo al objeto de la petición
|
1613
|
+
|
1614
|
+
El objeto de la petición entrante puede ser accedido desde el nivel de la
|
1615
|
+
petición (filtros, rutas y manejadores de errores) a través del método
|
1616
|
+
`request`:
|
1617
|
+
|
1618
|
+
``` ruby
|
1619
|
+
# app corriendo en http://ejemplo.com/ejemplo
|
1620
|
+
get '/foo' do
|
1621
|
+
t = %w[text/css text/html application/javascript]
|
1622
|
+
request.accept # ['text/html', '*/*']
|
1623
|
+
request.accept? 'text/xml' # true
|
1624
|
+
request.preferred_type(t) # 'text/html'
|
1625
|
+
request.body # cuerpo de la petición enviado por el cliente (ver más abajo)
|
1626
|
+
request.scheme # "http"
|
1627
|
+
request.script_name # "/ejemplo"
|
1628
|
+
request.path_info # "/foo"
|
1629
|
+
request.port # 80
|
1630
|
+
request.request_method # "GET"
|
1631
|
+
request.query_string # ""
|
1632
|
+
request.content_length # longitud de request.body
|
1633
|
+
request.media_type # tipo de medio de request.body
|
1634
|
+
request.host # "ejemplo.com"
|
1635
|
+
request.get? # true (hay métodos análogos para los otros verbos)
|
1636
|
+
request.form_data? # false
|
1637
|
+
request["UNA_CABECERA"] # valor de la cabecera UNA_CABECERA
|
1638
|
+
request.referrer # la referencia del cliente o '/'
|
1639
|
+
request.user_agent # user agent (usado por la condición :agent)
|
1640
|
+
request.cookies # hash de las cookies del browser
|
1641
|
+
request.xhr? # es una petición ajax?
|
1642
|
+
request.url # "http://ejemplo.com/ejemplo/foo"
|
1643
|
+
request.path # "/ejemplo/foo"
|
1644
|
+
request.ip # dirección IP del cliente
|
1645
|
+
request.secure? # false (sería true sobre ssl)
|
1646
|
+
request.forwarded? # true (si se está corriendo atrás de un proxy inverso)
|
1647
|
+
requuest.env # hash de entorno directamente entregado por Rack
|
1648
|
+
end
|
1649
|
+
```
|
1650
|
+
|
1651
|
+
Algunas opciones, como `script_name` o `path_info` pueden
|
1652
|
+
también ser escritas:
|
1653
|
+
|
1654
|
+
``` ruby
|
1655
|
+
before { request.path_info = "/" }
|
1656
|
+
|
1657
|
+
get "/" do
|
1658
|
+
"todas las peticiones llegan acá"
|
1659
|
+
end
|
1660
|
+
```
|
1661
|
+
|
1662
|
+
El objeto `request.body` es una instancia de IO o StringIO:
|
1663
|
+
|
1664
|
+
``` ruby
|
1665
|
+
post "/api" do
|
1666
|
+
request.body.rewind # en caso de que alguien ya lo haya leído
|
1667
|
+
datos = JSON.parse request.body.read
|
1668
|
+
"Hola #{datos['nombre']}!"
|
1669
|
+
end
|
1670
|
+
```
|
1671
|
+
|
1672
|
+
### Archivos Adjuntos
|
1673
|
+
|
1674
|
+
Podés usar el método helper `attachment` para indicarle al navegador que
|
1675
|
+
almacene la respuesta en el disco en lugar de mostrarla en pantalla:
|
1676
|
+
|
1677
|
+
``` ruby
|
1678
|
+
get '/' do
|
1679
|
+
attachment
|
1680
|
+
"guardalo!"
|
1681
|
+
end
|
1682
|
+
```
|
1683
|
+
|
1684
|
+
También podés pasarle un nombre de archivo:
|
1685
|
+
|
1686
|
+
``` ruby
|
1687
|
+
get '/' do
|
1688
|
+
attachment "info.txt"
|
1689
|
+
"guardalo!"
|
1690
|
+
end
|
1691
|
+
```
|
1692
|
+
|
1693
|
+
### Fecha y Hora
|
1694
|
+
|
1695
|
+
Sinatra pone a tu disposición el helper `time_for`, que genera un objeto `Time`
|
1696
|
+
a partir del valor que recibe como argumento. Este valor puede ser un
|
1697
|
+
`String`, pero también es capaz de convertir objetos `DateTime`, `Date` y de
|
1698
|
+
otras clases similares:
|
1699
|
+
|
1700
|
+
``` ruby
|
1701
|
+
get '/' do
|
1702
|
+
pass if Time.now > time_for('Dec 23, 2012')
|
1703
|
+
"todavía hay tiempo"
|
1704
|
+
end
|
1705
|
+
```
|
1706
|
+
|
1707
|
+
Este método es usado internamente por métodos como `expires` y `last_modified`,
|
1708
|
+
entre otros. Por lo tanto, es posible extender el comportamiento de estos
|
1709
|
+
métodos sobreescribiendo `time_for` en tu aplicación:
|
1710
|
+
|
1711
|
+
``` ruby
|
1712
|
+
helpers do
|
1713
|
+
def time_for(value)
|
1714
|
+
case value
|
1715
|
+
when :ayer then Time.now - 24*60*60
|
1716
|
+
when :mañana then Time.now + 24*60*60
|
1717
|
+
else super
|
1718
|
+
end
|
1719
|
+
end
|
1720
|
+
end
|
1721
|
+
|
1722
|
+
get '/' do
|
1723
|
+
last_modified :ayer
|
1724
|
+
expires :mañana
|
1725
|
+
"hola"
|
1726
|
+
end
|
1727
|
+
```
|
1728
|
+
|
1729
|
+
### Buscando los Archivos de las Plantillas
|
1730
|
+
|
1731
|
+
El helper `find_template` se utiliza para encontrar los archivos de las
|
1732
|
+
plantillas que se van a renderizar:
|
1733
|
+
|
1734
|
+
``` ruby
|
1735
|
+
find_template settings.views, 'foo', Tilt[:haml] do |archivo|
|
1736
|
+
puts "podría ser #{archivo}"
|
1737
|
+
end
|
1738
|
+
```
|
1739
|
+
|
1740
|
+
Si bien esto no es muy útil, lo interesante es que podés sobreescribir este
|
1741
|
+
método, y así enganchar tu propio mecanismo de búsqueda. Por ejemplo, para
|
1742
|
+
poder utilizar más de un directorio de vistas:
|
1743
|
+
|
1744
|
+
``` ruby
|
1745
|
+
set :views, ['vistas', 'plantillas']
|
1746
|
+
|
1747
|
+
helpers do
|
1748
|
+
def find_template(views, name, engine, &block)
|
1749
|
+
Array(views).each { |v| super(v, name, engine, &block) }
|
1750
|
+
end
|
1751
|
+
end
|
1752
|
+
```
|
1753
|
+
|
1754
|
+
Otro ejemplo consiste en usar directorios diferentes para los distintos motores
|
1755
|
+
de renderizado:
|
1756
|
+
|
1757
|
+
``` ruby
|
1758
|
+
set :views, :sass => 'vistas/sass', :haml => 'plantillas', :defecto => 'vistas'
|
1759
|
+
|
1760
|
+
helpers do
|
1761
|
+
def find_template(views, name, engine, &block)
|
1762
|
+
_, folder = views.detect { |k,v| engine == Tilt[k] }
|
1763
|
+
folder ||= views[:defecto]
|
1764
|
+
super(folder, name, engine, &block)
|
1765
|
+
end
|
1766
|
+
end
|
1767
|
+
```
|
1768
|
+
|
1769
|
+
¡Es muy fácil convertir estos ejemplos en una extensión y compartirla!.
|
1770
|
+
|
1771
|
+
Notá que `find_template` no verifica si un archivo existe realmente, sino
|
1772
|
+
que llama al bloque que recibe para cada path posible. Esto no representa un
|
1773
|
+
problema de rendimiento debido a que `render` va a usar `break` ni bien
|
1774
|
+
encuentre un archivo que exista. Además, las ubicaciones de las plantillas (y
|
1775
|
+
su contenido) se cachean cuando no estás en el modo de desarrollo. Es bueno
|
1776
|
+
tener en cuenta lo anteiror si escribís un método medio loco.
|
1777
|
+
|
1778
|
+
## Configuración
|
1779
|
+
|
1780
|
+
Ejecutar una vez, en el inicio, en cualquier entorno:
|
1781
|
+
|
1782
|
+
``` ruby
|
1783
|
+
configure do
|
1784
|
+
# asignando una opción
|
1785
|
+
set :opcion, 'valor'
|
1786
|
+
|
1787
|
+
# asignando varias opciones
|
1788
|
+
set :a => 1, :b => 2
|
1789
|
+
|
1790
|
+
# atajo para `set :opcion, true`
|
1791
|
+
enable :opcion
|
1792
|
+
|
1793
|
+
# atajo para `set :opcion, false`
|
1794
|
+
disable :opcion
|
1795
|
+
|
1796
|
+
# también podés tener configuraciones dinámicas usando bloques
|
1797
|
+
set(:css_dir) { File.join(views, 'css') }
|
1798
|
+
end
|
1799
|
+
```
|
1800
|
+
|
1801
|
+
Ejecutar únicamente cuando el entorno (la variable de entorno RACK_ENV) es
|
1802
|
+
`:production`:
|
1803
|
+
|
1804
|
+
``` ruby
|
1805
|
+
configure :production do
|
1806
|
+
...
|
1807
|
+
end
|
1808
|
+
```
|
1809
|
+
|
1810
|
+
Ejecutar cuando el entorno es `:production` o `:test`:
|
1811
|
+
|
1812
|
+
``` ruby
|
1813
|
+
configure :production, :test do
|
1814
|
+
...
|
1815
|
+
end
|
1816
|
+
```
|
1817
|
+
|
1818
|
+
Podés acceder a estas opciones utilizando el método `settings`:
|
1819
|
+
|
1820
|
+
``` ruby
|
1821
|
+
configure do
|
1822
|
+
set :foo, 'bar'
|
1823
|
+
end
|
1824
|
+
|
1825
|
+
get '/' do
|
1826
|
+
settings.foo? # => true
|
1827
|
+
settings.foo # => 'bar'
|
1828
|
+
...
|
1829
|
+
end
|
1830
|
+
```
|
1831
|
+
|
1832
|
+
### Configurando la Protección de Ataques
|
1833
|
+
|
1834
|
+
Sinatra usa [Rack::Protection](https://github.com/rkh/rack-protection#readme)
|
1835
|
+
para defender a tu aplicación de los ataques más comunes. Si por algún motivo,
|
1836
|
+
querés desactivar esta funcionalidad, podés hacerlo como se indica a
|
1837
|
+
continuación (tené en cuenta que tu aplicación va a quedar expuesta a un
|
1838
|
+
montón de vulnerabilidades bien conocidas):
|
1839
|
+
|
1840
|
+
``` ruby
|
1841
|
+
disable :protection
|
1842
|
+
```
|
1843
|
+
|
1844
|
+
También es posible desactivar una única capa de defensa:
|
1845
|
+
|
1846
|
+
``` ruby
|
1847
|
+
set :protection, :except => :path_traversal
|
1848
|
+
```
|
1849
|
+
|
1850
|
+
O varias:
|
1851
|
+
|
1852
|
+
``` ruby
|
1853
|
+
set :protection, :except => [:path_traversal, :session_hijacking]
|
1854
|
+
```
|
1855
|
+
|
1856
|
+
### Configuraciones Disponibles
|
1857
|
+
|
1858
|
+
<dl>
|
1859
|
+
<dt>absolute_redirects</dt>
|
1860
|
+
<dd>
|
1861
|
+
Si está deshabilitada, Sinatra va a permitir
|
1862
|
+
redirecciones relativas, sin embargo, como consecuencia
|
1863
|
+
de esto, va a dejar de cumplir con el RFC 2616 (HTTP
|
1864
|
+
1.1), que solamente permite redirecciones absolutas.
|
1865
|
+
|
1866
|
+
Activalo si tu apliación está corriendo atrás de un proxy
|
1867
|
+
inverso que no se ha configurado adecuadamente. Notá que
|
1868
|
+
el helper <tt>url</tt> va a seguir produciendo URLs absolutas, a
|
1869
|
+
menos que le pasés <tt>false</tt> como segundo parámetro.
|
1870
|
+
|
1871
|
+
Deshabilitada por defecto.
|
1872
|
+
</dd>
|
1873
|
+
|
1874
|
+
<dt>add_charsets</dt>
|
1875
|
+
<dd>
|
1876
|
+
Tipos mime a los que el helper <tt>content_type</tt> les
|
1877
|
+
añade automáticamente el charset.
|
1878
|
+
|
1879
|
+
En general, no deberías asignar directamente esta opción,
|
1880
|
+
sino añadirle los charsets que quieras:
|
1881
|
+
<tt>settings.add_charsets << "application/foobar"</tt>
|
1882
|
+
</dd>
|
1883
|
+
|
1884
|
+
<dt>app_file</dt>
|
1885
|
+
<dd>
|
1886
|
+
Path del archivo principal de la aplicación, se utiliza
|
1887
|
+
para detectar la raíz del proyecto, el directorio de las
|
1888
|
+
vistas y el público, así como las plantillas inline.
|
1889
|
+
</dd>
|
1890
|
+
|
1891
|
+
<dt>bind</dt>
|
1892
|
+
<dd>
|
1893
|
+
Dirección IP que utilizará el servidor integrado (por
|
1894
|
+
defecto: 0.0.0.0).
|
1895
|
+
</dd>
|
1896
|
+
|
1897
|
+
<dt>default_encoding</dt>
|
1898
|
+
<dd>
|
1899
|
+
Encoding utilizado cuando el mismo se desconoce (por
|
1900
|
+
defecto <tt>"utf-8"</tt>).
|
1901
|
+
</dd>
|
1902
|
+
|
1903
|
+
<dt>dump_errors</dt>
|
1904
|
+
<dd>
|
1905
|
+
Mostrar errores en el log.
|
1906
|
+
</dd>
|
1907
|
+
|
1908
|
+
<dt>environment</dt>
|
1909
|
+
<dd>
|
1910
|
+
Entorno actual, por defecto toma el valor de
|
1911
|
+
<tt>ENV['RACK_ENV']</tt>, o <tt>"development"</tt> si no
|
1912
|
+
está disponible.
|
1913
|
+
</dd>
|
1914
|
+
|
1915
|
+
<dt>logging</dt>
|
1916
|
+
<dd>
|
1917
|
+
Define si se utiliza el logger.
|
1918
|
+
</dd>
|
1919
|
+
|
1920
|
+
<dt>lock</dt>
|
1921
|
+
<dd>
|
1922
|
+
Coloca un lock alrededor de cada petición, procesando
|
1923
|
+
solamente una por proceso.
|
1924
|
+
|
1925
|
+
Habilitá esta opción si tu aplicación no es thread-safe.
|
1926
|
+
Se encuentra deshabilitada por defecto.
|
1927
|
+
</dd>
|
1928
|
+
|
1929
|
+
<dt>method_override</dt>
|
1930
|
+
<dd>
|
1931
|
+
Utiliza el parámetro <tt>_method</tt> para permtir
|
1932
|
+
formularios put/delete en navegadores que no los
|
1933
|
+
soportan.
|
1934
|
+
</dd>
|
1935
|
+
|
1936
|
+
<dt>port</dt>
|
1937
|
+
<dd>
|
1938
|
+
Puerto en el que escuchará el servidor integrado.
|
1939
|
+
</dd>
|
1940
|
+
|
1941
|
+
<dt>prefixed_redirects</dt>
|
1942
|
+
<dd>
|
1943
|
+
Define si inserta <tt>request.script_name</tt> en las
|
1944
|
+
redirecciones cuando no se proporciona un path absoluto.
|
1945
|
+
De esta manera, cuando está habilitada,
|
1946
|
+
<tt>redirect '/foo'</tt> se comporta de la misma manera
|
1947
|
+
que <tt>redirect to('/foo')</tt>. Se encuentra
|
1948
|
+
deshabilitada por defecto.
|
1949
|
+
</dd>
|
1950
|
+
|
1951
|
+
<dt>protection</dt>
|
1952
|
+
<dd>
|
1953
|
+
Define si deben activarse las protecciones para los
|
1954
|
+
ataques web más comunes. Para más detalles mirá la
|
1955
|
+
sección sobre la configuración de protección de ataques
|
1956
|
+
más arriba.
|
1957
|
+
</dd>
|
1958
|
+
|
1959
|
+
<dt>public_dir</dt>
|
1960
|
+
<dd>
|
1961
|
+
Alias para <tt>public_folder</tt>, que se encuentra a
|
1962
|
+
continuación.
|
1963
|
+
</dd>
|
1964
|
+
|
1965
|
+
<dt>public_folder</dt>
|
1966
|
+
<dd>
|
1967
|
+
Path del directorio desde donde se sirven los archivos
|
1968
|
+
públicos. Solo se utiliza cuando se sirven archivos
|
1969
|
+
estáticos (ver la opción <tt>static</tt>). Si no
|
1970
|
+
está presente, se infiere del valor de la opción
|
1971
|
+
<tt>app_file</tt>.
|
1972
|
+
</dd>
|
1973
|
+
|
1974
|
+
<dt>reload_templates</dt>
|
1975
|
+
<dd>
|
1976
|
+
Define si se recargan las plantillas entre peticiones.
|
1977
|
+
|
1978
|
+
Se encuentra activado en el entorno de desarrollo.
|
1979
|
+
</dd>
|
1980
|
+
|
1981
|
+
<dt>root</dt>
|
1982
|
+
<dd>
|
1983
|
+
Path del directorio raíz del proyecto. Si no está
|
1984
|
+
presente, se infiere del valor de la opción
|
1985
|
+
<tt>app_file</tt>.
|
1986
|
+
</dd>
|
1987
|
+
|
1988
|
+
<dt>raise_errors</dt>
|
1989
|
+
<dd>
|
1990
|
+
Elevar excepciones (detiene la aplicación). Se
|
1991
|
+
encuentra activada por defecto cuando el valor de
|
1992
|
+
<tt>environment</tt> es <tt>"test"</tt>. En caso
|
1993
|
+
contrario estará desactivada.
|
1994
|
+
</dd>
|
1995
|
+
|
1996
|
+
<dt>run</dt>
|
1997
|
+
<dd>
|
1998
|
+
Cuando está habilitada, Sinatra se va a encargar de
|
1999
|
+
iniciar el servidor web, no la habilités cuando estés
|
2000
|
+
usando rackup o algún otro medio.
|
2001
|
+
</dd>
|
2002
|
+
|
2003
|
+
<dt>running</dt>
|
2004
|
+
<dd>
|
2005
|
+
Indica si el servidor integrado está ejecutandose, ¡no
|
2006
|
+
cambiés esta configuración!.
|
2007
|
+
</dd>
|
2008
|
+
|
2009
|
+
<dt>server</dt>
|
2010
|
+
<dd>
|
2011
|
+
Servidor, o lista de servidores, para usar como servidor
|
2012
|
+
integrado. Por defecto: <tt>['thin', 'mongrel', 'webrick']</tt>,
|
2013
|
+
el orden establece la prioridad.
|
2014
|
+
</dd>
|
2015
|
+
|
2016
|
+
<dt>sessions</dt>
|
2017
|
+
<dd>
|
2018
|
+
Habilita el soporte de sesiones basadas en cookies a
|
2019
|
+
través de <tt>Rack::Session::Cookie</tt>. Ver la
|
2020
|
+
sección 'Usando Sesiones' para más información.
|
2021
|
+
</dd>
|
2022
|
+
|
2023
|
+
<dt>show_exceptions</dt>
|
2024
|
+
<dd>
|
2025
|
+
Muestra un stack trace en el navegador cuando ocurre una
|
2026
|
+
excepción. Se encuentra activada por defecto cuando el
|
2027
|
+
valor de <tt>environment</tt> es <tt>"development"</tt>.
|
2028
|
+
En caso contrario estará desactivada.
|
2029
|
+
</dd>
|
2030
|
+
|
2031
|
+
<dt>static</dt>
|
2032
|
+
<dd>
|
2033
|
+
Define si Sinatra debe encargarse de servir archivos
|
2034
|
+
estáticos.
|
2035
|
+
|
2036
|
+
Deshabilitala cuando usés un servidor capaz de
|
2037
|
+
hacerlo por sí solo, porque mejorará el
|
2038
|
+
rendimiento. Se encuentra habilitada por
|
2039
|
+
defecto en el estilo clásico y desactivado en el
|
2040
|
+
el modular.
|
2041
|
+
</dd>
|
2042
|
+
|
2043
|
+
<dt>static_cache_control</dt>
|
2044
|
+
<dd>
|
2045
|
+
Cuando Sinatra está sirviendo archivos estáticos, y
|
2046
|
+
está opción está habilitada, les va a agregar encabezados
|
2047
|
+
<tt>Cache-Control</tt> a las respuestas. Para esto
|
2048
|
+
utiliza el helper <tt>cache_control</tt>. Se encuentra
|
2049
|
+
deshabilitada por defecto. Notar que es necesario
|
2050
|
+
utilizar un array cuando se asignan múltiples valores:
|
2051
|
+
<tt>set :static_cache_control, [:public, :max_age => 300]</tt>.
|
2052
|
+
</dd>
|
2053
|
+
|
2054
|
+
<dt>views</dt>
|
2055
|
+
<dd>
|
2056
|
+
Path del directorio de las vistas. Si no está presente,
|
2057
|
+
se infiere del valor de la opción <tt>app_file</tt>.
|
2058
|
+
</dd>
|
2059
|
+
</dl>
|
2060
|
+
|
2061
|
+
## Entornos
|
2062
|
+
|
2063
|
+
Existen tres entornos (`environments`) predefinidos: `development`,
|
2064
|
+
`production` y `test`. El entorno por defecto es
|
2065
|
+
`development` y tiene algunas particularidades:
|
2066
|
+
|
2067
|
+
* Se recargan las plantillas entre una petición y la siguiente, a diferencia
|
2068
|
+
de `production` y `test`, donde se cachean.
|
2069
|
+
* Se instalan manejadores de errores `not_found` y `error`
|
2070
|
+
especiales que muestran un stack trace en el navegador cuando son disparados.
|
2071
|
+
|
2072
|
+
Para utilizar alguno de los otros entornos puede asignarse el valor
|
2073
|
+
correspondiente a la variable de entorno `RACK_ENV`, o bien utilizar la opción
|
2074
|
+
`-e` al ejecutar la aplicación:
|
2075
|
+
|
2076
|
+
``` shell
|
2077
|
+
ruby mi_app.rb -e <ENTORNO>
|
2078
|
+
```
|
2079
|
+
|
2080
|
+
Los métodos `development?`, `test?` y `production?` te permiten conocer el
|
2081
|
+
entorno actual.
|
2082
|
+
|
2083
|
+
## Manejo de Errores
|
2084
|
+
|
2085
|
+
Los manejadores de errores se ejecutan dentro del mismo contexto que las rutas
|
2086
|
+
y los filtros `before`, lo que significa que podés usar, por ejemplo,
|
2087
|
+
`haml`, `erb`, `halt`, etc.
|
2088
|
+
|
2089
|
+
### No encontrado <em>(Not Found)</em>
|
2090
|
+
|
2091
|
+
Cuando se eleva una excepción `Sinatra::NotFound`, o el código de
|
2092
|
+
estado de la respuesta es 404, el manejador `not_found` es invocado:
|
2093
|
+
|
2094
|
+
``` ruby
|
2095
|
+
not_found do
|
2096
|
+
'No existo'
|
2097
|
+
end
|
2098
|
+
```
|
2099
|
+
|
2100
|
+
### Error
|
2101
|
+
|
2102
|
+
El manejador `error` es invocado cada vez que una excepción es elevada
|
2103
|
+
desde un bloque de ruta o un filtro. El objeto de la excepción se puede
|
2104
|
+
obtener de la variable Rack `sinatra.error`:
|
2105
|
+
|
2106
|
+
``` ruby
|
2107
|
+
error do
|
2108
|
+
'Disculpá, ocurrió un error horrible - ' + env['sinatra.error'].name
|
2109
|
+
end
|
2110
|
+
```
|
2111
|
+
|
2112
|
+
Errores personalizados:
|
2113
|
+
|
2114
|
+
``` ruby
|
2115
|
+
error MiErrorPersonalizado do
|
2116
|
+
'Lo que pasó fue...' + env['sinatra.error'].message
|
2117
|
+
end
|
2118
|
+
```
|
2119
|
+
|
2120
|
+
Entonces, si pasa esto:
|
2121
|
+
|
2122
|
+
``` ruby
|
2123
|
+
get '/' do
|
2124
|
+
raise MiErrorPersonalizado, 'algo malo'
|
2125
|
+
end
|
2126
|
+
```
|
2127
|
+
|
2128
|
+
Obtenés esto:
|
2129
|
+
|
2130
|
+
Lo que pasó fue... algo malo
|
2131
|
+
|
2132
|
+
También, podés instalar un manejador de errores para un código de estado:
|
2133
|
+
|
2134
|
+
``` ruby
|
2135
|
+
error 403 do
|
2136
|
+
'Acceso prohibido'
|
2137
|
+
end
|
2138
|
+
|
2139
|
+
get '/secreto' do
|
2140
|
+
403
|
2141
|
+
end
|
2142
|
+
```
|
2143
|
+
|
2144
|
+
O un rango:
|
2145
|
+
|
2146
|
+
``` ruby
|
2147
|
+
error 400..510 do
|
2148
|
+
'Boom'
|
2149
|
+
end
|
2150
|
+
```
|
2151
|
+
|
2152
|
+
Sinatra instala manejadores `not_found` y `error` especiales
|
2153
|
+
cuando se ejecuta dentro del entorno de desarrollo "development".
|
2154
|
+
|
2155
|
+
## Rack Middleware
|
2156
|
+
|
2157
|
+
Sinatra corre sobre Rack[http://rack.rubyforge.org/], una interfaz minimalista
|
2158
|
+
que es un estándar para frameworks webs escritos en Ruby. Una de las
|
2159
|
+
capacidades más interesantes de Rack para los desarrolladores de aplicaciones
|
2160
|
+
es el soporte de "middleware" -- componentes que se ubican entre el servidor y
|
2161
|
+
tu aplicación, supervisando y/o manipulando la petición/respuesta HTTP para
|
2162
|
+
proporcionar varios tipos de funcionalidades comunes.
|
2163
|
+
|
2164
|
+
Sinatra hace muy sencillo construir tuberías de Rack middleware a través del
|
2165
|
+
método top-level `use`:
|
2166
|
+
|
2167
|
+
``` ruby
|
2168
|
+
require 'sinatra'
|
2169
|
+
require 'mi_middleware_personalizado'
|
2170
|
+
|
2171
|
+
use Rack::Lint
|
2172
|
+
use MiMiddlewarePersonalizado
|
2173
|
+
|
2174
|
+
get '/hola' do
|
2175
|
+
'Hola Mundo'
|
2176
|
+
end
|
2177
|
+
```
|
2178
|
+
|
2179
|
+
Las semánticas de `use` son idénticas a las definidas para el DSL
|
2180
|
+
Rack::Builder[http://rack.rubyforge.org/doc/classes/Rack/Builder.html] (más
|
2181
|
+
frecuentemente usado desde archivos rackup). Por ejemplo, el método `use`
|
2182
|
+
acepta argumentos múltiples/variables así como bloques:
|
2183
|
+
|
2184
|
+
``` ruby
|
2185
|
+
use Rack::Auth::Basic do |nombre_de_usuario, password|
|
2186
|
+
nombre_de_usuario == 'admin' && password == 'secreto'
|
2187
|
+
end
|
2188
|
+
```
|
2189
|
+
|
2190
|
+
Rack es distribuido con una variedad de middleware estándar para logging,
|
2191
|
+
debugging, enrutamiento URL, autenticación, y manejo de sesiones. Sinatra
|
2192
|
+
usa muchos de estos componentes automáticamente de acuerdo a su configuración
|
2193
|
+
para que típicamente no tengas que usarlas (con `use`) explícitamente.
|
2194
|
+
|
2195
|
+
Podés encontrar middleware útil en
|
2196
|
+
[rack](https://github.com/rack/rack/tree/master/lib/rack),
|
2197
|
+
[rack-contrib](https://github.com/rack/rack-contrib#readme),
|
2198
|
+
con [CodeRack](http://coderack.org/) o en la
|
2199
|
+
[Rack wiki](https://github.com/rack/rack/wiki/List-of-Middleware).
|
2200
|
+
|
2201
|
+
## Pruebas
|
2202
|
+
|
2203
|
+
Las pruebas para las aplicaciones Sinatra pueden ser escritas utilizando
|
2204
|
+
cualquier framework o librería de pruebas basada en Rack. Se recomienda usar
|
2205
|
+
[Rack::Test](http://rdoc.info/github/brynary/rack-test/master/frames):
|
2206
|
+
|
2207
|
+
``` ruby
|
2208
|
+
require 'mi_app_sinatra'
|
2209
|
+
require 'test/unit'
|
2210
|
+
require 'rack/test'
|
2211
|
+
|
2212
|
+
class MiAppTest < Test::Unit::TestCase
|
2213
|
+
include Rack::Test::Methods
|
2214
|
+
|
2215
|
+
def app
|
2216
|
+
Sinatra::Application
|
2217
|
+
end
|
2218
|
+
|
2219
|
+
def test_mi_defecto
|
2220
|
+
get '/'
|
2221
|
+
assert_equal 'Hola Mundo!', last_response.body
|
2222
|
+
end
|
2223
|
+
|
2224
|
+
def test_con_parametros
|
2225
|
+
get '/saludar', :name => 'Franco'
|
2226
|
+
assert_equal 'Hola Frank!', last_response.body
|
2227
|
+
end
|
2228
|
+
|
2229
|
+
def test_con_entorno_rack
|
2230
|
+
get '/', {}, 'HTTP_USER_AGENT' => 'Songbird'
|
2231
|
+
assert_equal "Estás usando Songbird!", last_response.body
|
2232
|
+
end
|
2233
|
+
end
|
2234
|
+
```
|
2235
|
+
|
2236
|
+
## Sinatra::Base - Middleware, Librerías, y Aplicaciones Modulares
|
2237
|
+
|
2238
|
+
Definir tu aplicación en el top-level funciona bien para micro-aplicaciones
|
2239
|
+
pero trae inconvenientes considerables a la hora de construir componentes
|
2240
|
+
reutilizables como Rack middleware, Rails metal, simple librerías con un
|
2241
|
+
componente de servidor, o incluso extensiones de Sinatra. El DSL de top-level
|
2242
|
+
asume una configuración apropiada para micro-aplicaciones (por ejemplo, un
|
2243
|
+
único archivo de aplicación, los directorios `./public` y
|
2244
|
+
`./views`, logging, página con detalles de excepción, etc.). Ahí es
|
2245
|
+
donde `Sinatra::Base` entra en el juego:
|
2246
|
+
|
2247
|
+
``` ruby
|
2248
|
+
require 'sinatra/base'
|
2249
|
+
|
2250
|
+
class MiApp < Sinatra::Base
|
2251
|
+
set :sessions, true
|
2252
|
+
set :foo, 'bar'
|
2253
|
+
|
2254
|
+
get '/' do
|
2255
|
+
'Hola Mundo!'
|
2256
|
+
end
|
2257
|
+
end
|
2258
|
+
```
|
2259
|
+
|
2260
|
+
Las subclases de `Sinatra::Base` tienen disponibles exactamente los
|
2261
|
+
mismos métodos que los provistos por el DSL de top-level. La mayoría de las
|
2262
|
+
aplicaciones top-level se pueden convertir en componentes
|
2263
|
+
`Sinatra::Base` con dos modificaciones:
|
2264
|
+
|
2265
|
+
* Tu archivo debe requerir `sinatra/base` en lugar de `sinatra`; de otra
|
2266
|
+
manera, todos los métodos del DSL de sinatra son importados dentro del
|
2267
|
+
espacio de nombres principal.
|
2268
|
+
* Poné las rutas, manejadores de errores, filtros y opciones de tu aplicación
|
2269
|
+
en una subclase de `Sinatra::Base`.
|
2270
|
+
|
2271
|
+
`Sinatra::Base` es una pizarra en blanco. La mayoría de las opciones están
|
2272
|
+
desactivadas por defecto, incluyendo el servidor incorporado. Mirá
|
2273
|
+
[Opciones y Configuraciones](http://sinatra.github.com/configuration.html)
|
2274
|
+
para detalles sobre las opciones disponibles y su comportamiento.
|
2275
|
+
|
2276
|
+
### Estilo Modular vs. Clásico
|
2277
|
+
|
2278
|
+
Contrariamente a la creencia popular, no hay nada de malo con el estilo clásico.
|
2279
|
+
Si se ajusta a tu aplicación, no es necesario que la cambies a una modular.
|
2280
|
+
|
2281
|
+
Las desventaja de usar el estilo clásico en lugar del modular consiste en que
|
2282
|
+
solamente podés tener una aplicación Sinatra por proceso Ruby. Si tenés
|
2283
|
+
planificado usar más, cambiá al estilo modular. Al mismo tiempo, tené en
|
2284
|
+
cuenta que no hay ninguna razón por la cuál no puedas mezclar los estilos
|
2285
|
+
clásico y modular.
|
2286
|
+
|
2287
|
+
A continuación se detallan las diferencias (sutiles) entre las configuraciones
|
2288
|
+
de ambos estilos:
|
2289
|
+
|
2290
|
+
<table>
|
2291
|
+
<tr>
|
2292
|
+
<td>Configuración</td>
|
2293
|
+
<td>Clásica</td>
|
2294
|
+
<td>Modular</td>
|
2295
|
+
</tr>
|
2296
|
+
|
2297
|
+
<tr>
|
2298
|
+
<td>app_file</td>
|
2299
|
+
<td>archivo que carga sinatra</td>
|
2300
|
+
<td>archivo con la subclase de Sinatra::Base</td>
|
2301
|
+
</tr>
|
2302
|
+
|
2303
|
+
<tr>
|
2304
|
+
<td>run</td>
|
2305
|
+
<td>$0 == app_file</td>
|
2306
|
+
<td>false</td>
|
2307
|
+
</tr>
|
2308
|
+
|
2309
|
+
<tr>
|
2310
|
+
<td>logging</td>
|
2311
|
+
<td>true</td>
|
2312
|
+
<td>false</td>
|
2313
|
+
</tr>
|
2314
|
+
|
2315
|
+
<tr>
|
2316
|
+
<td>method_override</td>
|
2317
|
+
<td>true</td>
|
2318
|
+
<td>false</td>
|
2319
|
+
</tr>
|
2320
|
+
|
2321
|
+
<tr>
|
2322
|
+
<td>inline_templates</td>
|
2323
|
+
<td>true</td>
|
2324
|
+
<td>false</td>
|
2325
|
+
</tr>
|
2326
|
+
|
2327
|
+
<tr>
|
2328
|
+
<td>static</td>
|
2329
|
+
<td>true</td>
|
2330
|
+
<td>false</td>
|
2331
|
+
</tr>
|
2332
|
+
</table>
|
2333
|
+
|
2334
|
+
### Sirviendo una Aplicación Modular
|
2335
|
+
|
2336
|
+
Las dos opciones más comunes para iniciar una aplicación modular son, iniciarla
|
2337
|
+
activamente con `run!`:
|
2338
|
+
|
2339
|
+
``` ruby
|
2340
|
+
# mi_app.rb
|
2341
|
+
require 'sinatra/base'
|
2342
|
+
|
2343
|
+
class MiApp < Sinatra::Base
|
2344
|
+
# ... código de la app ...
|
2345
|
+
|
2346
|
+
# iniciar el servidor si el archivo fue ejecutado directamente
|
2347
|
+
run! if app_file == $0
|
2348
|
+
end
|
2349
|
+
```
|
2350
|
+
|
2351
|
+
Iniciar con:
|
2352
|
+
|
2353
|
+
``` shell
|
2354
|
+
ruby mi_app.rb
|
2355
|
+
```
|
2356
|
+
|
2357
|
+
O, con un archivo `config.ru`, que permite usar cualquier handler Rack:
|
2358
|
+
|
2359
|
+
``` ruby
|
2360
|
+
# config.ru
|
2361
|
+
require './mi_app'
|
2362
|
+
run MiApp
|
2363
|
+
```
|
2364
|
+
|
2365
|
+
Después ejecutar:
|
2366
|
+
|
2367
|
+
``` shell
|
2368
|
+
rackup -p 4567
|
2369
|
+
```
|
2370
|
+
|
2371
|
+
### Usando una Aplicación Clásica con un Archivo config.ru
|
2372
|
+
|
2373
|
+
Escribí el archivo de tu aplicación:
|
2374
|
+
|
2375
|
+
``` ruby
|
2376
|
+
# app.rb
|
2377
|
+
require 'sinatra'
|
2378
|
+
|
2379
|
+
get '/' do
|
2380
|
+
'Hola mundo!'
|
2381
|
+
end
|
2382
|
+
```
|
2383
|
+
|
2384
|
+
Y el `config.ru` correspondiente:
|
2385
|
+
|
2386
|
+
``` ruby
|
2387
|
+
require './app'
|
2388
|
+
run Sinatra::Application
|
2389
|
+
```
|
2390
|
+
|
2391
|
+
### ¿Cuándo Usar config.ru?
|
2392
|
+
|
2393
|
+
Indicadores de que probablemente querés usar `config.ru`:
|
2394
|
+
|
2395
|
+
* Querés realizar el deploy con un hanlder Rack distinto (Passenger, Unicorn,
|
2396
|
+
Heroku, ...).
|
2397
|
+
* Querés usar más de una subclase de `Sinatra::Base`.
|
2398
|
+
* Querés usar Sinatra únicamente para middleware, pero no como un endpoint.
|
2399
|
+
|
2400
|
+
<b>No hay necesidad de utilizar un archivo `config.ru` exclusivamente
|
2401
|
+
porque tenés una aplicación modular, y no necesitás una aplicación modular para
|
2402
|
+
iniciarla con `config.ru`.</b>
|
2403
|
+
|
2404
|
+
### Utilizando Sinatra como Middleware
|
2405
|
+
|
2406
|
+
Sinatra no solo es capaz de usar otro Rack middleware, sino que a su vez,
|
2407
|
+
cualquier aplicación Sinatra puede ser agregada delante de un endpoint Rack
|
2408
|
+
como middleware. Este endpoint puede ser otra aplicación Sinatra, o cualquier
|
2409
|
+
aplicación basada en Rack (Rails/Ramaze/Camping/...):
|
2410
|
+
|
2411
|
+
``` ruby
|
2412
|
+
require 'sinatra/base'
|
2413
|
+
|
2414
|
+
class PantallaDeLogin < Sinatra::Base
|
2415
|
+
enable :sessions
|
2416
|
+
|
2417
|
+
get('/login') { haml :login }
|
2418
|
+
|
2419
|
+
post('/login') do
|
2420
|
+
if params[:nombre] == 'admin' && params[:password] == 'admin'
|
2421
|
+
session['nombre_de_usuario'] = params[:nombre]
|
2422
|
+
else
|
2423
|
+
redirect '/login'
|
2424
|
+
end
|
2425
|
+
end
|
2426
|
+
end
|
2427
|
+
|
2428
|
+
class MiApp < Sinatra::Base
|
2429
|
+
# el middleware se ejecutará antes que los filtros
|
2430
|
+
use PantallaDeLogin
|
2431
|
+
|
2432
|
+
before do
|
2433
|
+
unless session['nombre_de_usuario']
|
2434
|
+
halt "Acceso denegado, por favor <a href='/login'>iniciá sesión</a>."
|
2435
|
+
end
|
2436
|
+
end
|
2437
|
+
|
2438
|
+
get('/') { "Hola #{session['nombre_de_usuario']}." }
|
2439
|
+
end
|
2440
|
+
```
|
2441
|
+
|
2442
|
+
### Creación Dinámica de Aplicaciones
|
2443
|
+
|
2444
|
+
Puede que en algunas ocasiones quieras crear nuevas aplicaciones en
|
2445
|
+
tiempo de ejecución sin tener que asignarlas a una constante. Para
|
2446
|
+
esto tenés `Sinatra.new`:
|
2447
|
+
|
2448
|
+
``` ruby
|
2449
|
+
require 'sinatra/base'
|
2450
|
+
mi_app = Sinatra.new { get('/') { "hola" } }
|
2451
|
+
mi_app.run!
|
2452
|
+
```
|
2453
|
+
|
2454
|
+
Acepta como argumento opcional una aplicación desde la que se
|
2455
|
+
heredará:
|
2456
|
+
|
2457
|
+
``` ruby
|
2458
|
+
# config.ru
|
2459
|
+
require 'sinatra/base'
|
2460
|
+
|
2461
|
+
controller = Sinatra.new do
|
2462
|
+
enable :logging
|
2463
|
+
helpers MisHelpers
|
2464
|
+
end
|
2465
|
+
|
2466
|
+
map('/a') do
|
2467
|
+
run Sinatra.new(controller) { get('/') { 'a' } }
|
2468
|
+
end
|
2469
|
+
|
2470
|
+
map('/b') do
|
2471
|
+
run Sinatra.new(controller) { get('/') { 'b' } }
|
2472
|
+
end
|
2473
|
+
```
|
2474
|
+
|
2475
|
+
Construir aplicaciones de esta forma resulta especialmente útil para
|
2476
|
+
testear extensiones Sinatra o para usar Sinatra en tus librerías.
|
2477
|
+
|
2478
|
+
Por otro lado, hace extremadamente sencillo usar Sinatra como
|
2479
|
+
middleware:
|
2480
|
+
|
2481
|
+
``` ruby
|
2482
|
+
require 'sinatra/base'
|
2483
|
+
|
2484
|
+
use Sinatra do
|
2485
|
+
get('/') { ... }
|
2486
|
+
end
|
2487
|
+
|
2488
|
+
run ProyectoRails::Application
|
2489
|
+
```
|
2490
|
+
|
2491
|
+
## Ámbitos y Ligaduras
|
2492
|
+
|
2493
|
+
El ámbito en el que te encontrás determina que métodos y variables están
|
2494
|
+
disponibles.
|
2495
|
+
|
2496
|
+
### Ámbito de Aplicación/Clase
|
2497
|
+
|
2498
|
+
Cada aplicación Sinatra es una subclase de `Sinatra::Base`. Si estás
|
2499
|
+
usando el DSL de top-level (`require 'sinatra'`), entonces esta clase es
|
2500
|
+
`Sinatra::Application`, de otra manera es la subclase que creaste
|
2501
|
+
explícitamente. Al nivel de la clase tenés métodos como `get` o `before`, pero
|
2502
|
+
no podés acceder a los objetos `request` o `session`, ya que hay una única
|
2503
|
+
clase de la aplicación para todas las peticiones.
|
2504
|
+
|
2505
|
+
Las opciones creadas utilizando `set` son métodos al nivel de la clase:
|
2506
|
+
|
2507
|
+
``` ruby
|
2508
|
+
class MiApp < Sinatra::Base
|
2509
|
+
# Ey, estoy en el ámbito de la aplicación!
|
2510
|
+
set :foo, 42
|
2511
|
+
foo # => 42
|
2512
|
+
|
2513
|
+
get '/foo' do
|
2514
|
+
# Hey, ya no estoy en el ámbito de la aplicación!
|
2515
|
+
end
|
2516
|
+
end
|
2517
|
+
```
|
2518
|
+
|
2519
|
+
Tenés la ligadura al ámbito de la aplicación dentro de:
|
2520
|
+
|
2521
|
+
* El cuerpo de la clase de tu aplicación
|
2522
|
+
* Métodos definidos por extensiones
|
2523
|
+
* El bloque pasado a `helpers`
|
2524
|
+
* Procs/bloques usados como el valor para `set`
|
2525
|
+
|
2526
|
+
Este ámbito puede alcanzarse de las siguientes maneras:
|
2527
|
+
|
2528
|
+
* A través del objeto pasado a los bloques de configuración (`configure { |c| ...}`)
|
2529
|
+
* Llamando a `settings` desde dentro del ámbito de la petición
|
2530
|
+
|
2531
|
+
### Ámbito de Petición/Instancia
|
2532
|
+
|
2533
|
+
Para cada petición entrante, una nueva instancia de la clase de tu aplicación
|
2534
|
+
es creada y todos los bloques de rutas son ejecutados en ese ámbito. Desde este
|
2535
|
+
ámbito podés acceder a los objetos `request` y `session` o llamar a los métodos
|
2536
|
+
de renderización como `erb` o `haml`. Podés acceder al ámbito de la aplicación
|
2537
|
+
desde el ámbito de la petición utilizando `settings`:
|
2538
|
+
|
2539
|
+
``` ruby
|
2540
|
+
class MiApp < Sinatra::Base
|
2541
|
+
# Ey, estoy en el ámbito de la aplicación!
|
2542
|
+
get '/definir_ruta/:nombre' do
|
2543
|
+
# Ámbito de petición para '/definir_ruta/:nombre'
|
2544
|
+
@valor = 42
|
2545
|
+
|
2546
|
+
settings.get("/#{params[:nombre]}") do
|
2547
|
+
# Ámbito de petición para "/#{params[:nombre]}"
|
2548
|
+
@valor # => nil (no es la misma petición)
|
2549
|
+
end
|
2550
|
+
|
2551
|
+
"Ruta definida!"
|
2552
|
+
end
|
2553
|
+
end
|
2554
|
+
```
|
2555
|
+
|
2556
|
+
Tenés la ligadura al ámbito de la petición dentro de:
|
2557
|
+
|
2558
|
+
* bloques pasados a get/head/post/put/delete/options
|
2559
|
+
* filtros before/after
|
2560
|
+
* métodos ayudantes
|
2561
|
+
* plantillas/vistas
|
2562
|
+
|
2563
|
+
### Ámbito de Delegación
|
2564
|
+
|
2565
|
+
El ámbito de delegación solo reenvía métodos al ámbito de clase. De cualquier
|
2566
|
+
manera, no se comporta 100% como el ámbito de clase porque no tenés la ligadura
|
2567
|
+
de la clase: únicamente métodos marcados explícitamente para delegación están
|
2568
|
+
disponibles y no compartís variables/estado con el ámbito de clase (léase:
|
2569
|
+
tenés un `self` diferente). Podés agregar delegaciones de método llamando a
|
2570
|
+
`Sinatra::Delegator.delegate :nombre_del_metodo`.
|
2571
|
+
|
2572
|
+
Tenés la ligadura al ámbito de delegación dentro de:
|
2573
|
+
|
2574
|
+
* La ligadura del top-level, si hiciste `require "sinatra"`
|
2575
|
+
* Un objeto extendido con el mixin `Sinatra::Delegator`
|
2576
|
+
|
2577
|
+
Pegale una mirada al código: acá está el
|
2578
|
+
[Sinatra::Delegator mixin](https://github.com/sinatra/sinatra/blob/ca06364/lib/sinatra/base.rb#L1609-1633)
|
2579
|
+
que [extiende el objeto main](https://github.com/sinatra/sinatra/blob/ca06364/lib/sinatra/main.rb#L28-30).
|
2580
|
+
|
2581
|
+
## Línea de Comandos
|
2582
|
+
|
2583
|
+
Las aplicaciones Sinatra pueden ser ejecutadas directamente:
|
2584
|
+
|
2585
|
+
``` shell
|
2586
|
+
ruby miapp.rb [-h] [-x] [-e ENTORNO] [-p PUERTO] [-o HOST] [-s MANEJADOR]
|
2587
|
+
```
|
2588
|
+
|
2589
|
+
Las opciones son:
|
2590
|
+
|
2591
|
+
```
|
2592
|
+
-h # ayuda
|
2593
|
+
-p # asigna el puerto (4567 es usado por defecto)
|
2594
|
+
-o # asigna el host (0.0.0.0 es usado por defecto)
|
2595
|
+
-e # asigna el entorno (development es usado por defecto)
|
2596
|
+
-s # especifica el servidor/manejador rack (thin es usado por defecto)
|
2597
|
+
-x # activa el mutex lock (está desactivado por defecto)
|
2598
|
+
```
|
2599
|
+
|
2600
|
+
## Versiones de Ruby Soportadas
|
2601
|
+
|
2602
|
+
Las siguientes versiones de Ruby son soportadas oficialmente:
|
2603
|
+
|
2604
|
+
<dl>
|
2605
|
+
<dt>Ruby 1.8.7</dt>
|
2606
|
+
<dd>
|
2607
|
+
1.8.7 es soportado completamente. Sin embargo, si no hay nada que te lo
|
2608
|
+
prohíba, te recomendamos que usés 1.9.2 o cambies a JRuby o Rubinius. No se
|
2609
|
+
dejará de dar soporte a 1.8.7 hasta Sinatra 2.0 y Ruby 2.0, aunque si se
|
2610
|
+
libera la versión 1.8.8 de Ruby las cosas podrían llegar a cambiar. Sin
|
2611
|
+
embargo, que eso ocurra es muy poco probable, e incluso el caso de que lo
|
2612
|
+
haga, puede que se siga dando soporte a 1.8.7. <b>Hemos dejado de soportar
|
2613
|
+
Ruby 1.8.6.</b> Si querés ejecutar Sinatra sobre 1.8.6, podés utilizar la
|
2614
|
+
versión 1.2, pero tené en cuenta que una vez que Sinatra 1.4.0 sea liberado,
|
2615
|
+
ya no se corregirán errores por más que se reciban reportes de los mismos.
|
2616
|
+
</dd>
|
2617
|
+
|
2618
|
+
<dt>Ruby 1.9.2</dt>
|
2619
|
+
<dd>
|
2620
|
+
1.9.2 es soportado y recomendado. No usés 1.9.2p0, porque se producen fallos
|
2621
|
+
de segmentación cuando se ejecuta Sinatra. El soporte se mantendrá al menos
|
2622
|
+
hasta que se libere la versión 1.9.4/2.0 de Ruby. El soporte para la última
|
2623
|
+
versión de la serie 1.9 se mantendrá mientras lo haga el core team de Ruby.
|
2624
|
+
</dd>
|
2625
|
+
|
2626
|
+
<dt>Ruby 1.9.3</dt>
|
2627
|
+
<dd>
|
2628
|
+
1.9.3 es soportado y recomendado. Tené en cuenta que el cambio a 1.9.3 desde
|
2629
|
+
una versión anterior va a invalidar todas las sesiones.
|
2630
|
+
</dd>
|
2631
|
+
|
2632
|
+
<dt>Rubinius</dt>
|
2633
|
+
<dd>
|
2634
|
+
Rubinius es soportado oficialmente (Rubinius >= 1.2.4). Todo funciona
|
2635
|
+
correctamente, incluyendo los lenguajes de plantillas. La próxima versión,
|
2636
|
+
2.0, también es soportada, incluyendo el modo 1.9.
|
2637
|
+
</dd>
|
2638
|
+
|
2639
|
+
<dt>JRuby</dt>
|
2640
|
+
<dd>
|
2641
|
+
JRuby es soportado oficialmente (JRuby >= 1.6.7). No se conocen problemas
|
2642
|
+
con librerías de plantillas de terceras partes. Sin embargo, si elegís usar
|
2643
|
+
JRuby, deberías examinar sus Rack handlers porque el servidor web Thin no es
|
2644
|
+
soportado completamente. El soporte de JRuby para extensiones C se encuentra
|
2645
|
+
en una etapa experimental, sin embargo, de momento solamente RDiscount,
|
2646
|
+
Redcarpet, RedCloth y Yajl, así como Thin y Mongrel se ven afectadas.
|
2647
|
+
</dd>
|
2648
|
+
</dl>
|
2649
|
+
|
2650
|
+
Siempre le prestamos atención a las nuevas versiones de Ruby.
|
2651
|
+
|
2652
|
+
Las siguientes implementaciones de Ruby no se encuentran soportadas
|
2653
|
+
oficialmente. De cualquier manera, pueden ejecutar Sinatra:
|
2654
|
+
|
2655
|
+
* Versiones anteriores de JRuby y Rubinius
|
2656
|
+
* Ruby Enterprise Edition
|
2657
|
+
* MacRuby, Maglev e IronRuby
|
2658
|
+
* Ruby 1.9.0 y 1.9.1 (pero no te recomendamos que los usés)
|
2659
|
+
|
2660
|
+
No estar soportada oficialmente, significa que si las cosas solamente se rompen
|
2661
|
+
ahí y no en una plataforma soportada, asumimos que no es nuestro problema sino
|
2662
|
+
el suyo.
|
2663
|
+
|
2664
|
+
Nuestro servidor CI también se ejecuta sobre ruby-head (que será la próxima
|
2665
|
+
versión 2.0.0) y la rama 1.9.4. Como están en movimiento constante, no podemos
|
2666
|
+
garantizar nada. De todas formas, podés contar con que tanto 1.9.4-p0 como
|
2667
|
+
2.0.0-p0 sea soportadas.
|
2668
|
+
|
2669
|
+
Sinatra debería funcionar en cualquier sistema operativo soportado por la
|
2670
|
+
implementación de Ruby elegida.
|
2671
|
+
|
2672
|
+
En este momento, no vas a poder ejecutar Sinatra en Cardinal, SmallRuby,
|
2673
|
+
BlueRuby o cualquier versión de Ruby anterior a 1.8.7.
|
2674
|
+
|
2675
|
+
## A la Vanguardia
|
2676
|
+
|
2677
|
+
Si querés usar el código de Sinatra más reciente, sentite libre de ejecutar
|
2678
|
+
tu aplicación sobre la rama master, en general es bastante estable.
|
2679
|
+
|
2680
|
+
También liberamos prereleases de vez en cuando, así, podés hacer
|
2681
|
+
|
2682
|
+
``` shell
|
2683
|
+
gem install sinatra --pre
|
2684
|
+
```
|
2685
|
+
|
2686
|
+
Para obtener algunas de las últimas características.
|
2687
|
+
|
2688
|
+
### Con Bundler
|
2689
|
+
|
2690
|
+
Esta es la manera recomendada para ejecutar tu aplicación sobre la última
|
2691
|
+
versión de Sinatra usando [Bundler](http://gembundler.com/).
|
2692
|
+
|
2693
|
+
Primero, instalá bundler si no lo hiciste todavía:
|
2694
|
+
|
2695
|
+
``` shell
|
2696
|
+
gem install bundler
|
2697
|
+
```
|
2698
|
+
|
2699
|
+
Después, en el directorio de tu proyecto, creá un archivo `Gemfile`:
|
2700
|
+
|
2701
|
+
``` ruby
|
2702
|
+
source :rubygems
|
2703
|
+
gem 'sinatra', :git => "git://github.com/sinatra/sinatra.git"
|
2704
|
+
|
2705
|
+
# otras dependencias
|
2706
|
+
gem 'haml' # por ejemplo, si usás haml
|
2707
|
+
gem 'activerecord', '~> 3.0' # quizás también necesités ActiveRecord 3.x
|
2708
|
+
```
|
2709
|
+
|
2710
|
+
Tené en cuenta que tenés que listar todas las dependencias directas de tu
|
2711
|
+
aplicación. No es necesario listar las dependencias de Sinatra (Rack y Tilt)
|
2712
|
+
porque Bundler las agrega directamente.
|
2713
|
+
|
2714
|
+
Ahora podés arrancar tu aplicación así:
|
2715
|
+
|
2716
|
+
``` shell
|
2717
|
+
bundle exec ruby miapp.rb
|
2718
|
+
```
|
2719
|
+
|
2720
|
+
### Con Git
|
2721
|
+
|
2722
|
+
Cloná el repositorio localmente y ejecutá tu aplicación, asegurándote que el
|
2723
|
+
directorio `sinatra/lib` esté en el `$LOAD_PATH`:
|
2724
|
+
|
2725
|
+
``` shell
|
2726
|
+
cd miapp
|
2727
|
+
git clone git://github.com/sinatra/sinatra.git
|
2728
|
+
ruby -Isinatra/lib miapp.rb
|
2729
|
+
```
|
2730
|
+
|
2731
|
+
Para actualizar el código fuente de Sinatra en el futuro:
|
2732
|
+
|
2733
|
+
``` shell
|
2734
|
+
cd miapp/sinatra
|
2735
|
+
git pull
|
2736
|
+
```
|
2737
|
+
|
2738
|
+
### Instalación Global
|
2739
|
+
|
2740
|
+
Podés construir la gem vos mismo:
|
2741
|
+
|
2742
|
+
``` shell
|
2743
|
+
git clone git://github.com/sinatra/sinatra.git
|
2744
|
+
cd sinatra
|
2745
|
+
rake sinatra.gemspec
|
2746
|
+
rake install
|
2747
|
+
```
|
2748
|
+
|
2749
|
+
Si instalás tus gems como root, el último paso debería ser
|
2750
|
+
|
2751
|
+
``` shell
|
2752
|
+
sudo rake install
|
2753
|
+
```
|
2754
|
+
|
2755
|
+
## Versionado
|
2756
|
+
|
2757
|
+
Sinatra utiliza el [Versionado Semántico](http://semver.org/),
|
2758
|
+
siguiendo las especificaciones SemVer y SemVerTag.
|
2759
|
+
|
2760
|
+
## Lecturas Recomendadas
|
2761
|
+
|
2762
|
+
* [Sito web del proyecto](http://www.sinatrarb.com/) - Documentación
|
2763
|
+
adicional, noticias, y enlaces a otros recursos.
|
2764
|
+
* [Contribuyendo](http://www.sinatrarb.com/contributing) - ¿Encontraste un
|
2765
|
+
error?. ¿Necesitás ayuda?. ¿Tenés un parche?.
|
2766
|
+
* [Seguimiento de problemas](http://github.com/sinatra/sinatra/issues)
|
2767
|
+
* [Twitter](http://twitter.com/sinatra)
|
2768
|
+
* [Lista de Correo](http://groups.google.com/group/sinatrarb/topics)
|
2769
|
+
* [IRC: #sinatra](irc://chat.freenode.net/#sinatra) en http://freenode.net
|
2770
|
+
* [Sinatra Book](http://sinatra-book.gittr.com) Tutorial (en inglés).
|
2771
|
+
* [Sinatra Recipes](http://recipes.sinatrarb.com/) Recetas contribuidas
|
2772
|
+
por la comunidad (en inglés).
|
2773
|
+
* Documentación de la API para la
|
2774
|
+
[última versión liberada](http://rubydoc.info/gems/sinatra) o para la
|
2775
|
+
[rama de desarrollo actual](http://rubydoc.info/github/sinatra/sinatra)
|
2776
|
+
en http://rubydoc.info/
|
2777
|
+
* [Servidor de CI](http://travis-ci.org/sinatra/sinatra)
|