yaml_extend 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 053aef54e93b410f7b2eb373834abff17b4f1a2627d292f2eacb479fb78d4d9b
-  data.tar.gz: 70dd53ab46254a6dfed23530c74e3668d14a81844792ac980d4c03b0fb141d24
+  metadata.gz: e62864fb3a63fe8c957b6fc2a2432eeb67da44c5ff278aa00a4a9935c37fd7fd
+  data.tar.gz: 8156d6c5bd7d13d6753fbaecd86eb07f5e59791f7fa4bb790c0e3b1232408a6f
 SHA512:
-  metadata.gz: 390f032971732ece98f75c58bf471da9ce8085918cbedcf40fd840087a30e45da8a0db7df2fc06030d965ac9b0dae170f2745cdcacb09cf30b2acbcfe9d4118a
-  data.tar.gz: de9bfd1e7e9e2bf45f6783f387284720fdc54db997a6ba9f0eacf4b03a57f6fd2deb9c3596b868e81695da39873c277beefaee3d99ad7b31ffee103d4e208cfd
+  metadata.gz: 54a2f706e91c582c96a03c41567395a783bda1690adaff69866777f5dc77cb70da340055ff27b9a9219bf2cb361c54b52c49c297327d48b315d085d9b1eda900
+  data.tar.gz: c955e1c7c7055fb626fa13b8f77f916107ad67478a76758b3c9251dc0245ed84bed77c431ccce690014a4da6e54d872b0420f788f32b8fde334e127859f1e80e

data/README.md

@@ -1,6 +1,6 @@
 # yaml_extend
-![Gem](https://img.shields.io/gem/v/yaml_extend?color=default&style=plastic&logo=ruby&logoColor=red)
-![Gem](https://img.shields.io/gem/dt/yaml_extend?color=blue&style=plastic)
+[![Gem](https://img.shields.io/gem/v/yaml_extend?color=default&style=plastic&logo=ruby&logoColor=red)](https://rubygems.org/gems/yaml_extend)
+![downloads](https://img.shields.io/gem/dt/yaml_extend?color=blue&style=plastic)
 [![License: MIT](https://img.shields.io/badge/License-MIT-gold.svg?style=plastic&logo=mit)](LICENSE)
 
 > Extends YAML to support file based inheritance.
@@ -9,22 +9,19 @@ That can be very handy to build a configuration hierarchy.
 
 Basic support for ERB (embedded ruby) is included and automatically applied when config files are named `*.erb` or `*.erb.*`.
 
-## Installation
+If you are just doing administration without knowing ruby, you can also just use the command line tool that is included to use this librarys features. Ensure, that [ruby](https://www.ruby-lang.org/) is installed on your system, before following further instructions. 
 
-Add this line to your application's Gemfile:
+### Contents
+* [Common information](#common-information)
+* [Installation](#installation)
+* [Usage](#usage)
+* [Command line](#command-line)
+* [Documentation](#documentation)
+* [Contributing](#contributing)
 
-```ruby
-gem 'yaml_extend'
-```
 
-And then execute:
 
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install yaml_extend
-    
+<a name="common-information"></a>    
 ## Common information
 
 It is possible to build inheritance trees like:
@@ -52,6 +49,32 @@ 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.
 
+
+
+
+<a name="installation"></a>
+## Installation
+### Ruby
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yaml_extend'
+```
+
+And then execute:
+
+    $ bundle install
+
+### Command line
+If you just want to use the command line then run
+
+    $ gem install yaml_extend
+
+
+
+
+
+<a name="usage"></a>
 ## Usage
 yaml_extend adds the method YAML.ext_load_file to YAML.
 
@@ -155,6 +178,29 @@ foo: 'bar'
 config = YAML.ext_load_file 'custom2.yml', ['options','extend_file']
 ```
 
+
+
+<a name="command-line"></a>
+## Command line
+
+`yaml_extend` is also available on the command line after installation.
+
+To parse and merge a prepared YAML file, just run
+
+```
+yaml_extend path/to/my/yaml_file.yml
+```
+
+Usually you might want to put the result into resulting YAML file. So just use the basic command line features to do so:
+
+
+```
+yaml_extend path/to/my/yaml_file.yml > combined_yaml.yml
+```
+
+
+
+<a name="documentation"></a>
 ## Documentation
 ```ruby
 YAML.ext_load_file(yaml_path, inheritance_key='extends', options = {})
@@ -177,7 +223,9 @@ YAML.ext_load_file(yaml_path, inheritance_key='extends', options = {})
 
 See also rubydoc at [https://www.rubydoc.info/gems/yaml_extend](https://www.rubydoc.info/gems/yaml_extend)
 
-## Contributing
 
+
+<a name="documentation"></a>
+## 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/bin/yaml_extend

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+require 'yaml_extend'
+
+arg = ARGV[0]
+
+if %w[help -h --help].include?(arg) || arg.nil? || arg == ''
+  puts <<-TEXT
+    
+    yaml_extend #{YamlExtend::VERSION}
+    https://github.com/magynhard/yaml_extend
+
+    yaml_extend -h --help     # show this info
+    yaml_extend <file>        # parse and output given file
+
+  TEXT
+else
+  puts YAML.ext_load_file(arg).to_yaml
+end

data/bin/yaml_extend.bat

@@ -0,0 +1,2 @@
+@ECHO OFF
+@"%~dp0ruby.exe" "%~dpn0" %*

data/lib/yaml_extend/version.rb

@@ -1,3 +1,3 @@
 module YamlExtend
-  VERSION = '1.2.0'.freeze
+  VERSION = '1.3.0'.freeze
 end

data/lib/yaml_extend.rb

@@ -15,15 +15,15 @@ module YAML
   @@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,
+    :preserve_unmergeables,
+    :knockout_prefix,
+    :overwrite_arrays,
+    :sort_merged_arrays,
+    :unpack_arrays,
+    :merge_hash_arrays,
+    :extend_existing_arrays,
+    :merge_nil_values,
+    :merge_debug,
   ]
 
   #
@@ -86,19 +86,19 @@ module YAML
     yaml_path = yaml_path.to_s
     # backward compatibility to 1.0.1
     if options == true || options == false
-      options = {extend_existing_arrays: options}
+      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,
+      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
@@ -111,9 +111,17 @@ module YAML
 
     super_config =
       if yaml_path.match(/(\.erb\.|\.erb$)/)
-        YAML.unsafe_load(ERB.new(File.read(yaml_path)).result)
+        if YAML.respond_to? :unsafe_load # backward compatibility for Ruby 3.1 / Psych 4
+          YAML.unsafe_load(ERB.new(File.read(yaml_path)).result)
+        else
+          YAML.load(ERB.new(File.read(yaml_path)).result)
+        end
       else
-        YAML.unsafe_load_file(File.open(yaml_path))
+        if YAML.respond_to? :unsafe_load_file # backward compatibility for Ruby 3.1 / Psych 4
+          YAML.unsafe_load_file(File.open(yaml_path))
+        else
+          YAML.load_file(File.open(yaml_path))
+        end
       end
 
     super_inheritance_files = yaml_value_by_key inheritance_key, super_config
@@ -149,7 +157,8 @@ module YAML
     #   [2] is the external caller of YAML.ext_load_file
     base_path = if defined?(caller_locations)
                   File.dirname(caller_locations[2].path)
-                else # Fallback for ruby < 2.1.10
+                else
+                  # Fallback for ruby < 2.1.10
                   File.dirname(caller[2])
                 end
     return base_path + '/' + file_path if File.exist? base_path + '/' + file_path # relative path from yaml file
@@ -165,7 +174,7 @@ module YAML
   def self.absolute_path?(path)
     private_class_method
     path.start_with?('/') || # unix like
-        (path.length >= 3 && path[1] == ':') # ms windows
+      (path.length >= 3 && path[1] == ':') # ms windows
   end
 
   # Return the value of the corresponding key
@@ -187,7 +196,7 @@ module YAML
 
   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.")
+      raise(InvalidKeyTypeError, "Invalid key of type '#{key.class.name}'. Valid types are String and Array.")
   end
 
   def self.delete_yaml_key(key, config)

data/yaml_extend.gemspec

@@ -6,6 +6,7 @@ require 'yaml_extend/version'
 Gem::Specification.new do |spec|
   spec.name          = "yaml_extend"
   spec.version       = YamlExtend::VERSION
+  spec.executables   = %w[yaml_extend]
   spec.authors       = ["Matthäus Beyrle"]
   spec.email         = ["yaml_extend.gemspec@mail.magynhard.de"]
 
@@ -25,7 +26,7 @@ Gem::Specification.new do |spec|
   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']
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yaml_extend
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Matthäus Beyrle
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2022-07-19 00:00:00.000000000 Z
+date: 2023-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -83,6 +83,8 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- bin/yaml_extend
+- bin/yaml_extend.bat
 - lib/custom_errors/invalid_key_type_error.rb
 - lib/yaml_extend.rb
 - lib/yaml_extend/version.rb
@@ -107,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Extends YAML to support file based inheritance