strict_konf 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 293820438c4c79b061924c550a228b57f48f6807
+  data.tar.gz: f6161b314ef615d3030cadb8335e67780b4aee88
+SHA512:
+  metadata.gz: ec62272bca6d967e86bdc124677966de5029f3df8eec697a6f7dd948e7bba76b5304dae43666633202d2556497721c91850b456c522fb5e75503e9c78429860b
+  data.tar.gz: bcfa9bd708221358a1275cad2503a9e9e66d7b20928e2b1ce4318492fd4ce38cb47cfa8e3c739ac459345a2a15f7454f765a4f08b5825515f430d0ddd027e355

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - rbx-2

data/CONTRIBUTING.md

@@ -0,0 +1,6 @@
+1. Fork it ( http://github.com/wojtekmach/strict_konf/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Wojtek Mach
+
+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,55 @@
+# StrictKonf
+
+Extend Konf with required keys
+
+[![Build Status](http://img.shields.io/travis/wojtekmach/strict_konf.svg)][travis]
+
+[travis]: https://travis-ci.org/wojtekmach/strict_konf
+
+## Rationale
+
+It's very annoying when configuration files get out of sync, i.e.: you have a developer's `config.yml` that is ignored, `config.yml.sample` checked-in and another `config.yml` on the production box. Problems arise when the developer, when adding a new key, forgets to update `.sample` file or the production config and the code & configuration is out of sync.
+
+This gem extends Konf to fail when there is a discrepancy between the required list of keys and the actual configuration file content.
+
+## Example
+
+Based on <https://github.com/GBH/konf#usage>
+
+```yaml
+development:
+  name: Dev
+  email: dev@test.test
+```
+
+You can read the file like usual with Konf:
+
+```ruby
+config = StrictKonf.new('configuration.yml', 'development', [:name, :email])
+config.name # => Dev
+```
+
+It will fail when you have too much or too few keys in your configuration:
+
+```ruby
+StrictKonf.new('configuration.yml', 'development', [:name])                # raises UnknownKeys error
+StrictKonf.new('configuration.yml', 'development', [:name, :email, :role]) # raises NotFound error
+```
+
+It also supports nested hashes. We can pass `nil` to start from the root of the hash:
+
+```ruby
+StrictKonf.new('configuration.yml', nil, development: [:name, :email])
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'strict_konf', github: 'wojtekmach/strict_konf'
+```
+
+And then execute:
+
+    $ bundle

data/Rakefile

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

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/strict_konf.rb

@@ -0,0 +1,61 @@
+require "konf"
+
+class StrictKonf < Konf
+  VERSION = File.read(File.dirname(__FILE__) + '/../VERSION').strip
+
+  class UnknownKeys < StandardError; end
+
+  def initialize(source, root, required_keys)
+    super(source, root)
+    @required_keys = required_keys
+
+    _validate_required_keys
+    _validate_provided_keys
+  end
+
+  def method_missing(name, *args, &block)
+    result = super
+    if result.is_a? Konf
+      StrictKonf.new(result, nil, _normalize_keys.fetch(name))
+    else
+      result
+    end
+  end
+
+  private
+
+  def _validate_required_keys
+    keys = @required_keys
+    keys = keys.keys if keys.is_a? Hash
+
+    keys.each { |key|
+      if key.is_a? Symbol
+        public_send(key.to_s)
+      end
+    }
+  end
+
+  def _validate_provided_keys
+    required = @required_keys
+    required = required.keys if keys.is_a? Hash
+    required = required.map { |key| key.is_a?(Hash) ? key.keys : key }
+    required = required.flatten.map(&:to_s)
+
+    extra = keys - required
+    if extra.any?
+      raise UnknownKeys, "Unknown keys in config: #{extra}"
+    end
+  end
+
+  def _normalize_keys
+    @required_keys.each_with_object({}) {|key, hash|
+      if key.is_a? Hash
+        hash.merge!(key)
+      elsif key.is_a? Array
+        hash[key[0]] = key[1]
+      else
+        hash[key] = true
+      end
+    }
+  end
+end

data/strict_konf.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+version = File.read(File.dirname(__FILE__) + '/VERSION').strip
+
+Gem::Specification.new do |spec|
+  spec.name          = "strict_konf"
+  spec.version       = version
+  spec.authors       = ["Wojtek Mach"]
+  spec.email         = ["wojtek@wojtekmach.pl"]
+  spec.summary       = "Extend Konf to require/whitelist fields"
+  spec.description   = ""
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_dependency "konf", "0.0.2"
+end

data/test/strict_konf_test.rb

@@ -0,0 +1,57 @@
+require 'minitest/autorun'
+require 'strict_konf'
+
+describe StrictKonf do
+  it "behaves like Konf" do
+    config = StrictKonf.new({'development' => {'foo' => 1, 'bar' => 2}}, 'development', [:foo, :bar])
+    config.foo.must_equal 1
+    config.bar.must_equal 2
+  end
+
+  it "raises error when required key is missing" do
+    lambda {
+      StrictKonf.new({'foo' => 1}, nil, [:foo, :baz])
+    }.must_raise Konf::NotFound
+  end
+
+  it "raises error when config has key that is not a required key" do
+    lambda {
+      StrictKonf.new({'foo' => 1, 'bar' => 2}, nil, [:foo])
+    }.must_raise StrictKonf::UnknownKeys
+  end
+
+  describe "with nested hash" do
+    let(:data) {
+      {
+        'a' => {
+          'aa' => 1,
+          'ab' => 2,
+          'ac' => {
+            'aca' => 3
+          }
+        },
+        'b' => 4,
+      }
+    }
+
+    it "behaves like Konf" do
+      config = StrictKonf.new(data, nil, a: [:aa, :ab, {ac: [:aca]}], b: true)
+      config.a.aa.must_equal 1
+      config.a.ab.must_equal 2
+      config.a.ac.aca.must_equal 3
+      config.b.must_equal 4
+    end
+
+    it "raises error when required key is missing" do
+      lambda {
+        StrictKonf.new(data, nil, a: [:aa, :ab, {ac: [:aca]}, :ad], b: true)
+      }.must_raise Konf::NotFound
+    end
+
+    it "raises error when config has key that is not a required key" do
+      lambda {
+        StrictKonf.new(data, nil, a: [:aa], b: true)
+      }.must_raise StrictKonf::UnknownKeys
+    end
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: strict_konf
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Wojtek Mach
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: konf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+description: ''
+email:
+- wojtek@wojtekmach.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/strict_konf.rb
+- strict_konf.gemspec
+- test/strict_konf_test.rb
+homepage: ''
+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: Extend Konf to require/whitelist fields
+test_files:
+- test/strict_konf_test.rb