Starter App - Partie 1 - Configuration initiale du projet

Vers la partie suivante

Actualisé le 25 Novembre 2016 pour une Starter App fonctionnant en Ruby 2.2 et Rails 4.2

Introduction : pourquoi "Starter App" ?

Au fil de nos projets, nous nous sommes aperçus que nous réutilisions (évidemment) un certain nombre de gems. Ces gems forment une sorte de noyau cohérent pouvant être considéré comme le cœur de toute bonne application Rails.

Noyau cohérent car la majorité de ces gems s'agencent les unes avec les autres et très souvent, elles s'intègrent parfaitement ensemble.
Cœur de l'application Rails car ces gems, sans être primordiales pour faire tourner une application Rails, vont ajouter des fonctionnalités incontournables et utilisées partout sur le Web de nos jours.

Je vous propose donc avec cette liste d'articles "Starter App" de vous créer une base de projet "vierge", avec les configurations dont vous aurez besoin et les gems les plus utiles, nécessaires dans tout (ou presque) projet. A la fin de cette suite d'articles, vous disposerez d'une application :
- pré-configurée pour le déploiement (sur Heroku ou serveur dédié),
- traduisible dans différentes langues,
- capable d'envoyer des mails,
- possédant une partie administrative complète,
- ainsi qu'une interface client compatible mobiles,
- capable de bien d'autres choses encore...

• Foundation: Peut-être connaissez-vous plutôt "Twitter Bootstrap" ? Ce sont deux frameworks pour le front end de votre application. Traduction : ces gems vous apportent tout un tas de fonctionnalités préconçues et une apparence toute faite (et plutôt pas mal) pour votre application. Après avoir mis en place un tel framework, vous serez surpris de voir la rapidité avec laquelle vous produirez une magnifique application compatible PC et Mobiles !
• Devise : cette gem est devenue incontournable dans toute application avec une partie privée. Elle vous met en place en deux temps trois mouvements un système d'authentification robuste et facilement personnalisable. De plus, de nombreux plugins (d'autres gems) viennent se greffer dessus pour ajouter de nouvelles fonctionnalités. Comme la possibilité pour vos utilisateurs de s'authentifier grâce à leur réseau social préféré ou leur compte Google.
• Simple Form : cette gem quoi que moins importante va vous faciliter la vie pour créer vos formulaires. Nous la verrons avec un d'autant plus grand intérêt que ceux qui l'ont conçues sont les mêmes que ceux qui ont conçu Devise. De fait, ces deux gems fonctionnent fort bien ensemble.
• Cancan / Rolify : on ne peut parler de système d'authentification sans parler de rôles. Les rôles permettent de restreindre l'accès à certaines parties d'un site à certains utilisateurs spéciaux. Ce pourrait être, par exemple, la restriction de la partie "modératrice" d'un forum aux utilisateurs dont le rôle est d'être modérateur. Ces deux gems (CanCan / Rolify) fonctionnent de concert pour vous faciliter la mise en place de ce type de restriction. Il n'est pas surprenant non plus qu'une documentation fournie explique comment les mettre en place ensemble avec Devise.

Création du projet

$ rails new starter_app

Notez que vous pouvez aussi utiliser SQLite3, mais ça ne serait pas vraiment une "Starter App" si je ne vous expliquais pas comment utiliser une autre SGBD.

gem 'sqlite3'

gem 'mysql2' # https://github.com/brianmario/mysql2 <- lien vers le projet associé sur GitHub 

$ bundle install

default: &default

  # Remplacez selon le sgbd choisi

  adapter: mysql2

  # Encodage de votre base de données, en général utf8

  encoding: utf8 

  # Règles de tri à utiliser pour votre base de données, 

  # utf8_general_ci est la mieux adaptée pour le français

  collation: utf8_general_ci

  # Quelques options de connexion

  reconnect: false

  pool: 5

  timeout: 5000

  # Identifiants de connexion à votre base de données, 

  # généralement identique dans les environnements development/test

  username: identifiant

  password: mot_de_passe

  # Adresse IP de la machine où le serveur MySQL est hébergé, 

  # par exemple, sur un réseau privé local :

  # host: 192.168.1.2 

  # ou localhost si c'est sur votre machine de développement 

  # ou rien du tout, localhost sera utilisé par défaut



development:

  <<: *default

  # Nom de votre base de données

  database: starterapp_dev



# Même chose pour l'environnement de test, 

# comme cet environnement est souvent identique à celui de development, 

# on réutilise simplement les paramètres par défaut

test:

  <<: *default

  database: starterapp_test



# Pour l'environnement de production, vous devez adapter, 

# en fonction du serveur où votre application sera hébergée.

production:

  <<: *default

  # On écrase ici certaines configurations par défaut

  database: starterapp_prod

  pool: 20

  timeout: 10000

  username: identifiant_serveur_mysql

  password: mot_de_passe_serveur_mysql

  host: XXX.XXX.XXX.XXX 

  # L'adresse IP du serveur de base de données MySQL. 

  # Ou ne le mettez pas si MySQL est installé sur le même serveur que l'application

$ rake db:create

J'indiquais ici auparavant que nous utilisions la gem "thin" un serveur plus rapide que WebRick, celui qui est utilisé par défaut. Mais en rails 4, la gem "spring" est utilisée pour accélérer l'environnement de développement. J'estime donc que thin n'est plus nécessaire.

Faites attention, si vous voulez accéder à votre application Rails depuis un autre poste, il faut désormais exécuter la commande rails server avec une option : -b 0.0.0.0, ce qui rendra l'application RoR ouverte au reste de votre réseau.

Depuis plusieurs versions, Rails inclut turbolinks par défaut. Je vous laisse découvrir cette gem sensée accélérer grandement le chargement de vos pages Web. Cependant elle est souvent désactivée dans les projets car entre souvent en conflit avec d'autres framework front-end comme angular, react, etc. Vous êtes seuls aptes à décider de la désactiver ou non.

Création de la première page

Rails.application.routes.draw do

  # Dans le fichier config/routes.rb, ajoutez la ligne: 

  root "client_pages#home"

end

$ rails generate controller ClientPages home

<h1><%= t :home %></h1>

<p><%= flash[:notice] %></p>

class ClientPagesController < ApplicationController

  def home

    flash[:notice] = t(:greetings)

  end

end

en:

  home: "Home Page"

  greetings: "Welcome to StarterApp"

Mise en français d'une application Rails

fr:

  home: "Page d'accueil"

  greetings: "Bienvenue sur StarterApp"

config.i18n.load_path += Dir[Rails.root.join('config', 'locales', '**', '*.{rb,yml}').to_s] 

config.i18n.default_locale = :fr 

config.i18n.available_locales = [:fr, :en] 

config.i18n.fallbacks = [:fr, :en] 

# Toujours dans application.rb, décommenter #config.time_zone et mettre : 

config.time_zone = 'Paris'

before_filter :set_locale

 

 def set_locale

    I18n.locale = params[:locale] || I18n.default_locale

 end

gem "rails-i18n" # github.com/svenfuchs/rails-i18n

gem "i18n" # github.com/svenfuchs/i18n

gem 'inflections' # github.com/davidcelis/inflections

Configuration de base de l'application

# Dans config/initializers/autoload_paths.rb, ajoutez : 

# Comment the lib/shared line if you don't need it.

Rails.application.config.autoload_paths += %W(#{Rails.root}/lib/shared)

# lib/shared/table_functions/headers.rb

module TableFunctions::Headers

end

Rails.application.config.autoload_paths += Dir["#{Rails.root}/app/models/*"].find_all { |f| File.stat(f).directory? }

class User < ActiveRecord::Base

end

class UsersRelated::User < ActiveRecord::Base

end

class User::Customer < ActiveRecord::Base

end

# Dans config/initializers/assets.rb

Rails.application.config.assets.paths << "#{Rails.root}/app/assets/fonts"

@mixin face {

  @font-face {

    font: {

       family: "my_font";

       weight: 'normal';

       style: 'normal';

    }

    src: asset-url('my_font.eot', font);

    src: asset-url('my_font.eot?#iefix', font) format('embedded-opentype'),

         asset-url('my_font.woff', font) format('woff'),

         asset-url('my_font.ttf', font) format('truetype'),

         asset-url('my_font.svg', font) format('svg');

  }

}

Configuration des environnements

group :development do 

  ...

  gem "letter_opener" # github.com/ryanb/letter_opener

  ...

end

  # ActionMailer Config

  # en dev, l'host c'est localhost ou l'ip du poste où tourne votre application RoR

  config.action_mailer.default_url_options = { :host => 'localhost:3000' } 

  config.action_mailer.delivery_method = :letter_opener

  # change to true to allow email to be sent during development

  config.action_mailer.perform_deliveries = true

  # pour récupérer les erreurs lors d'un envoi de mail

  config.action_mailer.raise_delivery_errors = true 

  config.action_mailer.default :charset => "utf-8"

  # ActionMailer Config

  config.action_mailer.default_url_options = { :host => 'www.example.com' } 

  config.action_mailer.delivery_method = :smtp

  config.action_mailer.default :charset => "utf-8"

ActionMailer::Base.smtp_settings = {

    :address => "smtp.server.com", # par exemple pour Google : smtp.gmail.com

    :port => 587, # généralement utilisé par Google

    :user_name => "votre@adresse.com",

    :password => "votre_mot_de_passe",

    :authentication => :login, # méthode d'authentification, attention :plain enverra votre mot de passe en clair

    :enable_starttls_auto => true # Un peu de sécurité, ça fait jamais de mal, attention ce paramètre n'est pas toujours supporté par les serveurs SMTP

  }

ActionMailer::Base.smtp_settings = {

    :address => "smtp.server.com", 

    :port => 587,

    :user_name => ENV['SMTP_LOGIN'], # utiliser la constante ENV pour accéder aux variables d'environnement dans ruby

    :password => ENV["SMTP_PASSWORD'],

    :authentication => :login,

    :enable_starttls_auto => true

  }

config.action_dispatch.x_sendfile_header = "X-Sendfile" # apache

config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # nginx

config.assets.initialize_on_precompile = false # Heroku

Index -- Article précédent: URSSAF, RSI, CIPAV... -- Article suivant: Starter App - Partie 2 - Des Gems pour le développement !

• 
• ruby on rails
• starter app