config_volumizer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 51fccd17634bc4c6605169c3f0aaa1552ed7e09b
+  data.tar.gz: 7eedb6855853b5e3e643bfd95dc4286b4ef6a654
+SHA512:
+  metadata.gz: a451d91280f236cbc6fc3442f1be856542d5042f7ba1113fb4996a78f11b44a4f121c342edcb76138eea9459dffb553c71638b65ad7bf5b64acbfd56285fce6c
+  data.tar.gz: 493db1a62e270c7f0d01c4ca2545b85f9e38c33760ae6b3f4b24466210beff9dfda2625939bad0eed7dbdb058a869df008247017d97de59496058b326de97109

data/.document

@@ -0,0 +1,3 @@
+- 
+ChangeLog.md
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,5 @@
+.ruby-version
+Gemfile.lock
+doc/
+pkg/
+vendor/cache/*.gem

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - "2.0.0"
+  - "2.1.5"
+  - "2.2.1"
+script: "bundle exec rspec"

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title "config_volumizer Documentation" --protected

data/ChangeLog.md

@@ -0,0 +1,4 @@
+### 0.1.0 / 2015-04-03
+
+* Initial release:
+

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'kramdown'
+  gem 'bundler'
+  gem 'rake'
+  gem 'rspec'
+  gem 'rubygems-tasks'
+  gem 'yard'
+  gem 'flay'
+  gem 'flog'
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2015 PayrollHero Pte. Ltd.
+
+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,65 @@
+# config_volumizer
+
+[![Build Status](https://travis-ci.org/payrollhero/config_volumizer.svg)](https://travis-ci.org/payrollhero/config_volumizer)
+[![Code Climate](https://codeclimate.com/github/payrollhero/config_volumizer/badges/gpa.svg)](https://codeclimate.com/github/payrollhero/config_volumizer)
+
+* [Homepage](https://rubygems.org/gems/config_volumizer)
+* [Documentation](http://rubydoc.info/gems/config_volumizer/frames)
+* [Email](mailto:piotr.banasik at gmail.com)
+
+## Description
+
+Ever wanted to move to ENV based 12 Factor config but are stuck with somewhat complex yaml (or simillar) files
+holding all your settings?
+
+Been scratching your head how to convert your deeply nested config to ENV?
+
+Config Volumizer comes to the rescue.
+
+## Examples
+
+Convert this:
+```yaml
+some:
+  setting:
+    - one
+    - two
+    - three
+  with:
+    another: setting
+```
+
+info a series of ENV variables like so:
+
+```
+some.setting[0] = one
+some.setting[1] = two
+some.setting[2] = three
+some.with.another = setting
+```
+
+... and then just give it some volume with the volumizer to turn it back to the original rich structure
+
+```ruby
+ConfigVolumizer.parse(ENV, 'some')
+```
+
+## Features
+
+The gem basically smartly parses all keys within the passed in Hash that match the prefix specified.
+
+It allows to nest either arrays or hashes inside eachother, basically any reasonable combination of hash/array notation should work.
+
+## Install
+
+Add it to your gemfile and use it.
+
+```ruby
+gem 'config_volumizer'
+```
+
+## Copyright
+
+Copyright (c) 2015 PayrollHero Pte. Ltd.
+
+See LICENSE.txt for details.

data/Rakefile

@@ -0,0 +1,34 @@
+# encoding: utf-8
+
+require 'rubygems'
+
+begin
+  require 'bundler'
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install bundler` to install Bundler."
+  exit -1
+end
+
+begin
+  Bundler.setup(:development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn "Run `bundle install` to install missing gems."
+  exit e.status_code
+end
+
+require 'rake'
+
+require 'rubygems/tasks'
+Gem::Tasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :test    => :spec
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new  
+task :doc => :yard

data/config_volumizer.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/config_volumizer/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "config_volumizer"
+  gem.version       = ConfigVolumizer::VERSION
+  gem.summary       = "Adds volume to an otherwise flat config"
+  gem.description   = "Allows turning dot notation config from ENV to rich Hash/Array structures"
+  gem.license       = "MIT"
+  gem.authors       = ["Piotr Banasik"]
+  gem.email         = "piotr.banasik@gmail.com"
+  gem.homepage      = "https://rubygems.org/gems/config_volumizer"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+end

data/lib/config_volumizer/parser.rb

@@ -0,0 +1,82 @@
+require 'strscan'
+require 'yaml'
+
+module ConfigVolumizer
+  module Parser
+
+    class << self
+
+      def parse(source, base_name)
+        result = {}
+        source.each do |key, value|
+          if matches_name(base_name, key)
+            fragments = key.gsub(/^#{base_name}/, '')
+            handle_item(result, base_name, fragments, value)
+          end
+        end
+        result
+      end
+
+      private
+
+      def matches_name(base_name, key)
+        key == base_name || key =~ /^#{base_name}([.\[])/
+      end
+
+      def format_value(value)
+        YAML.load(value)
+      end
+
+      def initialize_array(result, key)
+        validate_result_key_kind(result, key, Array)
+        result[key] ||= []
+      end
+
+      def initialize_hash(result, key)
+        validate_result_key_kind(result, key, Hash)
+        result[key] ||= {}
+      end
+
+      def validate_result_key_kind(result, key, kind)
+        if result[key] && !result[key].kind_of?(kind)
+          raise ArgumentError, "referencing #{kind} key #{name} when its already a #{result[key].class}"
+        end
+      end
+
+      def handle_item(result, base_name, name, value)
+        dst, key = result, base_name
+        scanner = StringScanner.new(name)
+
+        until scanner.eos?
+          dst, key = case next_fragment(scanner)
+                     when /^\.(.+)/
+                       handle_hash($~, dst, key)
+                     when /\[(\d+)\]/
+                       handle_array($~, dst, key)
+                     end
+        end
+
+        dst[key] = format_value(value)
+      end
+
+      def handle_array(match, dst, key)
+        index = match[1].to_i
+        initialize_array(dst, key)
+        return dst[key], index
+      end
+
+      def handle_hash(match, dst, key)
+        hash_key = match[1]
+        initialize_hash(dst, key)
+        return dst[key], hash_key
+      end
+
+      def next_fragment(scanner)
+        fragment = scanner.scan /\.[^.\[]+|\[\d+\]/
+        raise "failed: rest: #{scanner.rest} inside #{scanner.string}" unless fragment
+        fragment
+      end
+
+    end
+  end
+end

data/lib/config_volumizer/version.rb

@@ -0,0 +1,4 @@
+module ConfigVolumizer
+  # config_volumizer version
+  VERSION = "0.1.0"
+end

data/lib/config_volumizer.rb

@@ -0,0 +1,12 @@
+require 'config_volumizer/version'
+require 'config_volumizer/parser'
+
+module ConfigVolumizer
+  class << self
+
+    def parse(source, base_name)
+      Parser.parse(source, base_name)
+    end
+
+  end
+end

data/spec/config_volumizer_spec.rb

@@ -0,0 +1,224 @@
+require 'spec_helper'
+
+describe ConfigVolumizer do
+  let(:key) { 'ex' }
+  let(:result) { described_class.parse(input, key) }
+
+  describe "1 level hash" do
+    let(:input) { { "ex" => "1a" } }
+    let(:expected_result) { { 'ex' => '1a' } }
+
+    example do
+      expect(result).to eq(expected_result)
+    end
+  end
+
+  describe "2 level hash" do
+    let(:key) { 'ex1' }
+    let(:input) do
+      {
+        "ex1.bar" => "1a",
+        "ex1.bar2" => "2a",
+      }
+    end
+    let(:expected_result) do
+      {
+        'ex1' => {
+          'bar' => '1a',
+          'bar2' => '2a',
+        },
+      }
+    end
+
+    example do
+      expect(result).to eq(expected_result)
+    end
+  end
+
+  describe "3 level hash" do
+    let(:key) { 'ex3' }
+    let(:input) do
+      {
+        "ex3.one.two" => "1a",
+        "ex3.one.three" => "2a",
+        "ex3.two.three" => "3a",
+      }
+    end
+    let(:expected_result) do
+      {
+        'ex3' => {
+          'one' => {
+            'two' => '1a',
+            'three' => '2a',
+          },
+          'two' => {
+            'three' => '3a',
+          },
+        },
+      }
+    end
+
+    example do
+      expect(result).to eq(expected_result)
+    end
+  end
+
+  describe "array of values in hash" do
+    let(:input) do
+      {
+        "ex.one[0]" => "1a",
+        "ex.one[1]" => "2a",
+      }
+    end
+    let(:expected_result) do
+      {
+        'ex' => { 'one' => ['1a', '2a'] }
+      }
+    end
+
+    example do
+      expect(result).to eq(expected_result)
+    end
+  end
+
+  describe "just array of values" do
+    let(:input) do
+      {
+        "ex[0]" => "1a",
+        "ex[1]" => "2a",
+      }
+    end
+    let(:expected_result) do
+      {
+        'ex' => ['1a', '2a']
+      }
+    end
+
+    example do
+      expect(result).to eq(expected_result)
+    end
+  end
+
+  describe "array of hashes" do
+    let(:input) do
+      {
+        "ex[0].foo" => "1a",
+        "ex[0].bar" => "2a",
+        "ex[1].foo" => "3a",
+      }
+    end
+    let(:expected_result) do
+      {
+        'ex' => [
+          { 'foo' => '1a', 'bar' => '2a' },
+          { 'foo' => '3a' },
+        ]
+      }
+    end
+
+    example do
+      expect(result).to eq(expected_result)
+    end
+  end
+
+  describe "array of hash in hash" do
+    let(:key) { 'ex2' }
+    let(:input) do
+      {
+        "ex2.one[0].foo" => "1a",
+        "ex2.one[0].bar" => "2a",
+        "ex2.one[1].foo" => "3a",
+      }
+    end
+    let(:expected_result) do
+      {
+        'ex2' => {
+          'one' => [
+            {
+              "foo" => '1a',
+              "bar" => '2a',
+            },
+            {
+              "foo" => '3a',
+            }
+          ],
+        },
+      }
+    end
+
+    example do
+      expect(result).to eq(expected_result)
+    end
+  end
+
+  describe "empty hash value" do
+    let(:input) { { "ex" => "{}", } }
+    let(:expected_result) { { 'ex' => {} } }
+
+    example do
+      expect(result).to eq(expected_result)
+    end
+  end
+
+  describe "empty array value" do
+    let(:input) { { "ex" => "[]", } }
+    let(:expected_result) { { 'ex' => [] } }
+
+    example do
+      expect(result).to eq(expected_result)
+    end
+  end
+
+  describe "2d arrays" do
+    let(:input) do
+      {
+        "ex[0][0]" => "1a",
+        "ex[0][1]" => "2a",
+        "ex[1][0]" => "3a",
+        "ex[1][1]" => "4a",
+      }
+    end
+    let(:expected_result) do
+      {
+        'ex' => [
+          ['1a', '2a'],
+          ['3a', '4a']
+        ]
+      }
+    end
+
+    example do
+      expect(result).to eq(expected_result)
+    end
+  end
+
+  describe "3d arrays" do
+    let(:input) do
+      {
+        'ex[0][0][1]' => "1a",
+        'ex[0][1][0]' => "2a",
+        'ex[1][0][1]' => "3a",
+        'ex[1][1][0]' => "4a",
+      }
+    end
+    let(:expected_result) do
+      {
+        'ex' => [
+          [
+            [nil, '1a'],
+            ['2a'],
+          ],
+          [
+            [nil, '3a'],
+            ['4a'],
+          ]
+        ]
+      }
+    end
+
+    example do
+      expect(result).to eq(expected_result)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rspec'
+require 'config_volumizer'

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: config_volumizer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Piotr Banasik
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-03 00:00:00.000000000 Z
+dependencies: []
+description: Allows turning dot notation config from ENV to rich Hash/Array structures
+email: piotr.banasik@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".document"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".yardopts"
+- ChangeLog.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- config_volumizer.gemspec
+- lib/config_volumizer.rb
+- lib/config_volumizer/parser.rb
+- lib/config_volumizer/version.rb
+- spec/config_volumizer_spec.rb
+- spec/spec_helper.rb
+homepage: https://rubygems.org/gems/config_volumizer
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Adds volume to an otherwise flat config
+test_files:
+- spec/config_volumizer_spec.rb
+- spec/spec_helper.rb