Ruby on rails
Ruby on rails est un framework web libre écrit en Ruby. Il est basé sur l'architecture Modèle-Vue-Contrôleur (MVC). Il a pour but de respecter deux principes fondamentaux de la programmation
- DRY : Don't repeat yourself, ne vous répétez pas
- Convention Over Configuration, Convention plutôt que configuration
Les générateurs
Ruby on Rails vient avec bon nombres de scripts appelé des générateurs, qui on pour but d'aider au développement en créant les fondations d'une nouvelle application Rails.
$ rails new blog
Va ainsi crée toute une arborescence :
$ tree -d -L 2
.
└── blog
├── app
├── bin
├── config
├── db
├── lib
├── log
├── node_modules
├── public
├── storage
├── test
├── tmp
└── vendor
- app contient les models, views, helpers, mailers, channels, jobs, et assets pour l'application.
- bin contient les scripts permettant démarrer de l'application, ainsi que d'autres script pour définir, mettre à jour, déployer ou exécuter l'application.
- config contient la configuration des routes, bases de données et autres.
- db contient sans surprise la base de données, ainsi que les migrations.
- lib contient les modules pour l'application.
- log contient simplement les logs.
- public contient des fichiers statiques ainsi que des ressources compilées. Quand l'application est lancée, ce dossier est exposé tel quel.
- storage stockage actif de fichier.
- test contient les tests unitaires
- tmp contient des fichiers temporaires
- vendor contient des gems externe
On y trouve également les fichiers suivant :
- Gemfile qui permet de spécifier les dépendances
- package.json qui permet de spécifier les dépendances vis à vis de npm
Test du serveur
Le coté pratique de RoR est que juste après avoir utilisé un générateur il est possible de démarrer le serveur avec la commande :
$ rails server
Vous pourrez voir le résultat à l'adresse http://localhost:3000 Il s'agit simplement d'une page visant à prouver que le serveur est lancé et RoR est opérationnel.
Notions MVC
L'architecture MVC (Modèle Vue Contrôleur), permet de cloisonner correctement les différentes tâches.
Modèles
Les modèles sont des classes écrite en Ruby utilisées pour représenter les données et possiblement interagir avec la base de données au travers de : "Active Record"
Pour créer un modèle la commande est la suivante :
$ rails generate model Article title:string body:text
Running via Spring preloader in process 21517
invoke active_record
create db/migrate/20211105132513_create_articles.rb
create app/models/article.rb
invoke test_unit
create test/models/article_test.rb
create test/fixtures/articles.yml
Vous pouvez voir que cette commande à créé de nombreux fichiers
- 20211105132513_create_articles.rb qui contient les modifications à apporter à la base de données
- article.rb qui est le fichier contenant la classe en Ruby
- article_test.rb les tests unitaires pour la classe
- articles.yml (rôle inconnu ... pour l'instant)
La commande précédente se contente de créer les différents fichiers, mais sans modifier la base de données. Pour cela il faut exécuter la commande :
$ rails db:migrate == 20211105132513 CreateArticles: migrating =================================== -- create_table(:articles) -> 0.0020s == 20211105132513 CreateArticles: migrated (0.0020s) ==========================
C'est ici que vont commencer à rentrer en jeu les conventions, car comme vous pouvez le voir, la table se nomme : "articles", donc en minuscule et au pluriel.
Conventions :
- La convention de nommage sur les modèles est d'écrire tout attaché mais avec une majuscule pour la première lettre de chaque mot : "Table", "NouvelleTable"
- Le nom des tables dans la base de données sera toujours en minuscule, les mots séparé par des '_' et au pluriel. Exemple : "tables", "nouvelle_tables"
Exemple :
$ rails generate model ArticleTest title:string body:text
Running via Spring preloader in process 8929
invoke active_record
create db/migrate/20211106075639_create_article_tests.rb
create app/models/article_test.rb
invoke test_unit
create test/models/article_test_test.rb
create test/fixtures/article_tests.yml
$ rails db:migrate
== 20211106075639 CreateArticleTests: migrating ===============================
-- create_table(:article_tests)
-> 0.0022s
== 20211106075639 CreateArticleTests: migrated (0.0023s) ======================
On peut voir ici qu'en nommant un modèle "ArticleTest", donc en respectant la convention d'écrire tout attaché, mais avec une majuscule au début de chaque mot. Rails va être capable de créer la table : "article_tests" donc tout en minuscule, les mots séparés par '_' et au pluriel.
Jouer avec les modèles
Il est tout à fait possible de tester les modèles crées sans modifier l'application, pour ce faire il faut utiliser la console rails avec la commande :
$ rails console
Pour créer un nouvel article, mais sans pour autant le sauvegarder dans la base de données il faut utiliser la méthode "new" :
article = Article.new(title: "Bonjour Rails", body: "Je suis sur rails!")
À cette étape, seule la variable "article" contient des données, l'appel des méthodes "Article.find(1)", "Article.all", ne donnera rien car le modèle Article n'a pas encore interagit avec la base de données.
> article
=> #<Article id: nil, title: "Bonjour Rails", body: "Je suis sur rails!", created_at: nil, updated_at: nil>
> Article.find(1)
Article Load (0.2ms) SELECT "articles".* FROM "articles" WHERE "articles"."id" = ? LIMIT ? [["id", 1], ["LIMIT", 1]]
Traceback (most recent call last):
1: from (irb):8
ActiveRecord::RecordNotFound (Couldn't find Article with 'id'=1)
Pour modifier la base de données et inclure les informations de la variable "article" il faut utiliser la commande :
> article.save
TRANSACTION (0.1ms) begin transaction
Article Create (0.5ms) INSERT INTO "articles" ("title", "body", "created_at", "updated_at") VALUES (?, ?, ?, ?) [["title", "Bonjour Rails"], ["body", "Je suis sur rails!"], ["created_at", "2021-11-06 09:23:32.737847"], ["updated_at", "2021-11-06 09:23:32.737847"]]
TRANSACTION (4.5ms) commit transaction
=> true
On peut voir apparaître avec cette commande : " INSERT INTO "articles" ", la base de données a donc bien été modifiée. Maintenant la commande :
> Article.find(1) Article Load (0.3ms) SELECT "articles".* FROM "articles" WHERE "articles"."id" = ? LIMIT ? [["id", 1], ["LIMIT", 1]] => #<Article id: 1, title: "Bonjour Rails", body: "Je suis sur rails!", created_at: "2021-11-06 09:23:32.737847000 +0000", updated_at: "2021-11-06 09:23:32.737847000 +0000">
Renvoie bien des données.
Contrôleurs
Au vu de l'acronyme MVC, après les modèles on serait tenté de continuer avec les vues, cependant l'élément qui va permettre de chercher et d'afficher la vue est le contrôleur. Mais avant d'attaquer ce morceau, il va falloir faire un détour par les routes.
Les routes
Le rôles des routes est de reconnaître les URLs et de déclencher le contrôleur adéquat. Le fichier à modifier est : "config/routes.rb". La syntaxe à utiliser est la suivante :
Verbe_HTTP 'URL', to: 'contrôleur#méthode'
- Verbe_HTTP, est la méthode avec laquelle la requête sera effectuée : get, post, patch, delete et root.
- URL, est simplement l'adresse qui doit déclencher le contrôleur
- contrôleur, correspond au nom du fichier dans le dossier "app/controllers/
- méthode, les contrôleurs étant des classes écrite en Ruby, elles possèdent des méthodes
Les verbes HTTP
- get est simplement le passage par l'URL, historiquement limité à 255 caractères
- post est utilisé pour envoyer des données au serveur
- Patch est utilisé pour faire des mises à jours sur les données
- delete pour effacer des données
- root est un peu particulier car il s'agit simplement de demander la page par défaut
Les URLs
Pour ce paramètre il peut s'agir tout simplement de l'adresse (toujours par rapport à la racine du site), on peut donc avoir des URLs de ce type: 'aide', ou '/aide'. Cette route sera donc utilisée lorsque le client demande la page : "http://site.domain/aide"
Mais il peut également s'agir de couple : adresse + paramètre, qu'il faut alors noté de la manière suivante : 'aide/:id', on peut même avoir à faire à des syntaxe du type : 'aide/:id/edit'
Contrôleurs et méthodes