qonfig 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c0b292545534b8b00206fd23720da284b5028075c172133d4813e4b6f23f6dc
-  data.tar.gz: f83fb1c73fa7485ef2fe21c5b27277700255c3a012355576f1261750f130eb06
+  metadata.gz: 5ca1aaa94952636ee2ef114d513d68b4836f9162f02b2296ec0fb3fa16037761
+  data.tar.gz: afc6d9158a2ce2a3c862987a22c20c922a4025d2025f01d5ca5d591429531c4a
 SHA512:
-  metadata.gz: 30bf79cc84a571522d1c7df4c05d3330f5b577fc12597035cdcc5a56b667dbb0e80466781627c0312bebeb31bc72a2f567439cfc11b13ae6519888bbd1bad611
-  data.tar.gz: 80c56739bcfd8664485fae8c5a080041a4357bbc72f90cf6f6b4137c0c4076b0159458d8f4397bab4892173e12dc1c12db01b01d922b4a66f6fb723f44280297
+  metadata.gz: 895e6bfe6c185e71d81f9a8f55740f48e12b2aff55cd3116ae12f9b68423b7726317263f33ab49e85cc670608a159de2efcc91882ec79dd00b40236f2f41d91f
+  data.tar.gz: 82187c64659aad286d3370e7da6ae8e7506a988a4ff056181df8073aa0039b4bc9210fdaa70cd4a11f27b0fc3c2be26651f96ce42e5fa5c50b1d68739436c42c

data/CHANGELOG.md

@@ -1,10 +1,14 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.9.0] - 2018-11-28
+### Added
+- `#slice` - get a slice of config options as a hash set (works in a `#dig` manner);
+
 ## [0.8.0] - 2018-11-21
 ### Changed
 - `expose_yaml`, `load_from_yaml`, `load_from_json` and `load_from_self` treats empty hash (`{}`)
-  as an option with empty hash value (previously treated as a nested setting);
+  as an option with empty hash value (previously treated as a nested setting without options);
 
 ## [0.7.0] - 2018-10-20
 ### Added

data/README.md

@@ -21,7 +21,7 @@ require 'qonfig'
 
 ## Usage
 
-- [Definition and Access](#definition-and-access)
+- [Definition and Settings Access](#definition-and-access)
 - [Configuration](#configuration)
 - [Inheritance](#inheritance)
 - [Composition](#composition)
@@ -43,6 +43,7 @@ require 'qonfig'
 ### Definition and Access
 
 ```ruby
+# --- definition ---
 class Config < Qonfig::DataSet
   # nil by default
   setting :project_id
@@ -60,7 +61,9 @@ class Config < Qonfig::DataSet
   end
 end
 
-config = Config.new
+config = Config.new # your configuration object instance
+
+# --- setting access ---
 
 # get option value via method
 config.settings.project_id # => nil
@@ -89,6 +92,12 @@ config[:enable_graphql] # => false
 # get option value in Hash#dig manner (and fail when the required key does not exist)
 config.dig(:vendor_api, :host) # => 'app.service.com' # (key exists)
 config.dig(:vendor_api, :port) # => Qonfig::UnknownSettingError # (key does not exist)
+
+# get a hash slice of setting options (and fail when the required key does not exist)
+config.slice(:vendor_api) # => { 'vendor_api' => { 'host' => 'app_service', 'user' => 'test_user' } }
+config.slice(:vendor_api, :user) # => { 'user' => 'test_user' }
+config.slice(:project_api) # => Qonfig::UnknownSettingError # (key does not exist)
+config.slice(:vendor_api, :port) # => Qonfig::UnknownSettingError # (key does not exist)
 ```
 
 ---

data/lib/qonfig/data_set.rb

@@ -95,6 +95,15 @@ module Qonfig
       thread_safe_access { settings.__dig__(*keys) }
     end
 
+    # @param keys [Array<String, Symbol>]
+    # @return [Hash]
+    #
+    # @api public
+    # @since 0.9.0
+    def slice(*keys)
+      thread_safe_access { settings.__slice__(*keys) }
+    end
+
     # @return [void]
     #
     # @api public

data/lib/qonfig/settings.rb

@@ -94,6 +94,15 @@ module Qonfig
       __lock__.thread_safe_access { __deep_access__(*keys) }
     end
 
+    # @param keys [Array<String, Symbol>]
+    # @return [Hash]
+    #
+    # @api private
+    # @since 0.9.0
+    def __slice__(*keys)
+      __lock__.thread_safe_access { __deep_slice__(*keys) }
+    end
+
     # @return [Hash]
     #
     # @api private
@@ -266,7 +275,6 @@ module Qonfig
     end
 
     # @param keys [Array<Symbol, String>]
-    # @option result [Object]
     # @return [Object]
     #
     # @raise [Qonfig::ArgumentError]
@@ -293,6 +301,23 @@ module Qonfig
       end
     end
 
+    # @param keys [Array<Symbol, String>]
+    # @return [Hash]
+    #
+    # @raise [Qonfig::ArgumentError]
+    # @raise [Qonfig::UnknownSettingError]
+    #
+    # @api private
+    # @since 0.9.0
+    def __deep_slice__(*keys)
+      {}.tap do |result|
+        __deep_access__(*keys).tap do |setting|
+          required_key = __indifferently_accessable_option_key__(keys.last)
+          result[required_key] = setting.is_a?(Qonfig::Settings) ? setting.__to_h__ : setting
+        end
+      end
+    end
+
     # @param options_part [Hash]
     # @return [Hash]
     #

data/lib/qonfig/version.rb

@@ -5,5 +5,5 @@ module Qonfig
   #
   # @api public
   # @since 0.1.0
-  VERSION = '0.8.0'
+  VERSION = '0.9.0'
 end

data/qonfig.gemspec

@@ -1,4 +1,4 @@
-# codning: utf-8
+# coding: utf-8
 # frozen_string_literal: true
 
 lib = File.expand_path('lib', __dir__)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qonfig
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Rustam Ibragimov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-21 00:00:00.000000000 Z
+date: 2018-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coveralls