yaml_extend 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b815a64857ec9c62d277b3f34d31bca9c571ac27
+  data.tar.gz: 36d0262f07cb5e3b8a1aad7cedb50fd3573f29ad
+SHA512:
+  metadata.gz: 8bf158f5a460b3126783673108c4c8c19b44e190439c09e9f7f75dcd0a2fa39160bb8dd4c1e75234163f5b544a66bc3025d12002fa62090ab593c650a172e382
+  data.tar.gz: ae4f1f62d722cba7bcc5d3f282d0f61eee8e88aef52a9df516fce04ac359f7f3a424d39234397eedf94560a44d3d51cbed53b85522ff737286c1453627255faa

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +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 m.beyrle@walz.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

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

data/LICENSE

@@ -0,0 +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.

data/README.md

@@ -0,0 +1,95 @@
+# yaml_extend
+
+Extends YAML to support file based inheritance,
+to e.g. to build a configuration hierachy.
+
+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.
+The child file overwrites same values if given in the parent file.
+
+## 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
+
+## 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
+
+
+```
+# start.yml
+extends: 'super.yml'
+data:
+    name: 'Mr. Superman'
+    age: 134    
+    favorites:
+        - 'Raspberrys'
+```
+
+```
+# super.yml
+data:
+    name: 'Unknown'
+    power: 2000
+    favorites:
+        - 'Bananas'
+        - 'Apples'
+```
+
+YAML.ext_load_file('start.yml')
+
+results in
+
+```
+data:
+    name: 'Mr. Superman'
+    age: 134
+    power: 2000
+    favorites:
+        - 'Bananas'
+        - 'Apples'
+        - 'Raspberrys'
+```
+
+#### Inherit from several files
+
+```
+extends:
+    - 'super_file.yml'
+    - 'parent_file.yml'
+...
+```
+
+## 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'
+- *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.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +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__)

data/bin/setup

@@ -0,0 +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

data/lib/yaml_extend/version.rb

@@ -0,0 +1,3 @@
+module YamlExtend
+  VERSION = '0.0.6'.freeze
+end

data/lib/yaml_extend.rb

@@ -0,0 +1,65 @@
+require "yaml_extend/version"
+
+require 'yaml'
+require 'deep_merge/rails_compat'
+
+require 'yaml'
+require 'deep_merge/rails_compat'
+
+#
+# Extending the YAML library to allow to inherit from another YAML files
+#
+
+module YAML
+  #
+  # Extended variant of the #load_file method by providing the 
+  # ability to inherit from other YAML files.
+  #
+  # @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 config [Hash] a hash to be merged into the result, usually recursivly called by the method itself
+  #
+  def self.ext_load_file(yaml_path, inheritance_key='extends', extend_existing_arrays=true, config = {})
+    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
+    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 = 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
+      total_config
+    else
+      merged_config.delete(inheritance_key)
+      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
+end

data/yaml_extend.gemspec

@@ -0,0 +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       = ["Beyrle, Matth\xC3\xA4us"]
+  spec.email         = ["post@entwanderer.de"]
+
+  spec.summary       = %q{Extends YAML to support file based inheritance}
+  spec.homepage      = "https://github.com/entwanderer/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

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: yaml_extend
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+platform: ruby
+authors:
+- Beyrle, Matthäus
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: deep_merge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  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: 
+email:
+- post@entwanderer.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/yaml_extend.rb
+- lib/yaml_extend/version.rb
+- yaml_extend.gemspec
+homepage: https://github.com/entwanderer/yaml_extend
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Extends YAML to support file based inheritance
+test_files: []