rails-application-templates

Usage

name	description	command
database_uuid	Active l'extension UUID sur la base de donnée (PostgreSQL) afin de remplacer les ID (bigint) en UUID	rails app:template LOCATION=https://raw.githubusercontent.com/Captive-Studio/rails-application-templates/main/templates/templates/database_uuid.rb
validation_telephone	Ajoute une validation sur le telephone	rails app:template LOCATION=https://raw.githubusercontent.com/Captive-Studio/rails-application-templates/main/templates/validation_telephone.rb
rswag	Configure rswag	rails app:template LOCATION=https://raw.githubusercontent.com/Captive-Studio/rails-application-templates/main/templates/rswag.rb
api	Configure l'api avec rswag	rails app:template LOCATION=https://raw.githubusercontent.com/Captive-Studio/rails-application-templates/main/templates/api.rb
sentry	Configure sentry sur l'app	rails app:template LOCATION=https://raw.githubusercontent.com/Captive-Studio/rails-application-templates/main/templates/sentry.rb
captive_admin	Configure captive_admin avec devise et active admin	rails app:template LOCATION=https://raw.githubusercontent.com/Captive-Studio/rails-application-templates/main/templates/captive_admin.rb
devise	Configure devise	rails app:template LOCATION=https://raw.githubusercontent.com/Captive-Studio/rails-application-templates/main/templates/devise.rb
active_admin	Configure active_admin	rails app:template LOCATION=https://raw.githubusercontent.com/Captive-Studio/rails-application-templates/main/templates/active_admin.rb
guard	Configure guard	rails app:template LOCATION=https://raw.githubusercontent.com/Captive-Studio/rails-application-templates/main/templates/guard.rb
environment	Configure l'application en Français, Anglais, ...	rails app:template LOCATION=https://raw.githubusercontent.com/Captive-Studio/rails-application-templates/main/templates/environment.rb
procfile	Configure foreman et un procfile pour déployer sur Scalingo	rails app:template LOCATION=https://raw.githubusercontent.com/Captive-Studio/rails-application-templates/main/templates/procfile.rb
rubocop_captive	Configure le rubocop avec la config captive	rails app:template LOCATION=https://raw.githubusercontent.com/Captive-Studio/rails-application-templates/main/templates/rubocop_captive.rb
bundle_locker	Configure la gem bundle-locker pour corriger le Gemfile	rails app:template LOCATION=https://raw.githubusercontent.com/Captive-Studio/rails-application-templates/main/templates/bundle_locker.rb
bullet	Configure bullet en environnnement de development et test	rails app:template LOCATION=https://raw.githubusercontent.com/Captive-Studio/rails-application-templates/main/templates/bullet.rb
formtastic	Configure formtastic	rails app:template LOCATION=https://raw.githubusercontent.com/Captive-Studio/rails-application-templates/main/templates/formtastic.rb

Vous pouvez simplifier l'usage des templates en ajoutant la fonction suivante dans votre fichier ~/.zshrc

run_rails_template() {
  if [ -z "$1" ]; then
    echo "Usage: run_rails_template PARAMETRE1"
    return 1
  fi

  local PARAMETRE1="$1"
  rails_command="rails app:template LOCATION=https://raw.githubusercontent.com/Captive-Studio/rails-application-templates/main/templates/${PARAMETRE1}.rb"

  eval "$rails_command"
}

Cela permettra d'utiliser un template de la manière suivante :

$ run_rails_template validation_telephone
  apply  https://raw.githubusercontent.com/Captive-Studio/rails-application-templates/main/templates/validation_telephone.rb
bin/rails aborted! pays par défaut (par exemple, 'FR' pour la France)? 

Rules

• chaque template doit être le plus unitaire possible

• les templates doivent être écris en snake_case

• Remplacer les puts par say

  Cela permet notamment de colorer le message

• Les questions (ask(string)) doivent commencer avec un verbe à l'infinitif

• Les questions (ask(string)) doivent comporter la valeur par défaut dans la phrase entre croché

# BAD
ask("Quel est votre pays ?", default: "FRANCE")

# GOOD
ask("Entrer votre pays [FRANCE]", default: "FRANCE")

• Les questions oui/non (yes?(string)) doit comporter la valeur par défaut dans la phrase entre croché Aimez-vous les brocolis ? [Y/n]
• Ne pas installer les gems en double sur le Gemfile

gems = %w(devise devise-i18n)

gems.each do |g|
  unless File.read("Gemfile").include?(g)
    gem g
  end
end