config_hound 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 889819e5d375efbd4ba6f012a02332fe2f79c0d1
+  data.tar.gz: f0b888501712c79f5e0f4f7e6d0db269ee7eda0a
+SHA512:
+  metadata.gz: a53953b012bf1acb2eb819d2a32265edf410a2691cb933b29706a9c82964e189c17b16aa6a282c2c45afd9c3c99beab581c3c949465a697b5d03041d62f9d7ef
+  data.tar.gz: 674d5e2e1c9f45ca97f2a3a2a8777f14ef4e9454bd7dfa6f651db9afce1504b82f95c88dcb7de0a4cbd7b9ca650dccee40f2a30c383817530cb17b732014185a

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1 @@
+--color --format doc

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in configuration_loader.gemspec
+gemspec
+
+gem "multi_json", :require => false
+gem "rspec"
+gem "toml", :require => false

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Mike Williams
+
+MIT License
+
+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,48 @@
+# ConfigHound
+
+ConfigHound makes it easy to load configuration data that is
+spread between multiple files.
+
+## Usage
+
+    # load YAML
+    config = ConfigHound.load("config.yml")
+
+    # load JSON
+    config = ConfigHound.load("config.json")
+
+    # load TOML
+    config = ConfigHound.load("config.toml")
+
+## Inclusion
+
+ConfigHound let's you include defaults from other files.
+Just list the file paths (or URLs) under the key "_include",
+
+For example, in `config.yml`:
+
+    _include:
+      - defaults.yml
+    pool:
+      size: 10
+    log:
+      file: "app.log"
+
+then in `defaults.yml`
+
+    log:
+      level: INFO
+    pool:
+      size: 1
+
+Values in the original config file override those from included files.
+Multiple levels of inclusion are possible.
+
+If the placeholder "`_include`" doesn't suit, you can specify
+another, e.g.
+
+    config = ConfigHound.load("config.yml", :include_key => "defaults")
+
+## Contributing
+
+It's on GitHub; you know the drill.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.rspec_opts = ["--colour", "--format", "documentation"]
+end
+
+task "default" => "spec"

data/config_hound.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'config_hound/version'
+
+Gem::Specification.new do |spec|
+
+  spec.name          = "config_hound"
+  spec.version       = ConfigHound::VERSION
+
+  spec.summary       = %q{Sniffs out config, wherever it may be.}
+  spec.license       = "MIT"
+
+  spec.authors       = ["Mike Williams"]
+  spec.email         = ["mdub@dogbiscuit.org"]
+  spec.homepage      = "https://github.com/mdub/config_hound"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+end

data/lib/config_hound.rb

@@ -0,0 +1,12 @@
+require "config_hound/loader"
+require "config_hound/version"
+
+module ConfigHound
+
+  def self.load(*args)
+    Loader.load(*args)
+  end
+
+end
+
+

data/lib/config_hound/loader.rb

@@ -0,0 +1,46 @@
+require "config_hound/parser"
+require "config_hound/resource"
+
+module ConfigHound
+
+  class Loader
+
+    DEFAULT_INCLUDE_KEY = "_include"
+
+    def self.load(path, options = {})
+      new(path, options).load
+    end
+
+    def initialize(path, options)
+      @resource = Resource.new(path.to_s)
+      @include_key = options.fetch(:include_key, DEFAULT_INCLUDE_KEY)
+    end
+
+    def load
+      data = Parser.parse(resource.read, resource.format)
+      Array(data.delete(include_key)).each do |i|
+        defaults = Loader.load(resource.resolve(i))
+        include_into!(data, defaults)
+      end
+      data
+    end
+
+    private
+
+    attr_reader :resource
+    attr_reader :include_key
+
+    def include_into!(data, defaults)
+      return unless data.is_a?(Hash) && defaults.is_a?(Hash)
+      defaults.each do |key, value|
+        if data.has_key?(key)
+          include_into!(data[key], value)
+        else
+          data[key] = value
+        end
+      end
+    end
+
+  end
+
+end

data/lib/config_hound/parser.rb

@@ -0,0 +1,36 @@
+module ConfigHound
+
+  class Parser
+
+    def self.parse(*args)
+      new.parse(*args)
+    end
+
+    def parse(raw, format)
+      parse_method = "parse_#{format}"
+      raise "unknown format: #{format}" unless respond_to?(parse_method, true)
+      send(parse_method, raw)
+    end
+
+    protected
+
+    def parse_yaml(raw)
+      require "yaml"
+      YAML.load(raw)
+    end
+
+    alias :parse_yml :parse_yaml
+
+    def parse_json(raw)
+      require "multi_json"
+      MultiJson.load(raw)
+    end
+
+    def parse_toml(raw)
+      require "toml"
+      TOML.load(raw)
+    end
+
+  end
+
+end

data/lib/config_hound/resource.rb

@@ -0,0 +1,55 @@
+require "open-uri"
+require "uri"
+
+module ConfigHound
+
+  LoadError = Class.new(StandardError)
+
+  # Represents a source of configuration data.
+  #
+  class Resource
+
+    def initialize(path)
+      @uri = uri_for(path)
+    end
+
+    def to_s
+      uri.to_s
+    end
+
+    def resolve(path)
+      self.class.new(uri + path)
+    end
+
+    def read
+      open(uri.scheme == "file" ? uri.path : uri.to_s) do |io|
+        io.read
+      end
+    rescue Errno::ENOENT
+      raise LoadError, "can't load: #{uri}"
+    end
+
+    def format
+      File.extname(uri.to_s)[1..-1]
+    end
+
+    private
+
+    attr_reader :uri
+
+    def uri_for(path)
+      case path
+      when URI
+        path
+      when %r{^\w+:/}
+        URI(path)
+      when %r{^/}
+        URI("file:#{path}")
+      else
+        URI("file:#{File.expand_path(path)}")
+      end
+    end
+
+  end
+
+end

data/lib/config_hound/version.rb

@@ -0,0 +1,3 @@
+module ConfigHound
+  VERSION = "1.0.0"
+end

data/spec/config_hound/resource_spec.rb

@@ -0,0 +1,67 @@
+require "spec_helper"
+
+require "config_hound/resource"
+require "uri"
+
+describe ConfigHound::Resource do
+
+  let(:resource) { described_class.new(path) }
+
+  context "with a URI" do
+
+    let(:uri) { URI("http://example.com/some_uri") }
+    let(:path) { uri }
+
+    it "retains the URI" do
+      expect(resource.to_s).to eq(uri.to_s)
+    end
+
+  end
+
+  context "with a fully-qualified path" do
+
+    let(:path) { "/path/to/file" }
+
+    it "assumes it's a file" do
+      expect(resource.to_s).to eq("file:/path/to/file")
+    end
+
+    describe "#resolve" do
+
+      context "with a relative path" do
+        it "resolves relatively" do
+          other_resource = resource.resolve("other_file")
+          expect(other_resource).to be_a(ConfigHound::Resource)
+          expect(other_resource.to_s).to eq("file:/path/to/other_file")
+        end
+      end
+
+      context "with an absolute file path" do
+        it "resolves relatively" do
+          other_resource = resource.resolve("/different/path")
+          expect(other_resource.to_s).to eq("file:/different/path")
+        end
+      end
+
+      context "with a fully-qualified URI" do
+        it "uses the URI provided" do
+          other_resource = resource.resolve("http://foo/bar")
+          expect(other_resource.to_s).to eq("http://foo/bar")
+        end
+      end
+
+    end
+
+  end
+
+  context "with a relative path" do
+
+    let(:path) { "config.yml" }
+
+    it "assumes it's a file relative to $CWD" do
+      expect(resource.to_s).to eq("file:#{Dir.pwd}/config.yml")
+    end
+
+  end
+
+end

data/spec/features/basics_spec.rb

@@ -0,0 +1,49 @@
+require "spec_helper"
+
+require "config_hound"
+
+describe ConfigHound do
+
+  def load(path)
+    ConfigHound.load(path)
+  end
+
+  given_resource "config.yml", %{
+    foo: 1
+    bar: 2
+  }
+
+  it "loads YAML" do
+    expect(load("config.yml")).to eq(
+      "foo" => 1,
+      "bar" => 2
+    )
+  end
+
+  given_resource "config.json", %{
+    {
+      "foo": 1,
+      "bar": 2
+    }
+  }
+
+  it "loads JSON" do
+    expect(load("config.json")).to eq(
+      "foo" => 1,
+      "bar" => 2
+    )
+  end
+
+  given_resource "config.toml", %{
+    foo = 1
+    bar = 2
+  }
+
+  it "loads TOML" do
+    expect(load("config.toml")).to eq(
+      "foo" => 1,
+      "bar" => 2
+    )
+  end
+
+end

data/spec/features/include_spec.rb

@@ -0,0 +1,169 @@
+
+describe ConfigHound do
+
+  let(:options) { {} }
+
+  def load(path)
+    ConfigHound.load(path, options)
+  end
+
+  let(:config) { load("config.yml") }
+
+  context "when file includes another" do
+
+    given_resource "config.yml", %{
+      foo: 42
+      _include: included.yml
+    }
+
+    given_resource "included.yml", %{
+      foo: 1
+      bar: 2
+    }
+
+    it "merges in the included file" do
+      expect(config).to eq(
+        "foo" => 42,
+        "bar" => 2
+      )
+    end
+
+  end
+
+  context "when the included file has a different format" do
+
+    given_resource "config.yml", %{
+      foo: 42
+      _include: included.toml
+    }
+
+    given_resource "included.toml", %{
+      foo = 1
+      bar = 2
+    }
+
+    it "doesn't matter" do
+      expect(config).to eq(
+        "foo" => 42,
+        "bar" => 2
+      )
+    end
+
+  end
+
+  context "with multiple levels of inclusion" do
+
+    given_resource "config.yml", %{
+      from_config: C
+      _include: a.yml
+    }
+
+    given_resource "a.yml", %{
+      from_a: A
+      _include: b.yml
+    }
+
+    given_resource "b.yml", %{
+      from_b: B
+    }
+
+    it "merges in both files" do
+      expect(config).to eq(
+        "from_config" => "C",
+        "from_a" => "A",
+        "from_b" => "B"
+      )
+    end
+
+  end
+
+  context "with an alernate :include_key" do
+
+    before do
+      options[:include_key] = "slurp"
+    end
+
+    given_resource "config.yml", %{
+      _include: a.yml
+      slurp: b.yml
+    }
+
+    given_resource "a.yml", %{
+      from_a: A
+    }
+
+    given_resource "b.yml", %{
+      from_b: B
+    }
+
+    it "uses the specified include-key" do
+      expect(config).to eq(
+        "_include" => "a.yml",
+        "from_b" => "B"
+      )
+    end
+
+  end
+
+  context "with relative inclusion" do
+
+    given_resource "config.yml", %{
+      from_config: C
+      _include: subdir/a.yml
+    }
+
+    given_resource "subdir/a.yml", %{
+      from_a: A
+      _include: b.yml
+    }
+
+    given_resource "subdir/b.yml", %{
+      from_b: B
+    }
+
+    it "resolves the relative references" do
+      expect(config).to eq(
+        "from_config" => "C",
+        "from_a" => "A",
+        "from_b" => "B"
+      )
+    end
+
+  end
+
+  context "with deep structures" do
+
+    given_resource "config.yml", %{
+      _include: defaults.yml
+      nested:
+        stuff:
+          name: Stuff
+          strategy: none
+    }
+
+    given_resource "defaults.yml", %{
+      nested:
+        stuff:
+          size: large
+          strategy:
+            first: think
+            then: do
+    }
+
+    it "merges deeply" do
+      expect(config).to eq(
+        "nested" => {
+          "stuff" => {
+            "name" => "Stuff",
+            "size" => "large",
+            "strategy" => "none"
+          }
+        }
+      )
+    end
+
+  end
+
+end
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+module GivenResource
+
+  def inputs
+    @inputs ||= {}
+  end
+
+  def given_resource(path, content)
+    unless path =~ %r(^\w+:/)
+      path = File.expand_path(path)
+    end
+    content = undent(content)
+    before do
+      allow_any_instance_of(ConfigHound::Resource).to receive(:open).with(path) do |_, _, &block|
+        block.call(StringIO.new(content.dup))
+      end
+    end
+  end
+
+  private
+
+  def undent(raw)
+    # raw = raw.gsub(/^ *$/,'')
+    if raw =~ /\A( +)/
+      indent = $1
+      raw.gsub(/^#{indent}/, '').gsub(/ +$/, '')
+    else
+      raw
+    end
+  end
+
+end
+
+RSpec.configure do |config|
+
+  config.extend(GivenResource)
+
+  config.before do
+    allow_any_instance_of(ConfigHound::Resource).to receive(:open) do |_, path, &block|
+      raise Errno::ENOENT, "can't load: #{path}"
+    end
+  end
+
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: config_hound
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mike Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: 
+email:
+- mdub@dogbiscuit.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- config_hound.gemspec
+- lib/config_hound.rb
+- lib/config_hound/loader.rb
+- lib/config_hound/parser.rb
+- lib/config_hound/resource.rb
+- lib/config_hound/version.rb
+- spec/config_hound/resource_spec.rb
+- spec/features/basics_spec.rb
+- spec/features/include_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mdub/config_hound
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Sniffs out config, wherever it may be.
+test_files:
+- spec/config_hound/resource_spec.rb
+- spec/features/basics_spec.rb
+- spec/features/include_spec.rb
+- spec/spec_helper.rb