sinatra 2.1.0 → 4.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/README.es.md DELETED
@@ -1,3202 +0,0 @@
1
- # Sinatra
2
-
3
- [![Build Status](https://secure.travis-ci.org/sinatra/sinatra.svg)](http://travis-ci.org/sinatra/sinatra)
4
-
5
- Sinatra es un
6
- [DSL](https://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
- Instala la gema:
19
-
20
- ```shell
21
- gem install sinatra
22
- ruby miapp.rb
23
- ```
24
-
25
- Y corre la aplicación:
26
- ```shell
27
- gem install sinatra
28
- ruby miapp.rb
29
- ```
30
-
31
- Ver en [http://localhost:4567](http://localhost:4567).
32
-
33
- El código que cambiaste no tendra efecto hasta que reinicies el servidor.
34
- Por favor reinicia el servidor cada vez que cambies tu código o usa [sinatra/reloader](http://www.sinatrarb.com/contrib/reloader).
35
-
36
- Se recomienda ejecutar `gem install thin`, porque Sinatra lo utilizará si está disponible.
37
-
38
-
39
- ## Tabla de Contenidos
40
-
41
- * [Sinatra](#sinatra)
42
- * [Tabla de Contenidos](#tabla-de-contenidos)
43
- * [Rutas](#rutas)
44
- * [Condiciones](#condiciones)
45
- * [Valores de Retorno](#valores-de-retorno)
46
- * [Comparadores de Rutas Personalizados](#comparadores-de-rutas-personalizados)
47
- * [Archivos Estáticos](#archivos-estáticos)
48
- * [Vistas / Plantillas](#vistas--plantillas)
49
- * [Plantillas Literales](#plantillas-literales)
50
- * [Lenguajes de Plantillas Disponibles](#lenguajes-de-plantillas-disponibles)
51
- * [Plantillas Haml](#plantillas-haml)
52
- * [Plantillas Erb](#plantillas-erb)
53
- * [Plantillas Builder](#plantillas-builder)
54
- * [Plantillas Nokogiri](#plantillas-nokogiri)
55
- * [Plantillas Sass](#plantillas-sass)
56
- * [Plantillas SCSS](#plantillas-scss)
57
- * [Plantillas Less](#plantillas-less)
58
- * [Plantillas Liquid](#plantillas-liquid)
59
- * [Plantillas Markdown](#plantillas-markdown)
60
- * [Plantillas Textile](#plantillas-textile)
61
- * [Plantillas RDoc](#plantillas-rdoc)
62
- * [Plantillas AsciiDoc](#plantillas-asciidoc)
63
- * [Plantillas Radius](#plantillas-radius)
64
- * [Plantillas Markaby](#plantillas-markaby)
65
- * [Plantillas RABL](#plantillas-rabl)
66
- * [Plantillas Slim](#plantillas-slim)
67
- * [Plantillas Creole](#plantillas-creole)
68
- * [Plantillas MediaWiki](#mediawiki-templates)
69
- * [Plantillas CofeeScript](#plantillas-coffeescript)
70
- * [Plantillas Stylus](#plantillas-stylus)
71
- * [Plantillas Yajl](#plantillas-yajl)
72
- * [Plantillas Wlang](#plantillas-wlang)
73
- * [Accediendo Variables en Plantillas](#accediendo-a-variables-en-plantillas)
74
- * [Plantillas con `yield` y `layout` anidado](#plantillas-con-yield-y-layout-anidado)
75
- * [Plantillas Inline](#plantillas-inline)
76
- * [Plantillas Nombradas](#plantillas-nombradas)
77
- * [Asociando Extensiones de Archivo](#asociando-extensiones-de-archivo)
78
- * [Añadiendo Tu Propio Motor de Plantillas](#añadiendo-tu-propio-motor-de-plantillas)
79
- * [Usando Lógica Personalizada para la Búsqueda en Plantillas](#usando-lógica-personalizada-para-la-búsqueda-en-plantillas)
80
- * [Filtros](#filtros)
81
- * [Helpers](#helpers)
82
- * [Usando Sesiones](#usando-sesiones)
83
- * [Secreto de Sesión](#secreto-de-sesión)
84
- * [Configuración de Sesión](#configuración-de-sesión)
85
- * [Escogiendo tu propio Middleware de Sesión](#escogiendo-tu-propio-middleware-de-sesión)
86
- * [Interrupcion](#interrupción)
87
- * [Paso](#paso)
88
- * [Desencadenando Otra Ruta](#desencadenando-otra-ruta)
89
- * [Configurando el Cuerpo, Código de Estado y los Encabezados](#configurando-el-cuerpo-código-de-estado-y-los-encabezados)
90
- * [Streaming De Respuestas](#streaming-de-respuestas)
91
- * [Logging](#logging)
92
- * [Tipos Mime](#tipos-mime)
93
- * [Generando URLs](#generando-urls)
94
- * [Redirección del Navegador](#redirección-del-navegador)
95
- * [Control del Cache](#control-del-cache)
96
- * [Enviando Archivos](#enviando-archivos)
97
- * [Accediendo al Objeto Request](#accediendo-al-objeto-request)
98
- * [Archivos Adjuntos](#archivos-adjuntos)
99
- * [Fecha y Hora](#fecha-y-hora)
100
- * [Buscando los Archivos de las Plantillas](#buscando-los-archivos-de-las-plantillas)
101
- * [Configuración](#configuración)
102
- * [Configurando la Protección Contra Ataques](#configurando-la-protección-contra-ataques)
103
- * [Configuraciones Disponibles](#configuraciones-disponibles)
104
- * [Entornos](#entornos)
105
- * [Manejo de Errores](#manejo-de-errores)
106
- * [Not Found](#not-found)
107
- * [Error](#error)
108
- * [Rack Middleware](#rack-middleware)
109
- * [Pruebas](#pruebas)
110
- * [Sinatra::Base - Middleware, Librerías, y Aplicaciones Modulares](#sinatrabase---middleware-librerías-y-aplicaciones-modulares)
111
- * [Estilo Modular vs Estilo Clásico](#estilo-modular-vs-clásico)
112
- * [Sirviendo una Aplicación Modular](#sirviendo-una-aplicación-modular)
113
- * [Usando una Aplicación de Estilo Clásico con config.ru](#usando-una-aplicación-clásica-con-un-archivo-configru)
114
- * [¿Cuándo usar config.ru?](#cuándo-usar-configru)
115
- * [Utilizando Sinatra como Middleware](#utilizando-sinatra-como-middleware)
116
- * [Creación Dinámica de Aplicaciones](#creación-dinámica-de-aplicaciones)
117
- * [Ámbitos y Ligaduras (Scopes and Binding)](#Ámbitos-y-ligaduras)
118
- * [Alcance de una Aplicación/Clase](#Ámbito-de-aplicaciónclase)
119
- * [Alcance de una Solicitud/Instancia](#Ámbito-de-peticióninstancia)
120
- * [Alcance de Delegación](#Ámbito-de-delegación)
121
- * [Línea de comandos](#línea-de-comandos)
122
- * [Multi-threading](#multi-threading)
123
- * [Requerimientos](#requerimientos)
124
- * [A la Vanguardia](#a-la-vanguardia)
125
- * [Usando bundler](#usando-bundler)
126
- * [Versionado](#versionado)
127
- * [Lecturas Recomendadas](#lecturas-recomendadas)
128
-
129
- ## Rutas
130
-
131
- En Sinatra, una ruta es un método HTTP junto a un patrón de un URL.
132
- Cada ruta está asociada a un bloque:
133
-
134
- ```ruby
135
- get '/' do
136
- .. mostrar algo ..
137
- end
138
-
139
- post '/' do
140
- .. crear algo ..
141
- end
142
-
143
- put '/' do
144
- .. reemplazar algo ..
145
- end
146
-
147
- patch '/' do
148
- .. modificar algo ..
149
- end
150
-
151
- delete '/' do
152
- .. aniquilar algo ..
153
- end
154
-
155
- options '/' do
156
- .. informar algo ..
157
- end
158
-
159
- link '/' do
160
- .. afiliar a algo ..
161
- end
162
-
163
- unlink '/' do
164
- .. separar algo ..
165
- end
166
-
167
- ```
168
-
169
- Las rutas son comparadas en el orden en el que son definidas. La primera ruta
170
- que coincide con la petición es invocada.
171
-
172
- Las rutas con barras al final son distintas a las que no tienen:
173
-
174
-
175
- ```ruby
176
- get '/foo' do
177
- # no es igual que "GET /foo/"
178
- end
179
- ```
180
-
181
- Los patrones de las rutas pueden incluir parámetros nombrados, accesibles a
182
- través del hash `params`:
183
-
184
-
185
- ```ruby
186
- get '/hola/:nombre' do
187
- # coincide con "GET /hola/foo" y "GET /hola/bar"
188
- # params['nombre'] es 'foo' o 'bar'
189
- "Hola #{params['nombre']}!"
190
- end
191
- ```
192
-
193
- También puede acceder a los parámetros nombrados usando parámetros de bloque:
194
-
195
- ```ruby
196
- get '/hola/:nombre' do |n|
197
- # coincide con "GET /hola/foo" y "GET /hola/bar"
198
- # params['nombre'] es 'foo' o 'bar'
199
- # n almacena params['nombre']
200
- "Hola #{n}!"
201
- end
202
- ```
203
-
204
- Los patrones de ruta también pueden incluir parámetros splat (o wildcard),
205
- accesibles a través del arreglo `params['splat']`:
206
-
207
- ```ruby
208
- get '/decir/*/al/*' do
209
- # coincide con /decir/hola/al/mundo
210
- params['splat'] # => ["hola", "mundo"]
211
- end
212
-
213
- get '/descargar/*.*' do
214
- # coincide con /descargar/path/al/archivo.xml
215
- params['splat'] # => ["path/al/archivo", "xml"]
216
- end
217
- ```
218
-
219
- O, con parámetros de bloque:
220
-
221
- ```ruby
222
- get '/descargar/*.*' do |path, ext|
223
- [path, ext] # => ["path/to/file", "xml"]
224
- end
225
- ```
226
-
227
- Rutas con Expresiones Regulares:
228
-
229
- ```ruby
230
- get /\/hola\/([\w]+)/ do
231
- "Hola, #{params['captures'].first}!"
232
- end
233
- ```
234
-
235
- O con un parámetro de bloque:
236
-
237
- ```ruby
238
- get %r{/hola/([\w]+)} do |c|
239
- "Hola, #{c}!"
240
- end
241
- ```
242
-
243
- Los patrones de ruta pueden contener parámetros opcionales:
244
-
245
- ```ruby
246
- get '/posts/:formato?' do
247
- # coincide con "GET /posts/" y además admite cualquier extensión, por
248
- # ejemplo, "GET /posts/json", "GET /posts/xml", etc.
249
- end
250
- ```
251
-
252
- Las rutas también pueden usar parámetros de consulta:
253
-
254
- ```ruby
255
- get '/posts' do
256
- # es igual que "GET /posts?title=foo&author=bar"
257
- title = params['title']
258
- author = params['author']
259
- # usa las variables title y author; la consulta es opcional para la ruta /posts
260
- end
261
- ```
262
-
263
- A propósito, a menos que desactives la protección para el ataque *path
264
- traversal* (ver más [abajo](#configurando-la-protección-contra-ataques)), el path de la petición puede ser modificado
265
- antes de que se compare con los de tus rutas.
266
-
267
- Puedes perzonalizar las opciones de [Mustermann](https://github.com/sinatra/mustermann) usadas para una ruta pasando
268
- el hash `:mustermann_opts`:
269
-
270
- ```ruby
271
- get '\A/posts\z', :mustermann_opts => { :type => :regexp, :check_anchors => false } do
272
- # es exactamente igual a /posts, con anclaje explícito
273
- "¡Si igualas un patrón anclado aplaude!"
274
- end
275
- ```
276
-
277
- ## Condiciones
278
-
279
- Las rutas pueden incluir una variedad de condiciones de selección, como por
280
- ejemplo el user agent:
281
-
282
- ```ruby
283
- get '/foo', :agent => /Songbird (\d\.\d)[\d\/]*?/ do
284
- "Estás usando la versión de Songbird #{params['agent'][0]}"
285
- end
286
-
287
- get '/foo' do
288
- # Coincide con navegadores que no sean songbird
289
- end
290
- ```
291
-
292
- Otras condiciones disponibles son `host_name` y `provides`:
293
-
294
- ```ruby
295
- get '/', :host_name => /^admin\./ do
296
- "Área de Administración, Acceso denegado!"
297
- end
298
-
299
- get '/', :provides => 'html' do
300
- haml :index
301
- end
302
-
303
- get '/', :provides => ['rss', 'atom', 'xml'] do
304
- builder :feed
305
- end
306
- ```
307
-
308
- `provides` busca el encabezado Accept de la solicitud
309
-
310
-
311
- Puede definir sus propias condiciones fácilmente:
312
-
313
- ```ruby
314
- set(:probabilidad) { |valor| condition { rand <= valor } }
315
-
316
- get '/gana_un_auto', :probabilidad => 0.1 do
317
- "Ganaste!"
318
- end
319
-
320
- get '/gana_un_auto' do
321
- "Lo siento, perdiste."
322
- end
323
- ```
324
-
325
- Para una condición que toma multiples valores usa splat:
326
-
327
- ```ruby
328
- set(:autorizar) do |*roles| # <- mira el splat
329
- condition do
330
- unless sesion_iniciada? && roles.any? {|rol| usuario_actual.tiene_rol? rol }
331
- redirect "/iniciar_sesion/", 303
332
- end
333
- end
334
- end
335
-
336
- get "/mi/cuenta/", :autorizar => [:usuario, :administrador] do
337
- "Detalles de mi cuenta"
338
- end
339
-
340
- get "/solo/administradores/", :autorizar => :administrador do
341
- "Únicamente para administradores!"
342
- end
343
- ```
344
-
345
- ## Valores de Retorno
346
-
347
- El valor de retorno de un bloque de ruta determina por lo menos el cuerpo de la respuesta
348
- transmitida al cliente HTTP o por lo menos al siguiente middleware en la pila de Rack.
349
- Lo más común es que sea un string, como en los ejemplos anteriores.
350
- Sin embargo, otros valores también son aceptados.
351
-
352
- Puedes retornar cualquier objeto que sea una respuesta Rack válida,
353
- un objeto que represente el cuerpo de una respuesta Rack o un código
354
- de estado HTTP:
355
-
356
- * Un arreglo con tres elementos: `[estado (Integer), cabeceras (Hash), cuerpo de
357
- la respuesta (responde a #each)]`
358
- * Un arreglo con dos elementos: `[estado (Integer), cuerpo de la respuesta
359
- (responde a #each)]`
360
- * Un objeto que responde a `#each` y que le pasa únicamente strings al bloque
361
- dado
362
- * Un Integer representando el código de estado
363
-
364
- De esa manera, por ejemplo, podemos fácilmente implementar un ejemplo de streaming:
365
-
366
- ```ruby
367
- class Stream
368
- def each
369
- 100.times { |i| yield "#{i}\n" }
370
- end
371
- end
372
-
373
- get('/') { Stream.new }
374
- ```
375
-
376
- También puedes usar el `stream` helper ([descrito abajo](#streaming-de-respuestas))
377
- para reducir el código repetitivo e incrustar la lógica de stream a la ruta
378
-
379
- ## Comparadores de Rutas Personalizados
380
-
381
- Como se mostró anteriormente, Sinatra permite utilizar strings y expresiones
382
- regulares para definir las rutas. Sin embargo, no termina ahí.Puedes
383
- definir tus propios comparadores muy fácilmente:
384
-
385
- ```ruby
386
- class TodoMenosElPatron
387
- Match = Struct.new(:captures)
388
-
389
- def initialize(excepto)
390
- @excepto = excepto
391
- @capturas = Match.new([])
392
- end
393
-
394
- def match(str)
395
- @capturas unless @excepto === str
396
- end
397
- end
398
-
399
- def cualquiera_menos(patron)
400
- TodoMenosElPatron.new(patron)
401
- end
402
-
403
- get cualquiera_menos("/index") do
404
- # ...
405
- end
406
- ```
407
-
408
- Tenga en cuenta que el ejemplo anterior es un poco rebuscado. Un resultado
409
- similar puede conseguirse más sencillamente:
410
-
411
- ```ruby
412
- get // do
413
- pass if request.path_info == "/index"
414
- # ...
415
- end
416
- ```
417
-
418
- O, usando un look ahead negativo:
419
-
420
- ```ruby
421
- get %r{(?!/index)} do
422
- # ...
423
- end
424
- ```
425
-
426
- ## Archivos Estáticos
427
-
428
- Los archivos estáticos son servidos desde el directorio público
429
- `./public`. Puede especificar una ubicación diferente ajustando la
430
- opción `:public_folder`:
431
-
432
- ```ruby
433
- set :public_folder, __dir__ + '/static'
434
- ```
435
-
436
- Note que el nombre del directorio público no está incluido en la URL. Por
437
- ejemplo, el archivo `./public/css/style.css` se accede a través de
438
- `http://ejemplo.com/css/style.css`.
439
-
440
- Use la configuración `:static_cache_control` para agregar el encabezado
441
- `Cache-Control` (Ver mas [abajo](#control-del-cache)).
442
-
443
- ## Vistas / Plantillas
444
-
445
- Cada lenguaje de plantilla se expone a través de un método de renderizado que
446
- lleva su nombre. Estos métodos simplemente devuelven un string:
447
-
448
- ```ruby
449
- get '/' do
450
- erb :index
451
- end
452
- ```
453
-
454
- Renderiza `views/index.erb`.
455
-
456
- En lugar del nombre de la plantilla puedes proporcionar directamente el
457
- contenido de la misma:
458
-
459
- ```ruby
460
- get '/' do
461
- codigo = "<%= Time.now %>"
462
- erb codigo
463
- end
464
- ```
465
-
466
- Los métodos de renderizado, aceptan además un segundo argumento, el hash de
467
- opciones:
468
-
469
- ```ruby
470
- get '/' do
471
- erb :index, :layout => :post
472
- end
473
- ```
474
-
475
- Renderiza `views/index.erb` incrustado en `views/post.erb` (por
476
- defecto, la plantilla `:index` es incrustada en `views/layout.erb` siempre y
477
- cuando este último archivo exista).
478
-
479
- Cualquier opción que Sinatra no entienda le será pasada al motor de renderizado
480
- de la plantilla:
481
-
482
- ```ruby
483
- get '/' do
484
- haml :index, :format => :html5
485
- end
486
- ```
487
-
488
- Además, puede definir las opciones para un lenguaje de plantillas de forma
489
- general:
490
-
491
- ```ruby
492
- set :haml, :format => :html5
493
-
494
- get '/' do
495
- haml :index
496
- end
497
- ```
498
-
499
- Las opciones pasadas al método de renderizado tienen precedencia sobre las
500
- definidas mediante `set`.
501
-
502
- Opciones disponibles:
503
-
504
- <dl>
505
-
506
- <dt>locals</dt>
507
- <dd>
508
- Lista de variables locales pasadas al documento. Resultan muy útiles cuando
509
- se combinan con parciales.
510
- Ejemplo: <tt>erb "<%= foo %>", :locals => {:foo => "bar"}</tt>
511
- </dd>
512
-
513
- <dt>default_encoding</dt>
514
- <dd>
515
- Encoding utilizado cuando el de un string es dudoso. Por defecto toma el
516
- valor de <tt>settings.default_encoding</tt>.
517
- </dd>
518
-
519
- <dt>views</dt>
520
- <dd>
521
- Directorio desde donde se cargan las vistas. Por defecto toma el valor de
522
- <tt>settings.views</tt>.
523
- </dd>
524
-
525
- <dt>layout</dt>
526
- <dd>
527
- Si es <tt>true</tt> o <tt>false</tt> indica que se debe usar, o no, un layout,
528
- respectivamente. También puede ser un Symbol que especifique qué plantilla
529
- usar. Ejemplo: <tt>erb :index, :layout => !request.xhr?</tt>
530
- </dd>
531
-
532
- <dt>content_type</dt>
533
- <dd>
534
- Content-Type que produce la plantilla. El valor por defecto depende de cada
535
- lenguaje de plantillas.
536
- </dd>
537
-
538
- <dt>scope</dt>
539
- <dd>
540
- Ámbito en el que se renderiza la plantilla. Por defecto utiliza la instancia
541
- de la aplicación. Ten en cuenta que si cambiás esta opción las variables de
542
- instancia y los helpers van a dejar de estar disponibles.
543
- </dd>
544
-
545
- <dt>layout_engine</dt>
546
- <dd>
547
- Motor de renderizado de plantillas que usa para el layout. Resulta
548
- conveniente para lenguajes que no soportan layouts. Por defecto toma el valor
549
- del motor usado para renderizar la plantilla.
550
- Ejemplo: <tt>set :rdoc, :layout_engine => :erb</tt>
551
- </dd>
552
-
553
- <dt>layout_options</dt>
554
- <dd>
555
- Opciones especiales usadas únicamente para renderizar el layout. Ejemplo:
556
- <tt>set :rdoc, :layout_options => { :views => 'views/layouts' }</tt>
557
- </dd>
558
- </dl>
559
-
560
- Se asume que las plantillas están ubicadas directamente bajo el directorio `./views`.
561
- Para usar un directorio diferente:
562
-
563
- ```ruby
564
- set :views, settings.root + '/templates'
565
- ```
566
-
567
- Es importante acordarse que siempre tienes que referenciar a las plantillas con
568
- símbolos, incluso cuando se encuentran en un subdirectorio (en este caso
569
- tienes que usar: `:'subdir/plantilla'` o `'subdir/plantilla'.to_sym`). Esto es debido
570
- a que los métodos de renderización van a renderizar directamente cualquier string que
571
- se les pase como argumento.
572
-
573
- ### Plantillas Literales
574
-
575
- ```ruby
576
- get '/' do
577
- haml '%div.titulo Hola Mundo'
578
- end
579
- ```
580
-
581
- Renderiza el string de la plantilla. Opcionalmente puedes especificar
582
- `:path` y `:line` para un backtrace más claro si hay una ruta del sistema
583
- de archivos o una línea asociada con ese string
584
-
585
- ```ruby
586
- get '/' do
587
- haml '%div.titulo Hola Mundo', :path => 'ejemplos/archivo.haml', :line => 3
588
- end
589
- ```
590
-
591
- ### Lenguajes de Plantillas Disponibles
592
-
593
- Algunos lenguajes tienen varias implementaciones. Para especificar que
594
- implementación usar (y para ser thread-safe), deberías requerirla antes de
595
- usarla:
596
-
597
- ```ruby
598
- require 'rdiscount' # o require 'bluecloth'
599
- get('/') { markdown :index }
600
- ```
601
-
602
- #### Plantillas Haml
603
-
604
- <table>
605
- <tr>
606
- <td>Dependencias</td>
607
- <td><a href="http://haml.info/" title="haml">haml</a></td>
608
- </tr>
609
- <tr>
610
- <td>Expresiones de Archivo</td>
611
- <td><tt>.haml</tt></td>
612
- </tr>
613
- <tr>
614
- <td>Ejemplo</td>
615
- <td><tt>haml :index, :format => :html5</tt></td>
616
- </tr>
617
- </table>
618
-
619
- #### Plantillas Erb
620
-
621
- <table>
622
- <tr>
623
- <td>Dependencias</td>
624
- <td>
625
- <a href="http://www.kuwata-lab.com/erubis/" title="erubis">erubis</a>
626
- o erb (incluida en Ruby)
627
- </td>
628
- </tr>
629
- <tr>
630
- <td>Extensiones de Archivo</td>
631
- <td><tt>.erb</tt>, <tt>.rhtml</tt> o <tt>.erubis</tt> (solamente con Erubis)</td>
632
- </tr>
633
- <tr>
634
- <td>Ejemplo</td>
635
- <td><tt>erb :index</tt></td>
636
- </tr>
637
- </table>
638
-
639
- #### Plantillas Builder
640
-
641
- <table>
642
- <tr>
643
- <td>Dependencias</td>
644
- <td>
645
- <a href="https://github.com/jimweirich/builder" title="builder">builder</a>
646
- </td>
647
- </tr>
648
- <tr>
649
- <td>Extensiones de Archivo</td>
650
- <td><tt>.builder</tt></td>
651
- </tr>
652
- <tr>
653
- <td>Ejemplo</td>
654
- <td><tt>builder { |xml| xml.em "hola" }</tt></td>
655
- </tr>
656
- </table>
657
-
658
- También toma un bloque para plantillas inline (ver [ejemplo](#plantillas-inline)).
659
-
660
- #### Plantillas Nokogiri
661
-
662
- <table>
663
- <tr>
664
- <td>Dependencias</td>
665
- <td><a href="http://www.nokogiri.org/" title="nokogiri">nokogiri</a></td>
666
- </tr>
667
- <tr>
668
- <td>Extensiones de Archivo</td>
669
- <td><tt>.nokogiri</tt></td>
670
- </tr>
671
- <tr>
672
- <td>Ejemplo</td>
673
- <td><tt>nokogiri { |xml| xml.em "hola" }</tt></td>
674
- </tr>
675
- </table>
676
-
677
- También toma un bloque para plantillas inline (ver [ejemplo](#plantillas-inline)).
678
-
679
- #### Plantillas Sass
680
-
681
- <table>
682
- <tr>
683
- <td>Dependencias</td>
684
- <td><a href="http://sass-lang.com/" title="sass">sass</a></td>
685
- </tr>
686
- <tr>
687
- <td>Extensiones de Archivo</td>
688
- <td><tt>.sass</tt></td>
689
- </tr>
690
- <tr>
691
- <td>Ejemplo</td>
692
- <td><tt>sass :stylesheet, :style => :expanded</tt></td>
693
- </tr>
694
- </table>
695
-
696
- #### Plantillas SCSS
697
-
698
- <table>
699
- <tr>
700
- <td>Dependencias</td>
701
- <td><a href="http://sass-lang.com/" title="sass">sass</a></td>
702
- </tr>
703
- <tr>
704
- <td>Extensiones de Archivo</td>
705
- <td><tt>.scss</tt></td>
706
- </tr>
707
- <tr>
708
- <td>Ejemplo</td>
709
- <td><tt>scss :stylesheet, :style => :expanded</tt></td>
710
- </tr>
711
- </table>
712
-
713
- #### Plantillas Less
714
-
715
- <table>
716
- <tr>
717
- <td>Dependencias</td>
718
- <td><a href="http://lesscss.org/" title="less">less</a></td>
719
- </tr>
720
- <tr>
721
- <td>Extensiones de Archivo</td>
722
- <td><tt>.less</tt></td>
723
- </tr>
724
- <tr>
725
- <td>Ejemplo</td>
726
- <td><tt>less :stylesheet</tt></td>
727
- </tr>
728
- </table>
729
-
730
- #### Plantillas Liquid
731
-
732
- <table>
733
- <tr>
734
- <td>Dependencias</td>
735
- <td><a href="https://shopify.github.io/liquid/" title="liquid">liquid</a></td>
736
- </tr>
737
- <tr>
738
- <td>Extensiones de Archivo</td>
739
- <td><tt>.liquid</tt></td>
740
- </tr>
741
- <tr>
742
- <td>Ejemplo</td>
743
- <td><tt>liquid :index, :locals => { :clave => 'valor' }</tt></td>
744
- </tr>
745
- </table>
746
-
747
- Como no va a poder llamar a métodos de Ruby (excepto por `yield`) desde una
748
- plantilla Liquid, casi siempre va a querer pasarle locales.
749
-
750
- #### Plantillas Markdown
751
-
752
- <table>
753
- <tr>
754
- <td>Dependencias</td>
755
- <td>
756
- <a href="https://github.com/davidfstr/rdiscount" title="RDiscount">RDiscount</a>,
757
- <a href="https://github.com/vmg/redcarpet" title="RedCarpet">RedCarpet</a>,
758
- <a href="https://github.com/ged/bluecloth" title="bluecloth">BlueCloth</a>,
759
- <a href="http://kramdown.gettalong.org/" title="kramdown">kramdown</a> o
760
- <a href="https://github.com/bhollis/maruku" title="maruku">maruku</a>
761
- </td>
762
- </tr>
763
- <tr>
764
- <td>Extensiones de Archivo</td>
765
- <td><tt>.markdown</tt>, <tt>.mkd</tt> y <tt>.md</tt></td>
766
- </tr>
767
- <tr>
768
- <td>Ejemplo</td>
769
- <td><tt>markdown :index, :layout_engine => :erb</tt></td>
770
- </tr>
771
- </table>
772
-
773
- No es posible llamar métodos desde markdown, ni pasarle locales. Por lo tanto,
774
- generalmente va a usarlo en combinación con otro motor de renderizado:
775
-
776
- ```ruby
777
- erb :resumen, :locals => { :texto => markdown(:introduccion) }
778
- ```
779
-
780
- Tenga en cuenta que también puedes llamar al método `markdown` desde otras
781
- plantillas:
782
-
783
- ```ruby
784
- %h1 Hola Desde Haml!
785
- %p= markdown(:saludos)
786
- ```
787
-
788
- Como no puede utilizar Ruby desde Markdown, no puede usar layouts escritos en
789
- Markdown. De todos modos, es posible usar un motor de renderizado para el
790
- layout distinto al de la plantilla pasando la opción `:layout_engine`.
791
-
792
- #### Plantillas Textile
793
-
794
- <table>
795
- <tr>
796
- <td>Dependencias</td>
797
- <td><a href="http://redcloth.org/" title="RedCloth">RedCloth</a></td>
798
- </tr>
799
- <tr>
800
- <td>Extensiones de Archivo</td>
801
- <td><tt>.textile</tt></td>
802
- </tr>
803
- <tr>
804
- <td>Ejemplo</td>
805
- <td><tt>textile :index, :layout_engine => :erb</tt></td>
806
- </tr>
807
- </table>
808
-
809
- No es posible llamar métodos desde textile, ni pasarle locales. Por lo tanto,
810
- generalmente vas a usarlo en combinación con otro motor de renderizado:
811
-
812
- ```ruby
813
- erb :resumen, :locals => { :texto => textile(:introduccion) }
814
- ```
815
-
816
- Ten en cuenta que también puedes llamar al método `textile` desde otras
817
- plantillas:
818
-
819
- ```ruby
820
- %h1 Hola Desde Haml!
821
- %p= textile(:saludos)
822
- ```
823
-
824
- Como no puedes utilizar Ruby desde Textile, no puedes usar layouts escritos en
825
- Textile. De todos modos, es posible usar un motor de renderizado para el
826
- layout distinto al de la plantilla pasando la opción `:layout_engine`.
827
-
828
- #### Plantillas RDoc
829
-
830
- <table>
831
- <tr>
832
- <td>Dependencias</td>
833
- <td><a href="http://rdoc.sourceforge.net/" title="RDoc">RDoc</a></td>
834
- </tr>
835
- <tr>
836
- <td>Extensiones de Archivo</td>
837
- <td><tt>.rdoc</tt></td>
838
- </tr>
839
- <tr>
840
- <td>Ejemplo</td>
841
- <td><tt>rdoc :README, :layout_engine => :erb</tt></td>
842
- </tr>
843
- </table>
844
-
845
- No es posible llamar métodos desde rdoc, ni pasarle locales. Por lo tanto,
846
- generalmente vas a usarlo en combinación con otro motor de renderizado:
847
-
848
- ```ruby
849
- erb :resumen, :locals => { :texto => rdoc(:introduccion) }
850
- ```
851
-
852
- Ten en cuenta que también puedes llamar al método `rdoc` desde otras
853
- plantillas:
854
-
855
- ```ruby
856
- %h1 Hola Desde Haml!
857
- %p= rdoc(:saludos)
858
- ```
859
-
860
- Como no puedes utilizar Ruby desde RDoc, no puedes usar layouts escritos en RDoc.
861
- De todos modos, es posible usar un motor de renderizado para el layout distinto
862
- al de la plantilla pasando la opción `:layout_engine`.
863
-
864
- #### Plantillas AsciiDoc
865
-
866
- <table>
867
- <tr>
868
- <td>Dependencia</td>
869
- <td><a href="http://asciidoctor.org/" title="Asciidoctor">Asciidoctor</a></td>
870
- </tr>
871
- <tr>
872
- <td>Extensiones de Archivo</td>
873
- <td><tt>.asciidoc</tt>, <tt>.adoc</tt> and <tt>.ad</tt></td>
874
- </tr>
875
- <tr>
876
- <td>Ejemplo</td>
877
- <td><tt>asciidoc :README, :layout_engine => :erb</tt></td>
878
- </tr>
879
- </table>
880
-
881
- Desde que no se puede utilizar métodos de Ruby desde una
882
- plantilla AsciiDoc, casi siempre va a querer pasarle locales.
883
-
884
- #### Plantillas Radius
885
-
886
- <table>
887
- <tr>
888
- <td>Dependencias</td>
889
- <td><a href="https://github.com/jlong/radius" title="Radius">Radius</a></td>
890
- </tr>
891
- <tr>
892
- <td>Extensiones de Archivo</td>
893
- <td><tt>.radius</tt></td>
894
- </tr>
895
- <tr>
896
- <td>Ejemplo</td>
897
- <td><tt>radius :index, :locals => { :clave => 'valor' }</tt></td>
898
- </tr>
899
- </table>
900
-
901
- Desde que no se puede utilizar métodos de Ruby (excepto por `yield`) de una
902
- plantilla Radius, casi siempre se necesita pasar locales.
903
-
904
- #### Plantillas Markaby
905
-
906
- <table>
907
- <tr>
908
- <td>Dependencias</td>
909
- <td><a href="http://markaby.github.io/" title="Markaby">Markaby</a></td>
910
- </tr>
911
- <tr>
912
- <td>Extensiones de Archivo</td>
913
- <td><tt>.mab</tt></td>
914
- </tr>
915
- <tr>
916
- <td>Ejemplo</td>
917
- <td><tt>markaby { h1 "Bienvenido!" }</tt></td>
918
- </tr>
919
- </table>
920
-
921
- También toma un bloque para plantillas inline (ver [ejemplo](#plantillas-inline)).
922
-
923
- #### Plantillas RABL
924
-
925
- <table>
926
- <tr>
927
- <td>Dependencias</td>
928
- <td><a href="https://github.com/nesquena/rabl" title="Rabl">Rabl</a></td>
929
- </tr>
930
- <tr>
931
- <td>Extensiones de Archivo</td>
932
- <td><tt>.rabl</tt></td>
933
- </tr>
934
- <tr>
935
- <td>Ejemplo</td>
936
- <td><tt>rabl :index</tt></td>
937
- </tr>
938
- </table>
939
-
940
- #### Plantillas Slim
941
-
942
- <table>
943
- <tr>
944
- <td>Dependencias</td>
945
- <td><a href="http://slim-lang.com/" title="Slim Lang">Slim Lang</a></td>
946
- </tr>
947
- <tr>
948
- <td>Extensiones de Archivo</td>
949
- <td><tt>.slim</tt></td>
950
- </tr>
951
- <tr>
952
- <td>Ejemplo</td>
953
- <td><tt>slim :index</tt></td>
954
- </tr>
955
- </table>
956
-
957
- #### Plantillas Creole
958
-
959
- <table>
960
- <tr>
961
- <td>Dependencias</td>
962
- <td><a href="https://github.com/minad/creole" title="Creole">Creole</a></td>
963
- </tr>
964
- <tr>
965
- <td>Extensiones de Archivo</td>
966
- <td><tt>.creole</tt></td>
967
- </tr>
968
- <tr>
969
- <td>Ejemplo</td>
970
- <td><tt>creole :wiki, :layout_engine => :erb</tt></td>
971
- </tr>
972
- </table>
973
-
974
- No es posible llamar métodos desde creole, ni pasarle locales. Por lo tanto,
975
- generalmente va a usarlo en combinación con otro motor de renderizado:
976
-
977
- ```ruby
978
- erb :resumen, :locals => { :texto => cerole(:introduccion) }
979
- ```
980
-
981
- Debe tomar en cuenta que también puede llamar al método `creole` desde otras
982
- plantillas:
983
-
984
- ```ruby
985
- %h1 Hola Desde Haml!
986
- %p= creole(:saludos)
987
- ```
988
-
989
- Como no puedes utilizar Ruby desde Creole, no puedes usar layouts escritos en
990
- Creole. De todos modos, es posible usar un motor de renderizado para el layout
991
- distinto al de la plantilla pasando la opción `:layout_engine`.
992
-
993
- #### MediaWiki Templates
994
-
995
- <table>
996
- <tr>
997
- <td>Dependencia</td>
998
- <td><a href="https://github.com/nricciar/wikicloth" title="WikiCloth">WikiCloth</a></td>
999
- </tr>
1000
- <tr>
1001
- <td>Extension de Archivo</td>
1002
- <td><tt>.mediawiki</tt> and <tt>.mw</tt></td>
1003
- </tr>
1004
- <tr>
1005
- <td>Ejemplo</td>
1006
- <td><tt>mediawiki :wiki, :layout_engine => :erb</tt></td>
1007
- </tr>
1008
- </table>
1009
-
1010
- No es posible llamar métodos desde el markup de MediaWiki, ni pasar locales al mismo.
1011
- Por lo tanto usualmente lo usarás en combinación con otro motor de renderizado:
1012
-
1013
- ```ruby
1014
- erb :overview, :locals => { :text => mediawiki(:introduction) }
1015
- ```
1016
-
1017
- Nota que también puedes llamar al método `mediawiki` desde dentro de otras plantillas:
1018
-
1019
- ```ruby
1020
- %h1 Hello From Haml!
1021
- %p= mediawiki(:greetings)
1022
- ```
1023
-
1024
- Debido a que no puedes llamar a Ruby desde MediaWiki, no puedes usar los diseños escritos en MediaWiki.
1025
- De todas maneras, es posible usar otro motor de renderizado para esa plantilla pasando la opción :layout_engine.
1026
-
1027
- #### Plantillas CoffeeScript
1028
-
1029
- <table>
1030
- <tr>
1031
- <td>Dependencias</td>
1032
- <td>
1033
- <a href="https://github.com/josh/ruby-coffee-script" title="Ruby CoffeeScript">
1034
- CoffeeScript
1035
- </a> y un
1036
- <a href="https://github.com/sstephenson/execjs/blob/master/README.md#readme" title="ExecJS">
1037
- mecanismo para ejecutar javascript
1038
- </a>
1039
- </td>
1040
- </tr>
1041
- <tr>
1042
- <td>Extensiones de Archivo</td>
1043
- <td><tt>.coffee</tt></td>
1044
- </tr>
1045
- <tr>
1046
- <td>Ejemplo</td>
1047
- <td><tt>coffee :index</tt></td>
1048
- </tr>
1049
- </table>
1050
-
1051
- #### Plantillas Stylus
1052
-
1053
- <table>
1054
- <tr>
1055
- <td>Dependencias</td>
1056
- <td>
1057
- <a href="https://github.com/forgecrafted/ruby-stylus" title="Ruby Stylus">
1058
- Stylus
1059
- </a> y un
1060
- <a href="https://github.com/sstephenson/execjs/blob/master/README.md#readme" title="ExecJS">
1061
- mecanismo para ejecutar javascript
1062
- </a>
1063
- </td>
1064
- </tr>
1065
- <tr>
1066
- <td>Extensiones de Archivo</td>
1067
- <td><tt>.styl</tt></td>
1068
- </tr>
1069
- <tr>
1070
- <td>Ejemplo</td>
1071
- <td><tt>stylus :index</tt></td>
1072
- </tr>
1073
- </table>
1074
-
1075
- Antes de poder usar las plantillas de Stylus, necesitas cargar `stylus` y `stylus/tilt`:
1076
-
1077
- ```ruby
1078
- require 'sinatra'
1079
- require 'stylus'
1080
- require 'stylus/tilt'
1081
-
1082
- get '/' do
1083
- stylus :example
1084
- end
1085
- ```
1086
-
1087
- #### Plantillas Yajl
1088
-
1089
- <table>
1090
- <tr>
1091
- <td>Dependencias</td>
1092
- <td><a href="https://github.com/brianmario/yajl-ruby" title="yajl-ruby">yajl-ruby</a></td>
1093
- </tr>
1094
- <tr>
1095
- <td>Extensiones de Archivo</td>
1096
- <td><tt>.yajl</tt></td>
1097
- </tr>
1098
- <tr>
1099
- <td>Ejemplo</td>
1100
- <td>
1101
- <tt>
1102
- yajl :index,
1103
- :locals => { :key => 'qux' },
1104
- :callback => 'present',
1105
- :variable => 'resource'
1106
- </tt>
1107
- </td>
1108
- </tr>
1109
- </table>
1110
-
1111
- El contenido de la plantilla se evalúa como código Ruby, y la variable `json` es convertida a JSON mediante `#to_json`.
1112
-
1113
- ```ruby
1114
- json = { :foo => 'bar' }
1115
- json[:baz] = key
1116
- ```
1117
-
1118
- Las opciones `:callback` y `:variable` se pueden utilizar para decorar el objeto renderizado:
1119
-
1120
- ```ruby
1121
- var contenido = {"foo":"bar","baz":"qux"};
1122
- present(contenido);
1123
- ```
1124
-
1125
- #### Plantillas WLang
1126
-
1127
- <table>
1128
- <tr>
1129
- <td>Dependencias</td>
1130
- <td><a href="https://github.com/blambeau/wlang/" title="wlang">wlang</a></td>
1131
- </tr>
1132
- <tr>
1133
- <td>Extensiones de Archivo</td>
1134
- <td><tt>.wlang</tt></td>
1135
- </tr>
1136
- <tr>
1137
- <td>Ejemplo</td>
1138
- <td><tt>wlang :index, :locals => { :clave => 'valor' }</tt></td>
1139
- </tr>
1140
- </table>
1141
-
1142
- Como no vas a poder llamar a métodos de Ruby (excepto por `yield`) desde una
1143
- plantilla WLang, casi siempre vas a querer pasarle locales.
1144
-
1145
- ### Accediendo a Variables en Plantillas
1146
-
1147
- Las plantillas son evaluadas dentro del mismo contexto que los manejadores de
1148
- ruta. Las variables de instancia asignadas en los manejadores de ruta son
1149
- accesibles directamente por las plantillas:
1150
-
1151
- ```ruby
1152
- get '/:id' do
1153
- @foo = Foo.find(params['id'])
1154
- haml '%h1= @foo.nombre'
1155
- end
1156
- ```
1157
-
1158
- O es posible especificar un Hash de variables locales explícitamente:
1159
-
1160
- ```ruby
1161
- get '/:id' do
1162
- foo = Foo.find(params['id'])
1163
- haml '%h1= bar.nombre', :locals => { :bar => foo }
1164
- end
1165
- ```
1166
-
1167
- Esto es usado típicamente cuando se renderizan plantillas como parciales desde
1168
- adentro de otras plantillas.
1169
-
1170
- ### Plantillas con `yield` y `layout` anidado
1171
-
1172
- Un layout es usualmente una plantilla que llama a `yield`.
1173
- Dicha plantilla puede ser usada tanto a travé de la opción `:template`
1174
- como describimos arriba, o puede ser rederizada con un bloque como a
1175
- continuación:
1176
-
1177
- ```ruby
1178
- erb :post, :layout => false do
1179
- erb :index
1180
- end
1181
- ```
1182
- Este código es principalmente equivalente a `erb :index, :layout => :post`.
1183
-
1184
- Pasar bloques a métodos de renderizado es la forma mas útil de crear layouts anidados:
1185
-
1186
- ```ruby
1187
- erb :main_layout, :layout => false do
1188
- erb :admin_layout do
1189
- erb :user
1190
- end
1191
- end
1192
- ```
1193
-
1194
- Esto también se puede hacer en menos líneas de código con:
1195
-
1196
- ```ruby
1197
- erb :admin_layout, :layout => :main_layout do
1198
- erb :user
1199
- end
1200
- ```
1201
-
1202
- Actualmente, los siguientes métodos de renderizado aceptan un bloque: `erb`, `haml`,
1203
- `liquid`, `slim `, `wlang`. También el método general de `render` acepta un bloque.
1204
-
1205
- ### Plantillas Inline
1206
-
1207
- Las plantillas pueden ser definidas al final del archivo fuente:
1208
-
1209
- ```ruby
1210
- require 'sinatra'
1211
-
1212
- get '/' do
1213
- haml :index
1214
- end
1215
-
1216
- __END__
1217
-
1218
- @@ layout
1219
- %html
1220
- = yield
1221
-
1222
- @@ index
1223
- %div.titulo Hola Mundo
1224
- ```
1225
-
1226
- NOTA: Únicamente las plantillas inline definidas en el archivo fuente que
1227
- requiere Sinatra son cargadas automáticamente. Llamá `enable
1228
- :inline_templates` explícitamente si tienes plantillas inline en otros
1229
- archivos fuente.
1230
-
1231
- ### Plantillas Nombradas
1232
-
1233
- Las plantillas también pueden ser definidas usando el método top-level
1234
- `template`:
1235
-
1236
- ```ruby
1237
- template :layout do
1238
- "%html\n =yield\n"
1239
- end
1240
-
1241
- template :index do
1242
- '%div.titulo Hola Mundo!'
1243
- end
1244
-
1245
- get '/' do
1246
- haml :index
1247
- end
1248
- ```
1249
-
1250
- Si existe una plantilla con el nombre "layout", va a ser usada cada vez que
1251
- una plantilla es renderizada.Puedes desactivar los layouts individualmente
1252
- pasando `:layout => false` o globalmente con
1253
- `set :haml, :layout => false`:
1254
-
1255
- ```ruby
1256
- get '/' do
1257
- haml :index, :layout => !request.xhr?
1258
- end
1259
- ```
1260
-
1261
- ### Asociando Extensiones de Archivo
1262
-
1263
- Para asociar una extensión de archivo con un motor de renderizado, usa
1264
- `Tilt.register`. Por ejemplo, si quieres usar la extensión `tt` para
1265
- las plantillas Textile, puedes hacer lo siguiente:
1266
-
1267
- ```ruby
1268
- Tilt.register :tt, Tilt[:textile]
1269
- ```
1270
-
1271
- ### Añadiendo Tu Propio Motor de Plantillas
1272
-
1273
- Primero, registra tu motor con Tilt, y después, creá tu método de renderizado:
1274
-
1275
- ```ruby
1276
- Tilt.register :mipg, MiMotorDePlantilla
1277
-
1278
- helpers do
1279
- def mypg(*args) render(:mypg, *args) end
1280
- end
1281
-
1282
- get '/' do
1283
- mypg :index
1284
- end
1285
- ```
1286
-
1287
- Renderiza `./views/index.mypg`. Mirá https://github.com/rtomayko/tilt
1288
- para aprender más de Tilt.
1289
-
1290
- ### Usando Lógica Personalizada para la Búsqueda en Plantillas
1291
-
1292
- Para implementar tu propio mecanismo de búsqueda de plantillas puedes
1293
- escribir tu propio método `#find_template`
1294
-
1295
- ```ruby
1296
- configure do
1297
- set :views [ './views/a', './views/b' ]
1298
- end
1299
-
1300
- def find_template(views, name, engine, &block)
1301
- Array(views).each do |v|
1302
- super(v, name, engine, &block)
1303
- end
1304
- end
1305
- ```
1306
-
1307
- ## Filtros
1308
-
1309
- Los filtros `before` son evaluados antes de cada petición dentro del mismo
1310
- contexto que las rutas. Pueden modificar la petición y la respuesta. Las
1311
- variables de instancia asignadas en los filtros son accesibles por las rutas y
1312
- las plantillas:
1313
-
1314
- ```ruby
1315
- before do
1316
- @nota = 'Hey!'
1317
- request.path_info = '/foo/bar/baz'
1318
- end
1319
-
1320
- get '/foo/*' do
1321
- @nota #=> 'Hey!'
1322
- params['splat'] #=> 'bar/baz'
1323
- end
1324
- ```
1325
-
1326
- Los filtros `after` son evaluados después de cada petición dentro del mismo
1327
- contexto y también pueden modificar la petición y la respuesta. Las variables
1328
- de instancia asignadas en los filtros `before` y en las rutas son accesibles por
1329
- los filtros `after`:
1330
-
1331
- ```ruby
1332
- after do
1333
- puts response.status
1334
- end
1335
- ```
1336
-
1337
- Nota: A menos que uses el método `body` en lugar de simplemente devolver un
1338
- string desde una ruta, el cuerpo de la respuesta no va a estar disponible en
1339
- un filtro after, debido a que todavía no se ha generado.
1340
-
1341
- Los filtros aceptan un patrón opcional, que cuando está presente causa que los
1342
- mismos sean evaluados únicamente si el path de la petición coincide con ese
1343
- patrón:
1344
-
1345
- ```ruby
1346
- before '/protegido/*' do
1347
- autenticar!
1348
- end
1349
-
1350
- after '/crear/:slug' do |slug|
1351
- session[:ultimo_slug] = slug
1352
- end
1353
- ```
1354
-
1355
- Al igual que las rutas, los filtros también pueden aceptar condiciones:
1356
-
1357
- ```ruby
1358
- before :agent => /Songbird/ do
1359
- # ...
1360
- end
1361
-
1362
- after '/blog/*', :host_name => 'ejemplo.com' do
1363
- # ...
1364
- end
1365
- ```
1366
-
1367
- ## Helpers
1368
-
1369
- Usá el método top-level `helpers` para definir métodos ayudantes (helpers) que
1370
- pueden ser utilizados dentro de los manejadores de rutas y las plantillas:
1371
-
1372
- ```ruby
1373
- helpers do
1374
- def bar(nombre)
1375
- "#{nombre}bar"
1376
- end
1377
- end
1378
-
1379
- get '/:nombre' do
1380
- bar(params['nombre'])
1381
- end
1382
- ```
1383
-
1384
- Por cuestiones organizativas, puede resultar conveniente organizar los métodos
1385
- helpers en distintos módulos:
1386
-
1387
- ```ruby
1388
- module FooUtils
1389
- def foo(nombre) "#{nombre}foo" end
1390
- end
1391
-
1392
- module BarUtils
1393
- def bar(nombre) "#{nombre}bar" end
1394
- end
1395
-
1396
- helpers FooUtils, BarUtils
1397
- ```
1398
-
1399
- El efecto de utilizar `helpers` de esta manera es el mismo que resulta de
1400
- incluir los módulos en la clase de la aplicación.
1401
-
1402
- ### Usando Sesiones
1403
-
1404
- Una sesión es usada para mantener el estado a través de distintas peticiones.
1405
- Cuando están activadas, proporciona un hash de sesión para cada sesión de usuario:
1406
-
1407
- ```ruby
1408
- enable :sessions
1409
-
1410
- get '/' do
1411
- "valor = " << session[:valor].inspect
1412
- end
1413
-
1414
- get '/:valor' do
1415
- session[:valor] = params['valor']
1416
- end
1417
- ```
1418
-
1419
- #### Secreto de Sesión
1420
-
1421
- Para mejorar la seguridad, los datos de la sesión en la cookie se firman con un secreto usando `HMAC-SHA1`. El secreto de esta sesión debería ser de manera óptima
1422
- un valor aleatorio criptográficamente seguro de una longitud adecuada para
1423
- `HMAC-SHA1` que es mayor o igual que 64 bytes (512 bits, 128 hex caracteres).
1424
- Se le aconsejará que no use un secreto que sea inferior a 32
1425
- bytes de aleatoriedad (256 bits, 64 caracteres hexadecimales).
1426
- Por lo tanto, es **muy importante** que no solo invente el secreto,
1427
- sino que use un generador de números aleatorios para crearlo.
1428
- Los humanos somos extremadamente malos generando valores aleatorios
1429
-
1430
- De forma predeterminada, un secreto de sesión aleatorio seguro de 32 bytes se genera para usted por
1431
- Sinatra, pero cambiará con cada reinicio de su aplicación. Si tienes varias
1432
- instancias de tu aplicación y dejas que Sinatra genere la clave, cada instancia
1433
- tendría una clave de sesión diferente y probablemente no es lo que quieres.
1434
-
1435
- Para una mejor seguridad y usabilidad es
1436
- [recomendado](https://12factor.net/config) que genere un secreto de sesión
1437
- aleatorio seguro y se guarde en las variables de entorno en cada host que ejecuta
1438
- su aplicación para que todas las instancias de su aplicación compartan el mismo
1439
- secreto. Debería rotar periódicamente esta sesión secreta a un nuevo valor.
1440
- Aquí hay algunos ejemplos de cómo puede crear un secreto de 64 bytes y configurarlo:
1441
-
1442
- **Generación de Secreto de Sesión**
1443
-
1444
- ```text
1445
- $ ruby -e "require 'securerandom'; puts SecureRandom.hex(64)"
1446
- 99ae8af...snip...ec0f262ac
1447
- ```
1448
-
1449
- **Generación de Secreto de Sesión (Puntos Extras)**
1450
-
1451
- Usa la [gema sysrandom](https://github.com/cryptosphere/sysrandom) para preferir
1452
- el uso de el sistema RNG para generar valores aleatorios en lugar de
1453
- espacio de usuario `OpenSSL` que MRI Ruby tiene por defecto:
1454
-
1455
- ```text
1456
- $ gem install sysrandom
1457
- Building native extensions. This could take a while...
1458
- Successfully installed sysrandom-1.x
1459
- 1 gem installed
1460
-
1461
- $ ruby -e "require 'sysrandom/securerandom'; puts SecureRandom.hex(64)"
1462
- 99ae8af...snip...ec0f262ac
1463
- ```
1464
-
1465
- **Secreto de Sesión en Variable de Entorno**
1466
-
1467
- Establezca una variable de entorno `SESSION_SECRET` para Sinatra en el valor que
1468
- generaste. Haz que este valor sea persistente durante los reinicios de su host. El
1469
- método para hacer esto variará a través de los sistemas operativos, esto es para
1470
- propósitos ilustrativos solamente:
1471
-
1472
-
1473
- ```bash
1474
- # echo "export SESSION_SECRET=99ae8af...snip...ec0f262ac" >> ~/.bashrc
1475
- ```
1476
-
1477
- **Configuración de la Aplicación y su Secreto de Sesión**
1478
-
1479
- Configura tu aplicación a prueba de fallas si la variable de entorno
1480
- `SESSION_SECRET` no esta disponible
1481
-
1482
- Para puntos extras usa la [gema sysrandom](https://github.com/cryptosphere/sysrandom) acá tambien:
1483
-
1484
- ```ruby
1485
- require 'securerandom'
1486
- # -or- require 'sysrandom/securerandom'
1487
- set :session_secret, ENV.fetch('SESSION_SECRET') { SecureRandom.hex(64) }
1488
- ```
1489
-
1490
- #### Configuración de Sesión
1491
-
1492
- Si desea configurarlo más, también puede almacenar un hash con opciones
1493
- en la configuración `sessions`:
1494
-
1495
- ```ruby
1496
- set :sessions, :domain => 'foo.com'
1497
- ```
1498
-
1499
- Para compartir su sesión en otras aplicaciones en subdominios de foo.com, agregue el prefijo
1500
- dominio con un *.* como este en su lugar:
1501
-
1502
- ```ruby
1503
- set :sessions, :domain => '.foo.com'
1504
- ```
1505
-
1506
- #### Escogiendo tu Propio Middleware de Sesión
1507
-
1508
- Tenga en cuenta que `enable :sessions` en realidad almacena todos los datos en una cookie.
1509
- Esto no siempre podria ser lo que quieres (almacenar muchos datos aumentará su
1510
- tráfico, por ejemplo). Puede usar cualquier middleware de sesión proveniente de Rack
1511
- para hacerlo, se puede utilizar uno de los siguientes métodos:
1512
-
1513
- ```ruby
1514
- enable :sessions
1515
- set :session_store, Rack::Session::Pool
1516
- ```
1517
-
1518
- O para configurar sesiones con un hash de opciones:
1519
-
1520
- ```ruby
1521
- set :sessions, :expire_after => 2592000
1522
- set :session_store, Rack::Session::Pool
1523
- ```
1524
-
1525
- Otra opción es **no** llamar a `enable :sessions`, sino
1526
- su middleware de elección como lo haría con cualquier otro middleware.
1527
-
1528
- Es importante tener en cuenta que al usar este método, la protección
1529
- de sesiones **no estará habilitada por defecto**.
1530
-
1531
- También será necesario agregar el middleware de Rack para hacer eso:
1532
-
1533
- ```ruby
1534
- use Rack::Session::Pool, :expire_after => 2592000
1535
- use Rack::Protection::RemoteToken
1536
- use Rack::Protection::SessionHijacking
1537
- ```
1538
-
1539
- Mira '[Configurando la protección contra ataques](#configurando-la-protección-contra-ataques)' para mas información.
1540
-
1541
- ### Interrupción
1542
-
1543
- Para detener inmediatamente una petición dentro de un filtro o una ruta debes usar:
1544
-
1545
- ```ruby
1546
- halt
1547
- ```
1548
-
1549
- También puedes especificar el estado:
1550
-
1551
- ```ruby
1552
- halt 410
1553
- ```
1554
-
1555
- O el cuerpo:
1556
-
1557
- ```ruby
1558
- halt 'esto va a ser el cuerpo'
1559
- ```
1560
-
1561
- O los dos:
1562
-
1563
- ```ruby
1564
- halt 401, 'salí de acá!'
1565
- ```
1566
-
1567
- Con cabeceras:
1568
-
1569
- ```ruby
1570
- halt 402, { 'Content-Type' => 'text/plain' }, 'venganza'
1571
- ```
1572
-
1573
- Obviamente, es posible utilizar `halt` con una plantilla:
1574
-
1575
- ```ruby
1576
- halt erb(:error)
1577
- ```
1578
-
1579
- ### Paso
1580
-
1581
- Una ruta puede pasarle el procesamiento a la siguiente ruta que coincida con
1582
- la petición usando `pass`:
1583
-
1584
- ```ruby
1585
- get '/adivina/:quien' do
1586
- pass unless params['quien'] == 'Franco'
1587
- 'Adivinaste!'
1588
- end
1589
-
1590
- get '/adivina/*' do
1591
- 'Erraste!'
1592
- end
1593
- ```
1594
-
1595
- Se sale inmediatamente del bloque de la ruta y se le pasa el control a la
1596
- siguiente ruta que coincida. Si no coincide ninguna ruta, se devuelve 404.
1597
-
1598
- ### Desencadenando Otra Ruta
1599
-
1600
- A veces, `pass` no es lo que quieres, sino obtener el
1601
- resultado de la llamada a otra ruta. Simplemente use `call` para lograr esto:
1602
-
1603
- ```ruby
1604
- get '/foo' do
1605
- status, headers, body = call env.merge("PATH_INFO" => '/bar')
1606
- [status, headers, body.map(&:upcase)]
1607
- end
1608
-
1609
- get '/bar' do
1610
- "bar"
1611
- end
1612
- ```
1613
-
1614
- Nota que en el ejemplo anterior, es conveniente mover `"bar"` a un
1615
- helper, y llamarlo desde `/foo` y `/bar`. Así, vas a simplificar
1616
- las pruebas y a mejorar el rendimiento.
1617
-
1618
- Si quieres que la petición se envíe a la misma instancia de la aplicación en
1619
- lugar de otra, usá `call!` en lugar de `call`.
1620
-
1621
- En la especificación de Rack puedes encontrar más información sobre
1622
- `call`.
1623
-
1624
- ### Configurando el Cuerpo, Código de Estado y los Encabezados
1625
-
1626
- Es posible, y se recomienda, asignar el código de estado y el cuerpo de una
1627
- respuesta con el valor de retorno de una ruta. Sin embargo, en algunos
1628
- escenarios puede que sea conveniente asignar el cuerpo en un punto arbitrario
1629
- del flujo de ejecución con el método helper `body`. A partir de ahí, puedes usar ese
1630
- mismo método para acceder al cuerpo de la respuesta:
1631
-
1632
- ```ruby
1633
- get '/foo' do
1634
- body "bar"
1635
- end
1636
-
1637
- after do
1638
- puts body
1639
- end
1640
- ```
1641
-
1642
- También es posible pasarle un bloque a `body`, que será ejecutado por el Rack
1643
- handler (puedes usar esto para implementar streaming, mira ["Valores de Retorno"](#valores-de-retorno)).
1644
-
1645
- De manera similar, también puedes asignar el código de estado y encabezados:
1646
-
1647
- ```ruby
1648
- get '/foo' do
1649
- status 418
1650
- headers \
1651
- "Allow" => "BREW, POST, GET, PROPFIND, WHEN",
1652
- "Refresh" => "Refresh: 20; http://www.ietf.org/rfc/rfc2324.txt"
1653
- body "I'm a tea pot!"
1654
- end
1655
- ```
1656
-
1657
- También, al igual que `body`, `status` y `headers` sin agregarles argumentos pueden usarse
1658
- para acceder a sus valores actuales.
1659
-
1660
- ### Streaming De Respuestas
1661
-
1662
- A veces vas a querer empezar a enviar la respuesta a pesar de que todavía no
1663
- terminaste de generar su cuerpo. También es posible que, en algunos casos,
1664
- quieras seguir enviando información hasta que el cliente cierre la conexión.
1665
- Cuando esto ocurra, el helper `stream` te va a ser de gran ayuda:
1666
-
1667
- ```ruby
1668
- get '/' do
1669
- stream do |out|
1670
- out << "Esto va a ser legen -\n"
1671
- sleep 0.5
1672
- out << " (esperalo) \n"
1673
- sleep 1
1674
- out << "- dario!\n"
1675
- end
1676
- end
1677
- ```
1678
-
1679
- Puedes implementar APIs de streaming,
1680
- [Server-Sent Events](https://html.spec.whatwg.org/multipage/server-sent-events.html#server-sent-events) y puede ser usado
1681
- como base para [WebSockets](https://es.wikipedia.org/wiki/WebSockets). También
1682
- puede ser usado para incrementar el throughput si solo una parte del contenido
1683
- depende de un recurso lento.
1684
-
1685
- Hay que tener en cuenta que el comportamiento del streaming, especialmente el
1686
- número de peticiones concurrentes, depende del servidor web utilizado para
1687
- alojar la aplicación. Puede que algunos servidores no soporten streaming
1688
- directamente, así el cuerpo de la respuesta será enviado completamente de una
1689
- vez cuando el bloque pasado a `stream` finalice su ejecución. Si estás usando
1690
- Shotgun, el streaming no va a funcionar.
1691
-
1692
- Cuando se pasa `keep_open` como parámetro, no se va a enviar el mensaje
1693
- `close` al objeto de stream. Permite que tu lo cierres en el punto de ejecución
1694
- que quieras. Nuevamente, hay que tener en cuenta que este comportamiento es
1695
- posible solo en servidores que soporten eventos, como Thin o Rainbows. El
1696
- resto de los servidores van a cerrar el stream de todos modos:
1697
-
1698
- ```ruby
1699
- # long polling
1700
-
1701
- set :server, :thin
1702
- connections = []
1703
-
1704
- get '/subscribe' do
1705
- # registrar a un cliente interesado en los eventos del servidor
1706
- stream(:keep_open) do |out|
1707
- connections << out
1708
- # purgar conexiones muertas
1709
- connections.reject!(&:closed?)
1710
- end
1711
- end
1712
-
1713
- post '/:message' do
1714
- connections.each do |out|
1715
- # notificar al cliente que ha llegado un nuevo mensaje
1716
- out << params['message'] << "\n"
1717
-
1718
- # indicar al cliente para conectarse de nuevo
1719
- out.close
1720
- end
1721
-
1722
- # reconocer
1723
- "message received"
1724
- end
1725
- ```
1726
-
1727
- También es posible que el cliente cierre la conexión cuando intenta
1728
- escribir en el socket. Debido a esto, se recomienda verificar con
1729
- `out.closed?` antes de intentar escribir.
1730
-
1731
- ### Logging
1732
-
1733
- En el ámbito de la petición, el helper `logger` (registrador) expone
1734
- una instancia de `Logger`:
1735
-
1736
- ```ruby
1737
- get '/' do
1738
- logger.info "cargando datos"
1739
- # ...
1740
- end
1741
- ```
1742
-
1743
- Este logger tiene en cuenta la configuración de logueo de tu Rack
1744
- handler. Si el logueo está desactivado, este método va a devolver un
1745
- objeto que se comporta como un logger pero que en realidad no hace
1746
- nada. Así, no vas a tener que preocuparte por esta situación.
1747
-
1748
- Ten en cuenta que el logueo está habilitado por defecto únicamente
1749
- para `Sinatra::Application`. Si heredaste de
1750
- `Sinatra::Base`, probablemente quieras habilitarlo manualmente:
1751
-
1752
- ```ruby
1753
- class MiApp < Sinatra::Base
1754
- configure :production, :development do
1755
- enable :logging
1756
- end
1757
- end
1758
- ```
1759
-
1760
- Para evitar que se inicialice cualquier middleware de logging, configurá
1761
- `logging` a `nil`. Ten en cuenta que, cuando hagas esto, `logger` va a
1762
- devolver `nil`. Un caso común es cuando quieres usar tu propio logger. Sinatra
1763
- va a usar lo que encuentre en `env['rack.logger']`.
1764
-
1765
- ### Tipos Mime
1766
-
1767
- Cuando usás `send_file` o archivos estáticos tal vez tengas tipos mime
1768
- que Sinatra no entiende. Usá `mime_type` para registrarlos a través de la
1769
- extensión de archivo:
1770
-
1771
- ```ruby
1772
- configure do
1773
- mime_type :foo, 'text/foo'
1774
- end
1775
- ```
1776
-
1777
- También lo puedes usar con el helper `content_type`:
1778
-
1779
- ```ruby
1780
- get '/' do
1781
- content_type :foo
1782
- "foo foo foo"
1783
- end
1784
- ```
1785
-
1786
- ### Generando URLs
1787
-
1788
- Para generar URLs deberías usar el método `url`. Por ejemplo, en Haml:
1789
-
1790
- ```ruby
1791
- %a{:href => url('/foo')} foo
1792
- ```
1793
-
1794
- Tiene en cuenta proxies inversos y encaminadores de Rack, si están presentes.
1795
-
1796
- Este método también puede invocarse mediante su alias `to` (mirá un ejemplo
1797
- a continuación).
1798
-
1799
- ### Redirección del Navegador
1800
-
1801
- Puedes redireccionar al navegador con el método `redirect`:
1802
-
1803
- ```ruby
1804
- get '/foo' do
1805
- redirect to('/bar')
1806
- end
1807
- ```
1808
-
1809
- Cualquier parámetro adicional se utiliza de la misma manera que los argumentos
1810
- pasados a `halt`:
1811
-
1812
- ```ruby
1813
- redirect to('/bar'), 303
1814
- redirect 'http://www.google.com/', 'te confundiste de lugar, compañero'
1815
- ```
1816
-
1817
- También puedes redireccionar fácilmente de vuelta hacia la página desde donde
1818
- vino el usuario con `redirect back`:
1819
-
1820
- ```ruby
1821
- get '/foo' do
1822
- "<a href='/bar'>hacer algo</a>"
1823
- end
1824
-
1825
- get '/bar' do
1826
- hacer_algo
1827
- redirect back
1828
- end
1829
- ```
1830
-
1831
- Para pasar argumentos con una redirección, puedes agregarlos a la cadena de
1832
- búsqueda:
1833
-
1834
- ```ruby
1835
- redirect to('/bar?suma=42')
1836
- ```
1837
-
1838
- O usar una sesión:
1839
-
1840
- ```ruby
1841
- enable :sessions
1842
-
1843
- get '/foo' do
1844
- session[:secreto] = 'foo'
1845
- redirect to('/bar')
1846
- end
1847
-
1848
- get '/bar' do
1849
- session[:secreto]
1850
- end
1851
- ```
1852
-
1853
- ### Control del Cache
1854
-
1855
- Asignar tus encabezados correctamente es el cimiento para realizar un cacheo
1856
- HTTP correcto.
1857
-
1858
- Puedes asignar el encabezado Cache-Control fácilmente:
1859
-
1860
- ```ruby
1861
- get '/' do
1862
- cache_control :public
1863
- "cachealo!"
1864
- end
1865
- ```
1866
-
1867
- Pro tip: configurar el cacheo en un filtro `before`:
1868
-
1869
- ```ruby
1870
- before do
1871
- cache_control :public, :must_revalidate, :max_age => 60
1872
- end
1873
- ```
1874
-
1875
- Si estás usando el helper `expires` para definir el encabezado correspondiente,
1876
- `Cache-Control` se va a definir automáticamente:
1877
-
1878
- ```ruby
1879
- before do
1880
- expires 500, :public, :must_revalidate
1881
- end
1882
- ```
1883
-
1884
- Para usar cachés adecuadamente, deberías considerar usar `etag` o
1885
- `last_modified`. Es recomendable que llames a estos asistentes *antes* de hacer
1886
- cualquier trabajo pesado, ya que van a enviar la respuesta inmediatamente si
1887
- el cliente ya tiene la versión actual en su caché:
1888
-
1889
- ```ruby
1890
- get '/articulo/:id' do
1891
- @articulo = Articulo.find params['id']
1892
- last_modified @articulo.updated_at
1893
- etag @articulo.sha1
1894
- erb :articulo
1895
- end
1896
- ```
1897
-
1898
- También es posible usar una
1899
- [weak ETag](https://en.wikipedia.org/wiki/HTTP_ETag#Strong_and_weak_validation):
1900
-
1901
- ```ruby
1902
- etag @articulo.sha1, :weak
1903
- ```
1904
-
1905
- Estos helpers no van a cachear nada por vos, sino que van a facilitar la
1906
- información necesaria para poder hacerlo. Si estás buscando soluciones rápidas
1907
- de cacheo con proxys reversos, mirá
1908
- [rack-cache](https://github.com/rtomayko/rack-cache):
1909
-
1910
- ```ruby
1911
- require "rack/cache"
1912
- require "sinatra"
1913
-
1914
- use Rack::Cache
1915
-
1916
- get '/' do
1917
- cache_control :public, :max_age => 36000
1918
- sleep 5
1919
- "hola"
1920
- end
1921
- ```
1922
-
1923
- Usá la configuración `:static_cache_control` para agregar el encabezado
1924
- `Cache-Control` a archivos estáticos (ver la sección de configuración
1925
- para más detalles).
1926
-
1927
- De acuerdo con la RFC 2616 tu aplicación debería comportarse diferente si a las
1928
- cabeceras If-Match o If-None-Match se le asigna el valor `*` cuando el
1929
- recurso solicitado ya existe. Sinatra asume para peticiones seguras (como get)
1930
- y potentes (como put) que el recurso existe, mientras que para el resto
1931
- (como post) asume que no. Puedes cambiar este comportamiento con la opción
1932
- `:new_resource`:
1933
-
1934
- ```ruby
1935
- get '/crear' do
1936
- etag '', :new_resource => true
1937
- Articulo.create
1938
- erb :nuevo_articulo
1939
- end
1940
- ```
1941
-
1942
- Si quieres seguir usando una weak ETag, indicalo con la opción `:kind`:
1943
-
1944
- ```ruby
1945
- etag '', :new_resource => true, :kind => :weak
1946
- ```
1947
-
1948
- ### Enviando Archivos
1949
-
1950
- Para enviar archivos, puedes usar el método `send_file`:
1951
-
1952
- ```ruby
1953
- get '/' do
1954
- send_file 'foo.png'
1955
- end
1956
- ```
1957
-
1958
- Además acepta un par de opciones:
1959
-
1960
- ```ruby
1961
- send_file 'foo.png', :type => :jpg
1962
- ```
1963
-
1964
- Estas opciones son:
1965
-
1966
- <dl>
1967
- <dt>filename</dt>
1968
- <dd>Nombre del archivo devuelto, por defecto es el nombre real del archivo.</dd>
1969
-
1970
- <dt>last_modified</dt>
1971
- <dd>Valor para el encabezado Last-Modified, por defecto toma el mtime del archivo.</dd>
1972
-
1973
- <dt>type</dt>
1974
- <dd>El Content-Type que se va a utilizar, si no está presente se intenta
1975
- adivinar a partir de la extensión del archivo.</dd>
1976
-
1977
- <dt>disposition</dt>
1978
- <dd>
1979
- Se utiliza para el encabezado Content-Disposition, y puede tomar alguno de los
1980
- siguientes valores: <tt>nil</tt> (por defecto), <tt>:attachment</tt> y <tt>:inline</tt>
1981
- </dd>
1982
-
1983
- <dt>length</dt>
1984
- <dd>Encabezado Content-Length, por defecto toma el tamaño del archivo</dd>
1985
-
1986
- <dt>status</dt>
1987
- <dd>
1988
- Código de estado a enviar. Útil cuando se envía un archivo estático como un error página. Si es compatible con el controlador de Rack, otros medios que no sean la transmisión del proceso de Ruby será utilizado. Si usas este método de ayuda, Sinatra manejará automáticamente las solicitudes de rango.
1989
- </dd>
1990
- </dl>
1991
-
1992
- ### Accediendo al objeto Request
1993
-
1994
- El objeto de la petición entrante puede ser accedido desde el nivel de la
1995
- petición (filtros, rutas y manejadores de errores) a través del método
1996
- `request`:
1997
-
1998
- ```ruby
1999
- # app corriendo en http://ejemplo.com/ejemplo
2000
- get '/foo' do
2001
- t = %w[text/css text/html application/javascript]
2002
- request.accept # ['text/html', '*/*']
2003
- request.accept? 'text/xml' # true
2004
- request.preferred_type(t) # 'text/html'
2005
- request.body # cuerpo de la petición enviado por el cliente (ver más abajo)
2006
- request.scheme # "http"
2007
- request.script_name # "/ejemplo"
2008
- request.path_info # "/foo"
2009
- request.port # 80
2010
- request.request_method # "GET"
2011
- request.query_string # ""
2012
- request.content_length # longitud de request.body
2013
- request.media_type # tipo de medio de request.body
2014
- request.host # "ejemplo.com"
2015
- request.get? # true (hay métodos análogos para los otros verbos)
2016
- request.form_data? # false
2017
- request["UNA_CABECERA"] # valor de la cabecera UNA_CABECERA
2018
- request.referrer # la referencia del cliente o '/'
2019
- request.user_agent # user agent (usado por la condición :agent)
2020
- request.cookies # hash de las cookies del navegador
2021
- request.xhr? # es una petición ajax?
2022
- request.url # "http://ejemplo.com/ejemplo/foo"
2023
- request.path # "/ejemplo/foo"
2024
- request.ip # dirección IP del cliente
2025
- request.secure? # false (sería true sobre ssl)
2026
- request.forwarded? # true (si se está corriendo atrás de un proxy reverso)
2027
- request.env # hash de entorno directamente entregado por Rack
2028
- end
2029
- ```
2030
-
2031
- Algunas opciones, como `script_name` o `path_info` pueden
2032
- también ser escritas:
2033
-
2034
- ```ruby
2035
- before { request.path_info = "/" }
2036
-
2037
- get "/" do
2038
- "todas las peticiones llegan acá"
2039
- end
2040
- ```
2041
-
2042
- El objeto `request.body` es una instancia de IO o StringIO:
2043
-
2044
- ```ruby
2045
- post "/api" do
2046
- request.body.rewind # en caso de que alguien ya lo haya leído
2047
- datos = JSON.parse request.body.read
2048
- "Hola #{datos['nombre']}!"
2049
- end
2050
- ```
2051
-
2052
- ### Archivos Adjuntos
2053
-
2054
- Puedes usar el helper `attachment` para indicarle al navegador que
2055
- almacene la respuesta en el disco en lugar de mostrarla en pantalla:
2056
-
2057
- ```ruby
2058
- get '/' do
2059
- attachment
2060
- "guardalo!"
2061
- end
2062
- ```
2063
-
2064
- También puedes pasarle un nombre de archivo:
2065
-
2066
- ```ruby
2067
- get '/' do
2068
- attachment "info.txt"
2069
- "guardalo!"
2070
- end
2071
- ```
2072
-
2073
- ### Fecha y Hora
2074
-
2075
- Sinatra pone a tu disposición el helper `time_for`, que genera un objeto `Time`
2076
- a partir del valor que recibe como argumento. Este valor puede ser un
2077
- `String`, pero también es capaz de convertir objetos `DateTime`, `Date` y de
2078
- otras clases similares:
2079
-
2080
- ```ruby
2081
- get '/' do
2082
- pass if Time.now > time_for('Dec 23, 2012')
2083
- "todavía hay tiempo"
2084
- end
2085
- ```
2086
-
2087
- Este método es usado internamente por métodos como `expires` y `last_modified`,
2088
- entre otros. Por lo tanto, es posible extender el comportamiento de estos
2089
- métodos sobreescribiendo `time_for` en tu aplicación:
2090
-
2091
- ```ruby
2092
- helpers do
2093
- def time_for(value)
2094
- case value
2095
- when :ayer then Time.now - 24*60*60
2096
- when :mañana then Time.now + 24*60*60
2097
- else super
2098
- end
2099
- end
2100
- end
2101
-
2102
- get '/' do
2103
- last_modified :ayer
2104
- expires :mañana
2105
- "hola"
2106
- end
2107
- ```
2108
-
2109
- ### Buscando los Archivos de las Plantillas
2110
-
2111
- El helper `find_template` se utiliza para encontrar los archivos de las
2112
- plantillas que se van a renderizar:
2113
-
2114
- ```ruby
2115
- find_template settings.views, 'foo', Tilt[:haml] do |archivo|
2116
- puts "podría ser #{archivo}"
2117
- end
2118
- ```
2119
-
2120
- Si bien esto no es muy útil, lo interesante es que puedes sobreescribir este
2121
- método, y así enganchar tu propio mecanismo de búsqueda. Por ejemplo, para
2122
- poder utilizar más de un directorio de vistas:
2123
-
2124
- ```ruby
2125
- set :views, ['vistas', 'plantillas']
2126
-
2127
- helpers do
2128
- def find_template(views, name, engine, &block)
2129
- Array(views).each { |v| super(v, name, engine, &block) }
2130
- end
2131
- end
2132
- ```
2133
-
2134
- Otro ejemplo consiste en usar directorios diferentes para los distintos motores
2135
- de renderizado:
2136
-
2137
- ```ruby
2138
- set :views, :sass => 'vistas/sass', :haml => 'plantillas', :defecto => 'vistas'
2139
-
2140
- helpers do
2141
- def find_template(views, name, engine, &block)
2142
- _, folder = views.detect { |k,v| engine == Tilt[k] }
2143
- folder ||= views[:defecto]
2144
- super(folder, name, engine, &block)
2145
- end
2146
- end
2147
- ```
2148
-
2149
- ¡Es muy fácil convertir estos ejemplos en una extensión y compartirla!
2150
-
2151
- Notá que `find_template` no verifica si un archivo existe realmente, sino
2152
- que llama al bloque que recibe para cada path posible. Esto no representa un
2153
- problema de rendimiento debido a que `render` va a usar `break` ni bien
2154
- encuentre un archivo que exista. Además, las ubicaciones de las plantillas (y
2155
- su contenido) se cachean cuando no estás en el modo de desarrollo. Es bueno
2156
- tener en cuenta lo anterior si escribís un método extraño.
2157
-
2158
- ## Configuración
2159
-
2160
- Ejecutar una vez, en el inicio, en cualquier entorno:
2161
-
2162
- ```ruby
2163
- configure do
2164
- # asignando una opción
2165
- set :opcion, 'valor'
2166
-
2167
- # asignando varias opciones
2168
- set :a => 1, :b => 2
2169
-
2170
- # atajo para `set :opcion, true`
2171
- enable :opcion
2172
-
2173
- # atajo para `set :opcion, false`
2174
- disable :opcion
2175
-
2176
- # también puedes tener configuraciones dinámicas usando bloques
2177
- set(:css_dir) { File.join(views, 'css') }
2178
- end
2179
- ```
2180
-
2181
- Ejecutar únicamente cuando el entorno (la variable de entorno APP_ENV) es
2182
- `:production`:
2183
-
2184
- ```ruby
2185
- configure :production do
2186
- ...
2187
- end
2188
- ```
2189
-
2190
- Ejecutar cuando el entorno es `:production` o `:test`:
2191
-
2192
- ```ruby
2193
- configure :production, :test do
2194
- ...
2195
- end
2196
- ```
2197
-
2198
- Puedes acceder a estas opciones utilizando el método `settings`:
2199
-
2200
- ```ruby
2201
- configure do
2202
- set :foo, 'bar'
2203
- end
2204
-
2205
- get '/' do
2206
- settings.foo? # => true
2207
- settings.foo # => 'bar'
2208
- ...
2209
- end
2210
- ```
2211
-
2212
- ### Configurando la Protección Contra Ataques
2213
-
2214
- Sinatra usa [Rack::Protection](https://github.com/sinatra/sinatra/tree/master/rack-protection#readme)
2215
- para defender a tu aplicación de los ataques más comunes. Si por algún motivo,
2216
- quieres desactivar esta funcionalidad, puedes hacerlo como se indica a
2217
- continuación (ten en cuenta que tu aplicación va a quedar expuesta a un
2218
- montón de vulnerabilidades bien conocidas):
2219
-
2220
- ```ruby
2221
- disable :protection
2222
- ```
2223
-
2224
- También es posible desactivar una única capa de defensa:
2225
-
2226
- ```ruby
2227
- set :protection, :except => :path_traversal
2228
- ```
2229
-
2230
- O varias:
2231
-
2232
- ```ruby
2233
- set :protection, :except => [:path_traversal, :session_hijacking]
2234
- ```
2235
-
2236
- ### Configuraciones Disponibles
2237
-
2238
- <dl>
2239
- <dt>absolute_redirects</dt>
2240
- <dd>
2241
- Si está deshabilitada, Sinatra va a permitir
2242
- redirecciones relativas, sin embargo, como consecuencia
2243
- de esto, va a dejar de cumplir con el RFC 2616 (HTTP
2244
- 1.1), que solamente permite redirecciones absolutas.
2245
- </dd>
2246
- <dd>
2247
- Activalo si tu apliación está corriendo atrás de un proxy
2248
- reverso que no se ha configurado adecuadamente. Notá que
2249
- el helper <tt>url</tt> va a seguir produciendo URLs absolutas, a
2250
- menos que le pasés <tt>false</tt> como segundo parámetro.
2251
- </dd>
2252
- <dd>Deshabilitada por defecto.</dd>
2253
- </dd>
2254
-
2255
- <dt>add_charset</dt>
2256
- <dd>
2257
- Tipos mime a los que el helper <tt>content_type</tt> les
2258
- añade automáticamente el charset. En general, no deberías
2259
- asignar directamente esta opción, sino añadirle los charsets
2260
- que quieras:
2261
- <tt>settings.add_charset &lt;&lt; "application/foobar"</tt>
2262
- </dd>
2263
-
2264
- <dt>app_file</dt>
2265
- <dd>
2266
- Path del archivo principal de la aplicación, se utiliza
2267
- para detectar la raíz del proyecto, el directorio de las
2268
- vistas y el público, así como las plantillas inline.
2269
- </dd>
2270
-
2271
- <dt>bind</dt>
2272
- <dd>
2273
- Dirección IP que utilizará el servidor integrado (por
2274
- defecto: <tt>0.0.0.0</tt> <em>o</em> <tt>localhost</tt>
2275
- si su `environment` está configurado para desarrollo).
2276
- </dd>
2277
-
2278
- <dt>default_encoding</dt>
2279
- <dd>
2280
- Encoding utilizado cuando el mismo se desconoce (por
2281
- defecto <tt>"utf-8"</tt>).
2282
- </dd>
2283
-
2284
- <dt>dump_errors</dt>
2285
- <dd>
2286
- Mostrar errores en el log.
2287
- </dd>
2288
-
2289
- <dt>environment</dt>
2290
- <dd>
2291
- Entorno actual, por defecto toma el valor de
2292
- <tt>ENV['APP_ENV']</tt>, o <tt>"development"</tt> si no
2293
- está disponible.
2294
- </dd>
2295
-
2296
- <dt>logging</dt>
2297
- <dd>
2298
- Define si se utiliza el logger.
2299
- </dd>
2300
-
2301
- <dt>lock</dt>
2302
- <dd>
2303
- Coloca un lock alrededor de cada petición, procesando
2304
- solamente una por proceso.
2305
- </dd>
2306
- <dd>
2307
- Habilitá esta opción si tu aplicación no es thread-safe.
2308
- Se encuentra deshabilitada por defecto.
2309
- </dd>
2310
-
2311
- <dt>method_override</dt>
2312
- <dd>
2313
- Utiliza el parámetro <tt>_method</tt> para permtir
2314
- formularios put/delete en navegadores que no los
2315
- soportan.
2316
- </dd>
2317
-
2318
- <dt>mustermann_opts</dt>
2319
- <dd>
2320
- Un hash predeterminado de opciones para pasar a Mustermann.new
2321
- al compilar las rutas.
2322
- </dd>
2323
-
2324
- <dt>port</dt>
2325
- <dd>
2326
- Puerto en el que escuchará el servidor integrado.
2327
- </dd>
2328
-
2329
- <dt>prefixed_redirects</dt>
2330
- <dd>
2331
- Define si inserta <tt>request.script_name</tt> en las
2332
- redirecciones cuando no se proporciona un path absoluto.
2333
- De esta manera, cuando está habilitada,
2334
- <tt>redirect '/foo'</tt> se comporta de la misma manera
2335
- que <tt>redirect to('/foo')</tt>. Se encuentra
2336
- deshabilitada por defecto.
2337
- </dd>
2338
-
2339
- <dt>protection</dt>
2340
- <dd>
2341
- Define si se habilitan o no las protecciones de ataques web.
2342
- Ver la sección de protección encima.
2343
- </dd>
2344
-
2345
- <dt>public_folder</dt>
2346
- <dd>
2347
- Lugar del directorio desde donde se sirven los archivos
2348
- públicos. Solo se utiliza cuando se sirven archivos
2349
- estáticos (ver la opción <tt>static</tt>). Si no
2350
- está presente, se infiere del valor de la opción
2351
- <tt>app_file</tt>.
2352
- </dd>
2353
-
2354
- <dt>quiet</dt>
2355
- <dd>
2356
- Inhabilita los logs generados por los comandos de inicio y detención de Sinatra.
2357
- <tt> false </tt> por defecto.
2358
- </dd>
2359
-
2360
- <dt>reload_templates</dt>
2361
- <dd>
2362
- Define Si se vuelven a cargar plantillas entre las solicitudes o no. Habilitado en
2363
- modo de desarrollo.
2364
- </dd>
2365
-
2366
- <dt>root</dt>
2367
- <dd>
2368
- Lugar del directorio raíz del proyecto. Si no está
2369
- presente, se infiere del valor de la opción
2370
- <tt>app_file</tt>.
2371
- </dd>
2372
-
2373
- <dt>raise_errors</dt>
2374
- <dd>
2375
- Elevar excepciones (detiene la aplicación). Se
2376
- encuentra activada por defecto cuando el valor de
2377
- <tt>environment</tt> es <tt>"test"</tt>. En caso
2378
- contrario estará desactivada.
2379
- </dd>
2380
-
2381
- <dt>run</dt>
2382
- <dd>
2383
- Cuando está habilitada, Sinatra se va a encargar de
2384
- iniciar el servidor web, no la habilites cuando estés
2385
- usando rackup o algún otro medio.
2386
- </dd>
2387
-
2388
- <dt>running</dt>
2389
- <dd>
2390
- Indica si el servidor integrado está ejecutándose, ¡no
2391
- cambiés esta configuración!.
2392
- </dd>
2393
-
2394
- <dt>server</dt>
2395
- <dd>
2396
- Servidor, o lista de servidores, para usar como servidor
2397
- integrado. Por defecto: <tt>['thin', 'mongrel', 'webrick']</tt>,
2398
- el orden establece la prioridad.
2399
- </dd>
2400
-
2401
- <dt>server_settings</dt>
2402
- <dd>
2403
- Si está utilizando un servidor web WEBrick, presumiblemente para su entorno de desarrollo, puede pasar un hash de opciones a <tt> server_settings </tt>, como <tt> SSLEnable </tt> o <tt> SSLVerifyClient </tt>. Sin embargo, los servidores web como Puma y Thin no son compatibles, por lo que puede establecer <tt> server_settings </tt> definiéndolo como un método cuando llame a <tt> configure </tt>.
2404
- </dd>
2405
-
2406
- <dt>sessions</dt>
2407
- <dd>
2408
- Habilita el soporte de sesiones basadas en cookies a
2409
- través de <tt>Rack::Session::Cookie</tt>. Ver la
2410
- sección 'Usando Sesiones' para más información.
2411
- </dd>
2412
-
2413
- <dt>session_store</dt>
2414
- <dd>
2415
- Define el middleware de sesión Rack utilizado. Predeterminado a
2416
- <tt>Rack::Session::Cookie</tt>. Consulte la sección 'Uso de sesiones' para obtener más información.
2417
- información.
2418
- </dd>
2419
-
2420
- <dt>show_exceptions</dt>
2421
- <dd>
2422
- Muestra un stack trace en el navegador cuando ocurre una
2423
- excepción. Se encuentra activada por defecto cuando el
2424
- valor de <tt>environment</tt> es <tt>"development"</tt>.
2425
- En caso contrario estará desactivada.
2426
- </dd>
2427
- <dd>
2428
- También se puede establecer en <tt> :after_handler </tt> para activar la aplicación especificada
2429
- que hara el manejo de errores antes de mostrar un stack trace en el navegador.
2430
- </dd>
2431
-
2432
- <dt>static</dt>
2433
- <dd>
2434
- <dd> Define si Sinatra debe servir los archivos estáticos. </dd>
2435
- <dd> Deshabilitar cuando se utiliza un servidor capaz de hacer esto por su cuenta. </dd>
2436
- <dd> La desactivación aumentará el rendimiento. </dd>
2437
- <dd>
2438
- Habilitado por defecto en estilo clásico, deshabilitado para aplicaciones modulares.
2439
- </dd>
2440
- </dd>
2441
-
2442
- <dt>static_cache_control</dt>
2443
- <dd>
2444
- Cuando Sinatra está sirviendo archivos estáticos, y
2445
- esta opción está habilitada, les va a agregar encabezados
2446
- <tt>Cache-Control</tt> a las respuestas. Para esto
2447
- utiliza el helper <tt>cache_control</tt>. Se encuentra
2448
- deshabilitada por defecto. Notar que es necesario
2449
- utilizar un array cuando se asignan múltiples valores:
2450
- <tt>set :static_cache_control, [:public, :max_age => 300]</tt>.
2451
- </dd>
2452
-
2453
- <dt>threaded</dt>
2454
- <dd>
2455
- Si se establece en <tt> true </tt>, le dirá a Thin que use
2456
- <tt> EventMachine.defer </tt> para procesar la solicitud.
2457
- </dd>
2458
-
2459
- <dt> traps </dt>
2460
- <dd> Define si Sinatra debería manejar las señales del sistema. </dd>
2461
-
2462
- <dt>views</dt>
2463
- <dd>
2464
- Path del directorio de las vistas. Si no está presente,
2465
- se infiere del valor de la opción <tt>app_file</tt>.
2466
- </dd>
2467
- <dt>x_cascade</dt>
2468
- <dd>
2469
- Establece o no el encabezado de X-Cascade si no hay una coincidencia de ruta.
2470
- <tt> verdadero </tt> por defecto.
2471
- </dd>
2472
- </dl>
2473
-
2474
- ## Entornos
2475
-
2476
- Existen tres entornos (`environments`) predefinidos: `development`,
2477
- `production` y `test`. El entorno por defecto es
2478
- `development` y tiene algunas particularidades:
2479
-
2480
- * Se recargan las plantillas entre una petición y la siguiente, a diferencia
2481
- de `production` y `test`, donde se cachean.
2482
- * Se instalan manejadores de errores `not_found` y `error`
2483
- especiales que muestran un stack trace en el navegador cuando son disparados.
2484
-
2485
- Para utilizar alguno de los otros entornos puede asignarse el valor
2486
- correspondiente a la variable de entorno `APP_ENV`:
2487
- ```shell
2488
- APP_ENV=production ruby my_app.rb
2489
- ```
2490
-
2491
- Los métodos `development?`, `test?` y `production?` te permiten conocer el
2492
- entorno actual.
2493
-
2494
- ```ruby
2495
- get '/' do
2496
- if settings.development?
2497
- "development!"
2498
- else
2499
- "not development!"
2500
- end
2501
- end
2502
- ```
2503
-
2504
- ## Manejo de Errores
2505
-
2506
- Los manejadores de errores se ejecutan dentro del mismo contexto que las rutas
2507
- y los filtros `before`, lo que significa que puedes usar, por ejemplo,
2508
- `haml`, `erb`, `halt`, etc.
2509
-
2510
- ### Not Found
2511
-
2512
- Cuando se eleva una excepción `Sinatra::NotFound`, o el código de
2513
- estado de la respuesta es 404, el manejador `not_found` es invocado:
2514
-
2515
- ```ruby
2516
- not_found do
2517
- 'No existo'
2518
- end
2519
- ```
2520
-
2521
- ### Error
2522
-
2523
- El manejador `error` es invocado cada vez que una excepción es elevada
2524
- desde un bloque de ruta o un filtro. El objeto de la excepción se puede
2525
- obtener de la variable Rack `sinatra.error`:
2526
-
2527
- ```ruby
2528
- error do
2529
- 'Disculpá, ocurrió un error horrible - ' + env['sinatra.error'].message
2530
- end
2531
- ```
2532
-
2533
- Errores personalizados:
2534
-
2535
- ```ruby
2536
- error MiErrorPersonalizado do
2537
- 'Lo que pasó fue...' + env['sinatra.error'].message
2538
- end
2539
- ```
2540
-
2541
- Entonces, si pasa esto:
2542
-
2543
- ```ruby
2544
- get '/' do
2545
- raise MiErrorPersonalizado, 'algo malo'
2546
- end
2547
- ```
2548
-
2549
- Obtienes esto:
2550
-
2551
- ```
2552
- Lo que pasó fue... algo malo
2553
- ```
2554
-
2555
- También, puedes instalar un manejador de errores para un código de estado:
2556
-
2557
- ```ruby
2558
- error 403 do
2559
- 'Acceso prohibido'
2560
- end
2561
-
2562
- get '/secreto' do
2563
- 403
2564
- end
2565
- ```
2566
-
2567
- O un rango:
2568
-
2569
- ```ruby
2570
- error 400..510 do
2571
- 'Boom'
2572
- end
2573
- ```
2574
-
2575
- Sinatra instala manejadores `not_found` y `error` especiales
2576
- cuando se ejecuta dentro del entorno de desarrollo "development" y se muestran
2577
- en tu navegador para que tengas información adicional sobre el error.
2578
-
2579
- ## Rack Middleware
2580
-
2581
- Sinatra corre sobre [Rack](http://rack.github.io/), una interfaz minimalista
2582
- que es un estándar para frameworks webs escritos en Ruby. Una de las
2583
- características más interesantes de Rack para los desarrolladores de aplicaciones
2584
- es el soporte de "middleware" -- componentes que se ubican entre el servidor y
2585
- tu aplicación, supervisando y/o manipulando la petición/respuesta HTTP para
2586
- proporcionar varios tipos de funcionalidades comunes.
2587
-
2588
- Sinatra hace muy sencillo construir tuberías de Rack middleware a través del
2589
- método top-level `use`:
2590
-
2591
- ```ruby
2592
- require 'sinatra'
2593
- require 'mi_middleware_personalizado'
2594
-
2595
- use Rack::Lint
2596
- use MiMiddlewarePersonalizado
2597
-
2598
- get '/hola' do
2599
- 'Hola Mundo'
2600
- end
2601
- ```
2602
-
2603
- La semántica de `use` es idéntica a la definida para el DSL
2604
- [Rack::Builder](http://www.rubydoc.info/github/rack/rack/master/Rack/Builder) (más
2605
- frecuentemente usado en archivos rackup). Por ejemplo, el método `use`
2606
- acepta argumentos múltiples/variables así como bloques:
2607
-
2608
- ```ruby
2609
- use Rack::Auth::Basic do |nombre_de_usuario, password|
2610
- nombre_de_usuario == 'admin' && password == 'secreto'
2611
- end
2612
- ```
2613
-
2614
- Rack es distribuido con una variedad de middleware estándar para logging,
2615
- debugging, enrutamiento URL, autenticación y manejo de sesiones. Sinatra
2616
- usa muchos de estos componentes automáticamente de acuerdo a su configuración
2617
- para que usualmente no tengas que usarlas (con `use`) explícitamente.
2618
-
2619
- Puedes encontrar middleware útil en
2620
- [rack](https://github.com/rack/rack/tree/master/lib/rack),
2621
- [rack-contrib](https://github.com/rack/rack-contrib#readme),
2622
- o en la [Rack wiki](https://github.com/rack/rack/wiki/List-of-Middleware).
2623
-
2624
- ## Pruebas
2625
-
2626
- Las pruebas para las aplicaciones Sinatra pueden ser escritas utilizando
2627
- cualquier framework o librería de pruebas basada en Rack. Se recomienda usar
2628
- [Rack::Test](http://www.rubydoc.info/github/brynary/rack-test/master/frames):
2629
-
2630
- ```ruby
2631
- require 'mi_app_sinatra'
2632
- require 'minitest/autorun'
2633
- require 'rack/test'
2634
-
2635
- class MiAppTest < Minitest::Test
2636
- include Rack::Test::Methods
2637
-
2638
- def app
2639
- Sinatra::Application
2640
- end
2641
-
2642
- def test_mi_defecto
2643
- get '/'
2644
- assert_equal 'Hola Mundo!', last_response.body
2645
- end
2646
-
2647
- def test_con_parametros
2648
- get '/saludar', :name => 'Franco'
2649
- assert_equal 'Hola Frank!', last_response.body
2650
- end
2651
-
2652
- def test_con_entorno_rack
2653
- get '/', {}, 'HTTP_USER_AGENT' => 'Songbird'
2654
- assert_equal "Estás usando Songbird!", last_response.body
2655
- end
2656
- end
2657
- ```
2658
-
2659
- Nota: Si está utilizando Sinatra en el estilo modular, reemplace
2660
- `Sinatra::Application` anterior con el nombre de clase de su aplicación.
2661
-
2662
- ## Sinatra::Base - Middleware, Librerías, y Aplicaciones Modulares
2663
-
2664
- Definir tu aplicación en el nivel superior funciona bien para micro-aplicaciones
2665
- pero trae inconvenientes considerables a la hora de construir componentes
2666
- reutilizables como Rack middleware, Rails metal, librerías simples con un
2667
- componente de servidor o incluso extensiones de Sinatra. El DSL de alto nivel
2668
- asume una configuración apropiada para micro-aplicaciones (por ejemplo, un
2669
- único archivo de aplicación, los directorios `./public` y
2670
- `./views`, logging, página con detalles de excepción, etc.). Ahí es
2671
- donde `Sinatra::Base` entra en el juego:
2672
-
2673
- ```ruby
2674
- require 'sinatra/base'
2675
-
2676
- class MiApp < Sinatra::Base
2677
- set :sessions, true
2678
- set :foo, 'bar'
2679
-
2680
- get '/' do
2681
- 'Hola Mundo!'
2682
- end
2683
- end
2684
- ```
2685
-
2686
- Las subclases de `Sinatra::Base` tienen disponibles exactamente los
2687
- mismos métodos que los provistos por el DSL de top-level. La mayoría de las
2688
- aplicaciones top-level se pueden convertir en componentes
2689
- `Sinatra::Base` con dos modificaciones:
2690
-
2691
- * Tu archivo debe requerir `sinatra/base` en lugar de `sinatra`; de otra
2692
- manera, todos los métodos del DSL de sinatra son importados dentro del
2693
- espacio de nombres principal.
2694
- * Poné las rutas, manejadores de errores, filtros y opciones de tu aplicación
2695
- en una subclase de `Sinatra::Base`.
2696
-
2697
- `Sinatra::Base` es una pizarra en blanco. La mayoría de las opciones están
2698
- desactivadas por defecto, incluyendo el servidor incorporado. Mirá
2699
- [Opciones y Configuraciones](http://www.sinatrarb.com/configuration.html)
2700
- para detalles sobre las opciones disponibles y su comportamiento.
2701
- Si quieres un comportamiento más similar
2702
- a cuando defines tu aplicación en el nivel superior (también conocido como Clásico)
2703
- estilo), puede subclase `Sinatra::Aplicación`
2704
-
2705
- ```ruby
2706
- require 'sinatra/base'
2707
-
2708
- class MiAplicacion < Sinatra::Application
2709
- get '/' do
2710
- 'Hola Mundo!'
2711
- end
2712
- end
2713
- ```
2714
-
2715
- ### Estilo Modular vs. Clásico
2716
-
2717
- Contrariamente a la creencia popular, no hay nada de malo con el estilo clásico.
2718
- Si se ajusta a tu aplicación, no es necesario que la cambies a una modular.
2719
-
2720
- La desventaja de usar el estilo clásico en lugar del modular consiste en que
2721
- solamente puedes tener una aplicación Sinatra por proceso Ruby. Si tienes
2722
- planificado usar más, cambiá al estilo modular. Al mismo tiempo, ten en
2723
- cuenta que no hay ninguna razón por la cuál no puedas mezclar los estilos
2724
- clásico y modular.
2725
-
2726
- A continuación se detallan las diferencias (sútiles) entre las configuraciones
2727
- de ambos estilos:
2728
-
2729
- <table>
2730
- <tr>
2731
- <th>Configuración</th>
2732
- <th>Clásica</th>
2733
- <th>Modular</th>
2734
- <th>Modular</th>
2735
- </tr>
2736
-
2737
- <tr>
2738
- <td>app_file</td>
2739
- <td>archivo que carga sinatra</td>
2740
- <td>archivo con la subclase de Sinatra::Base</td>
2741
- <td>archivo con la subclase Sinatra::Application</td>
2742
- </tr>
2743
-
2744
- <tr>
2745
- <td>run</td>
2746
- <td>$0 == app_file</td>
2747
- <td>false</td>
2748
- <td>false</td>
2749
- </tr>
2750
-
2751
- <tr>
2752
- <td>logging</td>
2753
- <td>true</td>
2754
- <td>false</td>
2755
- <td>true</td>
2756
- </tr>
2757
-
2758
- <tr>
2759
- <td>method_override</td>
2760
- <td>true</td>
2761
- <td>false</td>
2762
- <td>true</td>
2763
- </tr>
2764
-
2765
- <tr>
2766
- <td>inline_templates</td>
2767
- <td>true</td>
2768
- <td>false</td>
2769
- <td>true</td>
2770
- </tr>
2771
-
2772
- <tr>
2773
- <td>static</td>
2774
- <td>true</td>
2775
- <td>File.exist?(public_folder)</td>
2776
- <td>true</td>
2777
- </tr>
2778
- </table>
2779
-
2780
- ### Sirviendo una Aplicación Modular
2781
-
2782
- Las dos opciones más comunes para iniciar una aplicación modular son, iniciarla
2783
- activamente con `run!`:
2784
-
2785
- ```ruby
2786
- # mi_app.rb
2787
- require 'sinatra/base'
2788
-
2789
- class MiApp < Sinatra::Base
2790
- # ... código de la app ...
2791
-
2792
- # iniciar el servidor si el archivo fue ejecutado directamente
2793
- run! if app_file == $0
2794
- end
2795
- ```
2796
-
2797
- Iniciar con:
2798
-
2799
- ```shell
2800
- ruby mi_app.rb
2801
- ```
2802
-
2803
- O, con un archivo `config.ru`, que permite usar cualquier handler Rack:
2804
-
2805
- ```ruby
2806
- # config.ru
2807
- require './mi_app'
2808
- run MiApp
2809
- ```
2810
-
2811
- Después ejecutar:
2812
-
2813
- ```shell
2814
- rackup -p 4567
2815
- ```
2816
-
2817
- ### Usando una Aplicación Clásica con un Archivo config.ru
2818
-
2819
- Escribí el archivo de tu aplicación:
2820
-
2821
- ```ruby
2822
- # app.rb
2823
- require 'sinatra'
2824
-
2825
- get '/' do
2826
- 'Hola mundo!'
2827
- end
2828
- ```
2829
-
2830
- Y el `config.ru` correspondiente:
2831
-
2832
- ```ruby
2833
- require './app'
2834
- run Sinatra::Application
2835
- ```
2836
-
2837
- ### ¿Cuándo usar config.ru?
2838
-
2839
- Indicadores de que probablemente quieres usar `config.ru`:
2840
-
2841
- * Quieres realizar el deploy con un handler Rack distinto (Passenger, Unicorn,
2842
- Heroku, ...).
2843
- * Quieres usar más de una subclase de `Sinatra::Base`.
2844
- * Quieres usar Sinatra únicamente para middleware, pero no como un endpoint.
2845
-
2846
- <b>No hay necesidad de utilizar un archivo `config.ru` exclusivamente
2847
- porque tienes una aplicación modular, y no necesitás una aplicación modular para
2848
- iniciarla con `config.ru`.</b>
2849
-
2850
- ### Utilizando Sinatra como Middleware
2851
-
2852
- Sinatra no solo es capaz de usar otro Rack middleware, sino que a su vez,
2853
- cualquier aplicación Sinatra puede ser agregada delante de un endpoint Rack
2854
- como middleware. Este endpoint puede ser otra aplicación Sinatra, o cualquier
2855
- aplicación basada en Rack (Rails/Ramaze/Camping/...):
2856
-
2857
- ```ruby
2858
- require 'sinatra/base'
2859
-
2860
- class PantallaDeLogin < Sinatra::Base
2861
- enable :sessions
2862
-
2863
- get('/login') { haml :login }
2864
-
2865
- post('/login') do
2866
- if params['nombre'] == 'admin' && params['password'] == 'admin'
2867
- session['nombre_de_usuario'] = params['nombre']
2868
- else
2869
- redirect '/login'
2870
- end
2871
- end
2872
- end
2873
-
2874
- class MiApp < Sinatra::Base
2875
- # el middleware se ejecutará antes que los filtros
2876
- use PantallaDeLogin
2877
-
2878
- before do
2879
- unless session['nombre_de_usuario']
2880
- halt "Acceso denegado, por favor <a href='/login'>iniciá sesión</a>."
2881
- end
2882
- end
2883
-
2884
- get('/') { "Hola #{session['nombre_de_usuario']}." }
2885
- end
2886
- ```
2887
-
2888
- ### Creación Dinámica de Aplicaciones
2889
-
2890
- Puede que en algunas ocasiones quieras crear nuevas aplicaciones en
2891
- tiempo de ejecución sin tener que asignarlas a una constante. Para
2892
- esto tienes `Sinatra.new`:
2893
-
2894
- ```ruby
2895
- require 'sinatra/base'
2896
- mi_app = Sinatra.new { get('/') { "hola" } }
2897
- mi_app.run!
2898
- ```
2899
-
2900
- Acepta como argumento opcional una aplicación desde la que se
2901
- heredará:
2902
-
2903
- ```ruby
2904
- # config.ru
2905
- require 'sinatra/base'
2906
-
2907
- controller = Sinatra.new do
2908
- enable :logging
2909
- helpers MisHelpers
2910
- end
2911
-
2912
- map('/a') do
2913
- run Sinatra.new(controller) { get('/') { 'a' } }
2914
- end
2915
-
2916
- map('/b') do
2917
- run Sinatra.new(controller) { get('/') { 'b' } }
2918
- end
2919
- ```
2920
-
2921
- Construir aplicaciones de esta forma resulta especialmente útil para
2922
- testear extensiones Sinatra o para usar Sinatra en tus librerías.
2923
-
2924
- Por otro lado, hace extremadamente sencillo usar Sinatra como
2925
- middleware:
2926
-
2927
- ```ruby
2928
- require 'sinatra/base'
2929
-
2930
- use Sinatra do
2931
- get('/') { ... }
2932
- end
2933
-
2934
- run ProyectoRails::Application
2935
- ```
2936
-
2937
- ## Ámbitos y Ligaduras
2938
-
2939
- El ámbito en el que te encuentras determina que métodos y variables están
2940
- disponibles.
2941
-
2942
- ### Ámbito de Aplicación/Clase
2943
-
2944
- Cada aplicación Sinatra es una subclase de `Sinatra::Base`. Si estás
2945
- usando el DSL de top-level (`require 'sinatra'`), entonces esta clase es
2946
- `Sinatra::Application`, de otra manera es la subclase que creaste
2947
- explícitamente. Al nivel de la clase tienes métodos como `get` o `before`, pero
2948
- no puedes acceder a los objetos `request` o `session`, ya que hay una única
2949
- clase de la aplicación para todas las peticiones.
2950
-
2951
- Las opciones creadas utilizando `set` son métodos al nivel de la clase:
2952
-
2953
- ```ruby
2954
- class MiApp < Sinatra::Base
2955
- # Ey, estoy en el ámbito de la aplicación!
2956
- set :foo, 42
2957
- foo # => 42
2958
-
2959
- get '/foo' do
2960
- # Hey, ya no estoy en el ámbito de la aplicación!
2961
- end
2962
- end
2963
- ```
2964
-
2965
- Tienes la ligadura al ámbito de la aplicación dentro de:
2966
-
2967
- * El cuerpo de la clase de tu aplicación
2968
- * Métodos definidos por extensiones
2969
- * El bloque pasado a `helpers`
2970
- * Procs/bloques usados como el valor para `set`
2971
- * El bloque pasado a `Sinatra.new`
2972
-
2973
- Este ámbito puede alcanzarse de las siguientes maneras:
2974
-
2975
- * A través del objeto pasado a los bloques de configuración (`configure { |c| ...}`)
2976
- * Llamando a `settings` desde dentro del ámbito de la petición
2977
-
2978
- ### Ámbito de Petición/Instancia
2979
-
2980
- Para cada petición entrante, una nueva instancia de la clase de tu aplicación
2981
- es creada y todos los bloques de rutas son ejecutados en ese ámbito. Desde este
2982
- ámbito puedes acceder a los objetos `request` y `session` o llamar a los métodos
2983
- de renderización como `erb` o `haml`. Puedes acceder al ámbito de la aplicación
2984
- desde el ámbito de la petición utilizando `settings`:
2985
-
2986
- ```ruby
2987
- class MiApp < Sinatra::Base
2988
- # Ey, estoy en el ámbito de la aplicación!
2989
- get '/definir_ruta/:nombre' do
2990
- # Ámbito de petición para '/definir_ruta/:nombre'
2991
- @valor = 42
2992
-
2993
- settings.get("/#{params['nombre']}") do
2994
- # Ámbito de petición para "/#{params['nombre']}"
2995
- @valor # => nil (no es la misma petición)
2996
- end
2997
-
2998
- "Ruta definida!"
2999
- end
3000
- end
3001
- ```
3002
-
3003
- Tienes la ligadura al ámbito de la petición dentro de:
3004
-
3005
- * bloques pasados a get, head, post, put, delete, options, patch, link y unlink
3006
- * filtros before/after
3007
- * métodos helpers
3008
- * plantillas/vistas
3009
-
3010
- ### Ámbito de Delegación
3011
-
3012
- El ámbito de delegación solo reenvía métodos al ámbito de clase. De cualquier
3013
- manera, no se comporta 100% como el ámbito de clase porque no tienes la ligadura
3014
- de la clase: únicamente métodos marcados explícitamente para delegación están
3015
- disponibles y no compartís variables/estado con el ámbito de clase (léase:
3016
- tienes un `self` diferente). Puedes agregar delegaciones de método llamando a
3017
- `Sinatra::Delegator.delegate :nombre_del_metodo`.
3018
-
3019
- Tienes és la ligadura al ámbito de delegación dentro de:
3020
-
3021
- * La ligadura del top-level, si hiciste `require "sinatra"`
3022
- * Un objeto extendido con el mixin `Sinatra::Delegator`
3023
-
3024
- Hechale un vistazo al código: acá está el
3025
- [Sinatra::Delegator mixin](https://github.com/sinatra/sinatra/blob/ca06364/lib/sinatra/base.rb#L1609-1633)
3026
- que [extiende el objeto main](https://github.com/sinatra/sinatra/blob/ca06364/lib/sinatra/main.rb#L28-30).
3027
-
3028
- ## Línea de Comandos
3029
-
3030
- Las aplicaciones Sinatra pueden ser ejecutadas directamente:
3031
-
3032
- ```shell
3033
- ruby myapp.rb [-h] [-x] [-q] [-e ENVIRONMENT] [-p PORT] [-o HOST] [-s HANDLER]
3034
- ```
3035
-
3036
- Las opciones son:
3037
-
3038
- ```
3039
- -h # ayuda
3040
- -p # asigna el puerto (4567 es usado por defecto)
3041
- -o # asigna el host (0.0.0.0 es usado por defecto)
3042
- -e # asigna el entorno (development es usado por defecto)
3043
- -s # especifica el servidor/manejador rack (thin es usado por defecto)
3044
- -q # activar el modo silecioso para el servidor (está desactivado por defecto)
3045
- -x # activa el mutex lock (está desactivado por defecto)
3046
- ```
3047
-
3048
- ### Multi-threading
3049
-
3050
- _Basado en [esta respuesta en StackOverflow](http://stackoverflow.com/questions/6278817/is-sinatra-multi-threaded/6282999#6282999) escrita por Konstantin_
3051
-
3052
- Sinatra no impone ningún modelo de concurrencia, sino que lo deja en manos del
3053
- handler Rack que se esté usando (Thin, Puma, WEBrick). Sinatra en sí mismo es
3054
- thread-safe, así que no hay problema en que el Rack handler use un modelo de
3055
- concurrencia basado en hilos.
3056
-
3057
- Esto significa que, cuando estemos arrancando el servidor, tendríamos que
3058
- especificar la opción adecuada para el handler Rack específico. En este ejemplo
3059
- vemos cómo arrancar un servidor Thin multihilo:
3060
-
3061
- ```ruby
3062
- # app.rb
3063
-
3064
- require 'sinatra/base'
3065
-
3066
- class App < Sinatra::Base
3067
- get '/' do
3068
- "¡Hola, Mundo!"
3069
- end
3070
- end
3071
-
3072
- App.run!
3073
- ```
3074
-
3075
- Para arrancar el servidor, el comando sería:
3076
-
3077
- ```shell
3078
- thin --threaded start
3079
- ```
3080
-
3081
- ## Requerimientos
3082
-
3083
- Las siguientes versiones de Ruby son soportadas oficialmente:
3084
-
3085
- <dl>
3086
- <dt>Ruby 2.3</dt>
3087
- <dd>
3088
- 2.3 Es totalmente compatible y recomendado. Actualmente no hay planes
3089
- soltar el apoyo oficial para ello.
3090
- </dd>
3091
-
3092
- <dt>Rubinius</dt>
3093
- <dd>
3094
- Rubinius es oficialmente compatible (Rubinius> = 2.x). Se recomienda instalar la gema puma
3095
- <tt>gem install puma</tt>.
3096
- </dd>
3097
-
3098
- <dt>JRuby</dt>
3099
- <dd>
3100
- La última versión estable de JRuby es oficialmente compatible. No lo es
3101
- recomienda usar extensiones C con JRuby. Se recomienda instalar la gema trinidad
3102
- <tt> gem install trinidad </tt>.
3103
- </dd>
3104
- </dl>
3105
-
3106
- Las versiones de Ruby anteriores a 2.2.2 ya no son compatibles con Sinatra 2.0 .
3107
-
3108
- Siempre le prestamos atención a las nuevas versiones de Ruby.
3109
-
3110
- Las siguientes implementaciones de Ruby no se encuentran soportadas
3111
- oficialmente. De cualquier manera, pueden ejecutar Sinatra:
3112
-
3113
- * Versiones anteriores de JRuby y Rubinius
3114
- * Ruby Enterprise Edition
3115
- * MacRuby, Maglev e IronRuby
3116
- * Ruby 1.9.0 y 1.9.1 (pero no te recomendamos que los uses)
3117
-
3118
- No ser soportada oficialmente, significa que si las cosas se rompen
3119
- ahí y no en una plataforma soportada, asumimos que no es nuestro problema sino
3120
- el suyo.
3121
-
3122
- También ejecutamos nuestro CI contra ruby-head (futuras versiones de MRI), pero
3123
- no puede garantizar nada, ya que se mueve constantemente. Esperar próxima
3124
- 2.x versiones para ser totalmente compatibles.
3125
-
3126
- Sinatra debería trabajar en cualquier sistema operativo compatible la implementación de Ruby
3127
- elegida
3128
-
3129
- Si ejecuta MacRuby, debe `gem install control_tower`.
3130
-
3131
- Sinatra actualmente no funciona con Cardinal, SmallRuby, BlueRuby o cualquier
3132
- versión de Ruby anterior a 2.2.
3133
-
3134
- ## A la Vanguardia
3135
-
3136
- Si quieres usar el código de Sinatra más reciente, sientete libre de ejecutar
3137
- tu aplicación sobre la rama master, en general es bastante estable.
3138
-
3139
- También liberamos prereleases de vez en cuando, así, puedes hacer:
3140
-
3141
- ```shell
3142
- gem install sinatra --pre
3143
- ```
3144
-
3145
- Para obtener algunas de las últimas características.
3146
-
3147
- ### Usando Bundler
3148
-
3149
- Esta es la manera recomendada para ejecutar tu aplicación sobre la última
3150
- versión de Sinatra usando [Bundler](http://bundler.io).
3151
-
3152
- Primero, instala Bundler si no lo hiciste todavía:
3153
-
3154
- ```shell
3155
- gem install bundler
3156
- ```
3157
-
3158
- Después, en el directorio de tu proyecto, creá un archivo `Gemfile`:
3159
-
3160
- ```ruby
3161
- source :rubygems
3162
- gem 'sinatra', :git => "git://github.com/sinatra/sinatra.git"
3163
-
3164
- # otras dependencias
3165
- gem 'haml' # por ejemplo, si usás haml
3166
- ```
3167
-
3168
- Ten en cuenta que tienes que listar todas las dependencias directas de tu
3169
- aplicación. No es necesario listar las dependencias de Sinatra (Rack y Tilt)
3170
- porque Bundler las agrega directamente.
3171
-
3172
- Ahora puedes arrancar tu aplicación así:
3173
-
3174
- ```shell
3175
- bundle exec ruby miapp.rb
3176
- ```
3177
-
3178
- ## Versionado
3179
-
3180
- Sinatra utiliza el [Versionado Semántico](http://semver.org/),
3181
- siguiendo las especificaciones SemVer y SemVerTag.
3182
-
3183
- ## Lecturas Recomendadas
3184
-
3185
- * [Sito web del proyecto](http://www.sinatrarb.com/) - Documentación
3186
- adicional, noticias, y enlaces a otros recursos.
3187
- * [Contribuyendo](http://www.sinatrarb.com/contributing) - ¿Encontraste un
3188
- error?. ¿Necesitas ayuda?. ¿Tienes un parche?.
3189
- * [Seguimiento de problemas](https://github.com/sinatra/sinatra/issues)
3190
- * [Twitter](https://twitter.com/sinatra)
3191
- * [Lista de Correo](http://groups.google.com/group/sinatrarb/topics)
3192
- * [IRC: #sinatra](irc://chat.freenode.net/#sinatra) en http://freenode.net
3193
- * [Sinatra & Friends](https://sinatrarb.slack.com) en Slack y revisa
3194
- [acá](https://sinatra-slack.herokuapp.com/) Para una invitación.
3195
- * [Sinatra Book](https://github.com/sinatra/sinatra-book/) Tutorial (en inglés).
3196
- * [Sinatra Recipes](http://recipes.sinatrarb.com/) Recetas contribuidas
3197
- por la comunidad (en inglés).
3198
- * Documentación de la API para la
3199
- [última versión liberada](http://www.rubydoc.info/gems/sinatra) o para la
3200
- [rama de desarrollo actual](http://www.rubydoc.info/github/sinatra/sinatra)
3201
- en http://www.rubydoc.info/
3202
- * [Servidor de CI](https://travis-ci.org/sinatra/sinatra)