Starter App - Partie 2 - Des Gems pour le développement !

Vers la partie précédenteVers la partie suivante
Actualisé le 16 Décembre 2016 pour une Starter App fonctionnant en Ruby 2.2 et Rails 4.2

Dans cette deuxième partie, nous allons découvrir et intégrer trois gems facilitant certaines tâches de la phase de développement. Nous allons évidemment continuer avec notre StarterApp dans l'état final de la précédente partie et à chaque fois je vous expliquerai comment mettre en place la gem, comment l'utiliser, son rôle, etc.

• - magic_encoding
• - quiet_assets
• - annotate

Magic Encoding

$ gem install magic_encoding

def home

    flash.now[:notice] = "Problème d'encodage"

    respond_to do |format|

      format.html { render :home }

    end

end

SyntaxError [...]/client_pages_controller.rb:4: invalid multibyte char (US-ASCII)

$ magic_encoding

"Magic comments set for 22 source files"

# -*- encoding : utf-8 -*-

Notez qu'avec magic_encoding vous pouvez préciser n'importe quel encodage en l'ajoutant en tant qu'option à la commande. A chaque fois que vous exécuterez la commande, cela remplacera les commentaires "magiques" déjà présents par le nouvel encodage spécifié.

Attention ! Le commentaire magique doit rester la première ligne de votre fichier.rb autrement il ne sera tout bonnement pas pris en compte !

Si vous souhaitez en savoir plus sur tous les problèmes d'encodage dans Ruby On Rails, je vous invite à lire notre autre article sur les encodages en ROR.

# Dans le fichier config/application.rb, ajoutez-y la ligne (s'il elle n'y est pas déjà, ce qui devrait être le cas pour toute application Ruby > version 1.9) : 

config.encoding = "utf-8"

<!-- Dans le Head de votre application, ajoutez-y la balise méta suivante : -->

<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

# Dans le fichier config/environment.rb modifiez-le comme ceci (et pas différemment) 

# -*- encoding : utf-8 -*-

# Load the rails application

require File.expand_path('../application', __FILE__)



# Set default encodings for datas that come in and out the application

Encoding.default_external = Encoding::UTF_8

Encoding.default_internal = Encoding::UTF_8



# Initialize the rails application

StarterApp::Application.initialize!

Quiet Assets

Started GET "/assets/application.css?body=1" for 127.0.0.1 at 2013-01-18 14:53:50 +0100

Served asset /application.css - 200 OK (2ms)

group :development do

  gem "quiet_assets", ">= 1.0.1" # https://github.com/evrone/quiet_assets

end

Started GET "/" for 127.0.0.1 at 2013-01-18 15:10:36 +0100

Connecting to database specified by database.yml

Processing by ClientPagesController#home as HTML

  Rendered client_pages/home.html.erb within layouts/application (30.4ms)

Completed 200 OK in 56ms (Views: 55.5ms | ActiveRecord: 0.0ms)

config.quiet_assets = false

Création de Models avant de continuer

$ rails generate model ClientPage title:string webtitle:string webdescription:text name:string published:boolean home:boolean 

• - Un titre title, qui sera placé dans une balise <h1> en haut de la page
• - Un titre webtitle, qui sera placé dans la balise <title> de la page Web
• - Une description webdescription qui sera placée dans la balise <meta description> de la page
• - Un nom name qui nous servira de référence pour la page
• - Et deux booléens published et home pour indiquer si la page sera publiée publiquement et pour la définir en tant que page d'accueil du site ou non

class CreateClientPages < ActiveRecord::Migration

  def change

    create_table :client_pages do |t|

      # nous ajoutons quelques options par défaut 

      t.string :title,        :null => false

      t.string :webtitle,     :null => false

      t.text :webdescription

      t.string :name,         :null => false

      t.boolean :published,   :default => false

      t.boolean :home,        :default => false



      t.timestamps

    end

  end

end

$ rails generate model ClientMenuButton priority:integer name:string page_id:integer

class CreateClientMenuButtons < ActiveRecord::Migration

  def change

    create_table :client_menu_buttons do |t|

      t.integer :priority,  :null => false, :default => 1

      t.string :name,       :null => false

      t.integer :page_id



      t.timestamps

    end

  end

end

$ rails generate model ClientPageContent title:string priority:integer body:text page_id:integer css_class:string

• - Un titre, qui sera placé dans une balise <h2>
• - Une priorité, pour ordonner ces contenus plus facilement
• - Un corps, qui contiendra le contenu proprement dit
• - Une (ou plusieurs) class CSS, pour personnaliser leur apparence, au besoin

class CreateClientPageContents < ActiveRecord::Migration

  def change

    create_table :client_page_contents do |t|

      t.string :title,    :null => false

      t.integer :priority, :null => false, :default => 1

      t.text :body,         :null => false

      t.integer :page_id,   :null => false

      t.string :css_class



      t.timestamps

    end

  end

end

Gem Annotate

group :development do

  gem "quiet_assets", ">= 1.0.1" # https://github.com/evrone/quiet_assets

  gem "annotate", :git => 'git://github.com/ctran/annotate_models.git' # https://github.com/ctran/annotate_models

end

$ bundle install

$ rails g annotate:install

Annotate.set_defaults({

      'position_in_routes'   => "after",

      'position_in_class'    => "after",

      'position_in_test'     => "after",

      'position_in_fixture'  => "after",

      'position_in_factory'  => "after",

# [...]

$ rake db:migrate

A la date où j'écris cet article, l'annotation automatique n'est pas encore fonctionnelle, mais ce n'est pas grave, elle viendra.

$ annotate

Annotated (3): ClientPageContent, ClientPage, ClientMenuButton

# == Schema Information

#

# Table name: client_pages

#

#  id             :integer          not null, primary key

#  title          :string(255)      not null

#  webtitle       :string(255)      not null

#  webdescription :text

#  name           :string(255)      not null

#  published      :boolean          default(FALSE)

#  home           :boolean          default(FALSE)

#  created_at     :datetime         not null

#  updated_at     :datetime         not null

#

Notez que la modification des positions dans le fichier de configuration .rake était importante pour notre cas. En effet, si nous laissons before et qu'un commentaire magique d'encodage généré par magic_encoding est déjà présent, annotate va ajouter les annotations avant ce commentaire. Dès lors, il ne sera plus pris en compte. D'ailleurs, n'oubliez pas de lancer un petit magic_encoding pour vos fichiers model.rb fraîchement créés.

Il y a pas mal d'autres options pour cette gem, je vous laisse les découvrir sur le dépôt de GitHub.

Index -- Article précédent: Starter App - Partie 1 - Configuration initiale du projet -- Article suivant: Bonne année 2017

• 
• ruby on rails
• starter app
• tutoriel