qonfig 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 985a8b16d7fd6a86ec41fea68569c83f283e60f293ac8bca047ad4b0ca21b563
-  data.tar.gz: b94a684b24f696a67ce8c6a5ff2ceec98da628a9768ce6689fe1bd4a49ef130c
+  metadata.gz: d31eafd74da18cba4ef82848b5046df61c5804a1913b5355b76a31a35baaede0
+  data.tar.gz: 6b8d69f450b342d5a825de242fff11c016aadbcd0063c801e7d07e7c28508110
 SHA512:
-  metadata.gz: cc879948b2e2a88aa1e207802d6cc7870944af239d67a0ab8e0c1dea21e8410eb0dd4d7063830f8ee0fd37cf7f0a2b61606d9fec6504918e1243128adacb70a3
-  data.tar.gz: ce80093052178e5d59c5b8f713029da8e74cc1ac14febcfc3fefd7023e0b37b2b1422638ac0ba4dc14e7b90b45a4094bde876274c757b8eea6df2194285c52cd
+  metadata.gz: '08ad599216433bc7e81a679d02d2cfd81162ca1895698f3086a174e559744c816cc3a171be925846ad3e84cee5234eb4e9701acc8be13323d1e24eab3572f893'
+  data.tar.gz: 3d83aaa571007f9502810f58d1eecdcaa92a0a5a202708ef35191f39f5c283f923a3c87ba91d5aaf4b42e3c45a9ade01a70eb53a843d53ed88f0ab4ef317e775

data/.rubocop.yml

@@ -4,7 +4,7 @@ inherit_gem:
     - lib/rubocop.rspec.yml
 
 AllCops:
-  TargetRubyVersion: 2.6.3
+  TargetRubyVersion: 2.6.4
   Include:
     - lib/**/*.rb
     - spec/**/*.rb

data/.travis.yml

@@ -5,13 +5,13 @@ matrix:
   - rvm: 2.3.8
     gemfile: gemfiles/with_external_deps.gemfile
     env: TEST_PLUGINS=true
-  - rvm: 2.4.6
+  - rvm: 2.4.7
     gemfile: gemfiles/with_external_deps.gemfile
     env: TEST_PLUGINS=true
-  - rvm: 2.5.5
+  - rvm: 2.5.6
     gemfile: gemfiles/with_external_deps.gemfile
     env: TEST_PLUGINS=true
-  - rvm: 2.6.3
+  - rvm: 2.6.4
     gemfile: gemfiles/with_external_deps.gemfile
     env: TEST_PLUGINS=true
   - rvm: ruby-head
@@ -22,11 +22,11 @@ matrix:
     env: TEST_PLUGINS=true
   - rvm: 2.3.8
     gemfile: gemfiles/without_external_deps.gemfile
-  - rvm: 2.4.6
+  - rvm: 2.4.7
     gemfile: gemfiles/without_external_deps.gemfile
-  - rvm: 2.5.5
+  - rvm: 2.5.6
     gemfile: gemfiles/without_external_deps.gemfile
-  - rvm: 2.6.3
+  - rvm: 2.6.4
     gemfile: gemfiles/without_external_deps.gemfile
   - rvm: ruby-head
     gemfile: gemfiles/without_external_deps.gemfile

data/CHANGELOG.md

@@ -1,9 +1,14 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.16.0] - 2019-09-13
+### Added
+- `Qonfig::DataSet.build(&config_klass_definitions)` - build config instance immidietly without `Qonfig::DataSet`-class definition;
+- `#subset` - get a subset of config settings represented as a hash;
+
 ## [0.15.0] - 2019-09-02
 ### Added
-- `:format`-option for `load_from_self` and `expose_self` commands thath identifies which data format
+- `:format`-option for `load_from_self` and `expose_self` commands that identifies which data format
   should be chosen for parsing;
 
 ## [0.14.0] - 2019-08-28

data/README.md

@@ -24,11 +24,18 @@ require 'qonfig'
 
 - [Definition](#definition)
   - [Definition and Settings Access](#definition-and-access)
+    - [access via method](#access-via-method)
+    - [index-method](#index-method)
+    - [.dig](#dig)
+    - [.slice](#slice)
+    - [.slice_value](#slice_value)
+    - [.subset](#subset)
   - [Configuration](#configuration)
   - [Inheritance](#inheritance)
   - [Composition](#composition)
   - [Hash representation](#hash-representation)
   - [Smart Mixin](#smart-mixin) (`Qonfig::Configurable`)
+  - [Instantiation without class definition](#instantiation-without-class-definition) (`Qonfig::DataSet.build(&definitions)`)
 - [Interaction](#interaction)
   - [Iteration over setting keys](#iteration-over-setting-keys) (`#each_setting`, `#deep_each_setting`)
   - [Config reloading](#config-reloading) (reload config definitions and option values)
@@ -86,18 +93,32 @@ class Config < Qonfig::DataSet
   setting :vendor_api do
     setting :user, 'test_user'
   end
+
+  # deep nesting
+  setting :credentials do
+    setting :user do
+      setting :login, 'D@iVeR'
+      setting :password, 'test123'
+    end
+  end
 end
 
 config = Config.new # your configuration object instance
+```
 
-# --- setting access ---
+#### access via method
 
+```ruby
 # get option value via method
 config.settings.project_id # => nil
 config.settings.vendor_api.host # => 'app.service.com'
 config.settings.vendor_api.user # => 'test_user'
 config.settings.enable_graphql # => false
+```
 
+#### index-method []
+
+```ruby
 # get option value via index (with indifferent (string / symbol / mixed) access)
 config.settings[:project_id] # => nil
 config.settings[:vendor_api][:host] # => 'app.service.com'
@@ -115,24 +136,51 @@ config['project_id'] # => nil
 config['enable_graphql'] # => false
 config[:project_id] # => nil
 config[:enable_graphql] # => false
+```
+
+#### .dig
 
-# get option value in Hash#dig manner (and fail when the required key does not exist)
+```ruby
+# 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)
+#### .slice
+
+```ruby
+# 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)
+```
+
+#### .slice_value
+
+```ruby
+# get value from the slice of setting options using the given key set
+# (and fail when the required key does not exist) (works in slice manner);
 
-# get value from the slice of setting options using the given key set (and fail when the required key does not exist) (works in slice manner)
 config.slice_value(:vendor_api) # => { 'host' => 'app_service', 'user' => 'test_user' }
 config.slice_value(:vendor_api, :user) # => 'test_user'
 config.slice_value(:project_api) # => Qonfig::UnknownSettingError # (key does not exist)
 config.slice_value(:vendor_api, :port) # => Qonfig::UnknownSettingError # (key does not exist)
 ```
 
+#### .subset
+
+```ruby
+# - get a subset (a set of sets) of config settings represented as a hash;
+# - each key (or key set) represents a requirement of a certain setting key;
+
+config.subet(:vendor_api, :enable_graphql)
+# => { 'vendor_api' => { 'user' => ..., 'host' => ... }, 'enable_graphql' => false }
+
+config.subset(:project_id, [:vendor_api, :host], [:credentials, :user, :login])
+# => { 'project_id' => nil, 'host' => 'app.service.com', 'login' => 'D@iVeR' }
+```
+
 ---
 
 ### Configuration
@@ -407,6 +455,20 @@ GeneralApplication.config.to_h
 # and etc... (all Qonfig-related features)
 ```
 
+### Instantiation without class definition
+
+```ruby
+config = Qonfig::DataSet.build do
+  setting :user, 'D@iVeR'
+  setting :password, 'test123'
+end
+
+config.is_a?(Qonfig::DataSet) # => true
+
+config.settings.user # => 'D@iVeR'
+config.settings.password # => 'test123'
+```
+
 ---
 
 ## Interaction

data/lib/qonfig/data_set.rb

@@ -12,6 +12,17 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
   # @since 0.13.0
   extend Qonfig::Validator::DSL
 
+  class << self
+    # @param config_klass_definitions [Proc]
+    # @return [Qonfig::DataSet]
+    #
+    # @api public
+    # @since 0.16.0
+    def build(&config_klass_definitions)
+      Class.new(self, &config_klass_definitions).new
+    end
+  end
+
   # @return [Qonfig::Settings]
   #
   # @api private
@@ -164,6 +175,15 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
     thread_safe_access { settings.__slice_value__(*keys) }
   end
 
+  # @param keys [Array<String, Symbol, Array<String, Symbol>>]
+  # @return [Hash]
+  #
+  # @api private
+  # @since 0.16.0
+  def subset(*keys)
+    thread_safe_access { settings.__subset__(*keys) }
+  end
+
   # @return [void]
   #
   # @api public

data/lib/qonfig/settings.rb

@@ -176,6 +176,15 @@ class Qonfig::Settings # NOTE: Layout/ClassStructure is disabled only for CORE_M
     __lock__.thread_safe_access { __deep_slice_value__(*keys) }
   end
 
+  # @param keys [Array<String, Symbol, Array<String, Symbol>>]
+  # @return [Hash]
+  #
+  # @api private
+  # @since 0.16.0
+  def __subset__(*keys)
+    __lock__.thread_safe_access { __deep_subset__(*keys) }
+  end
+
   # @option transform_key [Proc]
   # @option transform_value [Proc]
   # @return [Hash]
@@ -467,6 +476,34 @@ class Qonfig::Settings # NOTE: Layout/ClassStructure is disabled only for CORE_M
     __deep_slice__(*keys)[required_key]
   end
 
+  # @param keys [Array<String, Symbol, Array<String, Symbol>>]
+  # @return [Hash]
+  #
+  # @api private
+  # @since 0.16.0
+  def __deep_subset__(*keys)
+    {}.tap do |result|
+      keys.each do |key_set|
+        required_keys =
+          case key_set
+          when String, Symbol
+            # TODO: support for patterns
+            __indifferently_accessable_option_key__(key_set)
+          when Array
+            key_set.map(&method(:__indifferently_accessable_option_key__))
+          else
+            raise(
+              Qonfig::ArgumentError,
+              'All setting keys should be a symbol/string or an array of symbols/strings!'
+            )
+          end
+
+        required_options = __deep_slice__(*required_keys)
+        result.merge!(required_options)
+      end
+    end
+  end
+
   # @param options_part [Hash]
   # @option transform_key [Proc]
   # @option transform_value [Proc]

data/lib/qonfig/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qonfig
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Rustam Ibragimov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-02 00:00:00.000000000 Z
+date: 2019-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coveralls