Lea Linux - Contributions [fr]

Ruby On Rails

2006-10-23T13:38:31Z

Rapsys : /* Modèle MVC */

[[Category:Développer sous Linux]]
= Ruby On Rails =

<div class="leatitre">Ruby On Rails</div>
<div class="leapar">par [mailto:gedsismik_at_free_point_fr GEDsismik]</div>
<div class="leadesc">Monter un projet Ruby On Rails (RoR) pas à pas.</div>
----

== Avant propos ==

Ruby On Rails (RoR) est un framework web écrit en ruby. Ce document vous présente comment faire un petit projet Ruby On Rails.

On supposera installé et correctement configuré :
- un SGBD supporté par RoR (personnellement, j'utilise MySQL)
- Ruby
- Rails et ses dépendances

Il vous faudra aussi des notions de ruby.

Dans ce document, je mettrais en place un gestionnaire de livre rudimentaire. Le but est de présenter les bases d'un projet Rails. Il est évident que ces informations sont loin d'être exhaustives vue que RoR peut remplir tout un livre de 500 pages.

== Mise en place de l'environnement ==

<code>$ rails monsite
create
create app/controllers
create app/helpers
create app/models
create app/views/layouts
[...]
</code>
Le répertoire monsite vient d'être créé ainsi que la structure initiale du projet. Entrez maintenant dans ce répertoire.
Normalement, il devrait contenir les fichiers et répertoires suivants :
<code>app
components
config
db
doc
lib
log
public
Rakefile
README
script
test
tmp
vendor
</code>

== Configuration ==

Si vous n'avez pas de base de donnée, créez-en :
<code>mysql> create database monsite_development;
mysql> create database monsite_test;
mysql> create database monsite_production;</code>
<div class="aparte">
Note : J'en ai crée 3 pour pouvoir utiliser 3 environnements différents. Une seule peut suffir, ca dépend de ce que vous voulez faire.
</div>

Nous allons ensuite éditer ./config/database.yml. Vous avez 3 environnements de pré-configurées de la sorte :
<code>production:
adapter: mysql
database: monsite_production
username: root
password:
host: localhost</code>
Avec :
* adapter le type de base de donnée (mysql, postgres, sqlite...)
* database le nom de la base de donnée
* username le nom de l'utilisateur de la base de donnée
* password le mot de passe à la base de donnée
* host le serveur de base de donnée
Dans le cas de sqlite, on a :
* adapter le type de base de donnée (sqlite)
* dbfile nom du fichier de base de donnée

Editez-le en fonction des paramètres de votre base de donnée. Exemple :
<code>production:
adapter: mysql
database: monsite_production
username: gedsismik
password: mypassword
host: localhost
socket: /var/run/mysql/mysql.sock</code>
<div class="aparte">
Note : Sous Slackware, j'ai du ajouter la ligne <code>socket: /var/run/mysql/mysql.sock</code> sinon il ne trouve pas la socket MySQL.
</div>

== Modèle MVC ==

Ruby On Rails utilise le motif de conception MVC (modèle-vue-contrôleur). Je m'explique : dans un projet RoR, vous séparez :
- les modèles (répertoire <code>./app/models</code>) : ce qui concerne les données.

Dans notre cas, c'est donc principalement les tables des bases de données.
- les vues (répertoire <code>./app/views</code>) : ce qui concerne l'interface.

Dans notre cas, il s'agit de la présentation des pages (en HTML et Ruby embarqué, nous verrons ça plus tard).
- les contrôleurs (répertoire <code>./app/controllers</code>) : concerne la gestion des évenements.

Dans notre cas, ce sont les classes qui feront le lien entre les tables (models) et le html (views).Ce qui revient aux appels aux tables via les modèles et la création de variables dont le contenu sera affiché dans les vues.

Pour palier à certaines fonctions qui ne peuvent pas suivre le modèle MVC à la lettre, Rails dispose d'une partie appelée helpers (<code>./app/helpers</code>) qui contient des classes accessibles aux vues et qui contient du code ayant accès aux modèles sans passer par les contrôleurs.

== Création des modèles ==

=== Génération des fichiers relatifs à la table ===

On va utilisez le script <code>./script/generate</code> pour générer la première table.

<code>$ ./script/generate model livre
exists app/models/
exists test/unit/
exists test/fixtures/
create app/models/livre.rb
create test/unit/livre_test.rb
create test/fixtures/livres.yml
create db/migrate
create db/migrate/001_create_livres.rb
$ ./script/generate model auteur
exists app/models/
exists test/unit/
exists test/fixtures/
create app/models/auteur.rb
create test/unit/auteur_test.rb
create test/fixtures/auteurs.yml
exists db/migrate
create db/migrate/002_create_auteurs.rb
</code>

=== Fichiers de migration ===

Les fichiers de migration/création de table se trouvent dans <code>./db/migrate</code>. Il va falloir les éditez pour ajoutez les champs que vous voulez.
<div class="aparte">
Note : ne faites pas de champ "id", ils sont automatiquement créés et gérer par Rails.
</div>

==== create_livres.rb ====
Fichier ./db/migrate/001_create_livres.rb
<code>class CreateLivres < ActiveRecord::Migration
def self.up
create_table :livres do |t|
t.column :titre, :string, :null => false
t.column :auteur_id, :integer, :null => false
t.column :quantite, :integer, :default => "1"
end
end

def self.down
drop_table :livres
end
end
</code>

==== create_auteurs.rb ====
Fichier ./db/migrate/002_create_auteurs.rb
<code>class CreateAuteurs < ActiveRecord::Migration
def self.up
create_table :auteurs do |t|
t.column :nom, :string
t.column :prenom, :string
end
end

def self.down
drop_table :auteurs
end
end</code>

<div class="aparte">Notez que vous pouvez réunir les deux fichiers en un seul :
./db/migrate/001_initial.rb
<code>class Initial < ActiveRecord::Migration
def self.up
create_table :livres do |t|
t.column :titre, :string, :null => false
t.column :auteur_id, :integer, :null => false
t.column :quantite, :integer, :default => "1"
end
create_table :auteurs do |t|
t.column :nom, :string, :null => false
t.column :prenom, :string
end
end

def self.down
drop_table :livres
drop_table :auteurs
end
end</code></div>

=== Génération des tables ===

Toujours dans le repertoire monsite, exécutez <code>rake migrate</code>.
<code>$ rake migrate
(in /home/gedsismik/monsite)
== CreateLivres: migrating ====================================================
-- create_table(:livres)
-> 0.0441s
== CreateLivres: migrated (0.0442s) ===========================================

== CreateAuteurs: migrating ===================================================
-- create_table(:auteurs)
-> 0.0457s
== CreateAuteurs: migrated (0.0458s) ==========================================
</code>

Si vous regardez dans votre base de donnée, vous trouverez donc 3 tables :
- auteurs
- livres
- schema_info

Cette dernière table contient en fait la version de la base de donnée. Les versions sont incrémentées lors du <code>./script/generate model <nom table></code> et sont contenus dans le nom du fichier <code>./db/migrate/001_initial.rb</code> est donc la version 1 de la base.

=== Edition des modèles ===
Intéressons-nous aux fichiers <code>./app/models/auteur.rb</code> et <code>./app/models/livre.rb</code>. Ces classes héritant de ActiveRecord::Base, presque tout est déjà fait. Nous allons juste ajouter la relation : "un auteur écrit plusieurs livres". Cette relation se traduit dans <code>./app/models/auteur.rb</code> par :
<code>class Auteur < ActiveRecord::Base
has_many :livre
end</code>

En contrepartie, on peut avoir besoin d'accéder à l'auteur d'un livre. Modifions donc <code>./app/models/livre.rb</code> en :
<code>class Livre < ActiveRecord::Base
belongs_to :auteur
end</code>

Et voilà ! Ca devrait suffir pour les modèles. En effet, Rails fera tout seul le lien entre les deux tables grâce à auteur_id.

== Création d'un contrôleur ==
Tout d'abord, utilisons, comme pour les modèles, le script <code>./script/generate</code> :
<code>$ ./script/generate controller bibliotheque
exists app/controllers/
exists app/helpers/
create app/views/bibliotheque
exists test/functional/
create app/controllers/bibliotheque_controller.rb
create test/functional/bibliotheque_controller_test.rb
create app/helpers/bibliotheque_helper.rb</code>

Editons maintenant <code>./app/controllers/bibliotheque_controller.rb</code>. Par défaut, vous avez :
<code>class BibliothequeController < ApplicationController
end</code>

Nous allons créer des actions. Un contrôleur peut comporter plusieurs actions.
<code>class BibliothequeController < ApplicationController
def index
listeAuteur
render_action 'listeAuteur'
end

def listeAuteur
@auteurs = Auteur.find(:all, :order => "nom,prenom")
end

def ajoutAuteur
param = @params['auteur']
auteur = Auteur.new(param)
if auteur.save
flash[:ok] = "L'auteur a été ajouté"
else
flash[:error] = "Problème à l'ajout de l'auteur"
end
# ajoutAuteur n'a pas besoin de vue. Une fois l'auteur ajouté
# on réaffiche la liste
redirect_to :action => 'listeAuteur'
end
end
</code>

L'action index est l'action par défaut. L'action listeAuteur donnera la liste des auteurs. On constate ici qu'on peut largement se passer d'écrire du SQL dans Rails. @auteurs est une variable qui contiendra tous les auteurs.

== Mise en place des vues ==

=== Le layout ===

Tout d'abord, créons une layout. Le layout est la structure commune à toutes les pages. Ils se trouvent dans <code>./app/views/layouts/</code>.
<code>$ touch app/views/layouts/bibliotheque.rhtml
</code>
Editons maintenant ce fichier :
<code><!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//FR" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>Bibliothèque - <%= controller.action_name %></title>
<meta name="author" content="GEDsismik">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-15">
</head>
<body>
<h1>Bibliothèque</h1>
<br/>
<div class="all">
<p style="color: green"><%= flash[:notice] %></p>
<%= @content_for_layout %>
</div>
</body>
</html></code>
C'est du Ruby embarqué dans du HTML. Pour ceux qui connaissent, c'est un peu le même principe que le PHP. On écrit du HTML et aux endroits où on veut mettre du ruby, on place le code dans une balise <code><% #code %></code>. Si on veut afficher la sortie du code, on place le code dans une balise <code><%= #code %></code>.

<code><%= @content_for_layout %></code> affichera la partie propre à l'action.

=== La vue ===

Les vues sont dans un répertoire de la forme <code>./app/views/<contrôleur>/</code> et porte le nom <code><action>.rhtml</code>

Créons donc le fichier <code>./app/views/bibliotheque/listeAuteur.rhtml</code> :

<code><h2>Liste des auteurs</h2>
<ul>
<%
@auteurs.each do |auteur|
%><li><%= auteur.nom + " " + auteur.prenom %></li><%
end
%>
</ul>

<h2>Ajout d'un auteur</h2>
<%= start_form_tag :action => "ajoutAuteur" %>
<p><label>Prénom : <%= text_field 'auteur', 'prenom' %></label></p>
<p><label>Nom : <%= text_field 'auteur', 'nom' %></label></p>
<%= submit_tag("Ajouter") %>
<%= end_form_tag %></code>

== WebRick ==

Vous disposez d'un serveur de test appellé WebRick. Pour le lancez, tapez <code>./script/server </code>
<code>$ ./script/server
=> Booting WEBrick...
=> Rails application started on http://0.0.0.0:3000
=> Ctrl-C to shutdown server; call with --help for options
[2006-10-19 18:32:57] INFO WEBrick 1.3.1
[2006-10-19 18:32:57] INFO ruby 1.8.5 (2006-08-25) [i686-linux]
[2006-10-19 18:32:57] INFO WEBrick::HTTPServer#start: pid=26166 port=3000</code>

Par défaut, ce serveur écoute le port 3000. Ouvrez donc un navigateur et tapez : <code>http://localhost:3000</code>.
Normalement, vous devriez obtenir une page de test. Les url de Rails par défaut se décompose de la sorte <code>http://localhost:3000/<contrôleur>/<action>[/<parametres>]</code>. Tapez donc dans votre navigateur <code>http://localhost:3000/bibliotheque/listeAuteur</code>.

== Pour aller un peu plus loin ==
Ajoutons le support des livres dans <code>./app/controllers/bibliotheque_controller.rb</code> :
<code>class BibliothequeController < ApplicationController
def index
listeLivre
render_action 'listeLivre'
end

def listeAuteur
@auteurs = Auteur.find(:all, :order => "nom,prenom")
end

def listeLivre
@livres = Livre.find(:all, :order => "titre")
@auteurs = Auteur.find(:all, :order => "nom,prenom").map{ |u| [ u.nom + " (" + u.prenom + ")", u.id] }
end

def ajoutAuteur
param = @params['auteur']
auteur = Auteur.new(param)
if auteur.save
flash[:ok] = "L'auteur a été ajouté"
else
flash[:error] = "Problème à l'ajout de l'auteur"
end
redirect_to :action => 'listeAuteur'
end

def ajoutLivre
param = @params['livre']
livre = Livre.new(param)
if livre.save
flash[:ok] = "Le livre a été ajouté"
else
flash[:error] = "Problème à l'ajout du livre"
end
redirect_to :action => 'listeLivre'
end
end
</code>

Créons du même coup la vue correspondante à listeLivre <code>./app/views/bibliotheque/listeLivre.rhtml</code> :
<code><% if @livres.blank? %>
<h2>Liste des ouvrages</h2>
<ul>
<%
@livres.each do |livre|
%><li><%= livre.titre %> - <%= livre.auteur.prenom + " " + livre.auteur.nom %></li><%
end
%>
</ul>
<% else %>
<i>La bibliothèque ne contient aucun livre.</i>
<% end %>

<% unless @auteurs.blank? %>
<h2>Ajout d'un livre</h2>
<%= start_form_tag :action => "ajoutLivre" %>
<p><label>Titre : <%= text_field 'livre', 'titre' %></label></p>
<p><label>Nombre d'exemplaire : <%= text_field 'livre', 'quantite' %></label></p>
<p><label>Auteur : <%= select('livre', 'auteur_id', @auteurs) %></label></p>
<%= submit_tag("Ajouter") %>
<%= end_form_tag %>
<% end %></code>

== Les environnements ==
Pour utiliser les différents environnements, vous devez manipuler la variable <code>RAILS_ENV</code>. Par défaut, vous êtes dans le premier environnement du fichier <code>./config/database.yml</code> (à savoir en général development). Pour un <code>rake migrate</code> en production par exemple :
<code>RAILS_ENV=production rake migrate
</code>
notez que l'environnement <code>test</code> efface les tables à chaque <code>rake</code> et que l'environnement <code>production</code> n'affiche aucune information en cas d'exception (vous devez alors vous reportez aux fichiers de log <code>./log/<environnement>.log</code>).

= Copyright =
Copyright © 19/10/2006, GEDsismik
{{CC-BY-SA}}

Ruby On Rails

2006-10-23T13:36:58Z

Rapsys : /* Modèle MVC */

[[Category:Développer sous Linux]]
= Ruby On Rails =

<div class="leatitre">Ruby On Rails</div>
<div class="leapar">par [mailto:gedsismik_at_free_point_fr GEDsismik]</div>
<div class="leadesc">Monter un projet Ruby On Rails (RoR) pas à pas.</div>
----

== Avant propos ==

Ruby On Rails (RoR) est un framework web écrit en ruby. Ce document vous présente comment faire un petit projet Ruby On Rails.

On supposera installé et correctement configuré :
- un SGBD supporté par RoR (personnellement, j'utilise MySQL)
- Ruby
- Rails et ses dépendances

Il vous faudra aussi des notions de ruby.

Dans ce document, je mettrais en place un gestionnaire de livre rudimentaire. Le but est de présenter les bases d'un projet Rails. Il est évident que ces informations sont loin d'être exhaustives vue que RoR peut remplir tout un livre de 500 pages.

== Mise en place de l'environnement ==

<code>$ rails monsite
create
create app/controllers
create app/helpers
create app/models
create app/views/layouts
[...]
</code>
Le répertoire monsite vient d'être créé ainsi que la structure initiale du projet. Entrez maintenant dans ce répertoire.
Normalement, il devrait contenir les fichiers et répertoires suivants :
<code>app
components
config
db
doc
lib
log
public
Rakefile
README
script
test
tmp
vendor
</code>

== Configuration ==

Si vous n'avez pas de base de donnée, créez-en :
<code>mysql> create database monsite_development;
mysql> create database monsite_test;
mysql> create database monsite_production;</code>
<div class="aparte">
Note : J'en ai crée 3 pour pouvoir utiliser 3 environnements différents. Une seule peut suffir, ca dépend de ce que vous voulez faire.
</div>

Nous allons ensuite éditer ./config/database.yml. Vous avez 3 environnements de pré-configurées de la sorte :
<code>production:
adapter: mysql
database: monsite_production
username: root
password:
host: localhost</code>
Avec :
* adapter le type de base de donnée (mysql, postgres, sqlite...)
* database le nom de la base de donnée
* username le nom de l'utilisateur de la base de donnée
* password le mot de passe à la base de donnée
* host le serveur de base de donnée
Dans le cas de sqlite, on a :
* adapter le type de base de donnée (sqlite)
* dbfile nom du fichier de base de donnée

Editez-le en fonction des paramètres de votre base de donnée. Exemple :
<code>production:
adapter: mysql
database: monsite_production
username: gedsismik
password: mypassword
host: localhost
socket: /var/run/mysql/mysql.sock</code>
<div class="aparte">
Note : Sous Slackware, j'ai du ajouter la ligne <code>socket: /var/run/mysql/mysql.sock</code> sinon il ne trouve pas la socket MySQL.
</div>

== Modèle MVC ==

Ruby On Rails utilise le motif de conception MVC (modèle-vue-contrôleur). Je m'explique : dans un projet RoR, vous séparez :
- les modèles (répertoire <code>./app/models</code>) : ce qui concerne les données. Dans notre cas, c'est donc principalement les tables des bases de données.
- les vues (répertoire <code>./app/views</code>) : ce qui concerne l'interface.
Dans notre cas, il s'agit de la présentation des pages (en HTML et Ruby embarqué, nous verrons ça plus tard).
- les contrôleurs (répertoire <code>./app/controllers</code>) : concerne la gestion des évenements.
Dans notre cas, ce sont les classes qui feront le lien entre les tables (models) et le html (views).
Ce qui revient aux appels aux tables via les modèles et la création de variables dont le contenu sera affiché dans les vues.

Pour palier à certaines fonctions qui ne peuvent pas suivre le modèle MVC à la lettre, Rails dispose d'une partie appelée helpers (<code>./app/helpers</code>) qui contient des classes accessibles aux vues et qui contient du code ayant accès aux modèles sans passer par les contrôleurs.

== Création des modèles ==

=== Génération des fichiers relatifs à la table ===

On va utilisez le script <code>./script/generate</code> pour générer la première table.

<code>$ ./script/generate model livre
exists app/models/
exists test/unit/
exists test/fixtures/
create app/models/livre.rb
create test/unit/livre_test.rb
create test/fixtures/livres.yml
create db/migrate
create db/migrate/001_create_livres.rb
$ ./script/generate model auteur
exists app/models/
exists test/unit/
exists test/fixtures/
create app/models/auteur.rb
create test/unit/auteur_test.rb
create test/fixtures/auteurs.yml
exists db/migrate
create db/migrate/002_create_auteurs.rb
</code>

=== Fichiers de migration ===

Les fichiers de migration/création de table se trouvent dans <code>./db/migrate</code>. Il va falloir les éditez pour ajoutez les champs que vous voulez.
<div class="aparte">
Note : ne faites pas de champ "id", ils sont automatiquement créés et gérer par Rails.
</div>

==== create_livres.rb ====
Fichier ./db/migrate/001_create_livres.rb
<code>class CreateLivres < ActiveRecord::Migration
def self.up
create_table :livres do |t|
t.column :titre, :string, :null => false
t.column :auteur_id, :integer, :null => false
t.column :quantite, :integer, :default => "1"
end
end

def self.down
drop_table :livres
end
end
</code>

==== create_auteurs.rb ====
Fichier ./db/migrate/002_create_auteurs.rb
<code>class CreateAuteurs < ActiveRecord::Migration
def self.up
create_table :auteurs do |t|
t.column :nom, :string
t.column :prenom, :string
end
end

def self.down
drop_table :auteurs
end
end</code>

<div class="aparte">Notez que vous pouvez réunir les deux fichiers en un seul :
./db/migrate/001_initial.rb
<code>class Initial < ActiveRecord::Migration
def self.up
create_table :livres do |t|
t.column :titre, :string, :null => false
t.column :auteur_id, :integer, :null => false
t.column :quantite, :integer, :default => "1"
end
create_table :auteurs do |t|
t.column :nom, :string, :null => false
t.column :prenom, :string
end
end

def self.down
drop_table :livres
drop_table :auteurs
end
end</code></div>

=== Génération des tables ===

Toujours dans le repertoire monsite, exécutez <code>rake migrate</code>.
<code>$ rake migrate
(in /home/gedsismik/monsite)
== CreateLivres: migrating ====================================================
-- create_table(:livres)
-> 0.0441s
== CreateLivres: migrated (0.0442s) ===========================================

== CreateAuteurs: migrating ===================================================
-- create_table(:auteurs)
-> 0.0457s
== CreateAuteurs: migrated (0.0458s) ==========================================
</code>

Si vous regardez dans votre base de donnée, vous trouverez donc 3 tables :
- auteurs
- livres
- schema_info

Cette dernière table contient en fait la version de la base de donnée. Les versions sont incrémentées lors du <code>./script/generate model <nom table></code> et sont contenus dans le nom du fichier <code>./db/migrate/001_initial.rb</code> est donc la version 1 de la base.

=== Edition des modèles ===
Intéressons-nous aux fichiers <code>./app/models/auteur.rb</code> et <code>./app/models/livre.rb</code>. Ces classes héritant de ActiveRecord::Base, presque tout est déjà fait. Nous allons juste ajouter la relation : "un auteur écrit plusieurs livres". Cette relation se traduit dans <code>./app/models/auteur.rb</code> par :
<code>class Auteur < ActiveRecord::Base
has_many :livre
end</code>

En contrepartie, on peut avoir besoin d'accéder à l'auteur d'un livre. Modifions donc <code>./app/models/livre.rb</code> en :
<code>class Livre < ActiveRecord::Base
belongs_to :auteur
end</code>

Et voilà ! Ca devrait suffir pour les modèles. En effet, Rails fera tout seul le lien entre les deux tables grâce à auteur_id.

== Création d'un contrôleur ==
Tout d'abord, utilisons, comme pour les modèles, le script <code>./script/generate</code> :
<code>$ ./script/generate controller bibliotheque
exists app/controllers/
exists app/helpers/
create app/views/bibliotheque
exists test/functional/
create app/controllers/bibliotheque_controller.rb
create test/functional/bibliotheque_controller_test.rb
create app/helpers/bibliotheque_helper.rb</code>

Editons maintenant <code>./app/controllers/bibliotheque_controller.rb</code>. Par défaut, vous avez :
<code>class BibliothequeController < ApplicationController
end</code>

Nous allons créer des actions. Un contrôleur peut comporter plusieurs actions.
<code>class BibliothequeController < ApplicationController
def index
listeAuteur
render_action 'listeAuteur'
end

def listeAuteur
@auteurs = Auteur.find(:all, :order => "nom,prenom")
end

def ajoutAuteur
param = @params['auteur']
auteur = Auteur.new(param)
if auteur.save
flash[:ok] = "L'auteur a été ajouté"
else
flash[:error] = "Problème à l'ajout de l'auteur"
end
# ajoutAuteur n'a pas besoin de vue. Une fois l'auteur ajouté
# on réaffiche la liste
redirect_to :action => 'listeAuteur'
end
end
</code>

L'action index est l'action par défaut. L'action listeAuteur donnera la liste des auteurs. On constate ici qu'on peut largement se passer d'écrire du SQL dans Rails. @auteurs est une variable qui contiendra tous les auteurs.

== Mise en place des vues ==

=== Le layout ===

Tout d'abord, créons une layout. Le layout est la structure commune à toutes les pages. Ils se trouvent dans <code>./app/views/layouts/</code>.
<code>$ touch app/views/layouts/bibliotheque.rhtml
</code>
Editons maintenant ce fichier :
<code><!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//FR" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>Bibliothèque - <%= controller.action_name %></title>
<meta name="author" content="GEDsismik">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-15">
</head>
<body>
<h1>Bibliothèque</h1>
<br/>
<div class="all">
<p style="color: green"><%= flash[:notice] %></p>
<%= @content_for_layout %>
</div>
</body>
</html></code>
C'est du Ruby embarqué dans du HTML. Pour ceux qui connaissent, c'est un peu le même principe que le PHP. On écrit du HTML et aux endroits où on veut mettre du ruby, on place le code dans une balise <code><% #code %></code>. Si on veut afficher la sortie du code, on place le code dans une balise <code><%= #code %></code>.

<code><%= @content_for_layout %></code> affichera la partie propre à l'action.

=== La vue ===

Les vues sont dans un répertoire de la forme <code>./app/views/<contrôleur>/</code> et porte le nom <code><action>.rhtml</code>

Créons donc le fichier <code>./app/views/bibliotheque/listeAuteur.rhtml</code> :

<code><h2>Liste des auteurs</h2>
<ul>
<%
@auteurs.each do |auteur|
%><li><%= auteur.nom + " " + auteur.prenom %></li><%
end
%>
</ul>

<h2>Ajout d'un auteur</h2>
<%= start_form_tag :action => "ajoutAuteur" %>
<p><label>Prénom : <%= text_field 'auteur', 'prenom' %></label></p>
<p><label>Nom : <%= text_field 'auteur', 'nom' %></label></p>
<%= submit_tag("Ajouter") %>
<%= end_form_tag %></code>

== WebRick ==

Vous disposez d'un serveur de test appellé WebRick. Pour le lancez, tapez <code>./script/server </code>
<code>$ ./script/server
=> Booting WEBrick...
=> Rails application started on http://0.0.0.0:3000
=> Ctrl-C to shutdown server; call with --help for options
[2006-10-19 18:32:57] INFO WEBrick 1.3.1
[2006-10-19 18:32:57] INFO ruby 1.8.5 (2006-08-25) [i686-linux]
[2006-10-19 18:32:57] INFO WEBrick::HTTPServer#start: pid=26166 port=3000</code>

Par défaut, ce serveur écoute le port 3000. Ouvrez donc un navigateur et tapez : <code>http://localhost:3000</code>.
Normalement, vous devriez obtenir une page de test. Les url de Rails par défaut se décompose de la sorte <code>http://localhost:3000/<contrôleur>/<action>[/<parametres>]</code>. Tapez donc dans votre navigateur <code>http://localhost:3000/bibliotheque/listeAuteur</code>.

== Pour aller un peu plus loin ==
Ajoutons le support des livres dans <code>./app/controllers/bibliotheque_controller.rb</code> :
<code>class BibliothequeController < ApplicationController
def index
listeLivre
render_action 'listeLivre'
end

def listeAuteur
@auteurs = Auteur.find(:all, :order => "nom,prenom")
end

def listeLivre
@livres = Livre.find(:all, :order => "titre")
@auteurs = Auteur.find(:all, :order => "nom,prenom").map{ |u| [ u.nom + " (" + u.prenom + ")", u.id] }
end

def ajoutAuteur
param = @params['auteur']
auteur = Auteur.new(param)
if auteur.save
flash[:ok] = "L'auteur a été ajouté"
else
flash[:error] = "Problème à l'ajout de l'auteur"
end
redirect_to :action => 'listeAuteur'
end

def ajoutLivre
param = @params['livre']
livre = Livre.new(param)
if livre.save
flash[:ok] = "Le livre a été ajouté"
else
flash[:error] = "Problème à l'ajout du livre"
end
redirect_to :action => 'listeLivre'
end
end
</code>

Créons du même coup la vue correspondante à listeLivre <code>./app/views/bibliotheque/listeLivre.rhtml</code> :
<code><% if @livres.blank? %>
<h2>Liste des ouvrages</h2>
<ul>
<%
@livres.each do |livre|
%><li><%= livre.titre %> - <%= livre.auteur.prenom + " " + livre.auteur.nom %></li><%
end
%>
</ul>
<% else %>
<i>La bibliothèque ne contient aucun livre.</i>
<% end %>

<% unless @auteurs.blank? %>
<h2>Ajout d'un livre</h2>
<%= start_form_tag :action => "ajoutLivre" %>
<p><label>Titre : <%= text_field 'livre', 'titre' %></label></p>
<p><label>Nombre d'exemplaire : <%= text_field 'livre', 'quantite' %></label></p>
<p><label>Auteur : <%= select('livre', 'auteur_id', @auteurs) %></label></p>
<%= submit_tag("Ajouter") %>
<%= end_form_tag %>
<% end %></code>

== Les environnements ==
Pour utiliser les différents environnements, vous devez manipuler la variable <code>RAILS_ENV</code>. Par défaut, vous êtes dans le premier environnement du fichier <code>./config/database.yml</code> (à savoir en général development). Pour un <code>rake migrate</code> en production par exemple :
<code>RAILS_ENV=production rake migrate
</code>
notez que l'environnement <code>test</code> efface les tables à chaque <code>rake</code> et que l'environnement <code>production</code> n'affiche aucune information en cas d'exception (vous devez alors vous reportez aux fichiers de log <code>./log/<environnement>.log</code>).

= Copyright =
Copyright © 19/10/2006, GEDsismik
{{CC-BY-SA}}

Trucs:Gpg, kmail et attachement de signature

2006-05-21T12:24:48Z

<div class="leapar">fred<fred@lea-linux.org></div>

On prétend souvent que kmail n'est pas compatible avec OpenPGP ou avec les attachements PGP/MIME. C'est vrai que nativement c'est le cas, mais un plugin pour kmail a été développé et il fonctionne très bien. Voilà comment procéder pour l'installer et le configurer correctement.

=== Les prérequis ===

Il vous faut télécharger les logiciels suivants :

# [ftp://ftp.gnupg.org/gcrypt/alpha/libgcrypt/ libgcrypt (>= 1.1.10)]
# [ftp://ftp.gnupg.org/gcrypt/alpha/aegypten/ libksba (>= 0.4.7)]
# [ftp://ftp.gnupg.org/gcrypt/alpha/aegypten/ newpg (>= 0.9.4)]
# [ftp://ftp.gnupg.org/gcrypt/gpgme/ gpgme 0.3.x (>= 0.3.15; < 0.4.0)]
# [ftp://ftp.gnupg.org/gcrypt/alpha/cryptplug/ cryptplug 0.3.x (>= 0.3.15)]
# [ftp://ftp.gnupg.org/gcrypt/pinentry/ pinentry (>= 0.6.8)]

<div class="note">Note : beaucoup de ces librairies et utilisaires sont sûrement disponibles en tant que paquets binaires pour votre distribution : préférez leur utilisation à celles des sources proposés ici.</div>

=== Installation ===

Je ne détaillerais pas ici l'installation de tous ces utilitaires. Aprés décompactage, un simple :

<div class="code"> cd libgcrypt && ./configure && make && make check && su -c "make install" <br />cd libksba && ./configure && make && make check && su -c "make install" <br />cd newpg && ./configure && make && make check && su -c "make install" <br />cd gpgme && ./configure --without-gpgsm && make && make check && su -c "make install" <br />cd cryptplug && ./configure && make && su -c "make install" <br />cd pinentry && ./configure --disable-pinentry-gtk --disable-pinentry-curses --disable-fallback-curses && make && su -c "make install" </div>

devrait faire l'affaire.

<div class="note">Note: les <code>--disable-...</code> dans l'installation de pinentry sont facultatifs et peuvent être supprimés (ils ne servent qu'a compiler pinentry pour QT).</div>

=== Configuration de GnuPG ===

Il faut maintenant configurer GnuPG pour qu'il puisse utiliser pinentry pour taper le mot de passe. Il suffit pour cela d'éditer le fichier <code>~/.gnupg/gpg.conf</code> (pour chaque utilisateur) et d'y ajouter la ligne :

<div class="code"> use-agent </div>

Puis de créer un fichier <code>~/.gnupg/gpg-agent.conf</code> contenant :

<div class="code"> pinentry-program /usr/local/bin/pinentry-qt <br />no-grab <br />default-cache-ttl 1800 </div>

Evidemment le chemin conduisant à <code>pinentry-qt</code> doit être adapté si vous avez installé pinentry autrement que de la manière indiquée.

Ensuite, il faut faire en sorte de démarrer l'agent GnuPG (ici, pinentry-qt) automatiquement, il y a plusieurs solutions.

# Vous utilisez <code>~/.xsession</code> pour démarrer votre interface graphique préférée, ajoutez en debut de ce fichier : <div class="code">eval "$(gpg-agent --daemon)" </div>
# Vous utilisez xdm/kdm, ajoutez au fichier <code>/etc/X11/xdm/Xsession</code> : <div class="code"> # gestion de l'agent gpg <br />if grep use-agent ~/.gnupg/gpg.conf &> /dev/null ; then <br /> eval "$(gpg-agent --daemon)" <br />fi </div>

Ensuite, rédemarrez votre interface graphique (c'est le plus simple, bien que ce ne soit pas complétement nécessaire...)

=== Configuration de kmail ===

Lancez kmail, puis cliquez sur "Configuration" -> "Sécurité", sélectionnez l'onglet "OpenPGP", vérifiez que vous avez bien sélectionné "GNU Privacy Guard (GnuPG)" comme outil de cryptage (mauvaise traduction, il faudrait utiliser "chiffrage").

Puis sélectionnez l'onglet "Modules externes de cryptographie". Cliquez sur "Nouveau". Pour le "Nom" tapez ce que vous voulez, par exemple "PGP/Mime". Pour l'"Emplacement" tapez l'emplacement de "gpgme-openpgp.so", par défaut : <code>/usr/local/lib/cryptplug/gpgme-openpgp.so</code>. Comme sur cette [http://kmail.kde.org/art/kmail-pgpmime-plugin-config.png image].

Enfin, validez le tout.

=== Utilisation ===

Lorsque vous voudrez chiffrer, signer ou déchiffrer un message vous verrez maintenant que kmail vous propose maintenant deux possibilités :

# "OpenPGP dans le corps du message (incorporé)", c'est ce qu'il faisait sans l'installation du plugin ;
# "PGP/Mime (module externe)", c'est le plugin qu'on vient d'installer. L'utilisation du plugin, en plus de permettre le déchiffrage des messages PGP/Mime, permet aussi de chiffer et signer chaque pièce jointe individuellement. Mais attention : certains de vos correspondants utilisant un kmail "mal configuré" pourraient ne pas pouvoir les déchiffrer : indiquez leur ce truc pour qu'ils puissent le faire. ;-)

<div class="note">Les mails avec pièce jointe chiffrée et signature en pièce jointe sont conformes à la norme, et interopérables avec les logiciels la respectant, comme Mozilla avec le plugin Enigmail, et même Outlook© avec les bons plugins.</div>

Largement inspiré de [http://kmail.kde.org/kmail-pgpmime-howto.html kmail-pgpmime-howto.html].
[[Catégorie:Trucs_courrier]]

Trucs:Gpg, kmail et attachement de signature

2006-05-21T12:22:53Z

Rapsys : Correction de problème d'encoding (affichage d'utf-8 en iso8859-15), donc éèà et compagnie sont affiché n'importe comment...

<div class="leapar">fred<fred@lea-linux.org></div>

On prétend souvent que kmail n'est pas compatible avec OpenPGP ou avec les attachements PGP/MIME. C'est vrai que nativement c'est le cas, mais un plugin pour kmail a été développé et il fonctionne très bien. Voilà comment procéder pour l'installer et le configurer correctement.

=== Les prérequis ===

Il vous faut télécharger les logiciels suivants :

# [ftp://ftp.gnupg.org/gcrypt/alpha/libgcrypt/ libgcrypt (>= 1.1.10)]
# [ftp://ftp.gnupg.org/gcrypt/alpha/aegypten/ libksba (>= 0.4.7)]
# [ftp://ftp.gnupg.org/gcrypt/alpha/aegypten/ newpg (>= 0.9.4)]
# [ftp://ftp.gnupg.org/gcrypt/gpgme/ gpgme 0.3.x (>= 0.3.15; < 0.4.0)]
# [ftp://ftp.gnupg.org/gcrypt/alpha/cryptplug/ cryptplug 0.3.x (>= 0.3.15)]
# [ftp://ftp.gnupg.org/gcrypt/pinentry/ pinentry (>= 0.6.8)]

<div class="note">Note : beaucoup de ces librairies et utilisaires sont sûrement disponibles en tant que paquets binaires pour votre distribution : préférez leur utilisation à celles des sources proposés ici.</div>

=== Installation ===

Je ne détaillerais pas ici l'installation de tous ces utilitaires. Aprés décompactage, un simple :

<div class="code"> cd libgcrypt && ./configure && make && make check && su -c "make install" <br />cd libksba && ./configure && make && make check && su -c "make install" <br />cd newpg && ./configure && make && make check && su -c "make install" <br />cd gpgme && ./configure --without-gpgsm && make && make check && su -c "make install" <br />cd cryptplug && ./configure && make && su -c "make install" <br />cd pinentry && ./configure --disable-pinentry-gtk --disable-pinentry-curses --disable-fallback-curses && make && su -c "make install" </div>

devrait faire l'affaire.

<div class="note">Note: les <code>--disable-...</code> dans l'installation de pinentry sont facultatifs et peuvent être supprimés (ils ne servent qu'a compiler pinentry pour QT).</div>

=== Configuration de GnuPG ===

Il faut maintenant configurer GnuPG pour qu'il puisse utiliser pinentry pour taper le mot de passe. Il suffit pour cela d'éditer le fichier <code>~/.gnupg/gpg.conf</code> (pour chaque utilisateur) et d'y ajouter la ligne :

<div class="code"> use-agent </div>

Puis de créer un fichier <code>~/.gnupg/gpg-agent.conf</code> contenant :

<div class="code"> pinentry-program /usr/local/bin/pinentry-qt <br />no-grab <br />default-cache-ttl 1800 </div>

Evidemment le chemin conduisant à <code>pinentry-qt</code> doit être adapté si vous avez installé pinentry autrement que de la manière indiquée.

Ensuite, il faut faire en sorte de démarrer l'agent GnuPG (ici, pinentry-qt) automatiquement, il y a plusieurs solutions.

# Vous utilisez <code>~/.xsession</code> pour démarrer votre interface graphique préférée, ajoutez en debut de ce fichier : <div class="code">eval "$(gpg-agent --daemon)" </div>
# Vous utilisez xdm/kdm, ajoutez au fichier <code>/etc/X11/xdm/Xsession</code> : <div class="code"> # gestion de l'agent gpg <br />if grep use-agent ~/.gnupg/gpg.conf &> /dev/null ; then <br /> eval "$(gpg-agent --daemon)" <br />fi </div>

Ensuite, rédemarrez votre interface graphique (c'est le plus simple, bien que ce ne soit pas complétement nécessaire...)

=== Configuration de kmail ===

Lancez kmail, puis cliquez sur "Configuration" -> "Sécurité", sélectionnez l'onglet "OpenPGP", vérifiez que vous avez bien sélectionné "GNU Privacy Guard (GnuPG)" comme outil de cryptage (mauvaise traduction, il faudrait utiliser "chiffrage").

Puis sélectionnez l'onglet "Modules externes de cryptographie". Cliquez sur "Nouveau". Pour le "Nom" tapez ce que vous voulez, par exemple "PGP/Mime". Pour l'"Emplacement" tapez l'emplacement de "gpgme-openpgp.so", par défaut : <code>/usr/local/lib/cryptplug/gpgme-openpgp.so</code>. Comme sur cette [http://kmail.kde.org/art/kmail-pgpmime-plugin-config.png image].

Enfin, validez le tout.

=== Utilisation ===

Lorsque vous voudrez chiffrer, signer ou déchiffrer un message vous verrez maintenant que kmail vous propose maintenant deux possibilités :

# "OpenPGP dans le corps du message (incorporé)", c'est ce qu'il faisait sans l'installation du plugin ;
# "PGP/Mime (module externe)", c'est le plugin qu'on vient d'installer. L'utilisation du plugin, en plus de permettre le déchiffrage des messages PGP/Mime, permet aussi de chiffer et signer chaque pièce jointe individuellement. Mais attention : certains de vos correspondants utilisant un kmail "mal configuré" pourraient ne pas pouvoir les déchiffrer : indiquez leur ce truc pour qu'ils puissent le faire. ;-)

<div class="note">Les mails avec pièce jointe chiffrée et signature en pièce jointe sont conformes à la norme, et interopérables avec les logiciels la respectant, comme Mozilla avec le plugin Enigmail, et même Outlook avec les bons plugins.</div>

Largement inspiré de [http://kmail.kde.org/kmail-pgpmime-howto.html kmail-pgpmime-howto.html].
[[Catégorie:Trucs_courrier]]