config_volumizer 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc9530cd3c91c5a4fe838039cb30de8a14830e4f
-  data.tar.gz: 55016643bfc942b257bb0697bc033dde16befae7
+  metadata.gz: c0c29f0402462a29c95d7e2712a62d557ddfb71d
+  data.tar.gz: 52d81de5d4a22e8ed0aa6e7c96eae005f8484730
 SHA512:
-  metadata.gz: 4ea31fbd58d7f9067f0de317969777793669c210b50f41b45d08cfa32d6eccb9c2e98368f9964a0441f496ccb66c950b3fb9c2c2dcd131e548ef594421b85ed3
-  data.tar.gz: ba803bd708d6c13b5bc2426269f40a880a28aef3da8c1dbd7865eb766d1f235990bc12d110b7b1bd3707bf58e039c3e973c729aba17cd63cc14258938a67ab10
+  metadata.gz: 92db0ba571ec57b8b35116e8258808f230b5063b9bc0369011f99e15677cdbbfb5441ad98d6853f51cb178572ba7afc45e76125ba17d0af70c6be34e98cd883d
+  data.tar.gz: d2942c52b731795b2034d3730a8ddc67338741d4553657580166f89d21c29a254bf6543eec69671cb49e33337d46e15cbc311bcbcf9bf5437be97d17baa5ab3d

data/.gitignore

@@ -3,3 +3,4 @@ Gemfile.lock
 doc/
 pkg/
 vendor/cache/*.gem
+coverage

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Change Log
+
+## [v0.3.0](https://github.com/payrollhero/config_volumizer/tree/v0.3.0) (2015-04-18)
+
+[Full Changelog](https://github.com/payrollhero/config_volumizer/compare/v0.2.0...v0.3.0)
+
+**Merged pull requests:**
+
+- effectively a rewrite that uses mapping hashes to describe the syntax [\#1](https://github.com/payrollhero/config_volumizer/pull/1) ([piotrb](https://github.com/piotrb))
+
+## [v0.2.0](https://github.com/payrollhero/config_volumizer/tree/v0.2.0) (2015-04-03)
+
+[Full Changelog](https://github.com/payrollhero/config_volumizer/compare/v0.1.0...v0.2.0)
+
+## [v0.1.0](https://github.com/payrollhero/config_volumizer/tree/v0.1.0) (2015-04-03)
+
+
+
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/README.md

@@ -42,14 +42,14 @@ some_with_another = setting
 
 ```ruby
 mapping = { "some" => { "setting" => :value, "with" => { "another" => :value } } }
-ConfigVolumizer.parse(ENV, 'some', mapping)
+ConfigVolumizer.parse(ENV, mapping)
 ```
 
 ## Features
 
 ### Parsing
 
-You can parse a flattened config via `ConfigVolumizer.parse(ENV, 'some', mapping)`
+You can parse a flattened config via `ConfigVolumizer.parse(ENV, mapping)`
 
 For example if your ENV was:
 
@@ -82,6 +82,51 @@ some:
     another: setting
 ```
 
+### Fetching values (shorthand for parse)
+
+You can fetch a specific key from the given source
+
+For example:
+
+```ruby
+env = {
+  "some_setting" => "one,two,three",
+  "some_with_another" => "setting",
+}
+
+mapping = {
+  "setting" => [:value],
+  "with" => {
+    "another" => :value
+  }
+}
+
+ConfigVolumizer.fetch(env, "some", mapping)
+
+# returns:
+{
+ "setting" => [
+   "one","two","three"
+ ],
+ "with" => {
+   "another" => "setting",
+ }
+}
+```
+
+fetch works much like Hash#fetch, so you can pass an additional
+parameter for the default value, as well as use a block default value.
+
+eg:
+
+```ruby
+ConfigVolumizer.fetch(env, "another", mapping, "default_value")
+# => "default_value"
+
+ConfigVolumizer.fetch(env, "another", mapping) { |key| "default_#{key}" }
+# => "default_another"
+```
+
 ### Generation
 
 You can generate a flat list of configs (mostly as examples for your actual config) via:

data/Rakefile

@@ -35,5 +35,5 @@ task :doc => :yard
 
 desc "Updates the changelog"
 task :changelog do
-  sh "github_changelog_generator payrollhero/dispatch-rider"
+  sh "github_changelog_generator payrollhero/config_volumizer"
 end

data/lib/config_volumizer.rb

@@ -11,12 +11,27 @@ module ConfigVolumizer
     # @see ConfigVolumizer::Parser.parse
     #
     # @param [Hash] source
-    # @param [String] base_name
+    # @param [Hash] mapping
     # @return [Hash]
     def parse(source, mapping)
       Parser.parse(source, mapping)
     end
 
+    # Fetches the data described by the mapping from the source
+    # works similar to #parse, but has a default value mechanism
+    # and skips the root key
+    #
+    # @param [Hash] source
+    # @param [String] mapping_key
+    # @param [Object] mapping_info
+    # @param [Object] default - default value if key not found
+    # @param [proc] block - default value proc (is passed key as parameter)
+    # @return [Object]
+    def fetch(source, mapping_key, mapping_info, default=nil, &block)
+      value = Parser.parse(source, mapping_key => mapping_info)
+      value.fetch(mapping_key, *[default].compact, &block)
+    end
+
     # Generates a flattened config out of a data hash
     #
     # @see ConfigVolumizer::Generator.generate

data/lib/config_volumizer/parser.rb

@@ -13,7 +13,6 @@ module ConfigVolumizer
       # See Readme for an example
       #
       # @param [Hash] source
-      # @param [String] base_name
       # @param [Hash] mapping
       # @return [Hash]
       def parse(source, mapping)

data/lib/config_volumizer/version.rb

@@ -1,3 +1,3 @@
 module ConfigVolumizer
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/spec/config_volumizer_spec.rb

@@ -6,7 +6,7 @@ describe ConfigVolumizer do
 
     describe "1 level hash" do
       let(:input) { { "ex" => "1a" } }
-      let(:mapping) { { "ex" => :value }}
+      let(:mapping) { { "ex" => :value } }
       let(:expected_result) { { 'ex' => '1a' } }
 
       example do
@@ -325,4 +325,103 @@ describe ConfigVolumizer do
     end
 
   end
+
+  describe "fetch" do
+    let(:key_name) { "some_gem_settings" }
+    let(:result) { ConfigVolumizer.fetch(env, key_name, mapping) }
+
+    context "basic example" do
+      let(:env) do
+        {
+          "some_gem_settings_one" => "hello",
+          "some_gem_settings_two" => "world",
+          "some_gem_settings_three" => "yay",
+        }
+      end
+      let(:mapping) { :hash }
+      let(:expected) do
+        {
+          "one" => "hello",
+          "two" => "world",
+          "three" => "yay",
+        }
+      end
+
+      example { expect(result).to eq(expected) }
+    end
+
+    context "complex example" do
+      let(:env) do
+        {
+          "some_gem_settings_key1_one" => "hello1",
+          "some_gem_settings_key1_two" => "hello2",
+          "some_gem_settings_key2" => "hello,world",
+          "some_gem_settings_key3_0_foo_one" => "1",
+          "some_gem_settings_key3_0_foo_two" => "2",
+          "some_gem_settings_key3_1_foo_one" => "3",
+          "some_gem_settings_key3_1_foo_two" => "4",
+          "some_gem_settings_key3_2_foo_one" => "5",
+          "some_gem_settings_key3_2_foo_two" => "6",
+        }
+      end
+      let(:mapping) do
+        {
+          "key1" => :hash,
+          "key2" => [:value],
+          "key3" => [
+            {
+              "foo" => :hash,
+            }
+          ],
+        }
+      end
+      let(:expected) do
+        {
+          "key1" => { "one" => "hello1", "two" => "hello2" },
+          "key2" => ["hello", "world"],
+          "key3" => [{ "foo" => { "one" => 1, "two" => 2 } },
+                     { "foo" => { "one" => 3, "two" => 4 } },
+                     { "foo" => { "one" => 5, "two" => 6 } }]
+        }
+      end
+
+      example { expect(result).to eq(expected) }
+    end
+
+    context "key not found" do
+      let(:key_name) { "not_found" }
+      let(:env) do
+        {
+          "some_gem_settings_one" => "hello",
+          "some_gem_settings_two" => "world",
+          "some_gem_settings_three" => "yay",
+        }
+      end
+      let(:mapping) { :hash }
+
+      context "not specifying a default" do
+        let(:result) { ConfigVolumizer.fetch(env, key_name, mapping) }
+
+        example do
+          expect { result }.to raise_exception(KeyError)
+        end
+      end
+
+      context "specifying a default value" do
+        let(:result) { ConfigVolumizer.fetch(env, key_name, mapping, "default_value") }
+        let(:expected) { "default_value" }
+
+        example { expect(result).to eq(expected) }
+      end
+
+      context "specifying a default block" do
+        let(:result) { ConfigVolumizer.fetch(env, key_name, mapping) { |key| "default_#{key}" } }
+        let(:expected) { "default_not_found" }
+
+        example { expect(result).to eq(expected) }
+      end
+
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: config_volumizer
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Piotr Banasik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-18 00:00:00.000000000 Z
+date: 2015-12-01 00:00:00.000000000 Z
 dependencies: []
 description: Allows turning dot notation config from ENV to rich Hash/Array structures
 email: piotr.banasik@gmail.com
@@ -22,7 +22,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - ".yardopts"
-- ChangeLog.md
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -55,7 +55,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Adds volume to an otherwise flat config

data/ChangeLog.md

@@ -1,5 +0,0 @@
-### 0.2.0 / 2015-04-03
-
-* Initial release:
- - Implements parsing
- - Implements generation