qonfig 0.24.1 → 0.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d1999e0aae940158d50623dcf308d0cc37456f2f88fb3a2fea1b6f3e595c102
-  data.tar.gz: 9e80d958e30a13850712353ee6b624cccb7666e39b91c13d0c5308f9e6988e7a
+  metadata.gz: 9b875f81a892a041c391457b18989daa2626ce3b04afb3e0290314a0fafeb8ad
+  data.tar.gz: f7eb3ff0d6801364070e22a8560fdfcc10e08bec59d8e876834b800682832394
 SHA512:
-  metadata.gz: 94637e644c352e6c972c9387b773687212553bbc1dc88da8498dc07bd212edda281173d5d793df4d47ebf5f1e03f4ba65e3fb48bb89a85a24048ff6f25d379b1
-  data.tar.gz: ef6f5f2d6ef534f07daade1be1ba6f39ca4fee282ea1c082688e6e6c23aff257613349a4fefbad7582a1e907246c47f291c6e235ed5b0a95399e7e7ed5f1bcc4
+  metadata.gz: d0ea42e1bcaed282dee699f798eb8b21e188afb2f37720b9645c97dc9a791596604f65de2d81b34e83102a8f94a5a5fbb7892bd20184c0141884e3e4ac86a024
+  data.tar.gz: 6657ab2f25a10c86bda9c87cb32ccaa494fd831f1d237bd30f561f7c8e14da50e173de18ec2cca3a400d16769f8001397160b4ef33a9154da599d69317385ef9

data/.rubocop.yml

@@ -5,7 +5,7 @@ inherit_gem:
     - lib/rubocop.rspec.yml
 
 AllCops:
-  TargetRubyVersion: 2.6.5
+  TargetRubyVersion: 2.7.1
   Include:
     - lib/**/*.rb
     - spec/**/*.rb

data/.travis.yml

@@ -1,17 +1,22 @@
 language: ruby
-matrix:
+os: linux
+dist: xenial
+cache: bundler
+before_install: gem install bundler
+script: bundle exec rspec
+jobs:
   fast_finish: true
   include:
-  - rvm: 2.4.9
+  - rvm: 2.4.10
     gemfile: gemfiles/with_external_deps.gemfile
     env: TEST_PLUGINS=true FULL_TEST_COVERAGE_CHECK=true
-  - rvm: 2.5.7
+  - rvm: 2.5.8
     gemfile: gemfiles/with_external_deps.gemfile
     env: TEST_PLUGINS=true FULL_TEST_COVERAGE_CHECK=true
-  - rvm: 2.6.5
+  - rvm: 2.6.6
     gemfile: gemfiles/with_external_deps.gemfile
     env: TEST_PLUGINS=true FULL_TEST_COVERAGE_CHECK=true
-  - rvm: 2.7.0
+  - rvm: 2.7.1
     gemfile: gemfiles/with_external_deps.gemfile
     env: TEST_PLUGINS=true FULL_TEST_COVERAGE_CHECK=true
   - rvm: ruby-head
@@ -23,13 +28,13 @@ matrix:
   - rvm: truffleruby
     gemfile: gemfiles/with_external_deps.gemfile
     env: TEST_PLUGINS=true FULL_TEST_COVERAGE_CHECK=true
-  - rvm: 2.4.9
+  - rvm: 2.4.10
     gemfile: gemfiles/without_external_deps.gemfile
-  - rvm: 2.5.7
+  - rvm: 2.5.8
     gemfile: gemfiles/without_external_deps.gemfile
-  - rvm: 2.6.5
+  - rvm: 2.6.6
     gemfile: gemfiles/without_external_deps.gemfile
-  - rvm: 2.7.0
+  - rvm: 2.7.1
     gemfile: gemfiles/without_external_deps.gemfile
   - rvm: ruby-head
     gemfile: gemfiles/without_external_deps.gemfile
@@ -41,7 +46,3 @@ matrix:
   - rvm: ruby-head
   - rvm: jruby-head
   - rvm: truffleruby
-sudo: false
-cache: bundler
-before_install: gem install bundler
-script: bundle exec rspec

data/CHANGELOG.md

@@ -1,6 +1,40 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.25.0] - 2020-09-15
+### Added
+- Support for **Vault** config provider:
+  - realized as a plugin (`Qonfig.plugin(:vault)`);
+  - provides `#load_from_vault`, `#expose_vault` methods and works in `#*_yaml`-like manner);
+  - depends on `gem vault (>= 0.1)`
+- `Qonfig::Settings#[]` behave like `Qonfig::Settings#__dig__`;
+- An ability to represent the config hash in dot-notated style (all config keys are represented in dot-notated format):
+  - works via `#to_h(dot_style: true)`;
+  - `key_transformer:` and `value_transfomer:` options are supported too;
+
+```ruby
+class Config << Qonfig::DataSet
+  setting :database do
+    setting :host, 'localhost'
+    setting :port, 6432
+  end
+
+  setting :api do
+    setting :rest_enabled, true
+    setting :rpc_enabled, false
+  end
+end
+
+Config.new.to_h(dot_style: true)
+# =>
+{
+  'database.host' => 'localhost',
+  'database.port' => 6432,
+  'api.rest_enabled' => true,
+  'api.rpc_enabled' => false,
+}
+```
+
 ## [0.24.1] - 2020-03-10
 ### Changed
 - Enhanced dot-notated key resolving algorithm: now it goes through the all dot-notated key parts
@@ -9,7 +43,7 @@ All notable changes to this project will be documented in this file.
 ### Fixed
 - (**Pretty-Print Plugin**):
   - dot-noted setting keys can not be pretty-printed (they raise `Qonfig::UnknownSettingKeyError`);
-  - added `set` and `pp` dependnecy as pre-reloaded dependencies;
+  - added `set` and `pp` as preloaded dependencies;
 
 ## [0.24.0] - 2019-12-29
 ### Added

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018-2019 Rustam Ibragimov
+Copyright (c) 2018-2020 Rustam Ibragimov
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -40,6 +40,9 @@ require 'qonfig'
   - [Inheritance](#inheritance)
   - [Composition](#composition)
   - [Hash representation](#hash-representation)
+    - [Default behaviour (without options)](#default-behavior-without-options)
+    - [With transformations](#with-transformations)
+    - [Dot-style format](#dot-style-format)
   - [Smart Mixin](#smart-mixin) (`Qonfig::Configurable`)
   - [Instantiation without class definition](#instantiation-without-class-definition) (`Qonfig::DataSet.build(&definitions)`)
 - [Compacted config](#compacted-config)
@@ -102,6 +105,7 @@ require 'qonfig'
 - [Plugins](#plugins)
   - [toml](#plugins-toml) (support for `TOML` format)
   - [pretty_print](#plugins-pretty_print) (beautified/prettified console output)
+  - [vault](#plugins-vault) (support for `Vault` store)
 - [Roadmap](#roadmap)
 - [Build](#build)
 ---
@@ -188,6 +192,10 @@ config.settings['vendor_api']['domain'] # => 'app.service.com'
 config.settings['vendor_api']['login'] # => 'test_user'
 config.settings['enable_graphql'] # => false
 
+# dig to value
+config.settings[:vendor_api, :domain] # => 'app.service.com'
+config.settings[:vendor_api, 'login'] # => 'test_user'
+
 # get option value directly via index (with indifferent access)
 config['project_id'] # => nil
 config['enable_graphql'] # => false
@@ -271,7 +279,7 @@ config.slice_value('vendor_api.port') # => Qonfig::UnknownSettingError # (key do
 # - 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)
+config.subset(:vendor_api, :enable_graphql)
 # => { 'vendor_api' => { 'login' => ..., 'domain' => ... }, 'enable_graphql' => false }
 
 config.subset(:project_id, [:vendor_api, :domain], [:credentials, :user, :login])
@@ -436,6 +444,12 @@ project_config.settings.db.password # => 'testpaswd'
 
 ### Hash representation
 
+- works via `#to_h` and `#to_hash`;
+- supported options:
+  - `key_transformer:` - an optional proc that accepts setting key and makes your custom transformations;
+  - `value_transformer:` - an optional proc that accepts setting value and makes your custom transformations;
+  - `dot_style:` - (`false` by default) represent setting keys in dot-notation (transformations are supported too);
+
 ```ruby
 class Config < Qonfig::DataSet
   setting :serializers do
@@ -454,9 +468,13 @@ class Config < Qonfig::DataSet
 
   setting :logger, Logger.new(STDOUT)
 end
+```
 
-Config.new.to_h
+#### Default behavior (without-options)
 
+```ruby
+Config.new.to_h
+# =>
 {
   "serializers": {
     "json" => { "engine" => :ok },
@@ -467,6 +485,55 @@ Config.new.to_h
 }
 ```
 
+#### With transformations
+
+- with `key_transformer` and/or `value_transformer`;
+
+```ruby
+key_transformer = -> (key) { "#{key}!!" }
+value_transformer = -> (value) { "#{value}??" }
+
+Config.new.to_h(key_transformer: key_transformer, value_transformer: value_transformer)
+# =>
+{
+  "serializers!!": {
+    "json!!" => { "engine!!" => "ok??" },
+    "hash!!" => { "engine!!" => "native??" },
+  },
+  "adapter!!" => { "default!!" => "memory_sync??" },
+  "logger!!" => "#<Logger:0x00007fcde799f158>??"
+}
+```
+
+#### Dot-style format
+
+- transformations are supported too (`key_transformer` and `value_transformer`);
+
+```ruby
+Config.new.to_h(dot_style: true)
+# =>
+{
+  "serializers.json.engine" => :ok,
+  "serializers.hash.engine" => :native,
+  "adapter.default" => :memory_sync,
+  "logger" => #<Logger:0x4b0d79fc>,
+}
+```
+
+```ruby
+transformer = -> (value) { "$$#{value}$$" }
+
+Config.new.to_h(dot_style: true, key_transformer: transformer, value_transformer: transformer)
+
+# => "#<Logger:0x00007fcde799f158>??"
+{
+  "$$serializers.json.engine$$" => "$$ok$$",
+  "$$serializers.hash.engine$$" => "$$native$$",
+  "$$adapter.default$$" => "$$memory_sync$$",
+  "$$logger$$" => "$$#<Logger:0x00007fcde799f158>$$",
+}
+```
+
 ---
 
 ### Smart Mixin
@@ -3091,6 +3158,7 @@ dynamic: 10
 
 - [toml](#plugins-toml) (provides `load_from_toml`, `save_to_toml`, `expose_toml`);
 - [pretty_print](#plugins-pretty_print) (beautified/prettified console output);
+- [vault](#plugins-vault) (provides `load_from_vault`, `expose_vault`)
 
 ---
 
@@ -3214,6 +3282,31 @@ config = Config.new
 
 ---
 
+### Plugins: vault
+
+- `Qonfig.plugin(:vault)`
+- adds support for `vault kv store`, [more info](https://www.vaultproject.io/docs/secrets/kv/kv-v2)
+- depends on `vault` gem ([link](https://github.com/hashicorp/vault-ruby)) (tested on `>= 0.1`);
+- provides `.load_from_vault` (works in `.load_from_yaml` manner ([doc](#load-from-yaml-file)));
+- provides `.expose_vault` (works in `.expose_yaml` manner ([doc](#expose-yaml)));
+
+```ruby
+# 1) require external dependency
+require 'vault'
+
+# 2) Setup vault client
+
+Vault.address = 'http://localhost:8200'
+Vault.token = 'super-duper-token-here'
+
+# 3) enable plugin
+Qonfig.plugin(:vault)
+
+# 3) use vault :)
+```
+
+---
+
 ## Roadmap
 
 - **Major**:
@@ -3223,7 +3316,10 @@ config = Config.new
   - support for pattern matching;
 - **Minor**:
   - An ability to flag `Qonfig::Configurable`'s config object as `compacted` (`Qonfig::Compacted`);
+  - Instance-based behavior for `Vault` plugin, also use instance of `Vault` client instead of `Singleton`;
   - External validation class with an importing api for better custom validations;
+  - Setting value changement trace (in `anyway_config` manner);
+  - Instantiation and reloading callbacks;
 
 ## Build
 

data/Rakefile

@@ -4,7 +4,6 @@ require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop'
 require 'rubocop/rake_task'
-require 'rubocop-rails'
 require 'rubocop-performance'
 require 'rubocop-rspec'
 require 'rubocop-rake'

data/gemfiles/with_external_deps.gemfile

@@ -4,5 +4,7 @@ source 'https://rubygems.org'
 
 # @since 0.17.0 (qonfig: :toml plugin)
 gem 'toml-rb', '>= 2'
+# @since 0.25.0 (qonfig: :vault plugin)
+gem 'vault', '>= 0.1'
 
 gemspec path: '..'

data/lib/qonfig.rb

@@ -64,4 +64,6 @@ module Qonfig
   register_plugin('toml', Qonfig::Plugins::TOML)
   # @since 0.19.0
   register_plugin('pretty_print', Qonfig::Plugins::PrettyPrint)
+  # @since 0.25.0
+  register_plugin('vault', Qonfig::Plugins::Vault)
 end

data/lib/qonfig/data_set.rb

@@ -184,6 +184,7 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
     end
   end
 
+  # @option dot_style [Boolean]
   # @option key_transformer [Proc]
   # @option value_transformer [Proc]
   # @return [Hash]
@@ -191,11 +192,13 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
   # @api public
   # @since 0.1.0
   def to_h(
+    dot_style: Qonfig::Settings::REPRESENT_HASH_IN_DOT_STYLE,
     key_transformer: Qonfig::Settings::BASIC_SETTING_KEY_TRANSFORMER,
     value_transformer: Qonfig::Settings::BASIC_SETTING_VALUE_TRANSFORMER
   )
     thread_safe_access do
       settings.__to_hash__(
+        dot_notation: dot_style,
         transform_key: key_transformer,
         transform_value: value_transformer
       )

data/lib/qonfig/plugins.rb

@@ -8,6 +8,7 @@ module Qonfig::Plugins
   require_relative 'plugins/abstract'
   require_relative 'plugins/toml'
   require_relative 'plugins/pretty_print'
+  require_relative 'plugins/vault'
 
   # @since 0.4.0
   @plugin_registry = Registry.new

data/lib/qonfig/plugins/toml/commands/definition/expose_toml.rb

@@ -101,7 +101,7 @@ class Qonfig::Commands::Definition::ExposeTOML < Qonfig::Commands::Base
     realfile = dirname.join(envfile).to_s
 
     toml_data = load_toml_data(realfile)
-    toml_based_settings = builde_data_set_klass(toml_data).new.settings
+    toml_based_settings = build_data_set_klass(toml_data).new.settings
 
     settings.__append_settings__(toml_based_settings)
   end
@@ -125,7 +125,7 @@ class Qonfig::Commands::Definition::ExposeTOML < Qonfig::Commands::Base
       "#{file_path} file does not contain settings with <#{env}> environment key!"
     ) unless toml_data_slice
 
-    toml_based_settings = builde_data_set_klass(toml_data_slice).new.settings
+    toml_based_settings = build_data_set_klass(toml_data_slice).new.settings
 
     settings.__append_settings__(toml_based_settings)
   end
@@ -145,7 +145,7 @@ class Qonfig::Commands::Definition::ExposeTOML < Qonfig::Commands::Base
   #
   # @api private
   # @since 0.12.0
-  def builde_data_set_klass(toml_data)
+  def build_data_set_klass(toml_data)
     Qonfig::DataSet::ClassBuilder.build_from_hash(toml_data)
   end
 end

data/lib/qonfig/plugins/vault.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.25.0
+class Qonfig::Plugins::Vault < Qonfig::Plugins::Abstract
+  class << self
+    # @return [void]
+    #
+    # @api private
+    # @since 0.25.0
+    def install!
+      raise(
+        Qonfig::UnresolvedPluginDependencyError,
+        '::Vault does not exist or "vault" gem is not loaded'
+      ) unless const_defined?('::Vault')
+
+      require_relative 'vault/errors'
+      require_relative 'vault/loaders/vault'
+      require_relative 'vault/commands/definition/load_from_vault'
+      require_relative 'vault/commands/definition/expose_vault'
+      require_relative 'vault/dsl'
+    end
+  end
+end

data/lib/qonfig/plugins/vault/commands/definition/expose_vault.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.25.0
+class Qonfig::Commands::Definition::ExposeVault < Qonfig::Commands::Base
+  # @since 0.25.0
+  self.inheritable = true
+
+  # @return [Hash<Symbol,Symbol>]
+  #
+  # @api private
+  # @since 0.25.0
+  EXPOSERS = { path: :path, env_key: :env_key }.freeze
+
+  # @return [Hash]
+  #
+  # @api private
+  # @since 0.25.0
+  EMPTY_VAULT_DATA = {}.freeze
+
+  # @return [String, Pathname]
+  #
+  # @api private
+  # @since 0.25.0
+  attr_reader :path
+
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.25.0
+  attr_reader :strict
+
+  # @return [Symbol]
+  #
+  # @api private
+  # @since 0.25.0
+  attr_reader :via
+
+  # @return [Symbol, String]
+  #
+  # @api private
+  # @since 0.25.0
+  attr_reader :env
+
+  # @param path [String Pathname]
+  # @option strict [Boolean]
+  # @option via [Symbol]
+  # @option env [String, Symbol]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.25.0
+  def initialize(path, strict: true, via:, env:)
+    unless env.is_a?(Symbol) || env.is_a?(String) || env.is_a?(Numeric)
+      raise Qonfig::ArgumentError, ':env should be a string or a symbol'
+    end
+
+    raise Qonfig::ArgumentError, ':env should be provided'  if env.to_s.empty?
+    raise Qonfig::ArgumentError, 'used :via is unsupported' unless EXPOSERS.key?(via)
+
+    @path   = path
+    @strict = strict
+    @via    = via
+    @env    = env
+  end
+
+  # @param data_set [Qonfig::DataSet]
+  # @param settings [Qonfig::Settings]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.25.0
+  def call(_data_set, settings)
+    case via
+    when EXPOSERS[:path]
+      expose_path!(settings)
+    when EXPOSERS[:env_key]
+      expose_env_key!(settings)
+    end
+  end
+
+  private
+
+  # @param settings [Qonfig::Settings]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.25.0
+  def expose_path!(settings)
+    # NOTE: transform path (insert environment name into a secret name)
+    #   from: kv/data/secret_name
+    #   to:   kv/data/env_name/secret_name
+
+    splitted_path = path.split('/')
+    real_path = splitted_path.insert(-2, env.to_s).join('/')
+
+    vault_data = load_vault_data(real_path)
+    vault_based_settings = build_data_set_class(vault_data).new.settings
+
+    settings.__append_settings__(vault_based_settings)
+  end
+
+  # @param settings [Qonfig::Settings]
+  # @return [void]
+  #
+  # @raise [Qonfig::ExposeError]
+  #
+  # @api private
+  # @since 0.25.0
+  def expose_env_key!(settings)
+    vault_data       = load_vault_data(path)
+    vault_data_slice = vault_data[env.to_sym]
+    vault_data_slice = EMPTY_VAULT_DATA.dup if vault_data_slice.nil? && !strict
+
+    raise(
+      Qonfig::ExposeError,
+      "#{path} does not contain settings with <#{env}> environment key!"
+    ) unless vault_data_slice
+
+    vault_based_settings = build_data_set_class(vault_data_slice).new.settings
+
+    settings.__append_settings__(vault_based_settings)
+  end
+
+  # @param path [String]
+  # @return [Hash]
+  #
+  # @api private
+  # @since 0.25.0
+  def load_vault_data(path)
+    Qonfig::Loaders::Vault.load_file(path, fail_on_unexist: strict)
+  end
+
+  # @param vault_data [Hash]
+  # @return [Class<Qonfig::DataSet>]
+  #
+  # @api private
+  # @since 0.25.0
+  def build_data_set_class(vault_data)
+    Qonfig::DataSet::ClassBuilder.build_from_hash(vault_data)
+  end
+end

data/lib/qonfig/plugins/vault/commands/definition/load_from_vault.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.25.0
+class Qonfig::Commands::Definition::LoadFromVault < Qonfig::Commands::Base
+  # @since 0.25.0
+  self.inheritable = true
+
+  # @return [String, Pathname]
+  #
+  # @api private
+  # @since 0.25.0
+  attr_reader :path
+
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.25.0
+  attr_reader :strict
+
+  # @param path [String]
+  # @option strict [Boolean]
+  #
+  # @api private
+  # @since 0.25.0
+  def initialize(path, strict: true)
+    @path = path
+    @strict = strict
+  end
+
+  # @param data_set [Qonfig::DataSet]
+  # @param settings [Qonfig::Settings]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.25.0
+  def call(_data_set, settings)
+    vault_data = Qonfig::Loaders::Vault.load_file(path, fail_on_unexist: strict)
+    vault_based_settings = build_data_set_klass(vault_data).new.settings
+    settings.__append_settings__(vault_based_settings)
+  end
+
+  private
+
+  # @param toml_data [Hash]
+  # @return [Class<Qonfig::DataSet>]
+  #
+  # @api private
+  # @since 0.25.0
+  def build_data_set_klass(toml_data)
+    Qonfig::DataSet::ClassBuilder.build_from_hash(toml_data)
+  end
+end

data/lib/qonfig/plugins/vault/dsl.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.25.0
+module Qonfig::DSL
+  # @param path [String, Pathname]
+  # @option strict [Boolean]
+  # @return [void]
+  #
+  # @see Qonfig::Commands::Definition::LoadFromVault
+  #
+  # @api public
+  # @since 0.25.0
+  def load_from_vault(path, strict: true)
+    definition_commands << Qonfig::Commands::Definition::LoadFromVault.new(
+      path, strict: strict
+    )
+  end
+
+  # @param path [String, Pathname]
+  # @option strict [Boolean]
+  # @option via [Symbol]
+  # @option env [Symbol, String]
+  # @return [void]
+  #
+  # @see Qonfig::Commands::Definition::ExposeVault
+  #
+  # @api public
+  # @since 0.25.0
+  def expose_vault(path, strict: true, via:, env:)
+    definition_commands << Qonfig::Commands::Definition::ExposeVault.new(
+      path, strict: strict, via: via, env: env
+    )
+  end
+end

data/lib/qonfig/plugins/vault/errors.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# @api public
+# @since 0.25.0
+module Qonfig
+  # @api public
+  # @since 0.25.0
+  VaultLoaderError = Class.new(Vault::VaultError)
+end

data/lib/qonfig/plugins/vault/loaders/vault.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.25.0
+class Qonfig::Loaders::Vault < Qonfig::Loaders::Basic
+  # @return [Binding]
+  #
+  # @api private
+  # @since 0.25.0
+  VAULT_EXPR_EVAL_SCOPE = BasicObject.new.__binding__.tap do |binding|
+    Object.new.method(:freeze).unbind.bind(binding.receiver).call
+  end
+
+  class << self
+    # @param path [String, Pathname]
+    # @option fail_on_unexist [Boolean]
+    # @return [Object]
+    #
+    # @raise [Qonfig::FileNotFoundError]
+    #
+    # @api private
+    # @since 0.25.0
+    def load_file(path, fail_on_unexist: true)
+      data = ::Vault.with_retries(Vault::HTTPError) do
+        ::Vault.logical.read(path.to_s)&.data&.dig(:data)
+      end
+      raise Qonfig::FileNotFoundError, "Path #{path} not exist" if data.nil? && fail_on_unexist
+      result = data || empty_data
+      deep_transform_values(result)
+    rescue Vault::VaultError => error
+      raise(Qonfig::VaultLoaderError.new(error.message).tap do |exception|
+        exception.set_backtrace(error.backtrace)
+      end)
+    end
+
+    # @return [Hash]
+    #
+    # @api private
+    # @since 0.25.0
+    def empty_data
+      {}
+    end
+
+    private
+
+    # @param vault_data [Hash<Object,Object>]
+    # @return [Object]
+    #
+    # @api private
+    # @since 0.25.0
+    def deep_transform_values(vault_data)
+      return vault_data unless vault_data.is_a?(Hash)
+
+      vault_data.transform_values do |value|
+        next safely_evaluate(value) if value.is_a?(String)
+
+        deep_transform_values(value)
+      end
+    end
+
+    # @param vault_expr [String]
+    # @return [Object]
+    #
+    # @api private
+    # @since 0.25.0
+    def safely_evaluate(vault_expr)
+      parsed_expr = ::ERB.new(vault_expr).result
+      VAULT_EXPR_EVAL_SCOPE.eval(parsed_expr)
+    rescue StandardError, ScriptError
+      parsed_expr
+    end
+  end
+end

data/lib/qonfig/settings.rb

@@ -22,6 +22,12 @@ class Qonfig::Settings # NOTE: Layout/ClassStructure is disabled only for CORE_M
   # @since 0.11.0
   BASIC_SETTING_VALUE_TRANSFORMER = (proc { |value| value }).freeze
 
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.25.0
+  REPRESENT_HASH_IN_DOT_STYLE = false
+
   # @return [String]
   #
   # @api private
@@ -133,16 +139,13 @@ class Qonfig::Settings # NOTE: Layout/ClassStructure is disabled only for CORE_M
   # @param key [Symbol, String]
   # @return [Object]
   #
+  # @raise [Qonfig::ArgumentError]
+  #
   # @api public
   # @since 0.1.0
-  def [](key)
-    __lock__.thread_safe_access do
-      begin
-        __get_value__(key)
-      rescue Qonfig::UnknownSettingError
-        __deep_access__(*__parse_dot_notated_key__(key))
-      end
-    end
+  # @version 0.25.0
+  def [](*keys)
+    __dig__(*keys)
   end
 
   # @param key [String, Symbol]
@@ -211,27 +214,47 @@ class Qonfig::Settings # NOTE: Layout/ClassStructure is disabled only for CORE_M
     __lock__.thread_safe_access { __deep_subset__(*keys) }
   end
 
+  # @option dot_notation [Boolean]
   # @option transform_key [Proc]
   # @option transform_value [Proc]
   # @return [Hash]
   #
   # @api private
   # @since 0.1.0
-  # rubocop:disable Layout/LineLength
-  def __to_hash__(transform_key: BASIC_SETTING_KEY_TRANSFORMER, transform_value: BASIC_SETTING_VALUE_TRANSFORMER)
+  # @version 0.25.0
+  def __to_hash__(
+    dot_notation: REPRESENT_HASH_IN_DOT_STYLE,
+    transform_key: BASIC_SETTING_KEY_TRANSFORMER,
+    transform_value: BASIC_SETTING_VALUE_TRANSFORMER
+  )
     unless transform_key.is_a?(Proc)
-      ::Kernel.raise(Qonfig::IncorrectKeyTransformerError, 'Key transformer should be a type of proc')
+      ::Kernel.raise(
+        Qonfig::IncorrectKeyTransformerError,
+        'Key transformer should be a type of proc'
+      )
     end
 
     unless transform_value.is_a?(Proc)
-      ::Kernel.raise(Qonfig::IncorrectValueTransformerError, 'Value transformer should be a type of proc')
+      ::Kernel.raise(
+        Qonfig::IncorrectValueTransformerError,
+        'Value transformer should be a type of proc'
+      )
     end
 
     __lock__.thread_safe_access do
-      __build_hash_representation__(transform_key: transform_key, transform_value: transform_value)
+      if dot_notation
+        __build_dot_notated_hash_representation__(
+          transform_key: transform_key,
+          transform_value: transform_value
+        )
+      else
+        __build_basic_hash_representation__(
+          transform_key: transform_key,
+          transform_value: transform_value
+        )
+      end
     end
   end
-  # rubocop:enable Layout/LineLength
   alias_method :__to_h__, :__to_hash__
 
   # @option all_variants [Boolean]
@@ -496,7 +519,7 @@ class Qonfig::Settings # NOTE: Layout/ClassStructure is disabled only for CORE_M
   #
   # @api private
   # @since 0.21.0
-  # rubocop:disable Naming/RescuedExceptionsVariableName
+  # rubocop:disable Naming/RescuedExceptionsVariableName, Style/SlicingWithRange
   def __assign_value__(key, value)
     key = __indifferently_accessable_option_key__(key)
     __set_value__(key, value)
@@ -515,7 +538,7 @@ class Qonfig::Settings # NOTE: Layout/ClassStructure is disabled only for CORE_M
       raise(initial_error)
     end
   end
-  # rubocop:enable Naming/RescuedExceptionsVariableName
+  # rubocop:enable Naming/RescuedExceptionsVariableName, Style/SlicingWithRange
 
   # @param key [String, Symbol]
   # @param value [Object]
@@ -558,7 +581,8 @@ class Qonfig::Settings # NOTE: Layout/ClassStructure is disabled only for CORE_M
   #
   # @api private
   # @since 0.2.0
-  def __deep_access__(*keys) # rubocop:disable Metrics/AbcSize
+  # rubocop:disable Metrics/AbcSize, Style/SlicingWithRange
+  def __deep_access__(*keys)
     ::Kernel.raise(Qonfig::ArgumentError, 'Key list can not be empty') if keys.empty?
 
     result = nil
@@ -588,6 +612,7 @@ class Qonfig::Settings # NOTE: Layout/ClassStructure is disabled only for CORE_M
       result.__dig__(*rest_keys)
     end
   end
+  # rubocop:enable Metrics/AbcSize, Style/SlicingWithRange
 
   # @param keys [Array<Symbol, String>]
   # @return [Hash]
@@ -680,14 +705,15 @@ class Qonfig::Settings # NOTE: Layout/ClassStructure is disabled only for CORE_M
   # @return [Hash]
   #
   # @api private
-  # @since 0.2.0
-  def __build_hash_representation__(options_part = __options__, transform_key:, transform_value:)
+  # @since 0.25.0
+  # rubocop:disable Layout/LineLength
+  def __build_basic_hash_representation__(options_part = __options__, transform_key:, transform_value:)
     options_part.each_with_object({}) do |(key, value), hash|
       final_key = transform_key.call(key)
 
       case
       when value.is_a?(Hash)
-        hash[final_key] = __build_hash_representation__(
+        hash[final_key] = __build_basic_hash_representation__(
           value,
           transform_key: transform_key,
           transform_value: transform_value
@@ -703,6 +729,24 @@ class Qonfig::Settings # NOTE: Layout/ClassStructure is disabled only for CORE_M
       end
     end
   end
+  # rubocop:enable Layout/LineLength
+
+  # @option transform_key [Proc]
+  # @option transform_value [Proc]
+  # @return [Hash]
+  #
+  # @api private
+  # @since 0.25.0
+  def __build_dot_notated_hash_representation__(transform_key:, transform_value:)
+    {}.tap do |hash|
+      __deep_each_key_value_pair__ do |setting_key, setting_value|
+        final_key = transform_key.call(setting_key)
+        final_value = transform_value.call(setting_value)
+
+        hash[final_key] = final_value
+      end
+    end
+  end
 
   # @param key [Symbol, String]
   # @return [void]

data/lib/qonfig/settings/key_matcher.rb

@@ -147,12 +147,14 @@ class Qonfig::Settings::KeyMatcher
   #
   # @api private
   # @since 0.13.0
+  # rubocop:disable Style/SlicingWithRange
   def strip_regexp_string(regexp_string, left: false, right: false)
     pattern = regexp_string
     pattern = pattern[2..-1] if left && pattern[0..1] == MATCHER_SCOPE_SPLITTER
     pattern = pattern[0..-3] if right && pattern[-2..-1] == MATCHER_SCOPE_SPLITTER
     pattern
   end
+  # rubocop:enable Style/SlicingWithRange
 
   # @param scope_pattern [String]
   # @return [Regexp]

data/lib/qonfig/version.rb

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

data/qonfig.gemspec

@@ -6,7 +6,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'qonfig/version'
 
 Gem::Specification.new do |spec|
-  spec.required_ruby_version = '>= 2.4.9'
+  spec.required_ruby_version = '>= 2.4.10'
 
   spec.name        = 'qonfig'
   spec.version     = Qonfig::VERSION
@@ -29,9 +29,9 @@ Gem::Specification.new do |spec|
     f.match(%r{^(test|spec|features)/})
   end
 
-  spec.add_development_dependency 'simplecov',        '~> 0.18'
+  spec.add_development_dependency 'simplecov',        '~> 0.19'
   spec.add_development_dependency 'rspec',            '~> 3.9'
-  spec.add_development_dependency 'armitage-rubocop', '~> 0.79'
+  spec.add_development_dependency 'armitage-rubocop', '~> 0.89'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake', '>= 13'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qonfig
 version: !ruby/object:Gem::Version
-  version: 0.24.1
+  version: 0.25.0
 platform: ruby
 authors:
 - Rustam Ibragimov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-09 00:00:00.000000000 Z
+date: 2020-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0.19'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0.19'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.79'
+        version: '0.89'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.79'
+        version: '0.89'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -184,6 +184,12 @@ files:
 - lib/qonfig/plugins/toml/loaders/toml.rb
 - lib/qonfig/plugins/toml/tomlrb_fixes.rb
 - lib/qonfig/plugins/toml/uploaders/toml.rb
+- lib/qonfig/plugins/vault.rb
+- lib/qonfig/plugins/vault/commands/definition/expose_vault.rb
+- lib/qonfig/plugins/vault/commands/definition/load_from_vault.rb
+- lib/qonfig/plugins/vault/dsl.rb
+- lib/qonfig/plugins/vault/errors.rb
+- lib/qonfig/plugins/vault/loaders/vault.rb
 - lib/qonfig/settings.rb
 - lib/qonfig/settings/builder.rb
 - lib/qonfig/settings/callbacks.rb
@@ -225,7 +231,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.9
+      version: 2.4.10
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="