yaml_extend 0.2.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf470b2008a115bd29099864f2906f56f0c2a665
-  data.tar.gz: 7fd428b80b59c950cfc9ea26db2db35af2653174
+  metadata.gz: 8de4a06253714132d952fcaebc2592ef5410fe38
+  data.tar.gz: 6fb4e757d42962afa2d85e4fe754a83e0584e204
 SHA512:
-  metadata.gz: 2bf43ffb90add13d47f8fd37de9fee408175a3c292d8552fc050155490bb0355acaf8384818eb174a25d29d1967c311dbdc690c161b2ea337e0578342b4530ff
-  data.tar.gz: 583ba753e530b4dd5de049448382f6413c7928e03474d295b51a5f20093e5df316192561257bc6ade629fb2fe80fe38e9661cad1c69452b440095d018de424e4
+  metadata.gz: db63a4f3749846aa07412dbc8f95738f9cd43c6aa19ef45dee3b6cd098da66afd16739f3a6e74e0d5cc6188030ec57bd78b874583a8a5ea158350757322a7b8a
+  data.tar.gz: 9c1a44b1075bab488ce5f02b40ba20cc9afac1d5da487f6dcddf5f7f48acabeb1d980865d5f36c2c1b80658feaffb281096f523a9e74811c234e981081aa2092

data/README.md

@@ -48,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
 
@@ -77,7 +77,7 @@ data:
         - 'Apples'
 ```
 
-When you then call #ext_load_file
+When you then call `ext_load_file`
 
 ```ruby
 config = YAML.ext_load_file 'start.yml'
@@ -120,7 +120,7 @@ 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
 config = YAML.ext_load_file 'custom1.yml', 'inherit_from'
 ```
@@ -131,7 +131,7 @@ 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.
+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
@@ -151,12 +151,11 @@ 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
 

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,59 @@ 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))
+        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.5'.freeze
+  VERSION = '1.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yaml_extend
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Matthäus Beyrle
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-26 00:00:00.000000000 Z
+date: 2019-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -86,7 +86,6 @@ 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:
@@ -109,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14.3
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Extends YAML to support file based inheritance

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