mini_hiera 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 58140d759970bf1df9fe100deb1038373381332454f0166c6bb5180db2737475
+  data.tar.gz: 233d512135e1810c0f0b7bd8f0ea5b978f830f453ae29fa2c53d303f51937c55
+SHA512:
+  metadata.gz: ad21f9f936a310d972cab8f87ff46d0da844b4c96d516694a94ff5f4849b3964e810c1739b53dcf5bdcfe6795636ed472071a758b9417fcf2180225be434f17d
+  data.tar.gz: 5e69af08a797e2812e18ff73853a7069946112f6036ec97c88b9e01392cc246d19493158d023aa73dd327d68a5e1479e0a488c2ff530c0c947a41f9588c8b574

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in mini_hiera.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    mini_hiera (0.1.0)
+      deep_merge (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    deep_merge (1.2.1)
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  mini_hiera!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Thomas Haggett
+
+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,59 @@
+# Mini Hiera
+
+Puppet's Hiera library felt usable as a free-standing hierarchial key lookup library, but they pulled the source back into the Puppet codebase, thereby limiting any potential use outside Puppet itself.
+
+This is a free-standing gem that clean-room implements the behaviour of Hiera such that it can be used in any project.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mini_hiera'
+```
+
+## Usage
+
+The simplest way to use this gem is to provide a directory of `YAML` files and configure a hierarchy in code:
+
+```yaml
+config/device/device1.yaml:
+test_key: "loaded from device/device1.yaml"
+
+config/device/device2.yaml:
+test_key: "loaded from device/device2.yaml"
+
+config/site/site1.yaml
+test_key: "loaded from site/site1.yaml"
+
+config/type/typeA.yaml
+test_key: "loaded from type/typeA.yaml"
+
+config/common.yaml
+test_key: "loaded from common.yaml"
+```
+
+```ruby
+config = MiniHiera.new('path/to/config', hierarchy: [
+  'device/%{name}',
+  'site/%{site}',
+  'type/%{type}',
+  'common'
+])
+```
+
+Specific usage of this library can be found demonstrated in the `spec/usage_spec.rb`, which can be executed to ensure it's still accurate!
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/joshado/mini_hiera.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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 "mini_hiera"
+
+# 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/mini_hiera.rb

@@ -0,0 +1,132 @@
+require "mini_hiera/version"
+require 'deep_merge'
+
+module Enumerable
+  def find_value(ifnone=nil, &block)
+    each { |*v| o = block.call(*v) and return(o) }
+    ifnone
+  end
+end
+
+class MiniHiera
+  CircularReferenceError = Class.new(RuntimeError)
+  KeyNotFoundError = Class.new(RuntimeError)
+
+  attr_reader :config, :options
+  def initialize(config, options={})
+    @config = config
+    @options = options
+  end
+
+  class Context
+    def initialize(hiera, data, options)
+      @hiera, @data, @options = hiera, data, options
+    end
+
+    def postprocess(value)
+      if value.is_a?(String)
+        value.gsub(/\%\{([^}]+)\}/) do |match|
+          fetch($1)
+        end
+      elsif value.is_a?(Hash)
+        Hash[value.map { |k,v| [k, postprocess(v)] }]
+      elsif value.is_a?(Array)
+        value.map { |v| postprocess(v) }
+      else
+        value
+      end
+    end
+
+    def error_message_suffix
+      if !!(v = Thread.current[:interpolation_stack]) && !v.empty?
+        "whilst interpolating keys #{v.reverse.join(", ")}"
+      end
+    end
+
+    def detect_circular_interpolation(key)
+      Thread.current[:interpolation_stack] ||= []
+      raise CircularReferenceError, "Circular reference when resolving key '#{key}'" if Thread.current[:interpolation_stack].include?(key)
+      Thread.current[:interpolation_stack] << key
+      yield
+    ensure
+      Thread.current[:interpolation_stack].pop
+    end
+
+    def hiera_data
+      @hiera_data ||= @hiera.resolve(@data).inject({}) { |a,v| a.deep_merge(v, @options.fetch(:deep_merge, {})) }
+    end
+
+    DefaultObject = Object.new
+    def fetch(key, default=DefaultObject, &default_block)
+      key = key.to_s
+
+      raise ArgumentError, "default value and block specified" if default != DefaultObject && default_block
+
+      default_block ||= lambda { default == DefaultObject ? raise(KeyNotFoundError, [" ** Unknown key '#{key}'", error_message_suffix].join(" ")) : default }
+
+      default_block_wrapper = lambda { |*_| default_block.arity == 0 ? default_block.call : default_block.call(key) }
+
+      data = hiera_data
+
+      key.split(".").each do |k|
+        if data.is_a?(Array)
+          raise TypeError, "no implicit conversion of String into Integer" unless k.to_i.to_s == k
+          data = data[k.to_i]
+        elsif data.is_a?(Hash)
+          data = data.fetch(k, &default_block_wrapper)
+        else
+          data = default_block_wrapper.call
+          break
+        end
+      end
+
+      detect_circular_interpolation(key) do
+        postprocess(data)
+      end
+    end
+
+    def [](key)
+      fetch(key)
+    end
+
+    def has_key?(key)
+      fetch(key)
+      true
+    rescue MiniHiera::KeyNotFoundError
+      false
+    end
+  end
+
+  def replace(string, dictionary)
+    string.gsub(/\%\{([^}]+)\}/) do |match|
+      dictionary.fetch($1, match)
+    end
+  end
+
+  CACHE = {}
+
+  def self.cache(filename)
+    if CACHE.keys.include?(filename)
+      CACHE[filename]
+    else
+      CACHE[filename] = yield
+    end
+  end
+
+  TYPES = {
+    "yaml" => Proc.new { |filename| cache(filename) { YAML.load(File.read(filename), filename) } },
+    "json" => Proc.new { |filename| cache(filename) { JSON.load(File.read(filename), filename) } }
+  }
+
+  def load_path(path)
+    TYPES.map { |s,proc| ["#{path}.#{s}", proc] }.find_value { |filename,proc| proc.call(filename, binding) if File.exist?(filename) }
+  end
+
+  def resolve(data)
+    [data] + @options[:hierarchy].map { |path| load_path(File.join(@config, replace(path, data))) }.compact
+  end
+
+  def context(data={}, options={})
+    Context.new(self, data, @options.deep_merge(options))
+  end
+end

data/lib/mini_hiera/version.rb

@@ -0,0 +1,3 @@
+class MiniHiera
+  VERSION = "0.1.0"
+end

data/mini_hiera.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mini_hiera/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mini_hiera"
+  spec.version       = MiniHiera::VERSION
+  spec.authors       = ["Thomas Haggett"]
+  spec.email         = ["thomas@haggett.org"]
+
+  spec.summary       = %q{Hierarchial key/value configuration}
+  spec.description   = %q{Library to allows a key to be resolved via a hierarchy of context-specific values}
+  spec.homepage      = "https://thomas.haggett.org/"
+  spec.license       = "MIT"
+
+  # 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('..', __FILE__)) 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"]
+
+  spec.add_dependency 'deep_merge', '~> 1.0'
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  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: mini_hiera
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thomas Haggett
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-18 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.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: Library to allows a key to be resolved via a hierarchy of context-specific
+  values
+email:
+- thomas@haggett.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mini_hiera.rb
+- lib/mini_hiera/version.rb
+- mini_hiera.gemspec
+homepage: https://thomas.haggett.org/
+licenses:
+- MIT
+metadata: {}
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Hierarchial key/value configuration
+test_files: []