config_reader 1.0.3 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02627114450472254b226d2ffc7092a276ab4179
-  data.tar.gz: 053954bea858dcd8b10895371f791130b72dbc07
+  metadata.gz: 3fa20c036bed02f5864bb5fdaebbd2f0ecce3315
+  data.tar.gz: cea79cb4e8a5b14456f64d3988fe2f9274f36099
 SHA512:
-  metadata.gz: 6baee2f52c7b2c2eede17cffc14c4981aa886e555195e48a77dd42ba2ce582f00f93ae789ea76cbf259e792f8576881a4b4d73317d3866392c095ebd98dbb79a
-  data.tar.gz: 2c5bbc7636e67d247d57883a4f8e377d9d7087d00763bf5457dc949db1b2d0bf6dfca1cbdce38d2751f0f47caa4e2aa15db604fe8e614ce2a625a8e03aa6e03e
+  metadata.gz: 69f491dc61461f6d7415b65f3cf1d3ec22b64f950bd9ed996ffcbcb173c2de78e61afa87c6bdd1af1021f39bec8c0b792cd27f483c85c936ab00fd7c57055e10
+  data.tar.gz: 9bd67ba76fc575145621f4f0f274384e3fa7fef06f913876b11b3176400a9d043ace8559f55aae5b30222042ac86f30708dcf25be334955184b744963ed0f183

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    config_reader (1.0.3)
+    config_reader (1.0.5)
       deep_merge
 
 GEM
@@ -47,4 +47,4 @@ DEPENDENCIES
   sekrets (~> 1.7.0)
 
 BUNDLED WITH
-   1.15.1
+   1.16.1

data/History.rdoc

@@ -1,3 +1,9 @@
+== 1.0.5 2018-02-01
+* pass ignore_missing_keys to nested hashes during conversion
+
+== 1.0.4 2018-02-01
+* add a config option for Key Error behavior
+
 == 1.0.3 2017-06-20
 * add the deep_merge gem so all keys don't need to be duplicated across env sections
 

data/README.rdoc

@@ -27,6 +27,13 @@ Example class:
     self.config_file = 'config/my_config.yml'
   end
 
+don't throw errors on missing keys
+
+  class MyConfig < ConfigReader
+    self.config_file = 'config/my_config.yml'
+    self.ignore_missing_keys = true
+  end
+
 == Sekrets
 Now also includes Sekrets integration. https://github.com/ahoward/sekrets
 

data/lib/config_reader.rb

@@ -11,7 +11,7 @@ end
 
 class ConfigReader
   class << self
-    attr_accessor :config_file, :config, :sekrets_file
+    attr_accessor :config_file, :config, :sekrets_file, :ignore_missing_keys
 
     def config
       @config = nil unless defined?(@config)
@@ -22,6 +22,10 @@ class ConfigReader
       @config_file = file
     end
 
+    def ignore_missing_keys=(bool)
+      @ignore_missing_keys = bool
+    end
+
     def reload
       merge_configs(find_env, load_config, load_sekrets)
     end
@@ -106,7 +110,7 @@ class ConfigReader
       _conf.deep_merge!(sekrets['defaults']) if sekrets && sekrets['defaults']
       _conf.deep_merge!(conf[env]) if conf[env]
       _conf.deep_merge!(sekrets[env]) if sekrets && sekrets[env]
-      ConfigReader::MagicHash.convert_hash(_conf)
+      ConfigReader::MagicHash.convert_hash(_conf, @ignore_missing_keys)
     end
   end
 end

data/lib/config_reader/magic_hash.rb

@@ -1,12 +1,14 @@
 class ConfigReader
   class MagicHash < Hash
+    attr_accessor :ignore_missing_keys
 
-    def self.convert_hash(hash)
+    def self.convert_hash(hash, ignore_missing_keys=false)
       magic_hash = new
+      magic_hash.ignore_missing_keys = ignore_missing_keys
 
       hash.each_pair do |key, value|
         if value.is_a?(Hash)
-          magic_hash[key.to_sym] = convert_hash(value)
+          magic_hash[key.to_sym] = convert_hash(value, ignore_missing_keys)
         else
           magic_hash[key.to_sym] = value
         end
@@ -16,13 +18,21 @@ class ConfigReader
     end
 
     def [](key)
-      fetch(key.to_sym)
+      begin
+        fetch(key.to_sym)
+      rescue KeyError => e
+        raise e unless ignore_missing_keys
+      end
     end
 
     def method_missing(key, *args, &block)
-      has_key?(key) ?
-        fetch(key) :
-        super
+      begin
+        has_key?(key) ?
+          fetch(key) :
+          super
+      rescue KeyError, NoMethodError => e
+        raise e unless ignore_missing_keys
+      end
     end
 
   end

data/lib/config_reader/version.rb

@@ -1,3 +1,3 @@
 class ConfigReader
-  VERSION = "1.0.3"
+  VERSION = "1.0.5"
 end

data/spec/config_reader_spec.rb

@@ -16,6 +16,58 @@ describe "ConfigReader" do
     end
   end
 
+  describe "default KeyNotFound behavior" do
+    it "should raise on missing key with [] accessor" do
+      expect {
+        TestConfig[:no_key]
+      }.to raise_error(KeyError)
+    end
+
+    it "should raise on missing key with #key accessor" do
+      expect {
+        TestConfig.no_key
+      }.to raise_error(KeyError)
+    end
+
+    it "should raise on missing nested key with [] accessor" do
+      expect {
+        TestConfig[:nested_key][:missing]
+      }.to raise_error(KeyError)
+    end
+
+    it "should raise on missing nested key with #key accessor" do
+      expect {
+        TestConfig.nested_key.missing
+      }.to raise_error(NoMethodError)
+    end
+  end
+
+  describe "ignoring KeyNotFound" do
+    it "should not raise on missing key with [] accessor" do
+      expect {
+        NoKeyNoErrorConfig[:no_key]
+      }.to_not raise_error
+    end
+
+    it "should not raise on missing key with #key accessor" do
+      expect {
+        NoKeyNoErrorConfig.no_key
+      }.to_not raise_error
+    end
+
+    it "should not raise on missing nested key with [] accessor" do
+      expect {
+        NoKeyNoErrorConfig[:nested_key][:missing]
+      }.to_not raise_error
+    end
+
+    it "should not raise on missing nested key with #key accessor" do
+      expect {
+        NoKeyNoErrorConfig.nested_key.missing
+      }.to_not raise_error
+    end
+  end
+
   describe "parsing a YAML file" do
     it "should find values with method_missing" do
       TestConfig.app_name.should == 'test_app'
@@ -56,8 +108,6 @@ describe "ConfigReader" do
   end
 
   context 'using sekrets' do
-    ENV['SEKRETS_KEY'] = 'shhh'
-
     describe "parsing a YAML file" do
       it "should find values with method_missing" do
         SekretsConfig.app_name.should == 'test_app_sekret'

data/spec/no_key_no_error_config.rb

@@ -0,0 +1,4 @@
+class NoKeyNoErrorConfig < ConfigReader
+  self.config_file = 'spec/test_config.yml'
+  self.ignore_missing_keys = true
+end

data/spec/spec_helper.rb

@@ -1,10 +1,10 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'spec'
-# require 'spec/autorun'
 require 'config_reader'
 require 'test_config'
 require 'sekrets_config'
+require 'no_key_no_error_config'
 
 ENV['RACK_ENV'] = 'test'
-ENV['SEKRETS_KEY'] = 'shhh'
+ENV['SEKRETS_KEY'] = 'ruby2.4_needs_longer_keys'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: config_reader
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.5
 platform: ruby
 authors:
 - Michael Moen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-20 00:00:00.000000000 Z
+date: 2018-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -100,6 +100,7 @@ files:
 - lib/config_reader/magic_hash.rb
 - lib/config_reader/version.rb
 - spec/config_reader_spec.rb
+- spec/no_key_no_error_config.rb
 - spec/sekrets_config.rb
 - spec/sekrets_config.yml.enc
 - spec/spec_helper.rb
@@ -124,12 +125,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: config_reader
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Provides a way to manage environment specific configuration settings.
 test_files:
 - spec/config_reader_spec.rb
+- spec/no_key_no_error_config.rb
 - spec/sekrets_config.rb
 - spec/sekrets_config.yml.enc
 - spec/spec_helper.rb