config_plus 0.0.5 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 189eb84bec6ebcfa3fbb181d5d548c47fb7e4c3e
-  data.tar.gz: 8b71d5dc1ac70f6eadc0fe5d49d78e724d63ad6c
+  metadata.gz: e208952531353609f29e28211515eb3b11bf0781
+  data.tar.gz: 76453e257d4804a459336cd536d5a0ba5654ae48
 SHA512:
-  metadata.gz: 4c5807c8460291543b7c536d0394034b05cc3bdef580fddccf312f56ee7af0fd69f78a3481f661e131263b9b5eae7c3141c0c55006f10c682b19a2a807d897cc
-  data.tar.gz: 7ccf3c2d162116d904e5d56162461cfc1f311239af62158869efbeb25d6df09a72b3035bd2797eebb0d005657829a56e9eadaca6a7c506d3580b1cdb5b6bd754
+  metadata.gz: eea53a7069d354366b6bf0e9f6155736514459c0fe8e1dab6178a0d3f70500f33539f8a7b63f57b551ae3ab40622ec1d0ccc7e66938edaa95a5001d0216b7a07
+  data.tar.gz: 53697c89a5c3400e9d3e9179e67d78f4021a04160a647c00afe4a84afbbb9e1238d51736f99deb9e9ea3350f15a56e740ea06938397d2114b58b733834e4c41e

data/README.ja.md

@@ -141,6 +141,30 @@ Sample::SettingA.config
 #=> {"spam"=>"bacon", "ham"=>"spam", "egg"=>"baked beans"}
 ```
 
+個別ロード
+--------------------------------------------------
+`ConfigPlus` の基本動作では、指定された設定ファイル群の情報を `ConfigPlus.root`
+に読み込みます。つまり、すべての情報は基本的にひとつのオプジェクトで管理されます。
+
+これはシンプルな方法ですが、個別に読み込み、管理したいということもあるかもしれません。
+次のようにすると、個別に設定情報を持たせることができます。
+
+```ruby
+class Foo
+  extend ConfigPlus::Single
+  generate_config '/path/to/configuration/file.yml', as: :conf
+end
+
+Foo.conf[:foo]
+# => foo の値
+
+ConfigPlus.root
+# => nil
+```
+
+オプションの `as` で設定情報にアクセスするメソッド名を指定できます。
+省略すると `config` が使われます。
+
 その他
 --------------------------------------------------
 `ConfigPlus` の動作は設定で変更できます。

data/README.md

@@ -126,6 +126,29 @@ Sample::SettingA.config
 #=> {"spam"=>"bacon", "ham"=>"spam", "egg"=>"baked beans"}
 ```
 
+Load Individually
+------------------------------------------------------------
+Basically, `ConfigPlus` loads the specified configuration files
+and merges all of the data into a single hash `ConfigPlus.root`.
+
+But if you want to get the data in an other hash, you can do by
+the following way:
+
+```ruby
+class Foo
+  extend ConfigPlus::Single
+  generate_config '/path/to/configuration/file.yml', as: :conf
+end
+
+Foo.conf[:foo]
+# => a value of `foo'
+
+ConfigPlus.root
+# => nil
+```
+
+You can specify the method name for access to configuration data
+by the option `as`, which default value is `config`.
 
 Others
 ------------------------------------------------------------

data/lib/config_plus.rb

@@ -1,7 +1,8 @@
-require 'config_plus/base'
 require 'config_plus/version'
 
 module ConfigPlus
+  autoload :Base, 'config_plus/base'
+  autoload :Collection, 'config_plus/collection'
   autoload :Config, 'config_plus/config'
   autoload :DefaultLoaderLogic, 'config_plus/default_loader_logic'
   autoload :ErbYamlLoaderLogic, 'config_plus/erb_yaml_loader_logic'
@@ -9,4 +10,7 @@ module ConfigPlus
   autoload :Loader, 'config_plus/loader'
   autoload :Merger, 'config_plus/merger'
   autoload :Node, 'config_plus/node'
+  autoload :Single, 'config_plus/single'
+
+  extend Base
 end

data/lib/config_plus/base.rb

@@ -1,5 +1,5 @@
 module ConfigPlus
-  class << self
+  module Base
     attr_reader :root
 
     # Sets up configuration of ++ConfigPlus++ and loads data
@@ -28,7 +28,7 @@ module ConfigPlus
     #  ConfigPlus.generate(from: '/path/to/yaml/file.yml')
     #
     def generate(options={})
-      config.source = options.delete(:from) or options.delete('from')
+      config.source = options.delete(:from) || options.delete('from')
       options.each do |k, v|
         if config.has_property?(k)
           config.property_set(k, v)
@@ -39,16 +39,38 @@ module ConfigPlus
       load
     end
 
+    def single_generate(source, options={})
+      meth = [:as, :config_method].lazy.map {|nm|
+        options.delete(nm) || options.delete(nm.to_s)
+      }.find {|v| v } || :config
+      klass = options.delete(:to) || options.delete('to')
+      raise unless klass
+
+      conf = self::Config.new
+      conf.source = source
+      options.each do |k, v|
+        conf.has_property?(k) and conf.property_set(k, v) or
+          raise "Unknown configuration property `#{k}'"
+      end
+
+      hsh = conf.loader.load
+      conf.node_model.new(hsh).tap do |tree|
+        [klass.singleton_class, klass].each do |obj|
+          obj.instance_eval { define_method meth, lambda { tree } }
+        end
+      end
+    end
+
     protected
 
     def config
-      @config ||= self::Config.new
+      @config ||= ::ConfigPlus::Config.new
     end
 
     private
 
     # Loads a configuration data as a hash object
-    # from files specified with ++source++ or 
+    # from files specified with ++source++ or
     # ++root_dir++ settings.
     #
     def load
@@ -63,23 +85,23 @@ module ConfigPlus
         clazz.ancestors.include?(self)
       }.reverse.each.inject({}) {|hsh, clazz|
         h = clazz.public_send(self.config.config_method)
-        h = self::Helper.config_for(clazz, self.root) unless
+        h = ::ConfigPlus::Helper.config_for(clazz, self.root) unless
           h or h.is_a?(Hash)
-        self::Merger.merge(hsh, h)
+        ::ConfigPlus::Merger.merge(hsh, h)
       }
     end
 
     def included(base)
       method_name = self.config.config_method
       return unless method_name
-      own = self::Helper.config_for(base, self.root)
+      own = ::ConfigPlus::Helper.config_for(base, self.root)
       inheritance = inherited_config_of(base)
 
       node_model = config.node_model
       [base, base.singleton_class].each do |obj|
         obj.instance_eval do
-          config = inheritance ?
-            ::ConfigPlus::Merger.merge(inheritance, own || {}) : own
+          config = inheritance.empty? ? own :
+            ::ConfigPlus::Merger.merge(inheritance, own || {})
           config = node_model.new(config)
           define_method method_name, lambda { config }
         end

data/lib/config_plus/collection.rb

@@ -0,0 +1,193 @@
+require 'forwardable'
+
+module ConfigPlus
+  class Collection
+    extend Forwardable
+
+    def_delegators :data,
+                   :each,
+                   :include?,
+                   :inspect,
+                   :size,
+                   :to_a,
+                   :to_s,
+                   :values_at
+
+    def initialize(collection)
+      @hash_data = nil
+      @array_data = nil
+      data = retrieve_data_out_of(collection)
+
+      case data
+      when Hash
+        @hash_data = {}
+      when Array
+        @array_data = []
+      else
+        raise TypeError, "An argument should be Hash or Array " \
+                         "but #{collection.class.name}"
+      end
+    end
+
+    def [](key)
+      self.fetch(key, nil)
+    end
+
+    def fetch(*arguments)
+      raise ArgumentError if arguments.size > 2 or arguments.empty?
+      args = arguments.dup
+      args[0] = args[0].to_s
+
+      if array? and args[0] =~ /\A\d+\z/
+        args[0] = args[0].to_i
+        data.fetch(*args)
+      elsif hash?
+        v = data.fetch(*args)
+        if !v and args[0] =~ /\A\d+\z/
+          args[0] = args[0].to_i
+          v = data.fetch(*args)
+        end
+        v
+      else
+        raise
+      end
+    end
+
+    def merge(collection)
+      raise TypeError, "An argument should be an instance of #{data.class.name}" \
+                       " but #{collection.class.name}" if
+        self.miss_match?(collection)
+      data = retrieve_data_out_of collection
+
+      if hash?
+        hash_data.merge(data)
+      else
+        array_data + data
+      end
+    end
+
+    def merge!(collection)
+      raise TypeError, "An argument should be an instance of #{data.class.name}" \
+                       " but #{collection.class.name}" if
+        self.miss_match?(collection)
+      data = retrieve_data_out_of collection
+
+      if hash?
+        hash_data.merge!(data)
+      else
+        array_data.concat(data)
+      end
+    end
+
+    def each_key
+      if hash?
+        hash_data.each_key
+      else
+        (0...array_data.size).each
+      end
+    end
+
+    def each_pair
+      if hash?
+        hash_data.each_pair
+      else
+        array_data.lazy.with_index.map {|v, n|
+          [n, v]
+        }.each
+      end
+    end
+
+    def keys
+      if hash?
+        hash_data.keys
+      else
+        Array.new(array_data, &:to_i)
+      end
+    end
+
+    def key?(val)
+      if hash?
+        hash_data.key?(val.to_s)
+      elsif val.to_s =~ /\A\d+\z/
+        val.to_i.between?(0, array_data.size - 1)
+      else
+        false
+      end
+    end
+    alias :has_key? :key?
+
+    def store(key, val)
+      if hash?
+        hash_data.store(key.to_s, val)
+      elsif key.to_s =~ /\A\d+\z/
+        array_data[key.to_i] = val
+      end
+    end
+
+    def to_hash
+      if hash?
+        hash_data.to_hash
+      else
+        Hash.try_convert(data)
+      end
+    end
+
+    def value?(val)
+      if hash?
+        hash_data.value?(val)
+      else
+        array_data.include?(val)
+      end
+    end
+    alias :has_value? :value?
+
+    def values
+      if hash?
+        hash_data.values
+      else
+        array_data
+      end
+    end
+
+    def data
+      hash_data || array_data
+    end
+
+    def hash?
+      !!hash_data
+    end
+
+    def array?
+      !!array_data
+    end
+
+    protected
+
+    def miss_match?(collection)
+      data.class != collection.class && !collection.is_a?(self.class)
+    end
+
+    private
+
+    attr_reader :hash_data, :array_data
+
+    def retrieve_data_out_of(object)
+      case object
+      when Hash, Array
+        object
+      when self.class
+        object.data
+      else
+        raise TypeError, "#{object.class.name} could not be acceptable"
+      end
+    end
+
+    class << self
+      def generate_for(collection)
+        new(collection)
+      end
+
+      private :new
+    end
+  end
+end

data/lib/config_plus/config.rb

@@ -1,39 +1,32 @@
 module ConfigPlus
+  # Configuration of ConfigPlus
   class Config
-    class << self
-      attr_reader :properties
-
-      def prop_accessor(*names)
-        @properties ||= []
-        @properties.concat(names)
-        attr_accessor *names
-      end
-
-      private :prop_accessor
+    def self.default_properties
+      {
+        config_method: :config,
+        extension: nil,
+        namespace: nil,
+        node_model: Node,
+        root_dir: nil,
+        source: nil,
+        loader_logic: :default,
+      }
     end
 
-    prop_accessor :config_method,
-                  :extension,
-                  :namespace,
-                  :node_model,
-                  :root_dir,
-                  :source,
-                  :loader_logic
-
     def initialize
-      @config_method = :config
-      @extension = nil
-      @loader_logic = :default
-      @namespace = nil
-      @node_model = Node
-      @root_dir = nil
-      @source = nil
+      props = self.class.default_properties.each do |k, v|
+        instance_variable_set("@#{k}", v)
+      end
+
+      setup_attrs(props.keys)
     end
 
+    # returns a new loader instance
     def loader
       Loader.new(self)
     end
 
+    # returns loader class specified by +loader_logic+ property
     def loader_logic
       return @loader_logic if @loader_logic.is_a?(Class)
 
@@ -49,11 +42,20 @@ module ConfigPlus
     end
 
     def has_property?(name)
-      self.class.properties.include?(name.to_sym)
+      instance_variable_defined?("@#{name}")
     end
 
     def property_set(name, value)
       instance_variable_set("@#{name}", value)
     end
+
+    private
+
+    def setup_attrs(attr_names)
+      singleton_class.instance_eval do
+        attr_writer *attr_names
+        attr_reader *(attr_names - instance_methods)
+      end
+    end
   end
 end

data/lib/config_plus/helper.rb

@@ -31,6 +31,8 @@ module ConfigPlus
 
       private
 
+      # Finds parts of data that match with a name of the specified object
+      #
       def matched_configs(object, node)
         return [] unless node
         mod = object.is_a?(Module) ? object : object.class

data/lib/config_plus/loader.rb

@@ -8,9 +8,9 @@ module ConfigPlus
       paths = source_paths
       raise "No specified `source'" if paths.empty?
 
-      paths.each.inject({}) do |h, path|
+      paths.inject({}) do |h, path|
         hsh = loader_logic.load_from(path)
-        hsh = hsh[@config.namespace.to_s] if @config.namespace
+        hsh = hsh[config.namespace.to_s] if config.namespace
         Merger.merge(h, hsh)
       end
     end
@@ -18,20 +18,24 @@ module ConfigPlus
     protected
 
     def loader_logic
-      @loader_logic ||= @config.loader_logic.new(@config.extension)
+      @loader_logic ||= config.loader_logic.new(config.extension)
     end
 
     def source_paths
-      Array(@config.source).map {|s|
+      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 unless config.root_dir
+      return config.root_dir unless filepath
       return filepath if filepath.start_with?('/')
-      File.join(@config.root_dir, filepath)
+      File.join(config.root_dir, filepath)
     end
+
+    private
+
+    attr_reader :config
   end
 end

data/lib/config_plus/merger.rb

@@ -15,8 +15,12 @@ module ConfigPlus
       if collection1.is_a?(Array) and
           collection2.is_a?(Array)
         collection1.concat(collection2)
+      elsif collection2.is_a?(::ConfigPlus::Node)
+        collection1.merge(collection2.__send__(:node), &MERGER)
       else
-        collection1.merge(collection2, &MERGER)
+        object = collection2.__send__(:node) if collection2.is_a?(::ConfigPlus::Node)
+        object ||= collection2
+        collection1.merge(object, &MERGER)
       end
     end
   end

data/lib/config_plus/node.rb

@@ -1,18 +1,42 @@
+require 'forwardable'
+
 module ConfigPlus
-  class Node < Hash
-    def initialize(hash = nil)
-      node = super()
-      node.merge!(hash) if hash
+  class Node
+    extend Forwardable
+    include Enumerable
+
+    def_delegators :node,
+                   :array?,
+                   :each,
+                   :each_key,
+                   :each_pair,
+                   :hash?,
+                   :keys,
+                   :key?,
+                   :has_key?,
+                   :to_a,
+                   :to_hash,
+                   :to_s,
+                   :value?,
+                   :values,
+                   :values_at
+
+    def initialize(collection)
+      data = data_of(collection)
+      @node = ::ConfigPlus::Collection.generate_for(data)
+      self.merge!(data) 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)
+      value = node[key]
       return value if value.is_a?(self.class)
 
-      self.store(key.to_s, self.class.new(value))
+      case value
+      when Hash, Array, ::ConfigPlus::Collection
+        node.store(key.to_s, self.class.new(value))
+      else
+        value
+      end
     end
 
     def get(path)
@@ -22,29 +46,57 @@ module ConfigPlus
       self[key].get(rest)
     end
 
-    def merge!(hash)
-      result = super
-      hash.keys.each {|k| define_accessor(k) }
-      result
+    def dig(*keys)
+      key = keys.first
+      rest = keys[1..-1]
+      return self[key] if rest.empty?
+      return nil unless self[key]
+      self[key].dig(*rest)
+    end
+
+    def merge(collection)
+      data = data_of(collection)
+      self.class.new(node.merge(convert(data)))
+    end
+
+    def ==(object)
+      node.data == data_of(object)
     end
 
-    def merge(hash)
-      result = super
-      result.instance_eval {
-        hash.keys.each {|k| define_accessor(k) }
+    protected
+
+    attr_reader :node
+
+    def merge!(collection)
+      data = data_of(collection)
+      node.merge!(convert(data)).tap {
+        (node.hash? ? data : node).keys.each {|k| define_accessor(k) }
       }
-      result
     end
 
     private
 
+    def data_of(collection)
+      collection.is_a?(self.class) ? collection.node : collection
+    end
+
+    def convert(collection)
+      case collection
+      when Array
+        collection.map do |data|
+          data.is_a?(Array) || data.is_a?(Hash) ? self.class.new(data) : data
+        end
+      else
+        collection
+      end
+    end
+
     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, lambda { self[method_name] }
+      name = method_name.to_s
+      return if respond_to?(name) or
+        private_methods.include?(name.to_sym)
+      singleton_class.class_exec(self) do |node|
+        define_method name, lambda { node[method_name] }
       end
     end
   end

data/lib/config_plus/single.rb

@@ -0,0 +1,10 @@
+module ConfigPlus
+  module Single
+    private
+
+    def generate_config(source, options={})
+      opt = options.merge(to: self) unless options.key?(:to) or options.key('to')
+      ::ConfigPlus.single_generate(source, opt || options)
+    end
+  end
+end

data/lib/config_plus/version.rb

@@ -1,3 +1,3 @@
 module ConfigPlus
-  VERSION = '0.0.5'
+  VERSION = '0.0.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: config_plus
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.7
 platform: ruby
 authors:
 - m4oda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-07 00:00:00.000000000 Z
+date: 2018-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -35,6 +35,7 @@ files:
 - README.md
 - lib/config_plus.rb
 - lib/config_plus/base.rb
+- lib/config_plus/collection.rb
 - lib/config_plus/config.rb
 - lib/config_plus/default_loader_logic.rb
 - lib/config_plus/erb_yaml_loader_logic.rb
@@ -42,6 +43,7 @@ files:
 - lib/config_plus/loader.rb
 - lib/config_plus/merger.rb
 - lib/config_plus/node.rb
+- lib/config_plus/single.rb
 - lib/config_plus/version.rb
 homepage: https://github.com/m4oda/config_plus
 licenses:
@@ -63,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: An easy-to-use, powerful configuration module using YAML files