yaml_extend 0.2.4 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1e9451593e33ce34c29b421877a77b8311f1b9e12ec5e32f031d191b0e8517a
-  data.tar.gz: 50d624f0bcc5f0b859e83ce39b8752de9e0fb0a7b74d64327c0af79e008fcba4
+  metadata.gz: 515d21e196c6b0077a3f873a04281a0bcbd4d21858acaf64a6a380e75b07eeb5
+  data.tar.gz: 7ca9fbd9d902ee3eabcb81c4547018eb7fe5ffabe506b29dfb0582e54670de5e
 SHA512:
-  metadata.gz: 39f2e58240eda0ef6b12de0631b7d9965b1cd85c36401553dafdc90de7c2a6c57c6f982aaae30c5bf7f7da325e963c12ddcfc787de506569ae70bd8778aec4a3
-  data.tar.gz: 7012a0c7207557756926bc7a86ed36917717cef25d9eb036633f96293b8f7c58947e7d8eeafa37731b3cd948de014180c23e278e223935d01fac77596c8c5716
+  metadata.gz: aa16ed31fce2a1895f60c4871b926ffc8fe8a93af8548a2eee0f63220d2afe2a6f83dd8fd51f7a04e7af7bd4bb90620b7e9fc0bf5fe8d1f347ae5394be017961
+  data.tar.gz: 056f53baa09e83d64ac705811887f72677ce1e18f95441330d0b3fd0accc8cc041598fd6118b90db03e81705ff09173d67b2c70d13d0e6a99ef131ee16f617fc

data/.gitignore

@@ -1,15 +1,15 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-/.vscode/
-/.idea/
-*.gem
-
-# rspec failure tracking
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.vscode/
+/.idea/
+*.gem
+
+# rspec failure tracking
 .rspec_status

data/.rspec

@@ -1,2 +1,2 @@
---format documentation
---color
+--format documentation
+--color

data/.travis.yml

@@ -1,5 +1,5 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.3.3
-before_install: gem install bundler -v 1.14.6
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.14.6

data/CODE_OF_CONDUCT.md

@@ -1,74 +1,74 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at yaml_extend.gemspec@mail.magynhard.de. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at yaml_extend.gemspec@mail.magynhard.de. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in yaml_extend.gemspec
-gemspec
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in yaml_extend.gemspec
+gemspec

data/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2017 Matthäus Beyrle
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2017-2021 Matthäus J. N. Beyrle
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,156 +1,178 @@
-# yaml_extend
-
-Extends YAML to support file based inheritance.
-
-That can be very handy to build a configuration hierachy.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'yaml_extend'
-```
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install yaml_extend
-    
-## Common information
-
-It is possible to build inheritance trees like
-```
-default.yml   english.yml          default.yml   german.yml         de.yml
-         \    /                             \    /                    |
-          uk.yml                            de.yml                  at.yml
-```
-
-A file can inherit from as many as you want. Trees can be nested as deep as you want.
-
-YAML files are deep merged, the latest specified child file overwrites the former ones.
-Array values are merged as well by default. You can specifiy this with the 3rd Parameter.
-
-The files to inherit from are specified by the key 'extends:' in the YAML file.
-That key can be customized if you prefer another one.
-See the examples below.
-
-## Usage
-yaml_extend adds the method YAML#ext_load_file to YAML.
-
-This method works like the original YAML#load_file, by extending it with file inheritance.
-
-### Examples
-
-#### Basic Inheritance
-Given the following both files are defined:
-
-```yaml
-# start.yml
-extends: 'super.yml'
-data:
-    name: 'Mr. Superman'
-    age: 134    
-    favorites:
-        - 'Raspberrys'
-```
-
-```yaml
-# super.yml
-data:
-    name: 'Unknown'
-    power: 2000
-    favorites:
-        - 'Bananas'
-        - 'Apples'
-```
-
-When you then call #ext_load_file
-
-```ruby
-YAML.ext_load_file 'start.yml'
-```
-
-the returned YAML value results in
-
-```yaml
-data:
-    name: 'Mr. Superman'
-    age: 134
-    power: 2000
-    favorites:
-        - 'Bananas'
-        - 'Apples'
-        - 'Raspberrys'
-```
-
-#### Inherit from several files
-
-If you want to inherit from several files, you can specify a list (Array) of files.
-They are merged from top to bottom, so the latest file "wins" - that means it overwrites duplicate values if they exist with the values in the latest file where they occur.
-
-```yaml
-extends:
-    - 'super_file.yml'
-    - 'parent_file.yml'
-...
-```
-
-#### Using custom extend key
-
-If you don't want to use the default key 'extends:', you can specify your own custom key in two ways.
-
-```yaml
-#custom1.yml
-inherit_from:
-    - 'super_file.yml'
-foo: 'bar'
-...
-```
-##### 1. Specify by parameter
-You can specify the key by parameter, this is the way to go if you want to  use the different key only once or you use the #ext_load_file method only once in your application.
-```ruby
-YAML.ext_load_file 'custom1.yml', 'inherit_from'
-```
-##### 2. Global configuration of the key
-You can specify the key by configuration globally. So you only need to set the key once and not as parameter anymore
-```ruby
-YAML.ext_load_key = 'inherit_from'
-YAML.ext_load_file 'custom1.yml'
-YAML.ext_load_file 'custom2.yml'
-```
-##### Reset the global key
-To reset the global inheritance key, you can either set it to nil or call the #reset_load_key  method.
-```ruby
-YAML.reset_load_key # more readable
-YAML.ext_load_key = nil # more explicit
-```
-#### Using custom nested extend key
-```yaml
-#custom2.yml
-options:
-    extend_file: 'super_file.yml'
-    database: false
-foo: 'bar'
-...
-```
-
-```ruby
-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 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
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/magynhard/yaml_extend. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
+# yaml_extend
+
+Extends YAML to support file based inheritance.
+
+That can be very handy to build a configuration hierachy.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yaml_extend'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install yaml_extend
+    
+## Common information
+
+It is possible to build inheritance trees like:
+```
+     defaults.yml   
+  ________\_________    
+  \        \        \                         
+ dev.yml  int.yml  prod.yml                   
+```
+or like this:
+```
+fruits.yml   vegetables.yml          default.yml   extensions.yml       
+         \    /                             \    /                
+          food.yml                          merged.yml
+                                              |
+                                            another_extended.yml
+```
+
+A file can inherit from as many as you want. Trees can be nested as deep as you want.
+
+YAML files are deep merged, the latest specified child file overwrites the former ones.
+Array values are merged as well by default. You can specifiy this with the 3rd Parameter.
+
+The files to inherit from are specified by the key 'extends:' in the YAML file.
+That key can be customized if you prefer another one.
+See the examples below.
+
+## Usage
+yaml_extend adds the method YAML.ext_load_file to YAML.
+
+This method works like the original YAML.load_file, by extending it with file inheritance.
+
+### Examples
+
+#### Basic Inheritance
+Given the following both files are defined:
+
+```yaml
+# start.yml
+extends: 'super.yml'
+data:
+    name: 'Mr. Superman'
+    age: 134    
+    favorites:
+        - 'Raspberrys'
+```
+
+```yaml
+# super.yml
+data:
+    name: 'Unknown'
+    power: 2000
+    favorites:
+        - 'Bananas'
+        - 'Apples'
+```
+
+When you then call `ext_load_file`
+
+```ruby
+config = YAML.ext_load_file 'start.yml'
+```
+
+the returned YAML value results in
+
+```yaml
+data:
+    name: 'Mr. Superman'
+    age: 134
+    power: 2000
+    favorites:
+        - 'Bananas'
+        - 'Apples'
+        - 'Raspberrys'
+```
+
+#### Inherit from several files
+
+If you want to inherit from several files, you can specify a list (Array) of files.
+They are merged from top to bottom, so the latest file "wins" - that means it overwrites duplicate values if they exist with the values in the latest file where they occur.
+
+```yaml
+extends:
+    - 'super_file.yml'
+    - 'parent_file.yml'
+...
+```
+
+#### Using custom extend key
+
+If you don't want to use the default key 'extends:', you can specify your own custom key in two ways.
+
+```yaml
+#custom1.yml
+inherit_from:
+    - 'super_file.yml'
+foo: 'bar'
+...
+```
+##### 1. Specify by parameter
+You can specify the key by parameter, this is the way to go if you want to  use the different key only once or you use the `ext_load_file` method only once in your application.
+```ruby
+config = YAML.ext_load_file 'custom1.yml', 'inherit_from'
+```
+##### 2. Global configuration of the key
+You can specify the key by configuration globally. So you only need to set the key once and not as parameter anymore
+```ruby
+YAML.ext_load_key = 'inherit_from'
+config = YAML.ext_load_file 'custom1.yml'
+```
+##### Reset the global key
+To reset the global inheritance key, you can either set it to nil or call the `reset_load_key`  method.
+```ruby
+YAML.reset_load_key # more readable
+YAML.ext_load_key = nil # more explicit
+```
+#### Using custom nested extend key
+```yaml
+#custom2.yml
+options:
+    extend_file: 'super_file.yml'
+    database: false
+foo: 'bar'
+...
+```
+
+```ruby
+config = YAML.ext_load_file 'custom2.yml', ['options','extend_file']
+```
+
+## Documentation
+```ruby
+YAML.ext_load_file(yaml_path, inheritance_key='extends', options = {})
+```
+- `yaml_path` (String) relative or absolute path to yaml file to inherit from
+- `inheritance_key` (String) 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'`
+- `options` (Hash) collection of optional options, including all options of the based `deep_merge` gem
+  - `:preserve_inheritance_key` (Boolean) Preserve inheritance key(s) from resulting yaml, does most time not make sense especially in multiple inheritance - DEFAULT: false
+  - The following options are deep merge options that can be passed by - but the defaults differ from original
+    https://github.com/danielsdeleo/deep_merge#options
+  - `:preserve_unmergeables` (Boolean) Set to true to skip any unmergeable elements from source - DEFAULT: false
+  - `:knockout_prefix` (String) Set to string value to signify prefix which deletes elements from existing element - DEFAULT: nil
+  - `:overwrite_arrays` (Boolean) Set to true if you want to avoid merging arrays - DEFAULT: false
+  - `:sort_merged_arrays` (Boolean) Set to true to sort all arrays that are merged together - DEFAULT: false
+  - `:unpack_arrays` (String) Set to string value to run "Array::join" then "String::split" against all arrays - DEFAULT: nil
+  - `:merge_hash_arrays` (Boolean) Set to true to merge hashes within arrays - DEFAULT: false
+  - `:extend_existing_arrays` (Boolean) Set to true to extend existing arrays, instead of overwriting them - DEFAULT: true
+  - `:merge_nil_values` (Boolean) Set to true to merge nil hash values, overwriting a possibly non-nil value - DEFAULT: false
+  - `:merge_debug` (Boolean) Set to true to get console output of merge process for debugging - DEFAULT: false
+
+See also rubydoc at [https://www.rubydoc.info/gems/yaml_extend](https://www.rubydoc.info/gems/yaml_extend)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/magynhard/yaml_extend. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+

data/Rakefile

@@ -1,11 +1,11 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-#
-# run default task to see tasks to build and publish gem
-#
-task :default do
-  system 'rake --tasks'
-end
-
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+#
+# run default task to see tasks to build and publish gem
+#
+task :default do
+  system 'rake --tasks'
+end
+
 RSpec::Core::RakeTask.new(:spec)

data/bin/console

@@ -1,14 +1,14 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "yaml_extend"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "yaml_extend"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +1,8 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/custom_errors/invalid_key_type_error.rb

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

data/lib/yaml_extend.rb

@@ -1,130 +1,192 @@
-require 'yaml_extend/version'
-
-require 'yaml'
-require 'deep_merge/rails_compat'
-
-require_relative 'yaml_extend/yaml_extend_helper'
-
-require_relative 'custom_errors/invalid_key_type_error'
-
-#
-# Extending the YAML library to allow to inherit from another YAML file(s)
-#
-
-module YAML
-  # default path in the yaml file where the files to inherit from are defined
-  DEFAULT_INHERITANCE_KEY = 'extends'
-  @@ext_load_key = nil
-  #
-  # Set a custom inheritance key globally once.
-  # So you don't need to specify it on every call of ext_load_file()
-  #
-  # @param key [String|Array<String>|nil] the key in the yaml file, containing the file strings to extend from. Set nil or call #reset_load_key to reset the key.
-  def self.ext_load_key=(key)
-    if key.is_a?(String) || key.is_a?(Array) || key.nil?
-      @@ext_load_key = key
-    else
-      raise "Parameter 'key' must be of type String or Array<String> or nil"
-    end
-  end
-
-  #
-  # Reset the ext_load_key and use the default settings
-  #
-  def self.reset_load_key()
-    @@ext_load_key = nil
-  end
-  #
-  # Extended variant of the #load_file method by providing the 
-  # 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|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
-  #
-  # @return [Hash] the resulting yaml config 
-  #
-  def self.ext_load_file(yaml_path, inheritance_key=nil, extend_existing_arrays=true, config = {})
-    if inheritance_key.nil?
-      inheritance_key = @@ext_load_key || DEFAULT_INHERITANCE_KEY
-    end
-    total_config ||= {}
-    yaml_path = YAML.make_absolute_path yaml_path
-    super_config = YamlExtendHelper.encode_booleans YAML.load_file(File.open(yaml_path))
-    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
-      super_inheritance_files.each_with_index do |super_inheritance_file, index|
-        super_config_path = File.dirname(yaml_path) + '/' + super_inheritance_file
-        total_config = YamlExtendHelper.encode_booleans YAML.ext_load_file(super_config_path, inheritance_key, extend_existing_arrays, total_config.deeper_merge(merged_config, extend_existing_arrays: extend_existing_arrays))
-      end
-      YamlExtendHelper.decode_booleans total_config
-    else
-      delete_yaml_key inheritance_key, merged_config
-      YamlExtendHelper.decode_booleans merged_config
-    end
-  end
-
-  private
-
-  # some logic to ensure absolute file inheritance as well as 
-  # relative file inheritance in yaml files  
-  def self.make_absolute_path(file_path)
-    private_class_method
-    return file_path if YAML.absolute_path?(file_path) && File.exist?(file_path)
-    base_path = File.dirname(caller_locations[1].path)
-    return base_path + '/' + file_path if File.exist? base_path + '/' + file_path # relative path from yaml file
-    return Dir.pwd + '/' + file_path if File.exist? Dir.pwd + '/' + file_path # relative path from project
-    error_message = "Can not find absolute path of '#{file_path}'"
-    unless YAML.absolute_path? file_path
-      error_message += "\nAlso tried:\n- #{base_path + '/' + file_path}\n"\
-                       "- #{Dir.pwd + '/' + file_path}\n"
-    end
-    raise error_message
-  end
-
-  def self.absolute_path?(path)
-    private_class_method
-    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
+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)
+#
+
+module YAML
+  # default path in the yaml file where the files to inherit from are defined
+  DEFAULT_INHERITANCE_KEY = 'extends'
+  @@ext_load_key = nil
+
+  DEEP_MERGE_OPTIONS = [
+      :preserve_unmergeables,
+      :knockout_prefix,
+      :overwrite_arrays,
+      :sort_merged_arrays,
+      :unpack_arrays,
+      :merge_hash_arrays,
+      :extend_existing_arrays,
+      :merge_nil_values,
+      :merge_debug,
+  ]
+
+  #
+  # Set a custom inheritance key globally once.
+  # So you don't need to specify it on every call of ext_load_file()
+  #
+  # @param key [String|Array<String>|nil] the key in the yaml file, containing the file strings to extend from. Set nil or call #reset_load_key to reset the key.
+  def self.ext_load_key=(key)
+    if key.is_a?(String) || key.is_a?(Array) || key.nil?
+      @@ext_load_key = key
+    else
+      raise "Parameter 'key' must be of type String or Array<String> or nil"
+    end
+  end
+
+  #
+  # Reset the ext_load_key and use the default settings
+  #
+  def self.reset_load_key()
+    @@ext_load_key = nil
+  end
+
+  #
+  # Extended variant of the YAML.load_file method by providing the
+  # ability to inherit from other YAML file(s)
+  #
+  # @param [String] yaml_path the path to the yaml file to be loaded
+  # @param [String|Array] inheritance_key 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 [Hash] options to pass, including deep_merge options as well as
+  # @option options [Boolean] :preserve_inheritance_key Preserve inheritance key(s) from resulting yaml, does most time not make sense especially in multiple inheritance - DEFAULT: false
+  #
+  # deep merge options that can be passed by - but the defaults differ from original
+  # https://github.com/danielsdeleo/deep_merge#options
+  #
+  # @option options [Boolean] :preserve_unmergeables Set to true to skip any unmergeable elements from source - DEFAULT: false
+  # @option options [String] :knockout_prefix Set to string value to signify prefix which deletes elements from existing element - DEFAULT: nil
+  # @option options [Boolean] :overwrite_arrays Set to true if you want to avoid merging arrays - DEFAULT: false
+  # @option options [Boolean] :sort_merged_arrays Set to true to sort all arrays that are merged together - DEFAULT: false
+  # @option options [String] :unpack_arrays Set to string value to run "Array::join" then "String::split" against all arrays - DEFAULT: nil
+  # @option options [Boolean] :merge_hash_arrays Set to true to merge hashes within arrays - DEFAULT: false
+  # @option options [Boolean] :extend_existing_arrays Set to true to extend existing arrays, instead of overwriting them - DEFAULT: true
+  # @option options [Boolean] :merge_nil_values Set to true to merge nil hash values, overwriting a possibly non-nil value - DEFAULT: false
+  # @option options [Boolean] :merge_debug Set to true to get console output of merge process for debugging - DEFAULT: false
+  #
+  # @param  [Boolean] options Fallback for backward compatiblity: extend existing arrays instead of replacing them (deep_merge)
+  # @return [Hash] the resulting yaml config 
+  #
+  def self.ext_load_file(yaml_path, inheritance_key = nil, options = {})
+    YAML.ext_load_file_recursive(yaml_path, inheritance_key, options, {})
+  end
+
+  private
+
+  #
+  # @param config [Hash] a hash to be merged into the result, usually only recursivly called by the method itself
+  #
+  def self.ext_load_file_recursive(yaml_path, inheritance_key, options = {}, config)
+    # backward compatibility to 1.0.1
+    if options == true || options == false
+      options = {extend_existing_arrays: options}
+    end
+    default_options = {
+        preserve_inheritance_key: false,
+        preserve_unmergeables: false,
+        knockout_prefix: nil,
+        overwrite_arrays: false,
+        sort_merged_arrays: false,
+        unpack_arrays: nil,
+        merge_hash_arrays: false,
+        extend_existing_arrays: true,
+        merge_nil_values: false,
+        merge_debug: false,
+    }
+    options = default_options.merge options
+    private_class_method
+    if inheritance_key.nil?
+      inheritance_key = @@ext_load_key || DEFAULT_INHERITANCE_KEY
+    end
+    total_config = config.clone
+
+    yaml_path = YAML.make_absolute_path yaml_path
+    super_config = YAML.load_file(File.open(yaml_path))
+    super_inheritance_files = yaml_value_by_key inheritance_key, super_config
+    unless options[:preserve_inheritance_key]
+      delete_yaml_key inheritance_key, super_config # we don't merge the super inheritance keys into the base yaml
+    end
+
+    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
+      super_inheritance_files.each_with_index do |super_inheritance_file, index|
+        # Extend a YAML path in an absolute directory
+        if YAML.absolute_path?(super_inheritance_file)
+          super_config_path = YAML.make_absolute_path(super_inheritance_file)
+          # Extend a YAML path in a relative directory
+        else
+          super_config_path = File.dirname(yaml_path) + '/' + super_inheritance_file
+        end
+        total_config = YAML.ext_load_file_recursive(super_config_path, inheritance_key, options, total_config)
+      end
+    end
+    deep_merge_options = options.select { |k, v| DEEP_MERGE_OPTIONS.include? k }
+    total_config.deeper_merge!(super_config, deep_merge_options)
+  end
+
+  # some logic to ensure absolute file inheritance as well as 
+  # relative file inheritance in yaml files  
+  def self.make_absolute_path(file_path)
+    private_class_method
+    return file_path if YAML.absolute_path?(file_path) && File.exist?(file_path)
+    # caller_locations returns the current execution stack
+    #   [0] is the call from ext_load_file_recursive,
+    #   [1] is inside ext_load_file,
+    #   [2] is the exteranl caller of YAML.ext_load_file
+    base_path = File.dirname(caller_locations[2].path)
+    return base_path + '/' + file_path if File.exist? base_path + '/' + file_path # relative path from yaml file
+    return Dir.pwd + '/' + file_path if File.exist? Dir.pwd + '/' + file_path # relative path from project
+    error_message = "Can not find absolute path of '#{file_path}'"
+    unless YAML.absolute_path? file_path
+      error_message += "\nAlso tried:\n- #{base_path + '/' + file_path}\n"\
+                       "- #{Dir.pwd + '/' + file_path}\n"
+    end
+    raise error_message
+  end
+
+  def self.absolute_path?(path)
+    private_class_method
+    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

data/lib/yaml_extend/version.rb

@@ -1,3 +1,3 @@
-module YamlExtend
-  VERSION = '0.2.4'.freeze
-end
+module YamlExtend
+  VERSION = '1.0.3'.freeze
+end

data/yaml_extend.gemspec

@@ -1,37 +1,37 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'yaml_extend/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "yaml_extend"
-  spec.version       = YamlExtend::VERSION
-  spec.authors       = ["Matthäus Beyrle"]
-  spec.email         = ["yaml_extend.gemspec@mail.magynhard.de"]
-
-  spec.summary       = %q{Extends YAML to support file based inheritance}
-  spec.homepage      = "https://github.com/magynhard/yaml_extend"
-  spec.license       = "MIT"
-
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "https://rubygems.org"
-  else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
-  end
-
-  spec.files = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  spec.add_dependency 'deep_merge', '~> 1.1'
-
-  spec.add_development_dependency 'bundler',  '>= 1.14'
-  spec.add_development_dependency 'rake',     '~> 10.0'
-  spec.add_development_dependency 'rspec',    '~> 3.0'
-end
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yaml_extend/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "yaml_extend"
+  spec.version       = YamlExtend::VERSION
+  spec.authors       = ["Matthäus Beyrle"]
+  spec.email         = ["yaml_extend.gemspec@mail.magynhard.de"]
+
+  spec.summary       = %q{Extends YAML to support file based inheritance}
+  spec.homepage      = "https://github.com/magynhard/yaml_extend"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'deep_merge', '~> 1.1'
+
+  spec.add_development_dependency 'bundler',  '>= 1.14'
+  spec.add_development_dependency 'rake',     '>= 10.0'
+  spec.add_development_dependency 'rspec',    '>= 3.0'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yaml_extend
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 1.0.3
 platform: ruby
 authors:
 - Matthäus Beyrle
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-02-28 00:00:00.000000000 Z
+date: 2020-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -42,31 +42,31 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
+description:
 email:
 - yaml_extend.gemspec@mail.magynhard.de
 executables: []
@@ -86,14 +86,13 @@ files:
 - lib/custom_errors/invalid_key_type_error.rb
 - lib/yaml_extend.rb
 - lib/yaml_extend/version.rb
-- lib/yaml_extend/yaml_extend_helper.rb
 - yaml_extend.gemspec
 homepage: https://github.com/magynhard/yaml_extend
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -108,9 +107,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: Extends YAML to support file based inheritance
 test_files: []

data/lib/yaml_extend/yaml_extend_helper.rb

@@ -1,68 +0,0 @@
-
-#
-# This class includes a workaround patch, providing a solution of the unaccepted pull request
-# 'false is not overriden by true if preserve_unmergeables'
-# https://github.com/danielsdeleo/deep_merge/pull/28
-#
-# It ensures, that booleans can be merged correctly, by en- and decoding them to strings, before and after merging
-# see #encode_boolens and #decode_booleans
-#
-
-class YamlExtendHelper
-
-  TRUE_CLASS_ENCODED = '#={TrueClass}=#'
-  FALSE_CLASS_ENCODED = '#={FalseClass}=#'
-
-  def self.encode_booleans(hash)
-    hash.each_with_object({}) do |(k,v),g|
-      g[k] = if v.is_a? Hash
-               YamlExtendHelper.encode_booleans(v)
-             elsif v.is_a? Array
-               v.each_with_index do |av, ai|
-                  v[ai] = if av.is_a? Hash
-                            YamlExtendHelper.encode_booleans(av)
-                          elsif av.is_a? TrueClass
-                            TRUE_CLASS_ENCODED
-                          elsif av.is_a? FalseClass
-                            FALSE_CLASS_ENCODED
-                          else
-                            av
-                          end
-               end
-             elsif v.is_a? TrueClass
-               TRUE_CLASS_ENCODED
-             elsif v.is_a? FalseClass
-               FALSE_CLASS_ENCODED
-             else
-               v
-             end
-    end
-  end
-
-  def self.decode_booleans(hash)
-    hash.each_with_object({}) do |(k,v),g|
-      g[k] = if v.is_a? Hash
-               YamlExtendHelper.decode_booleans(v)
-             elsif v.is_a? Array
-               v.each_with_index do |av, ai|
-                 v[ai] = if av.is_a? Hash
-                           YamlExtendHelper.decode_booleans(av)
-                         elsif av === TRUE_CLASS_ENCODED
-                           true
-                         elsif av === FALSE_CLASS_ENCODED
-                           false
-                         else
-                           av
-                         end
-               end
-             elsif v === TRUE_CLASS_ENCODED
-               true
-             elsif v === FALSE_CLASS_ENCODED
-               false
-             else
-               v
-             end
-    end
-  end
-
-end