yaml_extend 0.2.2 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20c49d0c410649ca4b03ee48eb01bffe73657318ef58a445f5540e477050ae38
-  data.tar.gz: b02a716589f2efcd3657f4fe887b8839f95252516ce4f26bc3a43ec16fe23dca
+  metadata.gz: 709ab41867197b612c61535154fe7e65bad1354c7605417d0fcad1601d45c134
+  data.tar.gz: 72f4e212f76e450b96420bb61eeff03aa2e7dc685c6600312ebc767b34987c80
 SHA512:
-  metadata.gz: 1918b8ee81d0d1ba88ac69153ed4c84f857137d4c1115fcc902cefc5d1de021fe1a790158527b3878fbeda60f3e3c7a3a64a8ceb3e304646742d5a61687eb91a
-  data.tar.gz: e5925aa2497aa1b03557fbfa2d1a8e0f0699aab664f4051b7565027e5beeee9ff2f0153c8a48790d1e2c87cb6433287e978dbca18d73e042a7ca42bdd655a1fd
+  metadata.gz: aebb3c47f6b90557ac6683ed673a036a3b05a469b543c7bf4b3eb07108ff721410a6a5e57b5fa3a643360fe27cf59f3eb99b724a98f8bd483c34159d1d40956e
+  data.tar.gz: e15f2449c5c4d93abb0ba1a56cde3928fd06a7219d2cedb6ee20290cabc8fe1c2a27ecd976a04558395b26e26ab42c60f080595ca458c337996861313b532494

data/CODE_OF_CONDUCT.md

@@ -55,7 +55,7 @@ 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 m.beyrle@walz.de. All
+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.

data/README.md

@@ -22,11 +22,20 @@ Or install it yourself as:
     
 ## Common information
 
-It is possible to build inheritance trees like
+It is possible to build inheritance trees like:
 ```
-default.yml   english.yml          default.yml   german.yml         de.yml
-         \    /                             \    /                    |
-          uk.yml                            de.yml                  at.yml
+     defaults.yml   
+  ________\_________    
+  \        \        \                         
+ dev.yml  int.yml  prod.yml                   
+```
+or like this:
+```
+default.yml   english.yml          default.yml   german.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.
@@ -39,9 +48,9 @@ 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.
+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.
+This method works like the original YAML.load_file, by extending it with file inheritance.
 
 ### Examples
 
@@ -68,10 +77,10 @@ data:
         - 'Apples'
 ```
 
-When you then call #ext_load_file
+When you then call `ext_load_file`
 
 ```ruby
-YAML.ext_load_file 'start.yml'
+config = YAML.ext_load_file 'start.yml'
 ```
 
 the returned YAML value results in
@@ -111,19 +120,18 @@ 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.
+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'
+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'
-YAML.ext_load_file 'custom1.yml'
-YAML.ext_load_file 'custom2.yml'
+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.
+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
@@ -139,18 +147,17 @@ foo: 'bar'
 ```
 
 ```ruby
-YAML.ext_load_file 'custom2.yml', ['options','extend_file']
+config = 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.ext_load_file(yaml_path, inheritance_key='extends', extend_existing_arrays=true)
 
 - *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/entwanderer/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.
+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/lib/yaml_extend.rb

@@ -3,8 +3,6 @@ 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'
 
 #
@@ -34,50 +32,65 @@ module YAML
   def self.reset_load_key()
     @@ext_load_key = nil
   end
+
   #
-  # Extended variant of the #load_file method by providing the 
+  # Extended variant of the YAML.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 = {})
+  def self.ext_load_file(yaml_path, inheritance_key=nil, extend_existing_arrays=true)
+    YAML.ext_load_file_recursive(yaml_path, inheritance_key, extend_existing_arrays, {})
+  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, extend_existing_arrays, config)
+    private_class_method
     if inheritance_key.nil?
       inheritance_key = @@ext_load_key || DEFAULT_INHERITANCE_KEY
     end
-    total_config ||= {}
+    total_config = config.clone
+    
     yaml_path = YAML.make_absolute_path yaml_path
-    super_config = YamlExtendHelper.encode_booleans YAML.load_file(File.open(yaml_path))
+    super_config = 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))
+        # 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, extend_existing_arrays, total_config)
       end
-      YamlExtendHelper.decode_booleans total_config
-    else
-      delete_yaml_key inheritance_key, merged_config
-      YamlExtendHelper.decode_booleans merged_config
     end
+    total_config.deeper_merge!(super_config, extend_existing_arrays: extend_existing_arrays)
   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)
+    # 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
+    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"\

data/lib/yaml_extend/version.rb

@@ -1,3 +1,3 @@
 module YamlExtend
-  VERSION = '0.2.2'.freeze
+  VERSION = '1.0.1'.freeze
 end

data/yaml_extend.gemspec

@@ -6,11 +6,11 @@ require 'yaml_extend/version'
 Gem::Specification.new do |spec|
   spec.name          = "yaml_extend"
   spec.version       = YamlExtend::VERSION
-  spec.authors       = ["Matth\xC3\xA4us Beyrle"]
-  spec.email         = ["post@entwanderer.de"]
+  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/entwanderer/yaml_extend"
+  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'
@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
 
   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'
+  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.2
+  version: 1.0.1
 platform: ruby
 authors:
 - Matthäus Beyrle
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-05-27 00:00:00.000000000 Z
+date: 2020-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -28,47 +28,47 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.14'
 - !ruby/object:Gem::Dependency
   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:
-- post@entwanderer.de
+- yaml_extend.gemspec@mail.magynhard.de
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -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/entwanderer/yaml_extend
+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.7
-signing_key: 
+rubygems_version: 3.1.3
+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