qonfig 0.21.0 → 0.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8bb3c845cef4655af444f78682841a1d882176463aca7d05e6d156f64e70f38
-  data.tar.gz: 58e18c72976148f86eb6c9f845d976b69311ce3edbd5fe219a141accc9cec6a1
+  metadata.gz: 9b875f81a892a041c391457b18989daa2626ce3b04afb3e0290314a0fafeb8ad
+  data.tar.gz: f7eb3ff0d6801364070e22a8560fdfcc10e08bec59d8e876834b800682832394
 SHA512:
-  metadata.gz: c201ccb87e62e2424f38784aefaae67410c1725c6c2a33f00126412f9d495c081c6b8faf4fbf52b17e9f2ae674b87b8454002eedafdf4f5209e328afe4892821
-  data.tar.gz: d7a6bb166580c9f8d8df2aba63cefbbc3251b2e84daf6ca9863442b585267459ba9b528327e484a86a26a4f5e031adaa911d3acfca36b3cf6d434e2aa50bd14d
+  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,30 +1,40 @@
 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.8
     gemfile: gemfiles/with_external_deps.gemfile
-    env: TEST_PLUGINS=true
-  - rvm: 2.5.7
+    env: TEST_PLUGINS=true FULL_TEST_COVERAGE_CHECK=true
+  - rvm: 2.6.6
     gemfile: gemfiles/with_external_deps.gemfile
-    env: TEST_PLUGINS=true
-  - rvm: 2.6.5
+    env: TEST_PLUGINS=true FULL_TEST_COVERAGE_CHECK=true
+  - rvm: 2.7.1
     gemfile: gemfiles/with_external_deps.gemfile
-    env: TEST_PLUGINS=true
+    env: TEST_PLUGINS=true FULL_TEST_COVERAGE_CHECK=true
   - rvm: ruby-head
     gemfile: gemfiles/with_external_deps.gemfile
-    env: TEST_PLUGINS=true
+    env: TEST_PLUGINS=true FULL_TEST_COVERAGE_CHECK=true
   - rvm: jruby-head
     gemfile: gemfiles/with_external_deps.gemfile
-    env: TEST_PLUGINS=true
+    env: TEST_PLUGINS=true FULL_TEST_COVERAGE_CHECK=true
   - rvm: truffleruby
     gemfile: gemfiles/with_external_deps.gemfile
-    env: TEST_PLUGINS=true
-  - rvm: 2.4.9
+    env: TEST_PLUGINS=true FULL_TEST_COVERAGE_CHECK=true
+  - 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.1
     gemfile: gemfiles/without_external_deps.gemfile
   - rvm: ruby-head
     gemfile: gemfiles/without_external_deps.gemfile
@@ -36,10 +46,3 @@ matrix:
   - rvm: ruby-head
   - rvm: jruby-head
   - rvm: truffleruby
-sudo: false
-cache: bundler
-before_install: gem install bundler
-script: bundle exec rspec
-notifications:
-  slack:
-    secure: I03SDv+IrKy3IkeGjjHUJ9VneFMiYpLzIgPOixGFO5zGVXgulwmun82KsrPSW5HkK1UEQCahfoXt1hNECPwxcdsY01q6LBYJQx1jD0q17bXHllN/q0C6lx3peRN0KqNAAOU3/mHZxLt3HFV+N3HsSnoxDMuSYJgKbjCL/QVG2L2UYT9vi+JRNM/thj8R6MWKWlOHemik40GbLr2anCOCqiALzxnJzh5nJyGj+9SGvjhHfQq/fAIrg1+Scu+UchG8d+1yS5JWsGTt1/JF08i+Ux4ceTQ7GNBNeA5cj/xuUzvRx6A85renxyTiZMKIL0+jeceUm8c+/46XFcq0F7/kJB36lwjFhX1JRphcu/VouRdEwW/BvH74wnyHtygqOpk0LH4shp7A1DIS1DlnBbeJxrR5hdMDnmV85kTU6w6H0BbncsYY/pH1fji1kgH6jCsdwqDlq4wLB8x8I+eZABBsfb/r55z/HnBmmxlvR7Rt3X5/yR3gJrsgRrDBBZ5LwYy1RSCDu76vMQqWGJKG03FdfqSNqmC5V4MC5Ez8yjGDW0Yle09mwvsL2c6fDXyDPCeB/gwNk+FvgLRXnv7C4BaBNEoG4JnCL/dwauoJNg0lB6uF34BEmYAhZIrdY1CI6BqPWnaVMJfcJSYekBVXDIELDnTFRWjaGU1y8dM6lNzDmYE=

data/CHANGELOG.md

@@ -1,13 +1,69 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
-## [Unreleased]
+## [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
+  until it finds the required setting key (or fails with `Qonfig::UnknowSettingKeyError`);
+
+### Fixed
+- (**Pretty-Print Plugin**):
+  - dot-noted setting keys can not be pretty-printed (they raise `Qonfig::UnknownSettingKeyError`);
+  - added `set` and `pp` as preloaded dependencies;
+
+## [0.24.0] - 2019-12-29
+### Added
+- Support for **Ruby@2.7**;
+
+## [0.23.0] - 2019-12-12
+### Added
+- Support for `Pathname` file path in `.load_from_json`, `.load_from_yaml`, `.load_from_toml`, `.expose_yaml`, `.expose_json`, `.expose_toml`;
+
+## [0.22.0] - 2019-12-12
+### Added
+- Support for `Pathname` file path in `.values_file`, `#load_from_file`, `#load_from_yaml`, `#load_from_json` and `#load_from_toml`;
+
+## [0.21.0] - 2019-12-12
 ### Added
 - Brand new type of config objects `Qonfig::Compacted`:
   - represents the compacted config object with setting readers and setting writers only;
   - setting keys are represented as direct instace methods (`#settings` invokation does not need);
   - no any other useful instance-based functionality;
-  - full support of `Qonfig::DataSet` DSL commands (`setting`, `validate`, `add_validator`, `load_from_x`/`expose_x` and etc);
+  - full support of `Qonfig::DataSet` DSL commands (`.setting`, `.validate`, `.add_validator`, `.load_from_x`/`.expose_x` and etc);
   - can be instantiated by:
     - by existing config object: `Qonfig::DataSet#compacted` or `Qonfig::Compacted.build_from(config, &configuration)`
     - by direct instantiation: `Qonfig::Compacted.new(settings_values = {}, &configuration)`;

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)
@@ -90,7 +93,7 @@ require 'qonfig'
     - [Load from \_\_END\_\_](#load-from-__end__) (aka `.load_from_self`)
     - [Expose \_\_END\_\_](#expose-__end__) (aka `.expose_self`)
   - **Setting values**
-    - `(instance methods for loading setting values from a file to existing config object with already defined setting keys)`
+    - `(instance methods for loading the setting values from a file to existing config object with already defined setting keys)`
     - [Default setting values file](#default-setting-values-file)
     - [Load setting values from YAML file](#load-setting-values-from-yaml-file-by-instance)
     - [Load setting values from JSON file](#load-setting-values-from-json-file-by-instance)
@@ -102,7 +105,9 @@ 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)
 ---
 
 ## Definition
@@ -187,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
@@ -270,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])
@@ -435,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
@@ -453,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 },
@@ -466,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
@@ -633,9 +701,8 @@ config.settings.web_api # => "api.google.com"
 
 ---
 
-- `Qonfig::Compacted`: represents the compacted config object with setting readers and setting writers;
+- `Qonfig::Compacted`: represents the compacted config object with setting readers, setting writers and setting predicates only - and no any other useful instance-based functionality:
 - setting keys are represented as direct instace methods (`#settings` invokation does not need);
-- no any other useful instance-based functionality - just setting readers, setting writers and setting predicates:
 - support for index-like access methods (`[]`,`[]=`);
 - full support of `Qonfig::DataSet` definition DSL commands:
   - `setting`, `re_setting` [doc](#definition-and-access)
@@ -646,9 +713,9 @@ config.settings.web_api # => "api.google.com"
 - support for validation of potential setting values `.valid_with?` [documentation](#validation-of-potential-setting-values);
 - can be instantiated by:
   - by existing config object: `Qonfig::DataSet#compacted` or `Qonfig::Compacted.build_from(config, &configuration)`;
-  - from existing `Qonfig::DataSet` class: ``Qonfig::DataSet.build_compacted`;
+  - from existing `Qonfig::DataSet` class: `Qonfig::DataSet.build_compacted`;
   - by direct instantiation: `Qonfig::Compacted.new(settings_values = {}, &configuration)`;
-  - by implicit instance building without explicit class definition `Qonfig::Compacted.build(&dsl_commands) # => instance of Qonfig::Compacted`;
+  - by implicit instance building without explicit class definition `Qonfig::Compacted.build(&dsl_commands)`;
 - you can define your own instance methods too;
 
 ---
@@ -1001,6 +1068,8 @@ config.root_keys
 - method signature: `#reload!(configurations = {}, &configuration)`;
 
 ```ruby
+# -- config example ---
+
 class Config < Qonfig::DataSet
   setting :db do
     setting :adapter, 'postgresql'
@@ -1013,6 +1082,10 @@ config = Config.new
 
 config.settings.db.adapter # => 'postgresql'
 config.settings.logger # => #<Logger:0x00007ff9>
+```
+
+```ruby
+# --- redefine some settings (or add a new one) --
 
 config.configure { |conf| conf.logger = nil } # redefine some settings (will be reloaded)
 
@@ -1024,6 +1097,10 @@ class Config
 
   setting :enable_api, false # append new setting
 end
+```
+
+```ruby
+# --- reload ---
 
 # reload settings
 config.reload!
@@ -3081,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`)
 
 ---
 
@@ -3204,15 +3282,51 @@ 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**:
-  - distributed configuration server;
-  - cli toolchain;
   - support for Rails-like secrets;
   - support for persistent data storages (we want to store configs in multiple databases and files);
-  - Rails reload plugin;
+  - rails plugin;
+  - 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
+
+```shell
+bin/rspec -w # test the core functionality and plugins
+bin/rspec -n # test only the core functionality
+```
 
 ## Contributing
 

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/bin/rspec

@@ -36,6 +36,7 @@ module QonfigSpecRunner
 
   def run_with_specs_for_plugins!
     ENV['TEST_PLUGINS'] = 'true'
+    ENV['FULL_TEST_COVERAGE_CHECK'] = 'true'
     ENV['BUNDLE_GEMFILE'] = GEMFILES[:with_external_deps]
     run_tests!
   end

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

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
+require 'set'
 require 'yaml'
 require 'json'
 require 'erb'
+require 'pathname'
 
 # @api public
 # @since 0.1.0
@@ -62,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