Где разместить / получить доступ к файлу конфигурации в драгоценном камне?

Я перехожу к этому немного поздно, но я оставлю пример реализации того, как я обычно справляюсь с этим, для дальнейшего использования.

Как уже упоминалось, обычно вы хотите разрешить настройку как через файлы, так и через хэши. Включить оба способа довольно просто и легко, поэтому вам следует это сделать.

Что-то вроде этого работает для меня в большинстве сценариев:

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

Еще лучше было бы использовать значения по умолчанию для всех ключей конфигурации (как в приведенном выше примере). Таким образом, вы даете пользователю полную свободу в настройке вашей библиотеки.

Если ваш гем включает в себя команду, которую пользователь может запустить в интерактивном режиме, было бы лучше запросить все необходимые детали при первом запуске. Хорошим местом для сохранения конфигурации будет домашний каталог пользователя в виде точечного файла.

Если ваш гем предназначен исключительно для использования в другом коде в качестве библиотеки, тогда конфигурация должна быть разрешена для передачи в виде хэша или чего-то подобного.

Другой шаблон без использования файлов конфигурации:

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

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

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

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