config 1.5.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0bfea09c1ef9b78b0942e487411324dc3af0772c
-  data.tar.gz: ac44c082dd7fb235f7bd5345d15d8f581cecb528
+  metadata.gz: 208da22ed967b6e2d8122a591eb0b34cb0d7e574
+  data.tar.gz: 155481bf4b306be34a9e36641d73f3a3464af0b1
 SHA512:
-  metadata.gz: 034d7088dc7729f0f849fd956620fe4fc25da2995b26f886c5e7bf7c14261aa329a7b74d94881162c93b316a8f840db694ae032cf16897746d1091a52b978b05
-  data.tar.gz: 259b136866b0ed5f49add1bdd81f26e05b1caac25e9673eeaefdb18d907813649dfe688bfeb3238d9de3c5ac0bfd453cccd398ca363b50d8cd0ab32df5c158cf
+  metadata.gz: 89c487205d5b8ed2f29902aad3e0b1f57ffe9503328231d89fe5f8b3487aee97199fdb8b3eb5d00ad118025e3e33201cf5dc264344f8d249afe979a3b1eab272
+  data.tar.gz: a0a7faace3de2e72c84e51f940aebfa6a22fadaa7d257c081f5097993bcf98e2e6ccbaa6c049aee495b82579887b1775ae9658daf2215286f5357d7cd0eb3966

data/CHANGELOG.md

@@ -2,9 +2,14 @@
 
 ## Unreleased
 
+...
+
+## 1.6.0
+
 ### New features
 
-...
+* `Config#fail_on_missing` option (default `false`) to raise a `KeyError` exception when accessing a non-existing key
+* Add ability to test if a value was set for a given key with `key?` and `has_key?`
 
 ## 1.5.1
 

data/README.md

@@ -299,6 +299,49 @@ between the schema and your config.
 
 Check [dry-validation](https://github.com/dry-rb/dry-validation) for more details.
 
+### Missing keys
+
+For an example settings file:
+
+```yaml
+size: 1
+server: google.com
+```
+
+You can test if a value was set for a given key using `key?` and its alias `has_key?`:
+
+```ruby
+Settings.key?(:path)
+# => false
+Settings.key?(:server)
+# => true
+```
+
+By default, accessing to a missing key returns `nil`:
+
+```ruby
+Settings.key?(:path)
+# => false
+Settings.path
+# => nil
+```
+
+This is not "typo-safe". To solve this problem, you can configure the `fail_on_missing` option:
+
+```ruby
+Config.setup do |config|
+  config.fail_on_missing = true
+  # ...
+end
+```
+
+So it will raise a `KeyError` when accessing a non-existing key (similar to `Hash#fetch` behaviour):
+
+```ruby
+Settings.path
+# => raises KeyError: key not found: :path
+```
+
 ### Environment variables
 
 See section below for more details.

data/lib/config.rb

@@ -15,13 +15,15 @@ module Config
   # Ensures the setup only gets run once
   @@_ran_once = false
 
-  mattr_accessor :const_name, :use_env, :env_prefix, :env_separator, :env_converter, :env_parse_values
+  mattr_accessor :const_name, :use_env, :env_prefix, :env_separator,
+                 :env_converter, :env_parse_values, :fail_on_missing
   @@const_name = 'Settings'
   @@use_env    = false
   @@env_prefix = @@const_name
   @@env_separator = '.'
   @@env_converter = :downcase
   @@env_parse_values = true
+  @@fail_on_missing = false
 
   # deep_merge options
   mattr_accessor :knockout_prefix, :overwrite_arrays

data/lib/config/options.rb

@@ -153,6 +153,19 @@ module Config
       end
     end
 
+    delegate :key?, :has_key?, to: :table
+
+    def method_missing(method_name, *args)
+      if Config.fail_on_missing && method_name !~ /.*(?==\z)/m
+        raise KeyError, "key not found: #{method_name.inspect}" unless key?(method_name)
+      end
+      super
+    end
+
+    def respond_to_missing?(*args)
+      super
+    end
+
     protected
 
     def descend_array(array)

data/lib/config/version.rb

@@ -1,3 +1,3 @@
 module Config
-  VERSION = '1.5.1'
+  VERSION = '1.6.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: config
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.6.0
 platform: ruby
 authors:
 - Piotr Kuczynski
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-23 00:00:00.000000000 Z
+date: 2017-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport