config_plus 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 20890e554dc232e7ec1a72414f746b15ac7a3449
+  data.tar.gz: efacb601ce0541c0e2141e6846bede15ab2cb437
+SHA512:
+  metadata.gz: fb3a6f9ec6260f0ed6299053898d1638219d9a1146c9e117f5c28b8708d74abc1853fd4395ff1b531eeaae23dea1b86ba9dd7391e7503018ec9152047c9b52f4
+  data.tar.gz: 48713b64f82b3b38a8b3c486af64fa34e9ef38732ebebd091ef591384d1d9392ae6bff0cc8f737ff7e51b3de2cecbded7cd11b545860ab92582f50af05d1c650

data/README.ja.md

@@ -0,0 +1,137 @@
+ConfigPlus
+==================================================
+
+`ConfigPlus` は YAML ファイルから設定情報を読み込むためのライブラリです。
+読み込みたい YAML ファイルのパスを指定すると、`ConfigPlus.root` から設定情報にアクセスできるようになります。
+
+基本的な使用例
+--------------------------------------------------
+例として、次のような YAML ファイルがあるとすると、
+
+```yaml
+foo:
+  baa:
+    baz:
+      spam: 123
+      ham: abc
+```
+
+次のようにアクセスできます。
+
+```ruby
+ConfigPlus.generate(from: '/path/to/configuration/file.yml')
+ConfigPlus.root[:foo][:baa][:baz]
+#=> {"spam"=>123, "ham"=>"abc"}
+
+ConfigPlus.root['foo']['baa']['baz']
+#=> {"spam"=>123, "ham"=>"abc"}
+
+ConfigPlus.root.foo.baa.baz
+#=> {"spam"=>123, "ham"=>"abc"}
+
+ConfigPlus.root.get('foo.baa.baz')
+#=> {"spam"=>123, "ham"=>"abc"}
+```
+
+メソッド風のアクセスには多少の制限があります。
+キーがメソッド名として有効である必要があるのはもちろんのこと、private
+メソッドも含めて既存のメソッド名と重複した場合は、既存のメソッドの方が有効になります。
+
+`ConfigPlus.root` は `Hash` を拡張したオブジェクトなので、
+おおよそ `Hash` のメソッドを上書きできない（正確には `ConfigPlus::Node`
+のメソッドを上書きできない）、ということになります。
+
+自動マッピング
+--------------------------------------------------
+YAML の構造と同じパスを持つクラス（上記の場合であれば `Foo::Baa::Baz` というクラス）がある場合、
+次のようにして設定情報にアクセスすることもできます。
+
+```ruby
+module Foo
+  module Baa
+    class Baz
+      include ConfigPlus
+    end
+  end
+end
+
+Foo::Baa::Baz.config
+#=> {"spam"=>123, "ham"=>"abc"}
+
+Foo::Baa::Baz.config.spam
+#=> 123
+
+baz = Foo::Baa::Baz.new
+baz.config.ham
+#=> "abc"
+```
+
+`ConfigPlus` を `include` することで、クラスメソッドとインスタンスメソッドに
+`config` というメソッドが追加されます（このメソッド名は設定で変更できます）。
+そこから、読み込んだ設定情報にアクセスできるようになります。
+
+上書きマージ
+--------------------------------------------------
+`ConfigPlus` に読み込ませるパスには、ディレクトリを指定することもできます。
+ディレクトリを指定した場合は、サブディレクトリも含めてファイルが探索され、
+その中から拡張子がマッチしたものが全て読み込まれます。
+読み込まれた YAML は、最終的に一つにマージされた Hash となります。
+
+設定ファイルはファイル名でソートされた上で読み込まれ、マージされます。
+このため、同じ設定情報があればソート順の大きい方で上書きされます。
+
+例として、次のようなファイルが同じディレクトリに配置されていたとすると、
+
+```yml
+# sample-00.yml
+sample:
+  setting_a:
+    spam: spam-00
+    ham: ham-00
+    egg: egg-00
+```
+
+```yml
+# sample-01.yml
+sample:
+  setting_a:
+    ham: ham-01
+```
+
+`sample-00.yml` がベースとなり、そこに `sample-01.yml` が上書きされて読み込まれます。
+
+```ruby
+Sample::SettingA.config
+#=> {"spam"=>"spam-00", "ham"=>"ham-01", "egg"=>"egg-00"}
+```
+
+その他
+--------------------------------------------------
+`ConfigPlus` の動作は設定で変更できます。
+設定ファイルへのパス以外の設定がある場合、次のようにブロックを使って記述します。
+
+```ruby
+ConfigPlus.configure do |conf|
+  conf.root_dir      = Rails.root
+  conf.source        = 'config/config_plus'
+  conf.config_method = :setting
+  conf.extension     = '00.yml'
+  conf.namespace     = Rails.env
+end
+```
+
+`configure` メソッドは `generate` とほぼ同じ処理をするので、上記のように書けば改めて `generate` する必要はありません。
+
+主な設定を簡単に説明すると、次のようになります。
+
+| 設定            | 概要説明                                                             | 初期値            |
+| --------------- | -------------------------------------------------------------------- | ----------------- |
+| `config_method` | `include ConfigPlus` で自動マッピングした際の設定読み込みメソッド名  | `config`          |
+| `extension`     | 読み込むファイルの拡張子。`source` がディレクトリの場合に有効        | `['yml', 'yaml']` |
+| `namespace`     | 使用するネームスペース                                               |                   |
+| `root_dir`      | `source` で指定するパスの親ディレクトリのパス                        |                   |
+| `source`        | 設定ファイル、またはそれが格納されているディレクトリのパス           |                   |
+
+ライセンス
+--------------------------------------------------
+`ConfigPlus` は MIT ライセンスです。

data/README.md

@@ -0,0 +1,146 @@
+ConfigPlus
+============================================================
+
+An easy-to-use, powerful configuration module using YAML files
+for Ruby.
+
+
+Simple Usage
+------------------------------------------------------------
+Add a configuration file in YAML format in your project:
+
+```yml
+foo:
+  baa:
+    baz:
+      spam: 123
+      ham: abc
+```
+
+You can access the configuration values with `ConfigPlus.root`:
+
+```ruby
+ConfigPlus.generate(from: '/path/to/configuration/file.yml')
+ConfigPlus.root.foo.baa.baz.spam
+#=> 123
+
+ConfigPlus.root['foo']['baa']['baz']['spam']
+#=> 123
+
+ConfigPlus.root[:foo][:baa][:baz][:spam]
+#=> 123
+
+ConfigPlus.root.get('foo.baa.baz.spam')
+#=> 123
+```
+
+`ConfigPlus` recurses a file tree looking for configuration files
+when you specify a directory path at `ConfigPlus.generate from:`.
+
+```ruby
+ConfigPlus.generate(from: '/path/to/configuration/directory')
+```
+
+And you can specify some pathes using an array.
+
+```ruby
+ConfigPlus.generate(from: ['/path/to/directory1', '/path/to/file1.yml'])
+```
+
+
+Auto Mapping
+------------------------------------------------------------
+When data structure of loaded YAML and class structure of your
+Ruby project have the same hierarchy, accessing the configuration
+can be more simple:
+
+```yml
+fizz:
+  buzz:
+    spam: bacon
+    ham: sausage
+```
+
+```ruby
+ConfigPlus.generate(from: '/path/to/configuration/file.yml')
+
+module Fizz
+  class Buzz
+    include ConfigPlus
+  end
+end
+
+Fizz::Buzz.config.ham
+#=> "sausage"
+
+buzz = Fizz:Buzz.new
+buzz.config.spam
+#=> "bacon"
+```
+
+
+Overwrite Merge
+------------------------------------------------------------
+`ConfigPlus` loads the specified configuration files in file
+name order and merge all of configuration into a single hash.
+
+```yml
+# sample-00.yml
+
+sample:
+  setting_a:
+    spam: bacon
+    ham: sausage
+    egg: baked beans
+```
+
+```yml
+# sample-01.yml
+
+sample:
+  setting_a:
+    ham: spam
+```
+
+```ruby
+Sample::SettingA.config
+#=> {"spam"=>"bacon", "ham"=>"spam", "egg"=>"baked beans"}
+```
+
+
+Others
+------------------------------------------------------------
+Settings of `ConfigPlus` can be changed by the following way:
+
+```ruby
+ConfigPlus.configure do |conf|
+  conf.root_dir      = Rails.root
+  conf.source        = 'config/config_plus'
+  conf.config_method = :setting
+  conf.extension     = [:yml, :yaml]
+  conf.namespace     = Rails.env
+end
+```
+
+`configure` method works in a similar way as `generate` method.
+Properties you can set are following:
+
+* `config_method`
+  * a method name to access configuration using in a class
+    which does `include ConfigPlus`
+* `extension`
+  * extensions of configuration files which you allow to be
+    loaded when you specify a directory path as `source`
+* `namespace`
+  * load configuration only from a tree of which first
+    hierarchy key name is matched with the specified name
+* `root_dir`
+  * used as a parent directory path when you specify a
+    relative path as `source`
+* `source`
+  * a file path or a directory path or an array of them
+
+
+License
+------------------------------------------------------------
+MIT License

data/lib/config_plus.rb

@@ -0,0 +1,8 @@
+require 'config_plus/base'
+require 'config_plus/config'
+require 'config_plus/default_loader_logic'
+require 'config_plus/helper'
+require 'config_plus/loader'
+require 'config_plus/merger'
+require 'config_plus/node'
+require 'config_plus/version'

data/lib/config_plus/base.rb

@@ -0,0 +1,83 @@
+module ConfigPlus
+  class << self
+    attr_reader :root
+
+    # Sets up configuration of ++ConfigPlus++ and loads data
+    #
+    # When a YAML file path is specified with
+    # ++source++ (or ++root_dir++) setting as below,
+    # configuration data would be loaded from the file.
+    #
+    #  ConfigPlus.configure do |conf|
+    #    conf.source = '/path/to/yaml/file.yml'
+    #  end
+    #
+    # When a directory path is specified, configuration
+    # would be loaded from all YAML files under the
+    # specified directory.
+    #
+    def configure
+      yield config if block_given?
+      load
+    end
+
+    # Sets up configuration of ++ConfigPlus++ and loads data
+    #
+    # You can describe the following code, when it needs
+    # only a single file for a resource of ++ConfigPlus++.
+    #
+    #  ConfigPlus.generate(from: '/path/to/yaml/file.yml')
+    #
+    def generate(from: nil, **properties)
+      config.source = from if from
+      properties.each do |k, v|
+        attr = "#{k}="
+        config.public_send(attr, v) if config.respond_to? attr
+      end
+      load
+    end
+
+    protected
+
+    def config
+      @config ||= ::ConfigPlus::Config.new
+    end
+
+    private
+
+    # loads a configuration data as a hash object
+    # from files specified with ++source++ or 
+    # ++root_dir++ settings.
+    #
+    def load
+      hash = config.loader.load
+      @root = ::ConfigPlus::Node.new(hash)
+    end
+  end
+
+  def self.included(base)
+    method_name = self.config.config_method
+    return unless method_name
+    variable_name = "@#{method_name}"
+    helper = ::ConfigPlus::Helper
+    own = helper.config_for(base, ::ConfigPlus.root)
+
+    inheritance = base.ancestors.select {|klass|
+      klass != base and
+      klass != ConfigPlus and
+      klass.ancestors.include?(ConfigPlus)
+    }.reverse.each_with_object({}) {|klass, hsh|
+      h = klass.public_send(method_name)
+      h = helper.config_for(klass, ::ConfigPlus.root) unless
+        h or h.is_a?(Hash)
+      hsh.merge!(h)
+    }
+
+    [base, base.singleton_class].each do |obj|
+      obj.instance_eval do
+        config = inheritance ? inheritance.merge(own || {}) : own
+        define_method method_name, -> { config }
+      end
+    end
+  end
+end

data/lib/config_plus/config.rb

@@ -0,0 +1,33 @@
+module ConfigPlus
+  class Config
+    attr_accessor :config_method,
+                  :extension,
+                  :namespace,
+                  :root_dir,
+                  :source
+    attr_reader :version
+    attr_writer :loader_logic
+
+    def initialize
+      @version = VERSION
+      @config_method = :config
+      @extension = nil
+      @loader_logic = :default
+      @namespace = nil
+      @root_dir = nil
+      @source = nil
+    end
+
+    def loader
+      Loader.new(self)
+    end
+
+    def loader_logic
+      name = @loader_logic.to_s.capitalize
+      name = "#{name}LoaderLogic"
+      raise "Unknown loader logic named `#{name}'" unless
+        ConfigPlus::const_defined?(name)
+      ConfigPlus::const_get(name)
+    end
+  end
+end

data/lib/config_plus/default_loader_logic.rb

@@ -0,0 +1,31 @@
+require 'yaml'
+
+module ConfigPlus
+  class DefaultLoaderLogic
+    def initialize(config)
+      @config = config
+    end
+
+    def extension
+      @config.extension || [:yml, :yaml]
+    end
+
+    def load_from(path)
+      return load_file(path) if File.file?(path)
+      load_dir(path)
+    end
+
+    def load_file(filepath)
+      content = open(filepath).read
+      YAML.load(content).to_hash
+    end
+
+    def load_dir(dirpath)
+      ext = Array(extension).join(',')
+      path = File.join(dirpath, '**', "*.{#{ext}}")
+      Dir.glob(path).sort.inject({}) {|h, filepath|
+        Merger.merge(h, load_file(filepath))
+      }
+    end
+  end
+end

data/lib/config_plus/helper.rb

@@ -0,0 +1,39 @@
+module ConfigPlus
+  module Helper
+    class << self
+      def config_for(object, config)
+        configs = matched_configs(object, config)
+        return configs.first if configs.size <= 1
+
+        if configs.all? {|c| c.is_a? Hash }
+          configs.inject(::ConfigPlus::Node.new) {|h, conf|
+            ::ConfigPlus::Merger.merge(h, conf)
+          }
+        else
+          configs.inject([]) {|a, conf| a << conf }
+        end
+      end
+
+      def underscore(name)
+        name.gsub(/::/, '.')
+          .gsub(/((\A|\b)([A-Z]+))|([A-Z]+)/) do
+          next $3.downcase if $3
+          "_#{$4.downcase}"
+        end
+      end
+
+      private
+
+      def matched_configs(object, node)
+        return [] unless node
+        mod = object.is_a?(Module) ? object : object.class
+        path = underscore(mod.name)
+
+        [node[mod.name],
+         node[path],
+         node.get(path),
+        ].uniq.compact
+      end
+    end
+  end
+end

data/lib/config_plus/loader.rb

@@ -0,0 +1,37 @@
+module ConfigPlus
+  class Loader
+    def initialize(config)
+      @config = config
+    end
+
+    def load
+      paths = source_paths
+      raise "No specified `source'" if paths.empty?
+
+      paths.each.inject({}) do |h, path|
+        hsh = loader_logic.load_from(path)
+        hsh = hsh[@config.namespace.to_s] if @config.namespace
+        Merger.merge(h, hsh)
+      end
+    end
+
+    protected
+
+    def loader_logic
+      @loader_logic ||= @config.loader_logic.new(@config)
+    end
+
+    def source_paths
+      Array(@config.source).map {|s|
+        source_path(s)
+      }.reverse.uniq.compact.reverse
+    end
+
+    def source_path(filepath)
+      return filepath unless @config.root_dir
+      return @config.root_dir unless filepath
+      return filepath if filepath.start_with?('/')
+      File.join(@config.root_dir, filepath)
+    end
+  end
+end

data/lib/config_plus/merger.rb

@@ -0,0 +1,23 @@
+module ConfigPlus
+  module Merger
+    MERGER = ->(key, h1, h2) do
+      if h1.is_a?(Hash) and h2.is_a?(Hash)
+        h1.merge(h2, &MERGER)
+      else
+        h2
+      end
+    end
+
+    def self.merge(collection1, collection2)
+      return collection2 unless collection1
+      return collection1 unless collection2
+
+      if collection1.is_a?(Array) and
+          collection2.is_a?(Array)
+        collection1.concat(collection2)
+      else
+        collection1.merge(collection2, &MERGER)
+      end
+    end
+  end
+end

data/lib/config_plus/node.rb

@@ -0,0 +1,51 @@
+module ConfigPlus
+  class Node < Hash
+    def initialize(hash = nil)
+      node = super()
+      node.merge!(hash) if hash
+    end
+
+    def [](key)
+      value = self.fetch(key.to_s, nil)
+      value = self.fetch(key.to_i, nil) if
+        value.nil? and key.to_s =~ /\A\d+\z/
+      return value unless value.is_a?(Hash)
+      return value if value.is_a?(self.class)
+
+      self.store(key.to_s, self.class.new(value))
+    end
+
+    def get(path)
+      key, rest = path.split('.', 2)
+      return self[key] unless rest
+      return nil unless self[key]
+      self[key].get(rest)
+    end
+
+    def merge!(hash)
+      result = super
+      hash.keys.each {|k| define_accessor(k) }
+      result
+    end
+
+    def merge(hash)
+      result = super
+      result.instance_eval {
+        hash.keys.each {|k| define_accessor(k) }
+      }
+      result
+    end
+
+    private
+
+    def define_accessor(method_name)
+      return unless method_name.is_a?(String) or
+        method_name.is_a?(Symbol)
+      return if respond_to?(method_name) or
+        private_methods.include?(method_name.to_sym)
+      singleton_class.class_eval do
+        define_method method_name, -> { self[method_name] }
+      end
+    end
+  end
+end

data/lib/config_plus/version.rb

@@ -0,0 +1,3 @@
+module ConfigPlus
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: config_plus
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- m4oda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: ConfigPlus is an easy-to-use configuration module that uses YAML files
+  and has powerful features such as auto mapping.
+email: e5ww2sze@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.ja.md
+- README.md
+- lib/config_plus.rb
+- lib/config_plus/base.rb
+- lib/config_plus/config.rb
+- lib/config_plus/default_loader_logic.rb
+- lib/config_plus/helper.rb
+- lib/config_plus/loader.rb
+- lib/config_plus/merger.rb
+- lib/config_plus/node.rb
+- lib/config_plus/version.rb
+homepage: https://github.com/m4oda/config_plus
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: An easy-to-use, powerful configuration module using YAML files
+test_files: []