env-config 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1896a65fd942910ad642261a1fd8c527e6a2e24
-  data.tar.gz: 84624eb3c1508cd45a14fcb15d320d271ef16c7d
+  metadata.gz: 1a790b308075dbab78e02d9a57d4882a7d092e8c
+  data.tar.gz: 058a99ca23ba4107d5c078e6802c64afc3534312
 SHA512:
-  metadata.gz: 6809a76d3f24d34ded0ba3ab0668c2128dcaa9c0be61a331ae46501dbe559da4759b7a6aaa6cc1f28720fdb3bb8634e575f5e29de26b72459505cb319c412eb1
-  data.tar.gz: 38daa24b84ce05fb52603da0ae546d9eb4a2717114573a0ec50d989b227240096fd2544f1680450221eb5a6a17846826c15efcb892a63ebb88994e0602550e56
+  metadata.gz: d5ceacc2c99f120fc3dca0fda1b11c5484c7a435dfb1ab3d4aad838e4e86cb05fdcb18583352c235c8db49455b4b88a12d16410c2dda9fc2aff640b0bad54d0a
+  data.tar.gz: d6c7525ab5be1de756b93dcf4889bf76a2befbb2d4cfbfbe5db3d0a4156c4a65ec0003b302d52dcbe06c195bac7670c3989014db9fc540d8369ac0e8edcd3f8c

data/README.md

@@ -1,5 +1,43 @@
-Configuration
-=============
+# EnvConfig
 
 Basic ruby environment-dependent configuration
 
+## usage example:
+
+``` ruby
+# environment.rb
+EnvConfig.configure(:default) do |config|
+  config[:verbose] = true
+end
+
+# test.rb
+EnvConfig.configure(:test) do |config|
+  config[:verbose] = false
+end
+
+# development.rb
+EnvConfig.configure(:development) do |config|
+end
+
+
+config = EnvConfig.new(:test)
+config[:verbose] # => false
+
+config = EnvConfig.new(:development)
+config[:verbose] # => true
+```
+
+## Exceptions
+
+``` ruby
+config[:unknown_key_12345] # => EnvConfig::ArgumentError
+
+config = EnvConfig.new(:unknown_env_123) # => EnvConfig::UnknownEnvironmentError
+
+config = EnvConfig.new(:default) # => EnvConfig::AbstractError
+
+EnvConfig.configure(:test) do ...
+EnvConfig.configure(:default) do ... # => EnvConfig::LoadOrderError
+
+config[:verbose] = false # => EnvConfig::ImmutableError
+```

data/lib/env_config.rb

@@ -21,12 +21,27 @@
 # config = EnvConfig.new(:development)
 # config[:verbose] # => true
 #
+#
+# Exceptions:
+#
+# config[:unknown_key_12345] # => EnvConfig::ArgumentError
+#
+# config = EnvConfig.new(:unknown_env_123) # => EnvConfig::UnknownEnvironmentError
+#
+# config = EnvConfig.new(:default) # => EnvConfig::AbstractError
+#
+# EnvConfig.configure(:test) do ...
+# EnvConfig.configure(:default) do ... # => EnvConfig::LoadOrderError
+#
+# config[:verbose] = false # => EnvConfig::ImmutableError
+#
 class EnvConfig
 
   class UnknownEnvironmentError < RuntimeError ; end
   class AbstractError < RuntimeError ; end
   class LoadOrderError < RuntimeError ; end
   class ImmutableError < RuntimeError ; end
+  class ArgumentError < ::ArgumentError ; end
 
   @@configurations = {}
 
@@ -45,6 +60,10 @@ class EnvConfig
   end
 
   def [](key)
+    # be strict 
+    if !get_config.has_key?(key)
+      raise ArgumentError.new("key '#{key}' not defined in configuration or default")
+    end
     get_config[key]
   end
 

data/lib/version.rb

@@ -1,3 +1,3 @@
 class EnvConfig
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/test/env_config_test.rb

@@ -40,6 +40,13 @@ class EnvConfigTest < MiniTest::Test
     assert_equal 'default default_test_setting', config[:default_test_setting]
   end
 
+  def test_raises_if_config_key_not_set_in_at_least_default
+    config = EnvConfig.new('test')
+    assert_raises EnvConfig::ArgumentError do
+      config[:unknown_test_setting_12345]
+    end
+  end
+
   def test_environment_specific_setting_overrides_default
     EnvConfig.configure(:test2) do |config|
       config[:default_test_setting] = 'overwritten default_test_setting'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: env-config
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Markus Seeger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-01 00:00:00.000000000 Z
+date: 2014-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake