Ruby on rails

De wiki jackbot
Aller à la navigation Aller à la recherche

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èle

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" C'est à ce moment là que la compréhension peut être délicate, car il existe certaines conventions à respecter

Conventions :

  • Le nom des tables dans la base de données sera toujours en minuscule et les mots séparé par des '_'. Exemple : "table", "nouvelle_table"
  • La convention de nommage sur les modèles est d'écrire ne nom de la table sans coupure, mais avec des majuscule pour chaque mot exemple : "Table", "NouvelleTable"

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) ==========================

On peut voir ici apparaître une autre convention, dans la base de données le modèle sera mis au pluriel.