Къде да поставите/осъществите достъп до конфигурационния файл в gem?

Преминавам към това малко късно, но ще оставя примерна реализация за това как обикновено се справям с това за бъдещи справки.

Както беше споменато, обикновено ще искате да разрешите конфигурация чрез файлове и хешове. Доста лесно и леко е да включите и двата начина, така че трябва да го направите.

Нещо подобно работи за мен в повечето сценарии:

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

Добавена най-добра практика би била да имате настройки по подразбиране за всички ваши конфигурационни ключове (както в примера по-горе). По този начин вие давате на потребителя максимална свобода в начина, по който може да конфигурира вашата библиотека.

Ако вашият скъпоценен камък включва команда, която може да се изпълнява интерактивно от потребителя, най-добре би било да поискате всички необходими подробности при първото изпълнение. Добро място за запазване на конфигурацията би било в домашната директория на потребителя като dot-файл.

Ако вашият скъпоценен камък е само за използване в друг код като библиотека, тогава конфигурацията трябва да бъде разрешена да бъде предадена като хеш или подобно.

Друг модел без използване на конфигурационни файлове:

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

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

Като скъпоценен камък трябва да позволите на хората да взаимодействат с него както искат. Не можете да приемете каквато и да е структура на приложението. Вместо това изложете API, който позволява на програмиста да прехвърли хеш от опции или път към техния собствен YAML файл, който можете да прочетете и анализирате.

Но опитът да се установи конвенция за именуване на файлове от скъпоценен камък вероятно не е това, което искате.