From 95924e30ea59d51b3373b70e06cced4e223c2d63 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sylvain=20Desve=CC=81?= Date: Sun, 6 Mar 2011 22:01:52 +0100 Subject: [PATCH] Updated the French README. Signed-off-by: Konstantin Haase --- README.fr.rdoc | 1200 +++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 1028 insertions(+), 172 deletions(-) diff --git a/README.fr.rdoc b/README.fr.rdoc index 3d06b439..16ce0ac4 100644 --- a/README.fr.rdoc +++ b/README.fr.rdoc @@ -1,5 +1,6 @@ = Sinatra -Attention: Ce document correspond à la traduction de la version anglaise et il n'est peut être plus à jour. +Attention: Ce document correspond à la traduction de la version anglaise et +il n'est peut être plus à jour. Sinatra est un DSL pour créer rapidement des applications web en Ruby et sans effort: @@ -17,9 +18,13 @@ Installez le gem et lancez avec: Le résultat est visible sur: http://localhost:4567 +Il est également recommandé d'exécuter gem install thin, que Sinatra +utilisera si disponible. + == Routes -Dans Sinatra, une route est une méthode HTTP couplée à un masque (pattern) URL. +Dans Sinatra, une route est une méthode HTTP couplée à un masque (pattern) +URL. Chaque route est associée à un bloc: get '/' do @@ -38,11 +43,15 @@ Chaque route est associée à un bloc: .. effacer quelque chose .. end -Les routes sont comparées dans l'ordre où elles ont été définies. La première route qui -correspond à la requête est invoquée. + options '/' do + .. apaiser quelquechose .. + end -Les masques peuvent inclure des paramètres, accessibles par l'intermédiaire du -hash params: +Les routes sont comparées dans l'ordre où elles ont été définies. La première +route qui correspond à la requête est invoquée. + +Les masques peuvent inclure des paramètres nommés, accessibles par +l'intermédiaire du hash params: get '/bonjour/:nom' do # répond aux requêtes "GET /bonjour/foo" et "GET /bonjour/bar" @@ -50,14 +59,15 @@ hash params: "Bonjour #{params[:nom]}!" end -Vous pouvez aussi les nommer directement dans les paramètres du bloc comme ceci: +Vous pouvez aussi les nommer directement dans les paramètres du bloc comme +ceci: get '/bonjour/:nom' do |n| "Bonjour #{n}!" end -Une route peut contenir un splat (caractère joker), accessible par l'intermédiaire de -la liste params[:splat]. +Une route peut contenir un splat (caractère joker), accessible par +l'intermédiaire de la liste params[:splat]. get '/dire/*/a/*' do # répondrait à /dire/bonjour/a/monde @@ -83,7 +93,8 @@ Là aussi on peut utiliser les paramètres de bloc: === Conditions -Les routes peuvent définir toutes sortes de conditions, comme par exemple le "user agent": +Les routes peuvent définir toutes sortes de conditions, comme par exemple le +"user agent": get '/foo', :agent => /Songbird (\d\.\d)[\d\/]*?/ do "Vous utilisez Songbird version #{params[:agent][0]}" @@ -121,20 +132,24 @@ Vous pouvez facilement définir vos propres conditions: === Valeurs de retour -La valeur de retour d'un bloc définissant une route détermine le corps de la réponse -qui sera transmise au client HTTP ou du moins au prochain middleware dans la pile Rack. -Le plus généralement, il s'agit d'une chaîne de caractères, comme dans les exemples -précédents. Cependant, d'autres valeurs sont acceptées. +La valeur de retour d'un bloc définissant une route détermine le corps de la +réponse qui sera transmise au client HTTP ou du moins au prochain middleware +dans la pile Rack. Le plus généralement, il s'agit d'une chaîne de caractères, +comme dans les exemples précédents. Cependant, d'autres valeurs sont +acceptées. -Vous pouvez renvoyer n'importe quel objet qui soit une réponse Rack valide, un corps de -réponse Rack ou un code retour HTTP: +Vous pouvez renvoyer n'importe quel objet qui soit une réponse Rack valide, un +corps de réponse Rack ou un code retour HTTP: -* Un tableau de 3 éléments: [code retour (Fixnum), entêtes (Hash), corps de réponse (répondant à #each)] -* Un tableau de 2 élements: [code retour (Fixnum), corps de réponse (répondant à #each)] -* Un objet qui répond à #each et qui ne transmet que des chaînes de caractères au bloc fourni +* Un tableau de 3 éléments: [code retour (Fixnum), entêtes (Hash), corps + de réponse (répondant à #each)] +* Un tableau de 2 élements: [code retour (Fixnum), corps de réponse + (répondant à #each)] +* Un objet qui répond à #each et qui ne transmet que des chaînes de + caractères au bloc fourni * Un Fixnum représentant le code retour -Ainsi, on peut facilement implémenter un streaming par exemple: +Ainsi, on peut facilement implémenter un streaming par exemple : class Stream def each @@ -144,15 +159,59 @@ Ainsi, on peut facilement implémenter un streaming par exemple: get('/') { Stream.new } +=== Masques de route spécifiques + +Comme montré plus haut, Sinatra embarque le support pour l'utilisation de +masques utilisant des chaînes de caractères ou des expressions régulières +pour définir les routes. Toutefois, cela ne s'arrête pas là. Vous pouvez +facilement définir vos propres masques : + + class MasqueToutSauf + Masque = Struct.new(:captures) + + def initialize(except) + @except = except + @caputres = Masque.new([]) + end + + def match(str) + @caputres unless @except === str + end + end + + def tout_sauf(masque) + MasqueToutSauf.new(masque) + end + + get tout_sauf("/index") do + # ... + end + +Notez que l'exemple ci-dessus est bien trop compliqué et le même résultat +peut être obtenu avec : + + get // do + pass if request.path_info == "/index" + # ... + end + +Ou bien en utilisant la forme négative : + + get %r{^(?!/index$)} do + # ... + end + == Fichiers statiques -Par défaut, le dossier ./public est utilisé pour servir les fichiers statiques. -Vous pouvez changer ce dossier pour un autre nom grâce à l'option :public: +Par défaut, le dossier ./public est utilisé pour servir les fichiers +statiques. Vous pouvez changer ce dossier pour un autre nom grâce au paramètre +:public: set :public, File.dirname(__FILE__) + '/statique' -Notez que le nom du dossier public n'est pas inclus dans l'URL. Un fichier sous -./public/css/style.css est appelé avec l'URL: http://exemple.com/css/style.css. +Notez que le nom du dossier public n'est pas inclus dans l'URL. Un fichier +sous ./public/css/style.css est appelé avec l'URL : +http://exemple.com/css/style.css. == Vues / Templates @@ -163,13 +222,13 @@ Pour utiliser un autre dossier, il faut le déclarer: Il est important de noter que les templates sont toujours référencés sous forme de symboles, même s'il s'agit d'un sous-répertoire (dans ce -cas, utilisez :'sous_repertoire/template'). Vous devez utiliser un symbole -car les méthodes de rendu évalueront le contenu des chaînes de caractères -au lieu de les considérer comme un chemin vers un fichier. +cas, utilisez :'sous_repertoire/template'). Vous devez utiliser un +symbole car les méthodes de rendu évalueront le contenu des chaînes de +caractères au lieu de les considérer comme un chemin vers un fichier. === Templates Haml -Le gem haml est nécessaire pour utiliser la fonction de rendu Haml: +Le gem haml est nécessaire pour utiliser la fonction de rendu Haml: # Chargez la bibliothèque haml dans votre application require 'haml' @@ -201,11 +260,12 @@ et supportent aussi la réécriture (surcharge) comme dans cet exemple. erb :index end -Utilisera le template: ./views/index.erb +Utilisera le template: ./views/index.erb. -=== Erubis +=== Templates Erubis -Le gem erubis est nécessaire pour utiliser la fonction de rendu erubis: +Le gem erubis est nécessaire pour utiliser la fonction de rendu +erubis: # Chargez la bibliothèque erubis dans votre application require 'erubis' @@ -216,9 +276,21 @@ Le gem erubis est nécessaire pour utiliser la fonction de rendu erubis: Utilisera le template: ./views/index.erubis +Il est également possible de remplacer Erb par Erubis: + + require 'erubis' + Tilt.register :erb, Tilt[:erubis] + + get '/' do + erb :index + end + +Utilisera le template ./views/index.erb avec Erubis. + === Templates Builder -Le gem builder est nécessaire pour utiliser la fonction de rendu builder: +Le gem builder est nécessaire pour utiliser la fonction de rendu +builder: # Chargez la bibliothèque builder dans votre application require 'builder' @@ -231,7 +303,8 @@ Utilisera le template: ./views/index.builder. === Templates Nokogiri -Le gem nokogiri est nécessaire pour utiliser la fonction de rendu nokogiri: +Le gem nokogiri est nécessaire pour utiliser la fonction de rendu +nokogiri: # Chargez la bibliothèque nokogiri dans votre application require 'nokogiri' @@ -244,7 +317,8 @@ Utilisera le template: ./views/index.nokogiri. === Templates Sass -Le gem haml est nécessaire pour utiliser la fonction de rendu Sass: +Le gem haml ou sass est nécessaire pour utiliser la fonction +de rendu Sass: # Chargez la bibliothèque haml ou sass dans votre application require 'sass' @@ -268,7 +342,8 @@ et supportent aussi la réécriture (surcharge) comme dans cet exemple. === Scss Templates -Le gem haml est nécessaire pour utiliser la fonction de rendu Scss: +Le gem haml ou sass est nécessaire pour utiliser la fonction +de rendu Scss: # Chargez la bibliothèque haml ou sass dans votre application require 'sass' @@ -292,7 +367,7 @@ et supportent aussi la réécriture (surcharge) comme dans cet exemple. === Templates Less -Le gem less est nécessaire pour utiliser la fonction de rendu Less: +Le gem less est nécessaire pour utiliser la fonction de rendu Less: # Chargez la bibliothèque less dans votre application require 'less' @@ -305,7 +380,8 @@ Utilisera le template: ./views/stylesheet.less. === Templates Liquid -Le gem liquid est nécessaire pour utiliser la fonction de rendu Liquid: +Le gem liquid est nécessaire pour utiliser la fonction de rendu +Liquid: # Chargez la bibliothèque liquid dans votre application require 'liquid' @@ -317,13 +393,15 @@ Le gem liquid est nécessaire pour utiliser la fonction de rendu Liquid: Utilisera ./views/index.liquid. Comme vous ne pouvez pas appeler des méthodes Ruby (excepté +yield+) dans un -template Liquid, il sera toujours nécessaire de lui passer des variables locales: +template Liquid, il sera toujours nécessaire de lui passer des variables +locales: liquid :index, :locals => { :key => 'value' } === Templates Markdown -Le gem rdiscount est nécessaire pour utiliser la fonction de rendu Markdown: +Le gem rdiscount est nécessaire pour utiliser la fonction de rendu +Markdown: # Chargez la bibliothèque rdiscount dans votre application require "rdiscount" @@ -332,23 +410,64 @@ Le gem rdiscount est nécessaire pour utiliser la fonction de rendu Markdown: markdown :index end -Utilisera ./views/index.markdown (les extensions de fichier +md+ et +mkd+ -sont également acceptées). +Utilisera ./views/index.markdown (les extensions de fichier +md+ et ++mkd+ sont également acceptées). -Il n'est pas possible d'appeler des méthodes depuis markdown, ni même de lui passer des variables -locales. Par conséquent, il sera le plus souvent utilisé en combinaison avec un autre moteur -de rendu: +Il n'est pas possible d'appeler des méthodes depuis markdown, ni même de lui +passer des variables locales. Par conséquent, il sera le plus souvent utilisé +en combinaison avec un autre moteur de rendu: erb :vuedensemble, :locals => { :texte => markdown(:introduction) } -Notez que vous pouvez également appeler la méthode markdown au sein d'autres templates: +Notez que vous pouvez également appeler la méthode +markdown+ au sein d'autres +templates: %h1 Bonjour Depuis Haml! %p= markdown(:salutations) +Comme vous ne pouvez pas faire d'appels Ruby au sein de Markdown, vous ne +pouvez pas utiliser des layouts écrits en Markdown. Il est toutefois possible +d'utiliser un autre moteur de rendu pour le layout en passant l'option +:layout_engine : + + get '/' do + markdown :index, :layout_engine => :erb + end + +Ceci utilisera ./views/index.md avec ./views/layout.erb pour +layout. + +Souvenez vous que vous pouvez spécifier de telles options de rendu +globalement : + + set :markdown, :layout_engine => :haml, :layout => :post + + get '/' do + markdown :index + end + +Ceci utilisera ./views/index.md (et tout autre template Markdown) +avec ./views/post.haml pour layout. + +Il est également possible de traduire le Markdown avec BlueCloth plutôt que +RDiscount : + + require 'bluecloth' + + Tilt.register 'markdown', BlueClothTemplate + Tilt.register 'mkd', BlueClothTemplate + Tilt.register 'md', BlueClothTemplate + + get '/' do + markdown :index + end + +Utilisera ./views/index.md avec BlueCloth. + === Templates Textile -Le gem RedCloth est nécessaire pour utiliser la fonction de rendu Textile: +Le gem RedCloth est nécessaire pour utiliser la fonction de rendu +Textile: # Chargez la bibliothèqye redcloth dans votre application require "redcloth" @@ -359,20 +478,45 @@ Le gem RedCloth est nécessaire pour utiliser la fonction de rendu Textile: Utilisera ./views/index.textile. -Il n'est pas possible d'appeler des méthodes depuis textile, ni même de lui passer des variables -locales. Par conséquent, il sera le plus souvent utilisé en combinaison avec un autre moteur -de rendu: +Il n'est pas possible d'appeler des méthodes depuis textile, ni même de lui +passer des variables locales. Par conséquent, il sera le plus souvent utilisé +en combinaison avec un autre moteur de rendu: erb :vuedensemble, :locals => { :texte => textile(:introduction) } -Notez que vous pouvez également appeler la méthode textile au sein d'autres templates: +Notez que vous pouvez également appeler la méthode +textile+ au sein d'autres +templates: %h1 Bonjour Depuis Haml! %p= textile(:salutations) +Comme vous ne pouvez pas faire d'appels Ruby au sein de Textile, vous ne +pouvez pas utiliser des layouts écrits en Textile. Il est toutefois possible +d'utiliser un autre moteur de rendu pour le layout en passant l'option +:layout_engine : + + get '/' do + textile :index, :layout_engine => :erb + end + +Ceci utilisera ./views/index.textile avec ./views/layout.erb +pour layout. + +Souvenez vous que vous pouvez spécifier de telles options de rendu +globalement : + + set :textile, :layout_engine => :haml, :layout => :post + + get '/' do + textile :index + end + +Ceci utilisera ./views/index.textile (et tout autre template Textile) +avec ./views/post.haml pour layout. + === Templates RDoc -Le gem RDoc est nécessaire pour utiliser la fonction de rendu RDoc: +Le gem rdoc est nécessaire pour utiliser la fonction de rendu RDoc: # Chargez la bibliothèque rdoc/markup/to_html dans votre application require "rdoc/markup/to_html" @@ -383,22 +527,47 @@ Le gem RDoc est nécessaire pour utiliser la fonction de rendu RDoc: Utilisera ./views/index.rdoc. -Il n'est pas possible d'appeler des méthodes depuis rdoc, ni même de lui passer des variables -locales. Par conséquent, il sera le plus souvent utilisé en combinaison avec un autre moteur -de rendu: +Il n'est pas possible d'appeler des méthodes depuis rdoc, ni même de lui +passer des variables locales. Par conséquent, il sera le plus souvent utilisé +en combinaison avec un autre moteur de rendu: erb :vuedensemble, :locals => { :texte => rdoc(:introduction) } -Notez que vous pouvez également appeler la méthode rdoc au sein d'autres templates: +Notez que vous pouvez également appeler la méthode +rdoc+ au sein d'autres +templates: %h1 Bonjour Depuis Haml! %p= rdoc(:salutations) +Comme vous ne pouvez pas faire d'appels Ruby au sein de RDoc, vous ne +pouvez pas utiliser des layouts écrits en RDoc. Il est toutefois possible +d'utiliser un autre moteur de rendu pour le layout en passant l'option +:layout_engine : + + get '/' do + rdoc :index, :layout_engine => :erb + end + +Ceci utilisera ./views/index.rdoc avec ./views/layout.erb +pour layout. + +Souvenez vous que vous pouvez spécifier de telles options de rendu +globalement : + + set :rdoc, :layout_engine => :haml, :layout => :post + + get '/' do + rdoc :index + end + +Ceci utilisera ./views/index.rdoc (et tout autre template RDoc) +avec ./views/post.haml pour layout. + === Templates Radius Le gem radius est nécessaire pour utiliser la fonction de rendu Radius: - # Chargez la bibliotèque radius dans votre application + # Chargez la bibliothèque radius dans votre application require 'radius' get '/' do @@ -408,7 +577,8 @@ Le gem radius est nécessaire pour utiliser la fonction de rendu Radius: Utilisera ./views/index.radius. Comme vous ne pouvez pas appeler des méthodes Ruby (excepté +yield+) dans un -template Radius, il sera toujours nécessaire de lui passer des variables locales: +template Radius, il sera toujours nécessaire de lui passer des variables +locales: radius :index, :locals => { :key => 'value' } @@ -425,6 +595,12 @@ Le gem markaby est nécessaire pour utiliser la fonction de rendu Markaby: Utilisera ./views/index.mab. +Vous pouvez également utiliser Markaby en ligne : + + get '/' do + markaby { h1 "Salut !" } + end + === Templates Slim Le gem slim est nécessaire pour utiliser la fonction de rendu Slim: @@ -440,8 +616,17 @@ Utilisera ./views/index.slim. === Templates CoffeeScript -Le gem coffee-script et l'exécutable `coffee` sont nécessaires pour utiliser la -fonction de rendu CoffeeScript: +Le gem coffee-script est nécessaire ainsi que l'une des +options suivantes permettant l'exécution de Java script : + +* +node+ (de Node.js) dans votre path +* vous êtes sous OSX +* le gem +therubyracer+ + +Voir http://github.com/josh/ruby-coffee-script pour une liste à jour d'options +possibles. + +Maintenant vous pouvez générer des templates CoffeeScript : # Chargez la bibliothèque coffee-script dans votre application require 'coffee-script' @@ -452,14 +637,13 @@ fonction de rendu CoffeeScript: Utilisera ./views/application.coffee. -=== Templates en ligne +=== Templates embarqués get '/' do haml '%div.title Bonjour Monde' end -Utilisera le texte passé en argument pour générer la page, au lieu d'aller -chercher le texte dans un fichier. +Générera le template embarqué spécifié dans la chaîne de caractères. === Accéder aux variables dans un Template @@ -479,14 +663,14 @@ Alternativement, on peut passer un hash contenant des variables locales: haml '%h1= foo.nom', :locals => { :foo => foo } end -Ceci est généralement utilisé lorsque l'on veut utiliser un template comme partiel -(depuis un autre template) et qu'il est donc nécessaire d'adapter les noms de variables. +Ceci est généralement utilisé lorsque l'on veut utiliser un template comme +partiel (depuis un autre template) et qu'il est donc nécessaire d'adapter les +noms de variables. === Templates dans le fichier source Des templates peuvent être définis dans le fichier source comme ceci: - require 'rubygems' require 'sinatra' get '/' do @@ -503,12 +687,14 @@ Des templates peuvent être définis dans le fichier source comme ceci: %div.title Bonjour Monde!!!!! NOTE: Les templates du fichier source qui contient require 'sinatra' -sont automatiquement chargés. Si vous avez des templates dans d'autres fichiers source, -il faut explicitement les déclarer via: enable :inline_templates. +sont automatiquement chargés. Si vous avez des templates dans d'autres +fichiers source, il faut explicitement les déclarer via: +enable :inline_templates. === Templates nommés -Les templates peuvent aussi être définis grâce à la méthode de haut niveau template: +Les templates peuvent aussi être définis grâce à la méthode de haut niveau +template: template :layout do "%html\n =yield\n" @@ -522,29 +708,41 @@ Les templates peuvent aussi être définis grâce à la méthode de haut niveau haml :index end -Si un template nommé "layout" existe, il sera utilisé à chaque fois qu'un template -sera affiché. Vous pouvez désactivez le layout à tout moment en passant -:layout => false. +Si un template nommé "layout" existe, il sera utilisé à chaque fois qu'un +template sera affiché. Vous pouvez désactivez les layouts au cas par cas en +passant :layout => false ou bien les désactiver par défaut au moyen +de set :haml, :layout => false. get '/' do haml :index, :layout => !request.xhr? end -== Helpers +=== Associer des extensions de fichier -Utilisez la méthode de haut niveau helpers pour définir des routines qui -seront accessibles dans vos gestionnaires de route et dans vos templates: +Pour associer une extension de fichier avec un moteur de rendu, utilisez +Tilt.register. Par exemple, si vous désirez utiliser l'extension +de fichier +tt+ pour les templates Textile, vous pouvez faire comme suit : + + Tilt.register :tt, Tilt[:textile] + +=== Ajouter son propre moteur de rendu + +En premier lieu, déclarez votre moteur de rendu avec Tilt, ensuite créez +votre méthode de rendu : + + Tilt.register :monmoteur, MonMerveilleurMoteurDeRendu helpers do - def bar(nom) - "#{nom}bar" - end + def monmoteur(*args) render(:monmoteur, *args) end end - get '/:nom' do - bar(params[:nom]) + get '/' do + monmoteur :index end +Utilisera ./views/index.monmoteur. Voir +https://github.com/rtomayko/tilt pour en savoir plus sur Tilt. + == Filtres Un filtre before est évalué avant n'importe quelle requête, dans le @@ -564,13 +762,18 @@ et au template: Un filtre after est évalué après chaque requête, dans le contexte de celle-ci et peut également modifier la requête et/ou la réponse. Toutes les -variables d'instance déclarées dans un filtre before et dans le gestionnaire -de route sont accessibles dans le filtre after: +variables d'instance déclarées dans un filtre before et dans le +gestionnaire de route sont accessibles dans le filtre after: after do puts response.status end +Note : Sauf si vous utilisez la méthode +body+ au lieu de renvoyer une chaîne +de caractères dans vos gestionnaires de routes, le corps de la réponse ne sera +pas disponible dans le filtre after, étant donné qu'il est généré +plus tard. + En option, on peut passer un masque au filtre, ce qui le rend actif uniquement si la requête correspond au masque en question: @@ -582,9 +785,67 @@ si la requête correspond au masque en question: session[:dernier_travail] = travail end +Tout comme les routes, les filtres acceptent également les conditions : + + before :agent => /Songbird/ do + # ... + end + + after '/blog/*', :host_name => 'example.com' do + # ... + end + +== Helpers + +Utilisez la méthode de haut niveau helpers pour définir des routines +qui seront accessibles dans vos gestionnaires de route et dans vos templates : + + helpers do + def bar(nom) + "#{nom}bar" + end + end + + get '/:nom' do + bar(params[:nom]) + end + +=== Utiliser les sessions + +Une session est utilisé pour conserver un état entre les requêtes. Une fois +activées, vous avez un +hash+ de session par session utilisateur : + + enable :sessions + + get '/' do + "valeur = " << session[:valeur].inspect + end + + get '/:value' do + session[:valeur] = params[:valeur] + end + +Notez que enable :sessions enregistre en fait toutes les données dans +un +cookie+. Ce n'est pas toujours ce que vous voulez (enregistrer beaucoup de +données va augmenter le traffic par exemple). Vous pouvez utiliser n'importe +quel +middleware+ Rack de session afin d'éviter cela. N'utiliser *pas* +enable :sessions dans ce cas mais charger le +middleware+ de votre +choix comme vous le feriez pour n'importe quel autre +middleware+ : + + use Rack::Session::Pool, :expire_after => 2592000 + + get '/' do + "valeur = " << session[:valeur].inspect + end + + get '/:value' do + session[:valeur] = params[:valeur] + end + == Halt -Pour arrêter immédiatement la requête dans un filtre ou un gestionnaire de route: +Pour arrêter immédiatement la requête dans un filtre ou un gestionnaire de +route: halt @@ -604,6 +865,10 @@ Ainsi que les entêtes ... halt 402, {'Content-Type' => 'text/plain'}, 'revanche' +Bien sûr il est possible de cominer un template avec +halt+: + + halt erb(:erreur) + == Passer Une route peut passer le relais aux autres routes qui correspondent également @@ -622,13 +887,242 @@ On sort donc immédiatement de ce gestionnaire et on continue à chercher, dans les masques suivants, le prochain qui correspond à la requête. Si aucun des masques suivants ne correspond, un code 404 est retourné. +=== Déclencher une autre route + +Parfois, +pass+ n'est pas ce que vous recherchez, au lieu de cela vous +souhaitez obtenir le résultat d'une autre route. Pour cela, utilisez +simplement +call+ : + + get '/foo' do + status, headers, body = call request.env.merge("PATH_INFO" => '/bar') + [status, body.upcase] + end + + get '/bar' do + "bar" + end + +Notez que dans l'exemple ci-dessus, vous faciliterez les tests et améliorerez +la performance en déplaçant simplement "bar" dans un +helper+ +utilisé à la fois par /foo et /bar. + +Si vous souhiatez que la requête soit envoyée à la même instance de +l'application plutôt qu'à une copie, utilisez call! au lieu de +call. + +Lisez la spécification Rack si vous souhaitez en savoir plus sur +call. + +=== Définir le corps, le code retour et les entêtes + +Il est possible et recommandé de définir le code retour et le corps de la +réponse au moyen de la valeur de retour d'un bloc définissant une route. +Quoiqu'il en soit, dans certains cas vous pourriez avoir besoin de définir +le coprs de la réponse à un moment arbitraire de l'exécution. Vous pouvez le +faire au moyen de la méthode +body+. Si vous faites ainsi, vous pouvez alors +utiliser cette même méthode pour accéder au corps de la réponse : + + get '/foo' do + body "bar" + end + + after do + puts body + end + +Il est également possible de passer un bloc à +body+, qui sera exécuté par le +gestionnaire Rack (ceci peut être utilisé pour implémenter un +streaming+, +voir "Valeurs de retour"). + +Pareillement au corps de la réponse, vous pouvez également définir le code +retour et les entêtes : + + get '/foo' do + status 418 + headers \ + "Allow" => "BREW, POST, GET, PROPFIND, WHEN" + "Refresh" => "Refresh: 20; http://www.ietf.org/rfc/rfc2324.txt" + body "I'm a tea pot!" + end + +Comme +body+, +headers+ et +status+ peuvent être utilisés sans arguments +pour accéder à leurs valeurs. + +=== Types Mime + +Quand vous utilisez send_file ou des fichiers statiques, vous +pouvez rencontrer des types mime que Sinatra ne connaît pas. Utilisez ++mime_type+ pour les déclarer par extension de fichier : + + mime_type :foo, 'text/foo' + +Vous pouvez également les utiliser avec la méthode +content_type+ : + + get '/' do + content_type :foo + "foo foo foo" + end + +=== Former des URLs + +Pour former des URLs, vous devriez utiliser la méthode +url+, par exemple en +Haml : + + %a{:href => url('/foo')} foo + +Cela prend en compte les proxy inverse et les routeurs Rack, s'ils existent. + +Cette méthode est également disponible sous l'alias +to+ (voir ci-dessous +pour un exemple). + +=== Redirection du navigateur + +Vous pouvez déclencher une redirection du navigateur avec la méthode ++redirect+ : + + get '/foo' do + redirect to('/bar') + end + +Tout paramètre additionnel est géré comme des arguments pour la méthode ++halt+ : + + redirect to('/bar'), 303 + redirect 'http://google.com', 'mauvais endroit mon pote' + +Vous pouvez aussi rediriger vers la page dont l'utilisateur venait au moyen de +redirect back: + + get '/foo' do + "faire quelque chose" + end + + get '/bar' do + faire_quelque_chose + redirect back + end + +Pour passer des arguments à une redirection, ajoutez-les soit à la requête : + + redirect to('/bar?sum=42') + +Ou bien utilisez une session : + + enable :session + + get '/foo' do + session[:secret] = 'foo' + redirect to('/bar') + end + + get '/bar' do + session[:secret] + end + +=== Contrôle du cache + +Définir correctement vos entêtes à la base pour un bon cahce HTTP. + +Vous pouvez facilement définir l'entête Cache-Control de la manière suivante : + + get '/' do + cache_control :public + "met le en cache !" + end + +Conseil de pro : définir le cache dans un filtre +before+. + + before do + cache_control :public, :must_revalidate, :max_age => 60 + end + +Si vous utilisez la méthode +expires+ pour définir l'entête correspondant, +Cache-Control sera alors défini automatiquement : + + before do + expires 500, :public, :must_revalidate + end + +Pour utiliser correctement les caches, vous devriez utiliser +etag+ et ++last_modified+. Il est recommandé d'utiliser ces méthodes *avant* de faire +d'important modifications, car elles vont immédiatement déclencher la réponse +si le client a déjà la version courante dans son cache. + + get '/article/:id' do + @article = Article.find params[:id] + last_modified @article.updated_at + etag @article.sha1 + erb :article + end + +Il est également possible d'utiliser un +{weak ETag}[http://en.wikipedia.org/wiki/HTTP_ETag#Strong_and_weak_validation]: + + etag @article.sha1, :weak + +Ces méthodes ne sont pas chargées de mettre des données en cache, mais elles +fournissent les informations nécessaires pour votre cache. Si vous êtes à la +recherche de solutions rapides de cache, essayez +{rack-cache}[http://rtomayko.github.com/rack-cache/]: + + require "rack/cache" + require "sinatra" + + use Rack::Cache + + get '/' do + cache_control :public, :max_age => 36000 + sleep 5 + "hello" + end + +=== Envoyer des fichiers + +Pour envoyer des fichiers, vous pouvez utiliser la méthode +send_file : + + get '/' do + send_file 'foo.png' + end + +Quelques options sont également acceptées : + + send_file 'foo.png', :type => :jpg + +Les options sont : + +[filename] + le nom du fichier dans la réponse, par défaut le nom du fichier envoyé. + +[last_modified] + valeur pour l'entête Last-Modified, par défaut la date de modification du + fichier + +[type] + type de contenu à utiliser, deviné à partir de l'extension de fichier si + absent + +[disposition] + utilisé pour Content-Disposition, les valuers possibles étant : +nil+ (par + défaut), :attachment et :inline + +[length] + entête Content-Length, par défaut la taille du fichier + +Si le gestionnaire Rack le supporte, d'autres moyens que le +streaming+ via le +processus Ruby seront utilisés. Si vous utilisez cette méthode, Sinatra gérera +automatiquement les requêtes de type +range+. + == Accéder à l'objet requête -L'objet correspondant à la requête envoyée peut être récupéré dans le contexte de la requête (filtres, routes, gestionnaires d'erreur) au moyen de la méthode `request`: +L'objet correspondant à la requête envoyée peut être récupéré dans le contexte +de la requête (filtres, routes, gestionnaires d'erreur) au moyen de la méthode +`request`: # application tournant à l'adresse http://exemple.com/exemple get '/foo' do - request.body # corps de la requête envoyée par le client (voir ci-dessous) + request.body # corps de la requête envoyée par le client + # (voir ci-dessous) request.scheme # "http" request.script_name # "/exemple" request.path_info # "/foo" @@ -638,7 +1132,8 @@ L'objet correspondant à la requête envoyée peut être récupéré dans le con request.content_length # taille de request.body request.media_type # type de média pour request.body request.host # "exemple.com" - request.get? # true (méthodes similaires pour les autres verbes HTTP) + request.get? # true (méthodes similaires pour les autres + # verbes HTTP) request.form_data? # false request["UN_ENTETE"] # valeur de l'entête UN_ENTETE request.referer # référant du client ou '/' @@ -649,11 +1144,13 @@ L'objet correspondant à la requête envoyée peut être récupéré dans le con request.path # "/exemple/foo" request.ip # adresse IP du client request.secure? # false - request.env # tableau brut de l'environnement fourni par Rack + request.forwarded? # vrai (si on est derrière un proxy inverse) + request.env # tableau brut de l'environnement fourni par + # Rack end -Certaines options, telles que script_name ou path_info peuvent -également être modifiées: +Certaines options, telles que script_name ou path_info +peuvent également être modifiées: before { request.path_info = "/" } @@ -669,12 +1166,86 @@ Certaines options, telles que script_name ou path_info peuvent "Bonjour #{donnees['nom']}!" end +=== Fichiers joints + +Vous pouvez utiliser la méthode +attachment+ pour indiquer au navigateur que +la réponse devrait être stockée sur le disque plutôt qu'affichée. + + get '/' do + attachment + "enregistre-le !" + end + +Vous pouvez également lui passer un nom de fichier : + + get '/' do + attachment "info.txt" + "enregistre-le !" + end + +=== Chercher les fichiers de templates + +La méthode find_template est utilisée pour trouver les fichiers de +templates à générer : + + find_template settings.views, 'foo', Tilt[:haml] do |file| + puts "pourrait être #{file}" + end + +Ce n'est pas très utilise. En revanche, il est utile de pouvoir surcharger +cette méthode afin de définir son propre mécanisme de recherche. Par exemple, +vous pouvez utiliser plus d'un répertoire de vues : + + set :views, ['views', 'templates'] + + helpers do + def find_template(views, name, engine, &block) + Array(views).each { |v| super(v, name, engine, &block) } + end + end + +Un autre exemple est d'utiliser des répertoires différents pour des moteurs +de rendu différents : + + set :views, :sass => 'views/sass', :haml => 'templates', :default => 'views' + + helpers do + def find_template(views, name, engine, &block) + _, folder = views.detect { |k,v| engine == Tilt[k] } + folder ||= views[:default] + super(folder, name, engine, &block) + end + end + +Vous pouvez également écrire cela dans une extension et la partager avec +d'autres ! + +Notez que find_template ne vérifie pas que le fichier existe mais +va plutôt exécuter le bloc pour tous les chemins possibles. Cela n'induit pas +un problème de performance dans le sens où +render+ va utiliser +break+ dès +qu'un fichier est trouvé. De plus, l'emplacement des templates (et leur +contenu) est mis en cache si vous n'êtes pas en mode développement. Vous +devriez garder cela en tête si vous écrivez une méthode vraiment dingue. + == Configuration Lancé une seule fois au démarrage de tous les environnements: configure do - ... + # définir un paramètre + set :option, 'value' + + # définir plusieurs paramètre + set :a => 1, :b => 2 + + # identique à `set :option, true` + enable :option + + # identique à `set :option, false` + disable :option + + # vous pouvez également avoir des paramètres dynamiques avec des blocs + set(:css_dir) { File.join(views, 'css') } end Lancé si l'environnement (variable d'environnement RACK_ENV) est défini comme @@ -691,16 +1262,125 @@ Lancé si l'environnement est :production ou ... end +Vous pouvez accéder à ces paramètres via settings : + + configure do + set :foo, 'bar' + end + + get '/' do + settings.foo? # => true + settings.foo # => 'bar' + ... + end + +=== Paramètres disponibles + +[absolute_redirects] Si désactivé, Sinatra permettra les redirections + relatives. Toutefois, Sinatra ne sera plus conforme à la + RFC 2616 (HTTP 1.1), qui n'autorise que les redirections + absolues. + + Activez si votre application tourne derrière un proxy + inverse qui n'a pas été correctement configuré. Notez + que la méthode +url+ continuera de produire des URLs + absolues, sauf si vous lui passez +false+ comme second + argument. + + Désactivé par défaut. + +[add_charsets] types mime pour lesquels la méthode + content_type va automatiquement ajouter + l'information du +charset+. + + Vous devriez lui ajouter des valeurs plutôt que de + l'écraser : + + settings.add_charsets << "application/foobar" + +[app_file] fichier de l'application principale, utilisé pour + détecterla racine du projet, le dossier public et le + dossier de vues ainsi que pour les templates en ligne. + +[bind] adresse IP sur laquelle se brancher + (par défaut: 0.0.0.0). + Utiliser seulement pour le serveur intégré. + +[default_encoding] encodage à utiliser si inconnu (par défaut + "utf-8"). + +[dump_errors] afficher les erreurs dans le +log+. + +[environment] environnement courant, par défaut + ENV['RACK_ENV'], ou + "development" si absent. + +[logging] utiliser le +logger+. + +[lock] Place un +lock+ autour de chaque requête, n'exécutant + donc qu'une seule requête par processus Ruby. + + Activé si votre application n'est pas +thread-safe+. + Désactivé par défaut. + +[method_override] utilise la magie de _method afin de permettre + des formulaires put/delete dans des navigateurs qui ne + le permettent pas. + +[port] port à écouter. Utiliser seulement pour le serveur + intégré. + +[prefixed_redirects] si oui ou non request.script_name doit être + inséré dans les redirections si un chemin non absolu + est utilisé. Ainsi, redirect '/foo' se + comportera comme redirect to('/foo'). + Désactivé par défaut. + +[public] dossier duquel les fichiers publics sont servis + +[reload_templates] si oui ou non les templates doivent être rechargés + entre les requêtes. Activé en mode développement + et sur Ruby 1.8.6 (pour compenser un bug Ruby + occasionnant une fuite de mémoire). + +[root] dossier racine du projet. + +[raise_errors] soulever les erreurs (ce qui arrêtera l'application). + +[run] si activé, Sinatra s'occupera de démarrer le serveur, + ne pas activer si vous utiliser rackup ou autres. + +[running] est-ce que le serveur intégré est en marche ? + ne changez pas ce paramètre ! + +[server] serveur ou liste de serveurs à utiliser pour le serveur + intégré. + Par défaut ['thin', 'mongrel', 'webrick'], l'ordre + indiquant la priorité. + +[sessions] active l'enregistrement des sessions en utilisant les + cookies. + +[show_exceptions] affiche la trace de l'erreur dans le navigateur. + +[static] Si oui ou non Sinatra doit s'occuper de servir les + fichiers statiques. + Désactivez si vous utilisez un serveur capable de le + gérer lui même. Le désactiver augmentera la performance. + Activé par défaut. + +[views] dossier des vues. + == Gérer les erreurs -Les gestionnaires d'erreur s'exécutent dans le même contexte que les routes ou les -filtres, ce qui veut dire que vous avez accès (entre autres) aux bons vieux -haml, erb, halt, etc. +Les gestionnaires d'erreur s'exécutent dans le même contexte que les routes ou +les filtres, ce qui veut dire que vous avez accès (entre autres) aux bons +vieux haml, erb, halt, etc. === Pas Trouvé -Quand une exception Sinatra::NotFound est soulevée, ou que le code retour -est 404, le gestionnaire not_found est invoqué: +Quand une exception Sinatra::NotFound est soulevée, ou que le code +retour est 404, le gestionnaire not_found est invoqué: not_found do 'Pas moyen de trouver ce que vous cherchez' @@ -708,8 +1388,9 @@ est 404, le gestionnaire not_found est invoqué: === Erreur -Le gestionnaire +error+ est invoqué à chaque fois qu'une exception est soulevée dans une route -ou un filtre. L'objet exception est accessible via la variable Rack sinatra.error: +Le gestionnaire +error+ est invoqué à chaque fois qu'une exception est +soulevée dans une route ou un filtre. L'objet exception est accessible via la +variable Rack sinatra.error: error do 'Désolé mais une méchante erreur est survenue - ' + env['sinatra.error'].name @@ -731,7 +1412,8 @@ Vous obtenez ça: Donc il est arrivé ceci... quelque chose de mal -Alternativement, vous pouvez avoir un gestionnaire d'erreur associé à un code particulier: +Alternativement, vous pouvez avoir un gestionnaire d'erreur associé à un code +particulier: error 403 do 'Accès interdit' @@ -747,27 +1429,18 @@ Ou un intervalle: 'Boom' end -Sinatra installe pour vous quelques gestionnaires not_found et error -génériques lorsque vous êtes en environnement development. - -== Types Mime - -Quand vous utilisez send_file et que le fichier possède une extension que Sinatra -ne reconnaît pas, utilisez +mime_type+ pour la déclarer: - - mime_type :foo, 'text/foo' - -Vous pouvez aussi l'utiliser avec +content_type+: - - content_type :foo +Sinatra installe pour vous quelques gestionnaires not_found et +error génériques lorsque vous êtes en environnement +development. == Les Middlewares Rack Sinatra tourne avec Rack[http://rack.rubyforge.org/], une interface standard et minimale pour les web frameworks Ruby. Un des points forts de Rack est le -support de ce que l'on appelle des "middlewares" -- composant qui vient se situer -entre le serveur et votre application, et dont le but est de visualiser/manipuler la -requête/réponse HTTP, et d'offrir diverses fonctionnalités classiques. +support de ce que l'on appelle des "middlewares" -- composant qui vient se +situer entre le serveur et votre application, et dont le but est de +visualiser/manipuler la requête/réponse HTTP, et d'offrir diverses +fonctionnalités classiques. Sinatra permet de construire facilement des middlewares Rack via la méthode de haut niveau +use+: @@ -784,17 +1457,17 @@ haut niveau +use+: La sémantique de +use+ est identique à celle définie dans le DSL de Rack::Builder[http://rack.rubyforge.org/doc/classes/Rack/Builder.html] -(le plus souvent utilisé dans un fichier rackup). Par exemple, la méthode +use+ -accepte divers arguments ainsi que des blocs: +(le plus souvent utilisé dans un fichier rackup). Par exemple, la méthode ++use+ accepte divers arguments ainsi que des blocs: use Rack::Auth::Basic do |login, password| login == 'admin' && password == 'secret' end -Rack est distribué avec une bonne variété de middlewares standards pour les logs, -débuguer, faire du routage URL, de l'authentification, gérer des sessions. -Sinatra utilise beaucoup de ces composants automatiquement via la configuration, -donc pour ceux-ci vous n'aurez pas à utiliser la méthode +use+. +Rack est distribué avec une bonne variété de middlewares standards pour les +logs, débuguer, faire du routage URL, de l'authentification, gérer des +sessions. Sinatra utilise beaucoup de ces composants automatiquement via la +configuration, donc pour ceux-ci vous n'aurez pas à utiliser la méthode +use+. == Tester @@ -803,6 +1476,7 @@ basée sur Rack. {Rack::Test}[http://gitrdoc.com/brynary/rack-test] est recommandé: require 'mon_application_sinatra' + require 'test/unit' require 'rack/test' class MonTest < Test::Unit::TestCase @@ -839,8 +1513,8 @@ de créer des composants réutilisables comme des middlewares Rack, faire du Rails metal, ou de simples bibliothèques avec un composant serveur, ou même une extension pour Sinatra. Le DSL de haut niveau pollue l'espace de noms et est une configuration adaptée à une micro-application (un fichier unique -pour l'application, les dossiers ./public et ./views, les logs, pages d'erreur, etc.). -C'est là que Sinatra::Base entre en jeu: +pour l'application, les dossiers ./public et ./views, les logs, pages +d'erreur, etc.). C'est là que Sinatra::Base entre en jeu: require 'sinatra/base' @@ -853,13 +1527,6 @@ C'est là que Sinatra::Base entre en jeu: end end -La classe MonApplication est un composant Rack indépendant qui peut agir -comme un middleware Rack, une application Rack, ou Rails metal. vous pouvez -donc le lancer avec +run+ ou l'utiliser avec +use+ dans un fichier rackup; -ou contrôler un composant de serveur sous forme de bibliothèque: - - MonApplication.run! :host => 'localhost', :port => 9090 - Les méthodes disponibles dans Sinatra::Base sont exactement identiques à celles disponibles dans le DSL de haut niveau. La plupart des applications de haut niveau peuvent être converties en composant Sinatra::Base avec @@ -871,16 +1538,107 @@ deux modifications: * Mettre vos gestionnaires de route, vos gestionnaires d'erreur, vos filtres et options dans une sous-classe de Sinatra::Base. -Sinatra::Base est plutôt épuré. La plupart des options sont désactivées par défaut, -ceci inclus le serveur. Voir {Options et Configuration}[http://sinatra.github.com/configuration.html] +Sinatra::Base est plutôt épuré. La plupart des options sont +désactivées par défaut, ceci inclus le serveur. Voir {Options et +Configuration}[http://sinatra.github.com/configuration.html] pour plus de détails sur les options et leur comportement. +=== Style modulaire vs. style classique + +Contrairement aux croyanaces, le style classique n'a rien de mauvais. Si cela +convient à votre application, vous n'avez pas à changer pour une application +modulaire. + +Il n'y a que deux inconvénient au style classique comparé au style modulaire : + +* Vous ne pouvez avoir qu'une seule application Sinatra par processus Ruby. Si + vous envisagez d'en utiliser plus, passez au style modulaire + +* Le style classique pollue la classe Object avec des méthodes déléguantes. + Si vous prévoyez de diffuser votre application dans une bibliothèque/gem, + passez au style modulaire. + +Il n'y pas d'empêchement à mélanger style classic et style modulaire. + +Si vous passez d'un style à l'autre, vous devriez être vigilant à quelques +légères différences dans les paramètres : + + Paramètre Classique Modulaire + + app_file fichier chargeant sinatra nil + run $0 == app_file false + logging true false + method_override true false + inline_templates true false + + +=== Servir une application modulaire + +Il y a deux façons de faire pour démarrer une application modulaire, démarrez +avec run! : + + # my_app.rb + require 'sinatra/base' + + class MyApp < Sinatra::Base + # ... code de l'application ici ... + + # démarre le serveur si ce fichier est directement exécuté + run! if app_file == $0 + end + +Démarrez ensuite avec : + + ruby my_app.rb + +Ou alors avec un fichier config.ru, qui permet d'utiliser n'importe +quel gestionnaire Rack : + + # config.ru + require 'my_app' + run MyApp + +Exécutez : + + rackup -p 4567 + +=== Utiliser une application de style classique avec un fichier config.ru + +Ecrivez votre application : + + # app.rb + require 'sinatra' + + get '/' do + 'Hello world!' + end + +Et un fichier config.ru correspondant : + + require 'app' + run Sinatra::Application + +=== Quand utiliser un fichier config.ru ? + +Quelques cas où vous devriez utiliser un fichier config.ru : + +* Vous souhaitez déployer avec un autre gestionnaire Rack (Passenger, Unicorn, + Heroku, ...). +* Vous souhaitez utiliser plus d'une sous-classe de Sinatra::Base. +* Vous voulez utiliser Sinatra comme un +middleware+, non en tant que + +endpoint+. + +Il n'est pas nécessaire de passer par un fichier config.ru pour la +seule raison que vous êtes passé au style modulaire, et vous n'avez pas besoin +de passer au style modulaire pour utiliser un fichier config.ru. + === Utiliser Sinatra comme Middleware -Non seulement Sinatra peut utiliser d'autres middlewares Rack, il peut également être -à son tour utilisé au-dessus de n'importe quel +endpoint+ Rack en tant que middleware. -Ce +endpoint+ peut très bien être une autre application Sinatra, ou n'importe quelle -application basée sur Rack (Rails/Ramaze/Camping/...). +Non seulement Sinatra peut utiliser d'autres middlewares Rack, il peut +également être à son tour utilisé au-dessus de n'importe quel +endpoint+ Rack +en tant que middleware. Ce +endpoint+ peut très bien être une autre +application Sinatra, ou n'importe quelle application basée sur Rack +(Rails/Ramaze/Camping/...). require 'sinatra/base' @@ -919,11 +1677,12 @@ disponibles. === Contexte de l'application/classe Toute application Sinatra correspond à une sous-classe de Sinatra::Base. Si -vous utilisez le DSL haut niveau (require 'sinatra'), alors cette classe -est Sinatra::Application, sinon il s'agit de la sous-classe que vous avez définie. -Dans le contexte de la classe, vous avez accès aux méthodes telles que `get` ou -`before`, mais vous n'avez pas accès aux objets `request` ou `session` car c'est la -même classe d'application qui traitera toutes les requêtes. +vous utilisez le DSL haut niveau (require 'sinatra'), alors cette +classe est Sinatra::Application, sinon il s'agit de la sous-classe que vous +avez définie. Dans le contexte de la classe, vous avez accès aux méthodes +telles que `get` ou `before`, mais vous n'avez pas accès aux objets `request` +ou `session` car c'est la même classe d'application qui traitera toutes les +requêtes. Les options définies au moyen de `set` deviennent des méthodes de classe: @@ -951,11 +1710,12 @@ Vous pouvez atteindre ce contexte (donc la classe) de la façon suivante: === Contexte de la requête/instance -Pour tout traitement d'une requête, une nouvelle instance de votre classe d'application -est créée et tous vos gestionnaires sont exécutés dans ce contexte. Dans ce dernier, -vous pouvez accéder aux objets `request` et `session` et faire appel aux fonctions -de rendu telles que `erb` ou `haml`. Vous pouvez accéder au contexte de l'application -depuis le contexte de la requête au moyen de `settings`: +Pour tout traitement d'une requête, une nouvelle instance de votre classe +d'application est créée et tous vos gestionnaires sont exécutés dans ce +contexte. Dans ce dernier, vous pouvez accéder aux objets `request` et +`session` et faire appel aux fonctions de rendu telles que `erb` ou `haml`. +Vous pouvez accéder au contexte de l'application depuis le contexte de la +requête au moyen de `settings`: class MonApp < Sinatra::Base # Eh, je suis dans le contexte de l'application! @@ -974,7 +1734,7 @@ depuis le contexte de la requête au moyen de `settings`: Vous avez le binding du contexte de la requête dans: -* les blocs get/head/post/put/delete +* les blocs get/head/post/put/delete/options * les filtres before/after * les méthodes utilitaires (définies au moyen de `helpers`) * les vues/templates @@ -982,12 +1742,12 @@ Vous avez le binding du contexte de la requête dans: === Le contexte de délégation Le contexte de délégation se contente de transmettre les appels de méthodes au -contexte de classe. Toutefois, il ne se comporte pas à 100% comme le contexte de -classe car vous n'avez pas le binding de la classe: seules les méthodes -spécifiquement déclarées pour délégation sont disponibles et il n'est pas possible -de partager des variables/états avec le contexte de classe (comprenez: `self` n'est -pas le même). Vous pouvez ajouter des délégation de méthodes en appelant -Sinatra::Delegator.delegate :method_name. +contexte de classe. Toutefois, il ne se comporte pas à 100% comme le contexte +de classe car vous n'avez pas le binding de la classe: seules les méthodes +spécifiquement déclarées pour délégation sont disponibles et il n'est pas +possible de partager des variables/états avec le contexte de classe +(comprenez: `self` n'est pas le même). Vous pouvez ajouter des délégation de +méthodes en appelant Sinatra::Delegator.delegate :method_name. Vous avez le binding du contexte de délégation dans: @@ -995,7 +1755,8 @@ Vous avez le binding du contexte de délégation dans: * Un objet qui inclut le module `Sinatra::Delegator` Jetez un oeil -pour vous faire une idée: voici le mixin {Sinatra::Delegator}[http://github.com/sinatra/sinatra/blob/ceac46f0bc129a6e994a06100aa854f606fe5992/lib/sinatra/base.rb#L1128] +pour vous faire une idée: voici le mixin +{Sinatra::Delegator}[http://github.com/sinatra/sinatra/blob/ceac46f0bc129a6e994a06100aa854f606fe5992/lib/sinatra/base.rb#L1128] qui est {inclus dans l'espace de noms principal}[http://github.com/sinatra/sinatra/blob/ceac46f0bc129a6e994a06100aa854f606fe5992/lib/sinatra/main.rb#L28] == Ligne de commande @@ -1013,38 +1774,133 @@ Les options sont: -s # déclare le serveur/gestionnaire à utiliser (thin par défaut) -x # active le mutex lock (off par défaut) +== Configuration nécessaire + +Il est recommandé d'installer Sinatra sur Ruby 1.8.7, 1.9.2, JRuby ou +Rubinius. + +Les versions suivantes de Ruby sont officiellement supportées : + +[ Ruby 1.8.6 ] + Il n'est pas recommandé d'utiliser 1.8.6 pour Sinatra. Toutefois, ce sera + officiellement supporté jusqu'à l'arrivée Sinatra 1.3.0. Les templates RDoc + et CoffeScript ne sont pas supportés par cette version de Ruby. 1.8.6 + contient un défaut majeur de fuite de mémoire dans l'implémentation de Hash, + qui est déclenché par les versions de Sinatra antérieure à 1.1.1. La version + actuelle prévient explicitement ce risque au prix de la performance. Vous + devrez utiliser Rack 1.1.x dans la mesure où Rack >= 1.2 ne supporte plus + 1.8.6. + +[ Ruby 1.8.7 ] + 1.8.7 est complètement supporté, toutefois si rien ne vous y retient, nous + vous recommandons de passer à 1.9.2 ou bien de passer à JRuby ou Rubinius. + +[ Ruby 1.9.2 ] + 1.9.2 est supporté et recommandé. Notez que Radius et Markaby ne sont + actuellement pas compatible avec 1.9. N'utilisez pas 1.9.2p0 qui est + réputé causer des erreurs de segmentation lorque Sinatra est utilisé. + +[ Rubinius ] + Rubinius est officiellement supporté (Rubinius >= 1.2.2), à l'exception + des templates Textile. + +[ JRuby ] + JRuby est officiellement supporté (JRuby >= 1.5.6). Aucune anomalie avec + des bibliothèques de templates tierces ne sont connues. Toutefois, si vous + choisissez JRuby, alors tournez vous vers des gestionnaires Rack JRuby car + le serveur Thin n'est pas (encore) supporté par JRuby. + +Nous gardons également un oeil sur les versions Ruby à venir. + +Les implémentations Ruby suivantes ne sont pas officiellement supportées mais +sont toujours connues comme permettant à Sinatra de fonctionner : + +* Plus anciennes versions de JRuby et Rubinius +* MacRuby +* Maglev +* IronRuby +* Ruby 1.9.0 et 1.9.1 + +Ne pas être officiellement supporté signifie que si les choses se passent mal +sur ces plateformes et non sur celles supportées, nous considérons que +l'anomalie est de le ressort, pas du nôtre. + +Sinatra devrait fonctionner sur n'importe quel système d'exploitation +supportant l'implémentation Ruby choisie. + == Essuyer les plâtres -Si vous voulez utiliser la toute dernière version de Sinatra, créez un -clone local et lancez votre application avec le dossier sinatra/lib -dans votre LOAD_PATH: +Si vous voulez utiliser la toute dernière version de Sinatra, n'ayez pas peur +de faire tourner votre application sur la branche master, cela devrait être +stable. - cd mon_application +Nous publions également une gem de +prerelease+ de temps en temps donc vous +pouvez faire la chose suivante : + + gem install sinatra --pre + +afin d'avoir certaines des toutes dernières fonctionnalités. + +=== Avec Bundler + +Si vous voulez faire tourner votre application avec le tout dernier +Sinatra, {Bundler}[http://gembundler.com/] est recommandé. + +Tout d'abord, installer bundler si vous ne l'avez pas : + + gem install bundler + +Ensuite, dans le dossier de votre projet, créez un fichier +Gemfile+ : + + source :rubygems + gem 'sinatra', :git => "git://github.com/sinatra/sinatra.git" + + # autres dépendances + gem 'haml' # par exemple, si vous utilisez haml + gem 'activerecord', '~> 3.0' # peut-être que vous avez également besoin + # de ActiveRecord 3.x + +Notez que vous aurez à lister toutes les dépendances de votre application dans +ce fichier. Les dépendances directes de Sinatra (Rack et Tilt) seront +automatiquement téléchargées et ajoutées par Bundler. + +Maintenant, vous pouvez faire tourner votre application de la façon suivante : + + bundle exec ruby myapp.rb + +=== Faites le vous-même + +Créez un clone local et démarrez votre application avec le dossier +sinatra/lib dans le $LOAD_PATH : + + cd myapp git clone git://github.com/sinatra/sinatra.git - ruby -Isinatra/lib mon_application.rb + ruby -Isinatra/lib myapp.rb -Alternativement, vous pouvez ajoutez le dossier sinatra/lib à votre -LOAD_PATH à l'intérieur de votre application: +A l'avenir, pour mettre à jour le code source de Sinatra : - $LOAD_PATH.unshift File.dirname(__FILE__) + '/sinatra/lib' - require 'rubygems' - require 'sinatra' - - get '/a_propos' do - "J'utilise la version " + Sinatra::VERSION - end - -Pour mettre à jour les sources de Sinatra par la suite: - - cd mon_projet/sinatra + cd myapp/sinatra git pull +=== Installez globalement + +Vous pouvez construire la gem vous-même : + + git clone git://github.com/sinatra/sinatra.git + cd sinatra + rake sinatra.gemspec + rake install + +Si vous installez les gems en tant que +root+, la dernière étape sera : + + sudo rake install + == Mais encore * {Site internet}[http://www.sinatrarb.com/] - Plus de documentation, de news, et des liens vers d'autres ressources. -* {Contribuer}[http://www.sinatrarb.com/contributing] - Vous avez trouvé un bug? Besoin - d'aide? Vous avez un patch? +* {Contribuer}[http://www.sinatrarb.com/contributing] - Vous avez trouvé un + bug? Besoin d'aide? Vous avez un patch? * {Suivi des problèmes}[http://github.com/sinatra/sinatra/issues] * {Twitter}[http://twitter.com/sinatra] * {Mailing List}[http://groups.google.com/group/sinatrarb/topics]