mimi-config 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ede4e9494fa2da839879c476231cb7b53e917717
-  data.tar.gz: d6f19fbe2a4f66d6ffd2260becc0c724e0fbadbf
+  metadata.gz: cca2e6a1670a7c4f5721347e52617840139f84c3
+  data.tar.gz: 744fb11b98ed3ddbb7524a73a0a58b8156b0ddb7
 SHA512:
-  metadata.gz: 552d80c961767e0b097abfc384d15629e39bbca6495ff3651087d900c822f1f743dcc3e81ec7764a6ecc3a0fb6647db45d3e415022cba780dd6c1f2c178ea031
-  data.tar.gz: e303ea389d4ca52aa61e9b30593ae3e6c18afddb563c93af400174d558ad5a046253aef55d47dc387069c70619d95bf9b49c07a2e24c14bb2f97fb4ef6e3b8e6
+  metadata.gz: 8c7b0f8d48b89bfa92f24aea94ab620a692d8b67bc170bc89f1f75f0b2264cf2cdcfd82d06732681cff6c9f4527373f1be51448de19164d5eb9977848bca2a97
+  data.tar.gz: 4181ee303e70a2751fe026d89b639afc28ba6384e795f9f0f6c231dc855f4152b1ff63ea9cc023823bc855f51679fcabcfae35db82e4d29605acb229038fa5e9

data/Gemfile

@@ -3,4 +3,4 @@ source 'https://rubygems.org'
 gemspec
 
 # Comment out the following gem instructions, if you not using gem sources
-gem 'mimi-core', path: '/mimi-core'
+# gem 'mimi-core', path: '/mimi-core'

data/lib/mimi/config/manifest.rb

@@ -0,0 +1,86 @@
+module Mimi
+  class Config
+    class Manifest < Hash
+      # Reads manifest file and merges it with the current manifest.
+      #
+      # @return [Mimi::Config::Manifest] current manifest merged with the new one
+      #
+      def load(filename_or_hash, _opts = {})
+        new_manifest = nil
+        if filename_or_hash.is_a?(String) || filename_or_hash.is_a?(Pathname)
+          new_manifest = YAML.load(File.read(filename_or_hash))
+        end
+        new_manifest = filename_or_hash.dup if filename_or_hash.is_a?(Hash)
+        return self unless new_manifest
+        raise 'Invalid manifest file format' unless new_manifest.is_a?(Hash)
+        new_manifest.each do |k, v|
+          merge_key(k, v)
+        end
+        self
+      rescue StandardError => e
+        raise "Failed to load manifest file: #{e}"
+      end
+
+      # Returns YAML representation of the manifest
+      #
+      # @return [String]
+      #
+      def to_yaml
+        out = []
+        self.each do |k, v|
+          if v.key?(:const)
+            out << "#{k}:"
+            out << "  desc: #{value_to_yaml(v[:desc])}" if v.key?(:desc)
+            if v[:const]
+              out << "  const: #{value_to_yaml(v[:default])}"
+            elsif v.key?(:default)
+              out << "  default: #{value_to_yaml(v[:default])}"
+            end
+          elsif v.key?(:desc)
+            out << "#{k}: #{value_to_yaml(v[:desc])}"
+          else
+            out << "#{k}:"
+          end
+          out << ''
+        end
+        out.join("\n")
+      end
+
+      private
+
+      def value_to_yaml(v)
+        v.nil? ? '# nil' : v.inspect
+      end
+
+      def merge_key(k, v)
+        k = k.to_sym
+        self[k] ||= {}
+        if v.nil?
+          # var:
+        elsif v.is_a?(String)
+          # var: A description
+          self[k][:desc] = v
+        elsif v.is_a?(Hash)
+          merge_key_hash(k, v)
+        end
+      end
+
+      def merge_key_hash(k, v)
+        v = v.dup.stringify_keys
+        self[k][:desc] = v['desc'] if v.key?('desc')
+
+        if v.key?('const') && v.key?('default')
+          raise "Invalid mix of 'const' and 'default' in parameter definition '#{k}'"
+        end
+
+        if v.key?('default')
+          self[k][:const] = false
+          self[k][:default] = v['default']
+        elsif v.key?('const')
+          self[k][:const] = true
+          self[k][:default] = v['const']
+        end
+      end
+    end # class Manifest
+  end # class Config
+end # module Mimi

data/lib/mimi/config/version.rb

@@ -1,5 +1,5 @@
 module Mimi
   class Config
-    VERSION = '0.1.0'.freeze
+    VERSION = '0.1.1'.freeze
   end # class Config
 end # module Mimi

data/lib/mimi/config.rb

@@ -4,6 +4,13 @@ require 'dotenv'
 require 'mimi/core'
 
 module Mimi
+  # Returns all loaded modules combined configuration manifest
+  #
+  def self.loaded_modules_manifest
+    loaded_modules.reduce(Mimi::Config::Manifest.new) { |a, e| a.load(e.module_manifest) }
+  end
+
+
   #
   # Config stores the manifest and reads and stores configurable parameters from ENV.
   #
@@ -30,7 +37,7 @@ module Mimi
     # @param manifest_filename [String,nil] path to the manifest.yml or nil to skip loading manifest
     #
     def initialize(manifest_filename = nil, opts = {})
-      @manifest = {}
+      @manifest = Mimi::Config::Manifest.new
       @params = {}
       load(manifest_filename, opts) if manifest_filename
     end
@@ -70,6 +77,12 @@ module Mimi
       end
     end
 
+    # Returns raw manifest
+    #
+    def manifest_raw
+      @manifest
+    end
+
     # Returns true if the config manifest includes the parameter with the given name.
     #
     # If manifest includes the parameter name, it is safe to access paramter
@@ -107,20 +120,29 @@ module Mimi
       include?(name) || super
     end
 
+    # Returns Hash representation of the config.
+    # All Hash keys are Symbol
+    #
+    # @return [Hash]
+    #
+    def to_h
+      @manifest.keys.map do |k|
+        [k, self[k]]
+      end.to_h
+    end
+
+    # Returns to_h.to_s
+    #
+    def to_s
+      to_h.to_s
+    end
+
     private
 
     # Reads manifest file and merges it with the current manifest.
     #
     def load_manifest(filename, _opts = {})
-      new_manifest = YAML.load(File.read(filename))
-      return manifest unless new_manifest
-      raise 'Invalid manifest file format' unless new_manifest.is_a?(Hash)
-      new_manifest.each do |k, v|
-        merge_manifest_key(k, v)
-      end
-      manifest
-    rescue StandardError => e
-      raise "Failed to load manifest file: #{e}"
+      @manifest.load(filename)
     end
 
     # Reads parameters from the ENV according to the current manifest
@@ -142,36 +164,8 @@ module Mimi
       end
       @params
     end
-
-    def merge_manifest_key(k, v)
-      k = k.to_sym
-      @manifest[k] ||= {}
-      if v.nil?
-        # var:
-      elsif v.is_a?(String)
-        # var: A description
-        @manifest[k][:desc] = v
-      elsif v.is_a?(Hash)
-        merge_manifest_key_hash(k, v)
-      end
-    end
-
-    def merge_manifest_key_hash(k, v)
-      @manifest[k][:desc] = v['desc'] if v.key?('desc')
-
-      if v.key?('const') && v.key?('default')
-        raise "Invalid mix of 'const' and 'default' in parameter definition '#{k}'"
-      end
-
-      if v.key?('default')
-        @manifest[k][:const] = false
-        @manifest[k][:default] = v['default']
-      elsif v.key?('const')
-        @manifest[k][:const] = true
-        @manifest[k][:default] = v['const']
-      end
-    end
   end # class Config
 end # module Mimi
 
 require_relative 'config/version'
+require_relative 'config/manifest'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mimi-config
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Alex Kukushkin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-29 00:00:00.000000000 Z
+date: 2016-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mimi-core
@@ -112,6 +112,7 @@ files:
 - bin/console
 - bin/setup
 - lib/mimi/config.rb
+- lib/mimi/config/manifest.rb
 - lib/mimi/config/version.rb
 - mimi-config.gemspec
 homepage: https://github.com/kukushkin/mimi-config