Dónde colocar/acceder al archivo de configuración en gem?

Question

Escribo mi primera joya y me gustaría que el usuario pueda recuperar y establecer opciones específicas a través de un archivo config.yml.

¿Dónde se debe colocar este archivo dentro de la estructura de mi archivo gem y cómo alguien modifica el archivo al instalar mi gema? Supongo que pueden pasar opciones específicas al instalar la gema, y ​​esas opciones pueden asignarse al archivo config.yml, pero ¿cómo es posible?

Además, ¿es la mejor manera de recuperar el archivo a través de YAML.load_file?

He visto las grabaciones de Ryan sobre la creación de una gema a través de Bundler, pero él no cubre este tema.

Answer 1

Estoy saltando en este un poco tarde pero dejaré una implementación de ejemplo de cómo generalmente manejo esto, para referencia futura.

Como se mencionó, normalmente querrá permitir la configuración mediante archivos y hash. Es bastante fácil y ligero incluir ambas formas, por lo que debes hacerlo.

Algo como esto funciona para mí en la mayoría de escenarios:

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 

Una buena práctica añadido sería tener valores predeterminados para todas sus claves de configuración (como en el ejemplo anterior). De esta forma, le está dando al usuario la máxima libertad sobre cómo pueden configurar su biblioteca.

Answer 2

Como gema, debe permitir que las personas interactúen con ella como quieran. No puedes asumir ningún tipo de estructura de aplicación. En su lugar, exponga una API que permite al desarrollador pasar un hash de opciones o una ruta a su propio archivo YAML que puede leer y analizar.

Pero intentar establecer una convención de nomenclatura de archivo de una gema probablemente no es lo que desea.

Answer 3

Si su gema incluye un comando que puede ser ejecutado de forma interactiva por el usuario, sería mejor solicitar los detalles necesarios en la primera ejecución. Un buen lugar para guardar la configuración estaría en el directorio de inicio del usuario como un archivo de puntos.

Si su gema es puramente para uso en otro código como una biblioteca, entonces la configuración debe pasar como un hash o similar.

Answer 4

Otro patrón sin utilizar archivos de configuración:

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

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