qonfig 0.18.0 → 0.18.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec197a7e1d7185ff8c4e5906e244c5cbce610d1449dc60cfb1d2a167a2e79921
-  data.tar.gz: 47d2d394cfcc97cf5ab58a198865490ecd4c9494c7ee7096474ff7a6f0c5d7f2
+  metadata.gz: 6ed2259a3f11b04bb0730f73f982228c20263340cd2aa0bd5c4e8d2a418ba04c
+  data.tar.gz: 318f345a9f6dc250725ad74bc34a12d087e9bf50d8c7c54f3cbc5d29cb211749
 SHA512:
-  metadata.gz: 87e2688f74aa2dba959c423ea79ec36686c1873e20654826ad4eefc599da6f0d9967066e8de605b0f0a83d58465ecdb3f061e193fedc1aef6223d03794ffff7f
-  data.tar.gz: 107ccfc0dfe0ee109765699c4af58d431edd572d6ea30dace2449ff87d991bc8dbb555dedf95ccf7d3101cac2fb728fd7e44dec5c8a04a74583b006926e8ec46
+  metadata.gz: 3c97a92c975202ff93d5317b3e82552a54af184f47980d146239edb528fb7d4523927939d43b0c7d98ae8a1a85b3f29cc0368eaebc164e3b930eebb477c7e10f
+  data.tar.gz: ea7e2b6e6def6d70eb7fa67f3e83c1e7920068ae253b3e2042a44164bf9486120e37395beee81c318c9ce450106ce5f4f4a0180c53f53c9e1dd3b116a4582508

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.18.1] - 2019-11-05
+### Added
+- New `yield_all:` attribute for `#deep_each_setting` method (`#deep_each_setting(yield_all: false, &block)`))
+  - `yield_all:` means "yield all config objects" (end values and root setting objects those have nested settings) (`false` by default)
+
+### Fixed
+- `#keys(all_variants: true)` returns incorrect set of keys when some of keys has name in dot-notated format;
+
 ## [0.18.0] - 2019-11-04
 ### Added
 - `#keys` - returns a list of all config keys in dot-notation format;

data/README.md

@@ -552,10 +552,10 @@ config.settings.web_api # => "api.google.com"
 
 - `#each_setting { |key, value| }`
   - iterates over the root setting keys;
-- `#deep_each_setting { |key, value| }`
+- `#deep_each_setting(yield_all: false) { |key, value| }`
   - iterates over all setting keys (deep inside);
   - key object is represented as a string of `.`-joined setting key names;
-
+  - `yield_all:` means "yield all config objects" (end values and root setting objects those have nested settings) (`false` by default);
 
 ```ruby
 class Config < Qonfig::DataSet
@@ -598,6 +598,21 @@ config.deep_each_setting { |key, value| { key => value } }
 { 'telegraf_prefix' => 'test' }
 ```
 
+#### .deep_each_setting(yield_all: true)
+
+```ruby
+config.deep_each_setting(yield_all: true) { |key, value| { key => value } }
+
+# result of each step:
+{ 'db' => <Qonfig::Settings:0x00007ff8> } # (yield_all: true)
+{ 'db.creds' => <Qonfig::Settings:0x00002ff1> } # (yield_all: true)
+{ 'db.creds.user' => 'D@iVeR' }
+{ 'db.creds.password' => 'test123' }
+{ 'db.crds.data' => { test: false } }
+{ 'telegraf_url' => 'udp://localhost:8094' }
+{ 'telegraf_prefix' => 'test' }
+```
+
 ---
 
 ### List of config keys

data/lib/qonfig/data_set.rb

@@ -281,6 +281,7 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
   end
 
   # @param block [Proc]
+  # @option yield_all [Boolean]
   # @return [Enumerable]
   #
   # @yield [setting_key, setting_value]
@@ -289,8 +290,8 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
   #
   # @api public
   # @since 0.13.0
-  def deep_each_setting(&block)
-    thread_safe_access { settings.__deep_each_setting__(&block) }
+  def deep_each_setting(yield_all: false, &block)
+    thread_safe_access { settings.__deep_each_setting__(yield_all: yield_all, &block) }
   end
 
   # @return [Boolean]

data/lib/qonfig/settings.rb

@@ -59,6 +59,7 @@ class Qonfig::Settings # NOTE: Layout/ClassStructure is disabled only for CORE_M
 
   # @param initial_setting_key [String, NilClass]
   # @param block [Proc]
+  # @option yield_all [Boolean]
   # @return [Enumerable]
   #
   # @yield [key, value]
@@ -67,9 +68,9 @@ class Qonfig::Settings # NOTE: Layout/ClassStructure is disabled only for CORE_M
   #
   # @api private
   # @since 0.13.0
-  def __deep_each_setting__(initial_setting_key = nil, &block)
+  def __deep_each_setting__(initial_setting_key = nil, yield_all: false, &block)
     __lock__.thread_safe_access do
-      __deep_each_key_value_pair__(initial_setting_key, &block)
+      __deep_each_key_value_pair__(initial_setting_key, yield_all: yield_all, &block)
     end
   end
 
@@ -312,35 +313,19 @@ class Qonfig::Settings # NOTE: Layout/ClassStructure is disabled only for CORE_M
   # @api private
   # @since 0.18.0
   def __setting_keys__(all_variants: false)
-    # NOTE: generate a set of keys return simple 'a.b.c.d'
-    setting_keys_set = Set.new.tap do |setting_keys|
-      __deep_each_key_value_pair__ do |setting_key, _setting_value|
+    # NOTE: (if all_variants == true)
+    #   We have { a: { b: { c: { d : 1 } } } }
+    #   Its mean that we have these keys:
+    #     - 'a' # => returns { b: { c: { d: 1 } } }
+    #     - 'a.b' # => returns { c: { d: 1 } }
+    #     - 'a.b.c' # => returns { d: 1 }
+    #     - 'a.b.c.d' # => returns 1
+
+    Set.new.tap do |setting_keys|
+      __deep_each_key_value_pair__(yield_all: all_variants) do |setting_key, _setting_value|
         setting_keys << setting_key
       end
-    end
-
-    if all_variants
-      # NOTE:
-      #   We have { a: { b: { c: { d : 1 } } } }
-      #   Its mean that we have these keys:
-      #     - 'a' # => returns { b: { c: { d: 1 } } }
-      #     - 'a.b' # => returns { c: { d: 1 } }
-      #     - 'a.b.c' # => returns { d: 1 }
-      #     - 'a.b.c.d' # => returns 1
-      #   So, get them all :)
-
-      setting_keys_set.each_with_object(Set.new) do |setting_key, varianted_setting_keys|
-        setting_key_paths = setting_key.split('.')
-        combination_size  = setting_key_paths.size
-
-        combination_size.times do |merged_key_patterns_count|
-          sub_setting_key = setting_key_paths.slice(0..merged_key_patterns_count).join('.')
-          varianted_setting_keys << sub_setting_key
-        end
-      end
-    else
-      setting_keys_set
-    end
+    end.to_a
   end
 
   # @return [Array<String>]
@@ -378,6 +363,7 @@ class Qonfig::Settings # NOTE: Layout/ClassStructure is disabled only for CORE_M
 
   # @param initial_setting_key [String, NilClass]
   # @param block [Proc]
+  # @option yield_all [Boolean]
   # @return [Enumerator]
   #
   # @yield [setting_key, setting_value]
@@ -386,14 +372,15 @@ class Qonfig::Settings # NOTE: Layout/ClassStructure is disabled only for CORE_M
   #
   # @api private
   # @since 0.13.0
-  def __deep_each_key_value_pair__(initial_setting_key = nil, &block)
+  def __deep_each_key_value_pair__(initial_setting_key = nil, yield_all: false, &block)
     enumerator = Enumerator.new do |yielder|
       __each_key_value_pair__ do |setting_key, setting_value|
         final_setting_key =
           initial_setting_key ? "#{initial_setting_key}.#{setting_key}" : setting_key
 
         if __is_a_setting__(setting_value)
-          setting_value.__deep_each_setting__(final_setting_key, &block)
+          yielder.yield(final_setting_key, setting_value) if yield_all
+          setting_value.__deep_each_setting__(final_setting_key, yield_all: yield_all, &block)
         else
           yielder.yield(final_setting_key, setting_value)
         end

data/lib/qonfig/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qonfig
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.18.1
 platform: ruby
 authors:
 - Rustam Ibragimov