yaml_extend 0.0.12 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 232d8e4032b96d3acbb88086dce380d23ebf2dca
-  data.tar.gz: 7d5749a37cf8eec0f56f82a40ec44ee178c8906d
+SHA256:
+  metadata.gz: 04f4c2478bcf2e8aba3680677eceab0842a7d9fc2e7365aa2f28d0d6dd63a117
+  data.tar.gz: 43e083063da5ef8ed5908e0f9468424b92ed3da4dd3c263a8771f264a4e5d81d
 SHA512:
-  metadata.gz: b8078643bc9c5625f7e1c7666f69d14629eb6a11eaa7bac40f00df3ec878704a6ce019a648e01eb6ce1b39404285748739e2b7d234d54ce51421924872339300
-  data.tar.gz: abbeaa2005e79a0d3487102c6f9a65914e593e1045fd4bc51c0ee0dfc4b6a81d6311e12e792271c7e94b768b3dd526f391e20b3e43cb4ae06e3016dcbe3eb8a1
+  metadata.gz: d34ec7a111411afa7422674d3de2a5b5703016ffae3e5ad20c98844dc1fcd9a80c18465e10cbb4421d2eae0a76f861cc21762ad063c556e22b048a096a8bb546
+  data.tar.gz: 2a5a773487b707570e3a615278594998003fbab324c86b486c3cef0f5bcd8748b62926271b121be8a3389ffdc1a4b830e5f5fbe53467de1d8f49b2f23668dfd0

data/.gitignore

@@ -8,6 +8,7 @@
 /spec/reports/
 /tmp/
 /.vscode/
+/.idea/
 *.gem
 
 # rspec failure tracking

data/README.md

@@ -82,11 +82,37 @@ extends:
 ...
 ```
 
+#### Using custom extend key
+```
+#custom1.yml
+inherit_from:
+    - 'super_file.yml'
+foo: 'bar'
+...
+```
+
+```
+YAML.ext_load_file('custom1.yml','inherit_from')
+```
+#### Using custom nested extend key
+```
+#custom2.yml
+options:
+    extend_file: 'super_file.yml'
+    database: false
+foo: 'bar'
+...
+```
+
+```
+YAML.ext_load_file('custom2.yml',['options','extend_file'])
+```
+
 ## Documentation
 YAML#ext_load_file(yaml_path, inheritance_key='extends', extend_existing_arrays=true, config = {})
 
 - *yaml_path* relative or absolute path to yaml file to inherit from
-- *inheritance_key* you can overwrite the default key, if you use it already as part of your configuration. The inheritance_key is NOT included in the final merged file. Default: 'extends'
+- *inheritance_key* you can overwrite the default key, if you use the default 'extends' already as part of your configuration. The inheritance_key is NOT included, that means it will be deleted, in the final merged file. Default: 'extends'
 - *extend_existing_arrays* Extends existing arrays in yaml structure instead of replacing them. Default: true
 - *config* only intended to be used by the method itself due recursive algorithm
 

data/lib/custom_errors/invalid_key_type_error.rb

@@ -0,0 +1,2 @@
+class InvalidKeyTypeError < StandardError
+end

data/lib/yaml_extend/version.rb

@@ -1,3 +1,3 @@
 module YamlExtend
-  VERSION = '0.0.12'.freeze
+  VERSION = '0.1.0'.freeze
 end

data/lib/yaml_extend.rb

@@ -1,8 +1,10 @@
-require "yaml_extend/version"
+require 'yaml_extend/version'
 
 require 'yaml'
 require 'deep_merge/rails_compat'
 
+require_relative 'custom_errors/invalid_key_type_error'
+
 #
 # Extending the YAML library to allow to inherit from another YAML file(s)
 #
@@ -13,7 +15,9 @@ module YAML
   # ability to inherit from other YAML file(s)
   #
   # @param yaml_path [String] the path to the yaml file to be loaded
-  # @param inheritance_key [String] the key used in the yaml file to extend from another YAML file
+  # @param inheritance_key [String|Array]
+  #   The key used in the yaml file to extend from another YAML file.
+  #   Use an Array if you want to use a tree structure key like "options.extends" => ['options','extends']
   # @param extend_existing_arrays [Boolean] extend existing arrays instead of replacing them
   # @param config [Hash] a hash to be merged into the result, usually only recursivly called by the method itself
   #
@@ -23,8 +27,8 @@ module YAML
     total_config ||= {}
     yaml_path = YAML.make_absolute_path yaml_path
     super_config = YAML.load_file(File.open(yaml_path))
-    super_inheritance_files = super_config[inheritance_key]
-    super_config.delete inheritance_key # we don't merge the super inheritance keys into the base yaml
+    super_inheritance_files = yaml_value_by_key inheritance_key, super_config
+    delete_yaml_key inheritance_key, super_config # we don't merge the super inheritance keys into the base yaml
     merged_config = config.clone.deeper_merge(super_config, extend_existing_arrays: extend_existing_arrays)
     if super_inheritance_files && super_inheritance_files != ''
       super_inheritance_files = [super_inheritance_files] unless super_inheritance_files.is_a? Array # we support strings as well as arrays of type string to extend from
@@ -34,7 +38,7 @@ module YAML
       end
       total_config
     else
-      merged_config.delete(inheritance_key)
+      delete_yaml_key inheritance_key, merged_config
       merged_config
     end
   end
@@ -62,4 +66,40 @@ module YAML
     path.start_with?('/') || # unix like
       (path.length >= 3 && path[1] == ':') # ms windows
   end
+
+  # Return the value of the corresponding key
+  # @param key [String|Array]
+  def self.yaml_value_by_key(key, config)
+    return config[key] if key.is_a? String
+    if valid_key_type? key
+      cfg_copy = config.clone
+      key.each do |key|
+        if cfg_copy.nil?
+          return
+        elsif valid_key_type? key
+          cfg_copy = cfg_copy[key]
+        end
+      end
+      cfg_copy
+    end
+  end
+
+  def self.valid_key_type?(key)
+    key.is_a?(Array) || key.is_a?(String) ||
+        raise(InvalidKeyTypeError,"Invalid key of type '#{key.class.name}'. Valid types are String and Array.")
+  end
+
+  def self.delete_yaml_key(key, config)
+    return config.delete(key) if key.is_a? String
+    cfg_ref = config
+    last_ref = nil
+    key.each do |key|
+      if valid_key_type?(key) && !cfg_ref[key].nil?
+        last_ref = cfg_ref
+        cfg_ref = cfg_ref[key] unless cfg_ref.nil?
+      end
+    end
+    last_ref.delete key.last unless last_ref.nil?
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yaml_extend
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.1.0
 platform: ruby
 authors:
 - Matthäus Beyrle
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-14 00:00:00.000000000 Z
+date: 2018-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -83,6 +83,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/custom_errors/invalid_key_type_error.rb
 - lib/yaml_extend.rb
 - lib/yaml_extend/version.rb
 - yaml_extend.gemspec
@@ -107,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Extends YAML to support file based inheritance