qonfig 0.22.0 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48f718feaf6da5ef0dd8e81bad25fa58b7b06c2eb120b692c6111b745a507c4d
-  data.tar.gz: ad50f7258506db6837c0d08c9c6efaf003f12291427ec33c5b0f8c15124bfdfc
+  metadata.gz: cc38d7dba82dac66de4b7c240ae589cde85ff7266e87ae8055df1706d0877ebf
+  data.tar.gz: 213899d6509a51c3ac0434cf9a60467460a61294788a3489e6088417d4c82214
 SHA512:
-  metadata.gz: eb496fb435d1c6a203960ad98a36f2afac9efe5efd0d8a2466187f89c8df3a87af7a7c3678cd07fc73bacd10ca1ae1430a555d396d5783fcad58931cd2f08a1d
-  data.tar.gz: 926c610a00683e0a4cdbd2663777f95579a02c5a11e8548bdfb990a2c962e518e3797c5814a321be2cdc1e531e7855a20913d66bf0c6927f115b0106b30b050a
+  metadata.gz: f285e423068f4e5d56e6b0bb74a23c027a6056683ba8c873d37995f733edac9eacdf98a8e2f7222d45fb3fe5d55fc42218f55942a644cfdd7381f2620e0f9903
+  data.tar.gz: eb17c02d38048fa1004055b8b7ca19f757885d11e0ec20c716f9c81cfde73ddb1b470a3fee4e79a8bb8be759abbe18dbbb1ee734326ee56b9683c11db567b1fc

data/.gitignore

@@ -7,10 +7,8 @@
 /spec/reports/
 /tmp/
 .rspec_status
-Gemfile.lock
 /.idea
 .ruby-version
 /.vscode/
 /spec/artifacts/
-/gemfiles/*.gemfile.lock
 *.gem

data/.rubocop.yml

@@ -5,13 +5,15 @@ inherit_gem:
     - lib/rubocop.rspec.yml
 
 AllCops:
-  TargetRubyVersion: 2.6.5
+  TargetRubyVersion: 3.0.0
+  NewCops: enable
   Include:
     - lib/**/*.rb
     - spec/**/*.rb
     - Gemfile
     - Rakefile
     - qonfig.gemspec
+    - gemfiles/*.gemfile
     - bin/console
     - bin/rspec
 
@@ -26,3 +28,19 @@ Style/RedundantBegin:
 # NOTE: too situative
 Metrics/ParameterLists:
   Enabled: false
+
+# NOTE: too situative in current code base
+Style/NilComparison:
+  Enabled: false
+
+# NOTE: too situative in current code base
+Style/NonNilCheck:
+  Enabled: false
+
+# NOTE: too situative in current code base
+Lint/MissingSuper:
+  Enabled: false
+
+# NOTE: too situative in current code base
+Lint/EmptyBlock:
+  Enabled: false

data/.travis.yml

@@ -1,30 +1,45 @@
 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 FULL_TEST_COVERAGE_CHECK=true
+  - rvm: 2.6.6
     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.7.2
     gemfile: gemfiles/with_external_deps.gemfile
-    env: TEST_PLUGINS=true
-  - rvm: 2.6.5
+    env: TEST_PLUGINS=true FULL_TEST_COVERAGE_CHECK=true
+  - rvm: 3.0.0
     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.2
+    gemfile: gemfiles/without_external_deps.gemfile
+  - rvm: 3.0.0
     gemfile: gemfiles/without_external_deps.gemfile
   - rvm: ruby-head
     gemfile: gemfiles/without_external_deps.gemfile
@@ -36,10 +51,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,6 +1,62 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.26.0] - 2021-07-01
+### Added
+- Support `ERB` in `load_from_json` method;
+
+## [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`;
@@ -11,7 +67,7 @@ All notable changes to this project will be documented in this file.
   - 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/Gemfile.lock

@@ -0,0 +1,102 @@
+PATH
+  remote: .
+  specs:
+    qonfig (0.26.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    armitage-rubocop (1.7.0.1)
+      rubocop (= 1.7.0)
+      rubocop-performance (= 1.9.1)
+      rubocop-rails (= 2.9.1)
+      rubocop-rake (= 0.5.1)
+      rubocop-rspec (= 2.1.0)
+    ast (2.4.1)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    docile (1.3.4)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    minitest (5.14.2)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rack (2.2.3)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.0.2)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rubocop (1.7.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.3.0)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.9.1)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.9.1)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 0.90.0, < 2.0)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.1.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.10.1)
+    simplecov (0.20.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  armitage-rubocop (~> 1.7)
+  bundler
+  pry
+  qonfig!
+  rake (>= 13)
+  rspec (~> 3.10)
+  simplecov (~> 0.20)
+
+BUNDLED WITH
+   2.2.21

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,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!
@@ -2163,6 +2240,7 @@ config.settings.web.password # => staging_password (from sidekiq.staging.yml)
 
 ### Load from JSON file
 
+- supports `ERB`;
 - `:strict` mode (fail behaviour when the required yaml file doesnt exist):
   - `true` (by default) - causes `Qonfig::FileNotFoundError`;
   - `false` - do nothing, ignore current command;
@@ -3081,6 +3159,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 +3283,52 @@ 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;
+  - support for type checking (via `rbs`, `typeprof`, `steep`);
 - **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