Comment définir des variables de configuration personnalisées dans les rails

337

Je me demandais comment ajouter des variables de configuration personnalisées à une application rails et comment y accéder dans le contrôleur, par exemple, je veux pouvoir définir un répertoire de téléchargement dans les fichiers de configuration, dites development.rb et pouvoir y accéder dans l'un de mes contrôleurs.

Deuxièmement, je prévoyais d'avoir le support S3 pour les téléchargements dans mon application, si je voulais ajouter un fichier yaml avec l'accès s3, la clé secrète, comment l'initialiser dans mon application Rails et comment accéder aux valeurs que j'ai définies dans ce fichier de configuration.

Shiv
la source
1
Duplicate: stackoverflow.com/questions/592554/…
John Topley
Légèrement lié: n'oubliez pas de redémarrer le serveur lors de l'ajout de nouvelles variables de configuration.
Damien Ó Ceallaigh

Réponses:

165

Mise à jour 1

Très recommandé: je vais avec la gemme Rails Config de nos jours pour le contrôle à grain fin qu'elle fournit.

Update2

Si vous voulez une solution rapide, vérifiez la réponse de Jack Pratt ci-dessous.

Bien que ma réponse d'origine ci-dessous fonctionne toujours, cette réponse est désormais obsolète. Je recommande de consulter les mises à jour 1 et 2.

Réponse originale:

Pour une solution rapide, regarder l' écran "Fichier de configuration YAML" casté par Ryan Bates devrait être très utile.

En résumé:

# config/initializers/load_config.rb
APP_CONFIG = YAML.load_file("#{Rails.root}/config/config.yml")[Rails.env]

# application.rb
if APP_CONFIG['perform_authentication']
  # Do stuff
end
khelll
la source
62
Cette réponse est dépassée. Voir stackoverflow.com/questions/1450285/… ci
mattwynne
8
@matt: Est-ce obsolète parce que Rails 3 est sorti, ou parce que tout le monde est maintenant sur Rails 3, ou ...?
Lasse V. Karlsen
Merci d'avoir signalé le dépassé. Je déteste ça à propos de Rails - le code d'il y a 1 an est trop vieux.
jcollum
2
Pour toute personne souhaitant utiliser la méthode YAML dans Rails 3+, vous devrez remplacer RAILS_ENVpar Rails.envet RAILS_ROOTpar Rails.root.
Ryan
J'ai essayé rails_config. Dans la documentation, ils m'ordonnent d'enregistrer RailsConfig dans mon app.rb. Je suppose que app.rb = config / application.rb. Mais où dans le fichier application.rb dois-je mettre la ligne de registre RailsConfig?
Nhím Hổ Báo
375

Dans Rails 3, les données de configuration personnalisées spécifiques à l'application peuvent être placées dans l'objet de configuration d'application. La configuration peut être affectée dans les fichiers d'initialisation ou les fichiers d'environnement - disons pour une application donnée MyApp:

MyApp::Application.config.custom_config_variable = :my_config_setting

ou

Rails.configuration.custom_config_variable = :my_config_setting

Pour lire le paramètre, il suffit d'appeler la variable de configuration sans la définir:

Rails.configuration.custom_config_variable
=> :my_config_setting

MISE À JOUR Rails 4

Dans Rails 4, il existe une nouvelle façon pour cela => http://guides.rubyonrails.org/configuring.html#custom-configuration

entrez la description de l'image ici

Jack Pratt
la source
11
Ça marche pour moi. J'ai mis mes paramètres de configuration spécifiques à l'environnement dans les environnements / {environnement} .rb, par exemple, environnements / development.rb. Assurez-vous de redémarrer votre serveur après la modification. Il peut y avoir des techniques plus élégantes, mais je mets à niveau une application existante qui utilisait auparavant ENV ['XXX'] dans le même fichier, et comme je veux limiter la quantité de refactoring pendant la mise à niveau, cela a bien fonctionné.
pduey
13
C'est une affectation, mais comment accédez-vous à cette valeur alors?
kevzettler
9
Si vous regardez dans le fichier application.rb d'une application rails 3.x, il est indiqué que "la configuration de l'application doit aller dans des fichiers dans config / initializers", conformément à cette réponse. Il y a beaucoup de documentation sur la façon d'accéder à la variable ( edgeguides.rubyonrails.org/configuring.html ). Par exemple, dans un fichier appelé some_variables.rb dans le dossier initialiseurs, placez la variable comme décrit ci-dessus (en remplaçant MyApp par le nom de votre application) puis lorsque vous voulez l'utiliser, appelez simplement config.custom_config_variable Vous pouvez bien sûr utiliser le nom de variable que vous aimez . @Jack Pratt, vous pourriez modifier une réponse plus complète?
jamesc
48
Mec, simple: Chemin: config/environments/production.rb Config: config.whatever = false Accédez-y n'importe où: Rails.configuration.whatever
Victor S
5
Sachez que si vous définissez quelque chose uniquement en production et essayez d'y accéder dans un autre environnement, il se plaindra undefined method.
lulalala
69

Dans Rails 3.0.5, l'approche suivante a fonctionné pour moi:

Dans config/environments/development.rb, écrivez

config.custom_config_key = :config_value

La valeur custom_config_keypeut ensuite être référencée à partir d'autres fichiers en utilisant

Rails.application.config.custom_config_key
Rob Dawson
la source
4
Sachez que si vous définissez quelque chose uniquement en production et essayez d'y accéder dans un autre environnement, il se plaindra undefined method.
lulalala
J'ai essayé cela dans les rails 4.1 et method_missing': undefined method j'obtiens des erreurs, "... stocker 'pour # <Rails :: Application :: Configuration: 0x007f9f735b7240> ...". J'essayais d'ajouter la variable de configuration "config.store.works".
Spundun
1
@Spundun Vous obtenez cette erreur, car Rails ne sait pas ce que storec'est. Afin d'utiliser la méthode dans cette réponse, vous pouvez soit renommer votre variable store_works, soit créer un config.storebloc avec worksdéfini dans celle-ci.
Paul Pettengill
Merci, j'ai finalement compris cela. Que ce sont des hachages imbriqués, je dois donc initialiser les hachages vides de manière récursive si je veux utiliser des points dans mes noms de configuration.
Spundun
31

Cela fonctionne dans les rails 3.1:

dans config / environnement.rb (ou dans config / environnements / .. pour cibler un environnement spécifique):

YourApp::Application.config.yourKey = 'foo'

Cela sera accessible dans le contrôleur ou dans des vues comme celle-ci:

YourApp::Application.config.yourKey

(YourApp doit être remplacé par le nom de votre application.)

Remarque : C'est du code Ruby, donc si vous avez beaucoup de clés de configuration, vous pouvez le faire:

dans config / environment.rb:

YourApp::Application.configure do
  config.something = foo
  config.....
  config....
  .
  config....
end
Alain Beauvois
la source
2
camelCase: o utilisez snake_case!
siegy22
30

Dans Rails 4

En supposant que vous placez vos variables personnalisées dans un fichier yaml:

# config/acme.yml
development:
  :api_user: 'joe'
  :api_pass: 's4cret'
  :timeout: 20

Créez un initialiseur pour les charger:

# config/initializers/acme.rb
acme_config = Rails.application.config_for :acme

Rails.application.configure do
  config.acme = ActiveSupport::OrderedOptions.new
  config.acme.api_user = acme_config[:api_user]
  config.acme.api_pass = acme_config[:api_pass]
  config.acme.timeout  = acme_config[:timeout]
end

Maintenant, n'importe où dans votre application, vous pouvez accéder à ces valeurs comme suit:

Rails.configuration.acme.api_user

Il est pratique de Rails.application.config_for :acmecharger acme.ymlet d'utiliser l'environnement correct.

pymkin
la source
21

Depuis Rails 4.2, sans gemmes supplémentaires, vous pouvez charger config / hi.yml simplement en utilisant Rails.application.config_for :hi.

Par exemple:

  1. touch config/passwords.yml

        #config/passwords.yml
        development:
          username: 'a'
          password: 'b'
        production:
          username: 'aa'
          password: 'bb'
  1. touch config/initializers/constants.rb

    #config/initializers/constants.rb
    AUTHENTICATION = Rails.application.config_for :passwords
  1. et maintenant vous pouvez utiliser AUTHENTICATIONconstant partout dans votre application:

    #rails c production
    :001> AUTHENTICATION['username'] => 'aa'
  2. puis ajouter passwords.yml à .gitignore : echo /config/passwords.yml >> .gitignore, créez un fichier exemple pour votre confort cp /config/passwords.yml /config/passwords.example.ymlet il suffit d' éditer le fichier exemple dans votre console de production avec des valeurs réelles de production.

Lakesare
la source
13

Je voulais juste mettre à jour ceci pour les derniers trucs sympas de Rails 4.2, vous pouvez maintenant le faire dans n'importe lequel de vos config/**/*.rbfichiers:

config.x.whatever.you.want = 42

... et cela sera disponible dans votre application sous la forme:

Rails.configuration.x.whatever.you.want

Voir plus ici: http://guides.rubyonrails.org/configuring.html#custom-configuration

dégoût
la source
8

Découvrez ce joyau soigné en faisant exactement cela: https://github.com/mislav/choices

De cette façon, vos données sensibles ne seront pas exposées dans les projets open source

Flov
la source
4

J'ai créé un plugin simple pour les paramètres YAML: Yettings

Il fonctionne de manière similaire au code de la réponse de khelll, mais vous n'avez qu'à ajouter ce fichier de configuration YAML:

app/config/yetting.yml

Le plugin crée dynamiquement une classe qui vous permet d'accéder aux paramètres YML en tant que méthodes de classe dans votre application, comme suit:

Yetting.your_setting

De plus, si vous souhaitez utiliser plusieurs fichiers de paramètres avec des noms uniques, vous pouvez les placer dans un sous-répertoire dans app / config comme ceci:

app/config/yettings/first.yml
app/config/yettings/second.yml

Ensuite, vous pouvez accéder aux valeurs comme ceci:

FirstYetting.your_setting
SecondYetting.your_setting

Il vous fournit également des paramètres par défaut qui peuvent être remplacés par environnement. Vous pouvez également utiliser erb dans le fichier yml.

johnmcaliley
la source
Le dépôt officiel est maintenant sur: github.com/charlotte-ruby/yettings (le critique SO a rejeté ma modification en disant qu'elle était trop mineure)
lulalala
4

J'aime vraiment le bijou settingslogic . Très facile à installer et à utiliser.

https://github.com/binarylogic/settingslogic

Rahil Sondhi
la source
2
Aimer cela jusqu'à présent. Mettre votre objet de paramètres dans app / models / settings.rb vous permet également de recharger en mode dev. Gagner!
Mat Schaffer
4

Si vous utilisez Heroku ou avez besoin de conserver les paramètres de votre application comme variables d'environnement, la gemme figaro est très utile.

MikeH
la source
2

J'aime utiliser les paramètres de rails pour les valeurs de configuration globales qui doivent être modifiables via l'interface Web.

citer
la source
2
Je ne veux pas utiliser de plugins supplémentaires, etc., car j'apprends des rails, donc la meilleure façon de le faire serait sans plugins.
Shiv
Notez que cette base de données utilise pour stocker les configurations, qui peuvent être trop lourdes pour certaines personnes.
lulalala
0

Quelque chose que nous commençons à faire au travail est le hachage ordonné ActiveSupport

Ce qui vous permet de définir votre configuration proprement à l'intérieur des fichiers d'environnement par exemple

config.service = ActiveSupport::OrderedOptions.new
config.service.api_key = ENV['SERVICE_API_KEY']
config.service.shared_secret = ENV['SERVICE_SHARED_SECRET']
mdb29
la source
-5

Je suggérerais une bonne approche pour gérer la configuration dans votre application. Il existe trois règles de base:

  • changez votre configuration pas un code;
  • utiliser des configurations plutôt que des conditions;
  • écrire du code qui signifie quelque chose.

Pour avoir une vue d'ensemble plus détaillée, suivez ce lien: Configuration correcte des rails

paladiy
la source