MultiConfigを書いてみた

MultiConfig

追記) RubyGem化しました。公開はしていないので上記URLよりお好きに。

設定をどこから読むのか？ということが多い、主に考えられるものとして

1. 環境変数
2. コマンドラインパラメータ
3. プロセス実行中に動的されない設定ファイル
4. プロセス実行中に動的に更新される設定ファイル、Databaseなど
5. 設定されてない場合のデフォルト値

などがあげられる。これらの値をそれぞれ管理(読み込み、参照)し、使う方としては
その優先度を意識しなくてすむ設定classが欲しかった。

HOW TO USE

1. MultiConfig::EachConfigをincludeしたclassを作成する

  # Hashを用いた設定のConfig例
  class SimpleConfig < Hash
    include EachConfig
    def initialize(conf)
      @my_conf = conf
    end

    # refreshをoverrideする例
    def refresh
      puts 'override refresh!'
    end
  end

  # 環境変数を参照するConfigの例
  class EnvConfig
    include EachConfig

    # []をoverrideしてrubyのENV[]を返す
    def [](k)
      ENV[k]
    end

    def []=(k, v)
      ENV[k] = v
    end
  end

2. MultiConfig.instance.addで名前を指定して追加する

最初に追加したほうが優先度が高い。

#config設定
config = MultiConfig::MultiConfig.instance.add(
  configs: {
    simple1: MultiConfig::SimpleConfig.new('key1' => '1of1', 'key2' =>  '2of1'),
    simple2: MultiConfig::SimpleConfig.new('key1' => 'two of one', 'key2' => 'two of two'),
    env:     MultiConfig::EnvConfig.new
  })

3. アクセッサ[]でアクセスする

puts config['key1']

その他

# env一覧を表示
puts config.names

# :key1は先頭が:simple1のkey1なので'value1'
puts config['key1']

# :key2も同様なので2
puts config['key2']

# HOMEはenvにしかないので、:envのものが表示される
puts config['HOME']

# 'HOME'がどのように取得されているかみてみる
puts config.values('HOME')

# 順序を変えてみる
config.change_order(names: [:env, :simple2, :simple1])

# 参照してみる(3, value4となる)
puts config['key1']
puts config['key2']

# 自分で順序を指定してとる
puts config.value(:simple1)['key1']
puts config.value(:env)['key1']