yaml_extensions 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3c70c36c6334a48be6abb0efdad9dd6a5f5927362d9dabb609b28a0e37d4bb1b
+  data.tar.gz: 50a61007d447a40d7189ee5733bfd3c14613aacd9b3397f4a5f83fc2951ee8d2
+SHA512:
+  metadata.gz: e162f9c0f312262c79a270d1d7a5779340d302025c0ec6109b456241ca484a062ef4b50680be7fd4d1a25f6f805d40a7c8032aa9d628cacffc04b4a6f296e905
+  data.tar.gz: d31b63c17381277fb188fa7c30c8a432c7d73b54f2f155ca64d9512eef7a55f0b6b77df2603fa3f2edf47b0d2485530b25ffc03cd70593092cb67798b370133e

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

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 info@200ok.ch. 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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in yaml_extensions.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'minitest', '~> 5.0'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 200ok GmbH, Switzerland
+
+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.org

@@ -0,0 +1,165 @@
+* YamlExtensions
+  :PROPERTIES:
+  :CUSTOM_ID: yamlextensions
+  :END:
+
+Extensions to make YAML even more useful.
+
+** Installation
+   :PROPERTIES:
+   :CUSTOM_ID: installation
+   :END:
+
+Add this line to your application's Gemfile:
+
+#+BEGIN_SRC ruby
+  gem 'yaml_extensions'
+#+END_SRC
+
+And then execute:
+
+#+BEGIN_EXAMPLE
+  $ bundle install
+#+END_EXAMPLE
+
+Or install it yourself as:
+
+#+BEGIN_EXAMPLE
+  $ gem install yaml_extensions
+#+END_EXAMPLE
+
+** Usage
+   :PROPERTIES:
+   :CUSTOM_ID: usage
+   :END:
+
+Just require =yaml_extensions=. For now this will [[https://twitter.com/dhh/status/813075241236762624][freedom patch]] the
+YAML module to extend its functionality.
+
+#+begin_src ruby
+require 'yaml_extensions'
+#+end_src
+
+Deep Merge any key-value-list by replacing YAML's regular Merge Key
+=<<= with =<<<=. Example:
+
+#+begin_src yaml
+defaults: &DEFAULTS
+  hello: world
+  this:
+    is:
+      even: deeper
+
+main:
+  <<<: *DEFAULTS
+  this:
+    is:
+     somewhat: deep
+#+end_src
+
+will be interpreted as
+
+#+begin_src yaml
+defaults:
+  hello: world
+  this:
+    is:
+      even: deeper
+
+main:
+  this:
+    is:
+      somewhat: deep
+      even: deeper
+  hello: world
+#+end_src
+
+This does not acutally patch the parser, but runs a transformation on
+the already parse data structure. Multiple deep merges can be achieved
+by appending digits to =<<<=. Exmaple:
+
+#+begin_src yaml
+defaults: &DEFAULTS
+  hello: world
+  this:
+    is:
+      even: deeper
+
+overrides: &OVERRIDES
+  this:
+    is:
+      even: deeper, i tell you
+
+main:
+  <<<1: *DEFAULTS
+  <<<2: *OVERRIDES
+  this:
+    is:
+     somewhat: deep
+#+end_src
+
+will be interpreted as
+
+#+begin_src yaml
+defaults:
+  hello: world
+  this:
+    is:
+      even: deeper
+
+overrides:
+  this:
+    is:
+      even: deeper, i tell you
+
+main:
+  this:
+    is:
+      somewhat: deep
+      even: deeper, i tell you
+  hello: world
+#+end_src
+
+** Development
+   :PROPERTIES:
+   :CUSTOM_ID: development
+   :END:
+
+After checking out the repo, run =bin/setup= to install dependencies.
+Then, run =rake test= to run the tests. You can also run =bin/console=
+for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run
+=bundle exec rake install=. To release a new version, update the version
+number in =version.rb=, and then run =bundle exec rake release=, which
+will create a git tag for the version, push git commits and tags, and
+push the =.gem= file to [[https://rubygems.org][rubygems.org]].
+
+** Contributing
+   :PROPERTIES:
+   :CUSTOM_ID: contributing
+   :END:
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/200ok-ch/yaml_extensions. This project is intended to
+be a safe, welcoming space for collaboration, and contributors are
+expected to adhere to the
+[[https://github.com/branch14/yaml_extensions/blob/master/CODE_OF_CONDUCT.md][code of conduct]].
+
+** License
+   :PROPERTIES:
+   :CUSTOM_ID: license
+   :END:
+
+The gem is available as open source under the terms of the
+[[https://opensource.org/licenses/MIT][MIT License]].
+
+** Code of Conduct
+   :PROPERTIES:
+   :CUSTOM_ID: code-of-conduct
+   :END:
+
+Everyone interacting in the YamlExtensions project's codebases, issue
+trackers, chat rooms and mailing lists is expected to follow the
+[[https://github.com/200ok-ch/yaml_extensions/blob/master/CODE_OF_CONDUCT.md][code
+of conduct]].

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "yaml_extensions"
+
+# 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_extensions/version.rb

@@ -0,0 +1,3 @@
+module YamlExtensions
+  VERSION = "0.1.0"
+end

data/lib/yaml_extensions.rb

@@ -0,0 +1,51 @@
+require 'yaml'
+
+require 'yaml_extensions/version'
+
+class Hash
+  def deep_merge!(other_hash, &block)
+    merge!(other_hash) do |key, this, that|
+      if this.is_a?(Hash) && that.is_a?(Hash)
+        this.deep_merge!(that, &block)
+      elsif block_given?
+        yield(key, this, that)
+      else
+        that
+      end
+    end
+  end
+
+  def walk(&block)
+    reduce({}) do |aggregator, entry|
+      key, val = entry
+      nval = val.class.method_defined?(:walk) ? val.walk(&block) : val
+      aggregator.merge(key => nval)
+    end.tap { |result| yield(result) if block_given? }
+  end
+end
+
+class Array
+  def walk(&block)
+    map { |e| e.class.method_defined?(:walk) ? e.walk(&block) : e }
+  end
+end
+
+module YamlExtensions
+  def load(*args)
+    super(*args).walk do |h|
+      h.keys.sort.reverse_each do |key|
+        if key =~ /^<<<\d*$/
+          h.deep_merge!(h.delete(key)) { |_, this, _| this }
+        end
+      end
+    end
+  end
+end
+
+module YAML
+  class << self
+    prepend YamlExtensions
+  end
+end
+
+puts YAML.dump(YAML.load(ARGF.read)) if $PROGRAM_NAME == __FILE__

data/yaml_extensions.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/yaml_extensions/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'yaml_extensions'
+  spec.version       = YamlExtensions::VERSION
+  spec.authors       = ['Phil Hofmann']
+  spec.email         = ['phil@200ok.ch']
+
+  spec.summary       = %q{Extensions to make YAML even more useful}
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = 'https://github.com/200ok-ch/yaml_extensions'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  # spec.metadata['changelog_uri'] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |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']
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: yaml_extensions
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Phil Hofmann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-07-23 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- phil@200ok.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.org
+- Rakefile
+- bin/console
+- bin/setup
+- lib/yaml_extensions.rb
+- lib/yaml_extensions/version.rb
+- yaml_extensions.gemspec
+homepage: https://github.com/200ok-ch/yaml_extensions
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/200ok-ch/yaml_extensions
+  source_code_uri: https://github.com/200ok-ch/yaml_extensions
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Extensions to make YAML even more useful
+test_files: []