Où placer/accès au fichier de config dans gem?

Je suis en train d'écrire mon premier bijou et je voudrais des options spécifiques pour être récupérée et définie par l'utilisateur par le biais d'une config.fichier yml.

Où ce fichier doit être placé à l'intérieur de mon joyau de la structure du fichier et comment quelqu'un de modifier le fichier lors de l'installation de mon bijou? Je devine qu'ils peuvent passer à des options spécifiques lors de l'installation de la gemme, et ces options peuvent être mappées à la config.fichier yml, mais comment est-ce possible?

Aussi, est la meilleure façon de récupérer le fichier par l'intermédiaire de YAML.load_file?

J'ai regardé de Ryan railcasts sur la création d'un gem via le système de regroupement, mais il ne couvre pas ce thème.

InformationsquelleAutor webren | 2011-06-03
  1. 50

    Je suis de sauter sur celui-ci un peu en retard mais je vous laisse un exemple de mise en œuvre de la façon dont je manipulent généralement ce, pour référence future.

    Comme il a été mentionné, vous aurez généralement à permettre la configuration par le biais à la fois des fichiers et des tables de hachage. C'est assez facile et léger à inclure à la fois, de sorte que vous devriez le faire.

    Quelque chose comme cela fonctionne pour moi, dans la plupart des scénarios:

    require 'yaml'

module MyGem
  # Configuration defaults
  @config = {
              :log_level => "verbose",
              :min => 0,
              :max => 99 
            }

  @valid_config_keys = @config.keys

  # Configure through hash
  def self.configure(opts = {})
    opts.each {|k,v| @config[k.to_sym] = v if @valid_config_keys.include? k.to_sym}
  end

  # Configure through yaml file
  def self.configure_with(path_to_yaml_file)
    begin
      config = YAML::load(IO.read(path_to_yaml_file))
    rescue Errno::ENOENT
      log(:warning, "YAML configuration file couldn't be found. Using defaults."); return
    rescue Psych::SyntaxError
      log(:warning, "YAML configuration file contains invalid syntax. Using defaults."); return
    end

    configure(config)
  end

  def self.config
    @config
  end
end

    Ajoutée une meilleure pratique serait d'avoir des valeurs par défaut pour toutes vos clés de configuration(comme dans l'exemple ci-dessus). De cette façon, vous êtes offrant à l'utilisateur une liberté dans la façon dont ils peuvent configurer votre bibliothèque.

    • Je me sens plus intelligent pour avoir lu cette réponse.
    • Je reçois un undefined method 'to_sym' for {hash => 'var"}:Hash (NoMethodError lorsque j'utilise quelque chose comme ça. Sa se plaindre de l'auto.méthode configure ().
    • J'ai changé le k.to_sym à :k.to_sym, et l'erreur ne se produit plus, mais ce n'est pas encore essayer de lire mon fichier de config.
    InformationsquelleAutor Nicholas B.
  2. 5

    Si votre bijou comprend une commande qui peut être exécutée de manière interactive par l'utilisateur, il serait préférable d'invite pour toutes les précisions nécessaires sur la première manche. Un bon endroit pour enregistrer la configuration dans le répertoire home de l'utilisateur comme un point de fichier.

    Si votre bijou est purement pour une utilisation dans un autre code comme une bibliothèque, puis de configuration doit être autorisé à être transmis sous la forme d'une table de hachage ou d'autres choses semblables.

    • Ma situation est la dernière (mon code sera utilisé comme une bibliothèque). Comment pourrais-je aller sur permettant aux utilisateurs de soumettre des options via un hash?
    InformationsquelleAutor Iain Wilson
  3. 2

    Comme un bijou, vous devez autoriser les gens à l'interface avec elle comme ils le veulent. Vous ne pouvez pas assumer tout type d'application de la structure. Au lieu d'exposer une API qui permet aux développeurs de passer dans une table de hachage des options, ou une voie d'accès à leur propre fichier YAML que vous pouvez les lire et les analyser.

    Mais d'essayer d'établir une convention de nommage des fichiers à partir d'un bijou n'est probablement pas ce que vous voulez.

    • Un bijou créé par Bundler a une structure déjà mis en place pour vous. J'essaie de trouver le meilleur endroit pour coller mon fichier de config au sein de cette structure (au sein de ma propre gem). Il ya beaucoup de pierres précieuses qui permettent aux utilisateurs de spécifier des options. Disons par exemple que vous êtes en train de rédiger un joyau de la communication avec un service RESTful. Eh bien, nous avons besoin d'une URL pour vous connecter au service. Au lieu de coder en dur l'URL dans mon code de connexion, je tiens à le placer dans un fichier de config et de la récupérer dans mon code à partir de ce fichier.
    • Aussi, dire votre bijou permet aux utilisateurs de se connecter à un service RESTful, mais votre utilisateur doit connaître l'URL. Comment voulez-vous prendre de l'utilisateur, l'URL et le placer dans le service de connexion de la logique de ton code? (ceci reflète la question 2).
    • Vous voulez charger un fichier yaml emballés dans vous gem à partir de votre bijou? Ou vous voulez autimatically charger un fichier yaml du code de consommer votre bijou?
    • Oui à la première question. Comment puis-je charger un fichier de configuration YAML dans mon bijou? Et est-il possible pour l'utilisateur d'avoir accès à ce fichier et modifier les propriétés de celui-ci?
    • Permettant à l'utilisateur de fournir leur propre fichier YAML serait un excellent choix. Je suis en supposant un emplacement spécifique devra être spécifié dans mon joyau de la documentation et j'ai tout simplement utiliser YAML.load_file pour charger les informations de configuration?
    InformationsquelleAutor Alex Wayne
  4. 1

    Un autre modèle sans l'aide de fichiers de configuration:

    YourGem.configure do |config|
  config.api_key = 'your_key_here'
end

    https://robots.thoughtbot.com/mygem-configure-block

    InformationsquelleAutor Artur Beljajev