configvar 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37d5bee26a68074ec2e63a8e194291aeac3c68cc
-  data.tar.gz: 3110ae9bf7e441707e9ec653c9dddd69466afdee
+  metadata.gz: 2db7f4b9d6800b17346be3aa65e6d21425b06cc4
+  data.tar.gz: b7d4b89e25feaee02447fb8015c0ca9ac06cd8f6
 SHA512:
-  metadata.gz: e12a77bb4ce46bd1acb00786c607fd5864853ecca90d305c0aa5af115c494a5c75d11000db603a7f5df9b545ffd98880fbc5f6f011de7099a65f161d7ed9a7ba
-  data.tar.gz: d2cf44ff80a9cde9d07bfefa626c4dab06a2384a01ee4cdf66888bee72fec63d2d66ca8eedc8b76eb2a1974f910394b3da479e7309509bcd5ab4fe7c82667c90
+  metadata.gz: 7b0915605672ce36a0c273463ae90ede1974d40b82674bf67913ca2f73ffef717d13e1caf9ec61294b823b560f8075f05be40b2d1cd555c879f35ac61c664aac
+  data.tar.gz: a9d04070a911fd5e8ab899a3f0053260ec9ddf869fff63df463b94eaba807cdf0a1d2b6452c469c882265682130c8bba65946450ce915c6cf58c058744922e39

data/.gitignore

@@ -0,0 +1 @@
+pkg/

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    configvar (0.0.1)
+    configvar (0.0.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://magnum.travis-ci.com/heroku/configvar.svg?token=uNxDxTYyzRaxPpJGQ5yq)](https://magnum.travis-ci.com/heroku/configvar)
+[![Build Status](https://travis-ci.org/heroku/configvar.svg?branch=master)](https://travis-ci.org/heroku/configvar)
 
 # ConfigVar
 
@@ -52,10 +52,8 @@ When simple string, integer and boolean values aren't sufficient you can
 provide a block to process values from the environment according to your
 needs.  For example, if you want to load a required integer that must always
 be 0 or greater you can provide a custom block to do the required validation.
-It must take the environment to load values from and return a `Hash` of values
-to include in the loaded configuration.  The block should raise a
-`ConfigVar::ConfigError` or `ArgumentError` exception if a required value is
-missing or if any loaded value is invalid, respectively.
+It must take the environment to load values from and return a value to include
+in the loaded configuration.
 
 ```ruby
 config = ConfigVar.define do
@@ -65,7 +63,7 @@ config = ConfigVar.define do
       if value < 0
         raise ArgumentError.new("#{value} for AGE must be a 0 or greater")
       end
-      {age: value}
+      value
     else
       raise ConfigVar::ConfigError.new(name)
     end
@@ -73,10 +71,10 @@ config = ConfigVar.define do
 end
 ```
 
-Custom functions can return multiple key/value pairs and all of them will be
-included in the loaded configuration.  For example, if you want to extract
-parts of a URL and make them available as individual configuration variables
-you can provide a custom block to do so:
+Custom functions can return multiple key/value pairs in a `Hash` and all of
+them will be included in the loaded configuration.  For example, if you want
+to extract parts of a URL and make them available as individual configuration
+variables you can provide a custom block to do so:
 
 ```ruby
 config = ConfigVar.define do

data/lib/configvar/context.rb

@@ -60,9 +60,10 @@ module ConfigVar
 
     # Define a required custom config var.  The block must take the
     # environment as a parameter, load and process values from the it, and
-    # return a hash that will be merged into the collection of all config
-    # vars.  If a required value is not found in the environment the block
-    # must raise a ConfigVar::ConfigError exception.
+    # return either a single value to bind to the name of the configuration
+    # variable or a `Hash` that will be merged into the collection of all
+    # config vars.  If a required value is not found in the environment the
+    # block must raise a ConfigVar::ConfigError exception.
     def required_custom(name, &blk)
       define_config(name, &blk)
     end
@@ -100,10 +101,11 @@ module ConfigVar
       end
     end
 
-    # Define a required custom config var.  The block must take the
+    # Define an optional custom config var.  The block must take the
     # environment as a parameter, load and process values from the it, and
-    # return a hash that will be merged into the collection of all config
-    # vars.
+    # return either a single value to bind to the name of the configuration
+    # variable or a `Hash` that will be merged into the collection of all
+    # config vars.
     def optional_custom(name, &blk)
       define_config(name, &blk)
     end
@@ -135,7 +137,14 @@ module ConfigVar
       if @definitions.has_key?(name)
         raise ConfigError.new("#{name.to_s.upcase} is already registered")
       end
-      @definitions[name] = blk
+      @definitions[name] = Proc.new do |env|
+        value = yield env
+        if value.kind_of?(Hash)
+          value
+        else
+          {name => value}
+        end
+      end
     end
   end
 end

data/lib/configvar/version.rb

@@ -1,3 +1,3 @@
 module ConfigVar
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/test/context_test.rb

@@ -112,6 +112,17 @@ class ContextTest < Minitest::Test
     assert_equal(42, context.age)
   end
 
+  # Context.reload associates a single value returned from the custom block
+  # with the name specified in the configuration definition.
+  def test_reload_optional_custom_with_single_value
+    context = ConfigVar::Context.new
+    context.required_custom :name do |env|
+      'Bob'
+    end
+    context.reload({})
+    assert_equal('Bob', context.name)
+  end
+
   # Context.reload loads optional string values.
   def test_reload_optional_string
     context = ConfigVar::Context.new
@@ -195,6 +206,17 @@ class ContextTest < Minitest::Test
     assert_equal(42, context.age)
   end
 
+  # Context.reload associates a single value returned from the custom block
+  # with the name specified in the configuration definition.
+  def test_reload_optional_custom_with_single_value
+    context = ConfigVar::Context.new
+    context.optional_custom :name do |env|
+      'Bob'
+    end
+    context.reload({})
+    assert_equal('Bob', context.name)
+  end
+
   # Context.reload reinitialized loaded values from the provided environment.
   def test_reload
     context = ConfigVar::Context.new

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: configvar
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - jkakar
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-16 00:00:00.000000000 Z
+date: 2015-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -61,6 +61,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock