envolve 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bcf4d1b8c8e82829351a0c08bfd021da5f1bb0bd
-  data.tar.gz: 2fcf17f17172ec0fe8ecae50aa3abfc32952e081
+  metadata.gz: 94e9f25547cce1d320142122f72d7d580f52bd1e
+  data.tar.gz: 3cc94c1b0a79e41cda8dd96d1713077ffcfb73d9
 SHA512:
-  metadata.gz: 954bd0dc4b0d00bb6585d573f11048975219e27fc4828d50af831f10430b4801ba0788ecb69021aaba8ecd10d51139d44a99e163032d794bf11f2aeae168d868
-  data.tar.gz: a7a4b3f7ba9f453e733cfd56997e48d4db87b41b1afc9de829db21b1e80ba49eed5ce5587cbd9bf05fc9cada002aaeaa68d4056ee391f015da836c9d7d74e0dc
+  metadata.gz: 30b91a69a0210626901e6a0aa6feb34948e5d97b0c6fa6e488dc7e2ab6f59351eaec3c74c2fb2e7f6008db9d3ebf8e9d391779b7dc11352ee1dd01f1f31717d0
+  data.tar.gz: 58e606ad44024f0752863505c9951ac27d8072973cdc55341288e11d52a4170193165e3ffbf0b1ff5b278bc1fda5c3eb3c2be7b2044dba0f52a4bd4499bf8c64

data/HISTORY.md

@@ -1,4 +1,8 @@
 # Envolve Changelog
+## Version 1.1.0 - 2014-12-07
+
+* Add the ability to have required properties
+
 ## Version 1.0.1
 
 * Fix bug where ENV is only retrieved 1 time ever [Issue #1](https://github.com/copiousfreetime/envolve/issues/1).

data/Manifest.txt

@@ -6,6 +6,7 @@ README.md
 Rakefile
 lib/envolve.rb
 lib/envolve/config.rb
+lib/envolve/error.rb
 lib/envolve/version.rb
 tasks/default.rake
 tasks/this.rb

data/Rakefile

@@ -7,9 +7,9 @@ This.email    = "jeremy@copiousfreetime.org"
 This.homepage = "http://github.com/copiousfreetime/#{ This.name }"
 
 This.ruby_gemspec do |spec|
-  spec.add_development_dependency( 'rake'     , '~> 10.3')
+  spec.add_development_dependency( 'rake'     , '~> 10.4')
   spec.add_development_dependency( 'minitest' , '~> 5.4' )
-  spec.add_development_dependency( 'rdoc'     , '~> 4.1' )
+  spec.add_development_dependency( 'rdoc'     , '~> 4.2' )
   spec.add_development_dependency( 'simplecov', '~> 0.9' )
 end
 

data/lib/envolve.rb

@@ -6,4 +6,5 @@ module Envolve
   end
 end
 require 'envolve/version'
+require 'envolve/error'
 require 'envolve/config'

data/lib/envolve/config.rb

@@ -1,10 +1,11 @@
+require 'envolve/error'
 module Envolve
   # Public: A Configuration class to hold your application configuration
   #
   # Feed it ENV or some other Hash-like object and it will allow you to access
   # the elements in that hash via methods.
   #
-  # You can also tell it to only pull those items from the initial has that have
+  # You can also tell it to only pull those items from the initial hash that have
   # a particular prefix, and that prefix will be stripped off of the elements
   # for access.
   class Config
@@ -50,7 +51,7 @@ module Envolve
 
     # Public: Set a property, with possible transformations
     #
-    # In the conversion of a the environment to the configuration properties
+    # In the conversion of the environment to the configuration properties
     # sometimes the keys and/or values need to be converted to a new name.
     #
     # All property transformations take place AFTER the initial keys have been downcased
@@ -59,13 +60,16 @@ module Envolve
     # property - the name of the property we want to appear in the configuration
     # key      - the source key from the environment where this property comes from
     # value    - the new value for this property
-    # default  - setting a default for this property should it not exist
+    # default  - setting a default for this property should the environment not
+    #            provide a value
+    # required - this property is required to be set via env. If it is not, an
+    #            execption is raised when the environment is parsed
     #
     # value may also be a lambda, in which ase the lambda is given the original
     # value and the return value from the labmda is used for the new value.
     #
-    def self.property( property, key: nil, value: nil, default: nil )
-      properties[property] = { :key => key, :value => value, :default => default }
+    def self.property( property, key: nil, value: nil, default: nil, required: false )
+      properties[property] = { :key => key, :value => value, :default => default, :required => required }
     end
 
     # Internal: Return the hash holding the properties
@@ -75,7 +79,7 @@ module Envolve
       @_properties ||= Hash.new
     end
 
-    # Internal: The internal hash holding all the keys and values
+    # Internal: The internal hash like item holding all the keys and values
     attr_reader :_env
 
     # Internal: The prefix to strip off all the keys
@@ -107,6 +111,7 @@ module Envolve
 
     # Internal: Transform the environment variables to propreties
     #
+    # Raises MissingPropertyError if the property is required
     # Returns the transformed hash
     def transform_properties( env, properties )
       transformed = env.to_h.dup
@@ -117,6 +122,7 @@ module Envolve
         if value = transformed.delete(src_key) then
           value = apply_transformation(value, trans[:value]) if trans[:value]
         elsif value.nil? then
+          ::Envolve::MissingPropertyError.raise(_prefix, src_key) if trans[:required]
           value = trans[:default] if trans[:default]
         end
         transformed[dest_key] = value

data/lib/envolve/error.rb

@@ -0,0 +1,8 @@
+module Envolve
+  class Error < ::StandardError; end
+  class MissingPropertyError < Error
+    def self.raise(_prefix, env_var)
+      Kernel.raise(self, "Missing environment variable #{[ _prefix, env_var].compact.join('_').upcase}")
+    end
+  end
+end

data/lib/envolve/version.rb

@@ -1,3 +1,3 @@
 module Envolve
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/test/test_helper.rb

@@ -1,6 +1,5 @@
 require 'simplecov'
 SimpleCov.start if ENV['COVERAGE']
 
-gem 'minitest'
 require 'minitest/autorun'
 require 'minitest/pride'

data/test/test_property_config.rb

@@ -1,30 +1,38 @@
 require 'test_helper'
 require 'envolve/config'
 
-class PropertyConfig < ::Envolve::Config
-  environment_source {
-    {
-      'EV_TEST_1' => 'test-1',
-      'EV_TEST_2' => 'test-2',
-      'EV_FOO'    => 'test-bar',
-      'EV_WIBBLE' => 'wobble',
+class TestPropertyConfig < ::Minitest::Test
+  class PropertyConfig < ::Envolve::Config
+    environment_source {
+      {
+        'EV_TEST_1' => 'test-1',
+        'EV_TEST_2' => 'test-2',
+        'EV_FOO'    => 'test-bar',
+        'EV_WIBBLE' => 'wobble',
+      }
     }
-  }
 
-  prefix 'ev'
+    prefix 'ev'
 
-  property 'bar',    :key => 'foo'
-  property 'wibble', :value => lambda { |val| val.gsub('o', 'ee') }
-  property 'ara',    :default => 42, :value => lambda { |val| Integer(val) }
+    property 'bar',    :key => 'foo'
+    property 'wibble', :value => lambda { |val| val.gsub('o', 'ee') }
+    property 'ara',    :default => 42, :value => lambda { |val| Integer(val) }
 
-end
+  end
+
+  class PropertyMustConfig < ::Envolve::Config
+    property 'envolve_test_must',   :required => true
+  end
+
+  class PrefixPropertyMustConfig < ::Envolve::Config
+    prefix 'envolve_test'
+    property 'required_property',   :required => true
+  end
 
-class TestPropertyConfig < ::Minitest::Test
   def setup
     @config = PropertyConfig.new
   end
 
-
   def test_access_key_as_method
     assert_equal( 'test-1', @config.test_1 )
   end
@@ -50,4 +58,26 @@ class TestPropertyConfig < ::Minitest::Test
     assert_equal( 42, @config['ara'] )
   end
 
+
+  def test_required_property
+    assert_raises(::Envolve::MissingPropertyError) {
+      PropertyMustConfig.new
+    }
+  end
+
+  def test_required_property_error_message
+    begin
+      PropertyMustConfig.new
+    rescue ::Envolve::MissingPropertyError => e
+      assert_match( /\s+ENVOLVE_TEST_MUST\Z/, e.message )
+    end
+  end
+
+  def test_required_property_error_message_includes_prefix
+    begin
+      PrefixPropertyMustConfig.new
+    rescue ::Envolve::MissingPropertyError => e
+      assert_match( /\s+ENVOLVE_TEST_REQUIRED_PROPERTY\Z/, e.message )
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: envolve
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Jeremy Hinegardner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-01 00:00:00.000000000 Z
+date: 2014-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '10.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '10.4'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '4.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +86,7 @@ files:
 - Rakefile
 - lib/envolve.rb
 - lib/envolve/config.rb
+- lib/envolve/error.rb
 - lib/envolve/version.rb
 - tasks/default.rake
 - tasks/this.rb