qonfig 0.27.0 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f1dc9656c82767633db2cd0560ec5e556596db39cb24ebedb7e57e77953fe4f
-  data.tar.gz: e2cb31c582204c47346c3161974e7c0ae1c74f08ec25bcce33ab795dd2a920f0
+  metadata.gz: e9b55fb2c5f21d55b75ee61a82898e5b7c00edeb28b11f652d717bbde6dbdc77
+  data.tar.gz: 1ed16479237bfeb2d373561c075dce564c98bac9b70380b677918450b9050e0b
 SHA512:
-  metadata.gz: 9af958e6b471e7df6b66bea682622a02a1063d76b820aff9f4663b0a81b2a8ca8048aff94e4035d6d9376542da3b28e38cb4578d3f8d3e3f1f4a38c3eae220a2
-  data.tar.gz: fb8c4348721326fb48875506e20c48c924a6abd0d6317557849454a804a697801a71583c8b7cccc3b1b2441b3cac482872adbac9d59255357c65fd765aa05ff8
+  metadata.gz: dae870ef416e6ab02f9321c6b57a4383aa98b9fb99d82e47bef73a94d139b3c4d07b3b38c70a275d76fecae966bd254dbec33609e54f8db3fb3f02d30099e106
+  data.tar.gz: f593bbc8e6a4c5ced747181c10c11e061f45f4a6ac679636b98c9c9abe02d0b6d95d4eb9454211930e47c7a0f927b5a8055cfcd57e7c1820a2da1af23e6071a5

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.29.0] - 2024-05-06
+### Added
+- `replace_on_merge` option for load_from, expose-like methods that allows to configure behaviour on the conflicting key: deep merge (by default) or replacing.
+
+## [0.28.0] - 2022-06-12
+### Changed
+- Support for the new `toml-rb` release (`2.1`);
+- Updated dev-dependencies;
+- Existing code base was adopted to the new rubocop ruleset;
+
 ## [0.27.0] - 2022-01-12
 ### Changed
 - Drop Ruby 2.5 support.

data/Gemfile.lock

@@ -1,129 +1,143 @@
 PATH
   remote: .
   specs:
-    qonfig (0.27.0)
+    qonfig (0.29.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.4.4)
+    activesupport (6.1.6)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
-    armitage-rubocop (1.23.0.1)
-      rubocop (= 1.23.0)
-      rubocop-performance (= 1.12.0)
-      rubocop-rails (= 2.12.4)
+    armitage-rubocop (1.30.1.1)
+      rubocop (= 1.30.1)
+      rubocop-performance (= 1.14.2)
+      rubocop-rails (= 2.15.0)
       rubocop-rake (= 0.6.0)
-      rubocop-rspec (= 2.6.0)
+      rubocop-rspec (= 2.11.1)
     ast (2.4.2)
-    bundler-audit (0.9.0.1)
+    bundler-audit (0.9.1)
       bundler (>= 1.2.0, < 3)
       thor (~> 1.0)
-    ci-helper (0.4.2)
+    ci-helper (0.5.0)
       colorize (~> 0.8)
       dry-inflector (~> 0.2)
       umbrellio-sequel-plugins (~> 0.4)
     coderay (1.1.3)
     colorize (0.8.1)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
     docile (1.4.0)
     dry-inflector (0.2.1)
-    ffi (1.15.5-java)
-    i18n (1.8.11)
+    ffi (1.15.5)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
+    language_server-protocol (3.16.0.3)
+    listen (3.7.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
     method_source (1.0.0)
-    minitest (5.15.0)
-    parallel (1.21.0)
-    parser (3.1.0.0)
+    minitest (5.16.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    pry (0.14.1-java)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-      spoon (~> 0.0)
-    rack (2.2.3)
+    rack (2.2.3.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.2.0)
+    rb-fsevent (0.11.1)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rbs (2.5.0)
+    regexp_parser (2.5.0)
     rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.3)
-    rubocop (1.23.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.30.1)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.12.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.15.1)
-      parser (>= 3.0.1.1)
-    rubocop-performance (1.12.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.14.2)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rails (2.12.4)
+    rubocop-rails (2.15.0)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
       rubocop (>= 1.7.0, < 2.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.6.0)
+    rubocop-rspec (2.11.1)
       rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
-    sequel (5.52.0)
+    sequel (5.57.0)
     simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov-lcov (0.8.0)
-    simplecov_json_formatter (0.1.3)
-    spoon (0.0.6)
-      ffi
+    simplecov_json_formatter (0.1.4)
+    steep (1.0.0)
+      activesupport (>= 5.1)
+      language_server-protocol (>= 3.15, < 4.0)
+      listen (~> 3.0)
+      parallel (>= 1.0.0)
+      parser (>= 3.0)
+      rainbow (>= 2.2.2, < 4.0)
+      rbs (>= 2.3.2)
+      terminal-table (>= 2, < 4)
     symbiont-ruby (0.7.0)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
     thor (1.2.1)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    umbrellio-sequel-plugins (0.5.1.27)
+    umbrellio-sequel-plugins (0.6.0.36)
       sequel
       symbiont-ruby
     unicode-display_width (2.1.0)
-    zeitwerk (2.5.3)
+    zeitwerk (2.6.0)
 
 PLATFORMS
-  ruby
-  universal-java-1.8
+  arm64-darwin-21
+  arm64-darwin-23
 
 DEPENDENCIES
   activesupport (~> 6.0)
-  armitage-rubocop (~> 1.7)
-  bundler
-  bundler-audit
-  ci-helper
-  pry
+  armitage-rubocop (~> 1.30)
+  bundler (>= 1)
+  bundler-audit (~> 0.9)
+  ci-helper (~> 0.5)
+  pry (~> 0.14)
   qonfig!
   rake (>= 13)
-  rspec (~> 3.10)
-  simplecov (~> 0.20)
-  simplecov-lcov
+  rspec (~> 3.11)
+  simplecov (~> 0.21)
+  simplecov-lcov (~> 0.8)
+  steep (~> 1.0)
 
 BUNDLED WITH
-   2.3.3
+   2.3.15

data/README.md

@@ -1,8 +1,21 @@
-# Qonfig · [![Gem Version](https://badge.fury.io/rb/qonfig.svg)](https://badge.fury.io/rb/qonfig) [![Build Status](https://travis-ci.org/0exp/qonfig.svg?branch=master)](https://travis-ci.org/0exp/qonfig) [![Coverage Status](https://coveralls.io/repos/github/0exp/qonfig/badge.svg?branch=master)](https://coveralls.io/github/0exp/qonfig?branch=master)
+# Qonfig · [![Gem Version](https://badge.fury.io/rb/qonfig.svg)](https://badge.fury.io/rb/qonfig) [![Coverage Status](https://coveralls.io/repos/github/0exp/qonfig/badge.svg?branch=master)](https://coveralls.io/github/0exp/qonfig?branch=master)
+
+Powerful configuration Ruby-framework with a support for many commonly used config formats with a multi-functional API, developer-friendly DSL and object-oriented behavior.
+
+- Support for: **YAML**, **TOML**, **JSON**, **ENV**, **\_\_END\_\_**-instructions;
+- Fully thread-safe;
+- Object-oriented behavior (config as an object, inhertance, composition, etc), with an abilities of lazy-instantiation;
+- Pluggable and extendable multi-functional API;
+- Developer-friendly DSL :)
+
+```
+# in the past...:
 
 Config. Defined as a class. Used as an instance. Support for inheritance and composition.
-Lazy instantiation. Thread-safe. Command-style DSL. Validation layer. **DOT-NOTATION**! And pretty-print :) Support for **YAML**, **TOML**, **JSON**, **\_\_END\_\_**, **ENV**.
-Extremely simple to define. Extremely simple to use. That's all? **NOT** :)
+Lazy instantiation. Thread-safe. Command-style DSL. Validation layer. **Dot-notation**)
+And pretty-print :) Support for **YAML**, **TOML**, **JSON**, **\_\_END\_\_**, **ENV**.
+Extremely simple to define. Extremely simple to use. That's all? **Not** :)
+```
 
 ## Installation
 
@@ -2058,6 +2071,7 @@ end
 - `:strict` mode (fail behaviour when the required yaml file doesnt exist):
   - `true` (by default) - causes `Qonfig::FileNotFoundError`;
   - `false` - do nothing, ignore current command;
+- `:replace_on_merge` - whether the setting should be replaced on the key conflict, otherwise, it will be deep merged (default);
 
 ```yaml
 # travis.yml
@@ -2154,6 +2168,7 @@ Config.new.to_h # => { "nonexistent_yaml" => {}, "another_key" => nil }
     - `false`:
         - file is not required;
         - root key with `:env` name is not required (if `via: :env_key` is used);
+- `:replace_on_merge` - whether the setting should be replaced on the key conflict, otherwise, it will be deep merged (default);
 
 #### Environment is defined as a root key of YAML file
 
@@ -2244,6 +2259,7 @@ config.settings.web.password # => staging_password (from sidekiq.staging.yml)
 - `:strict` mode (fail behaviour when the required yaml file doesnt exist):
   - `true` (by default) - causes `Qonfig::FileNotFoundError`;
   - `false` - do nothing, ignore current command;
+- `:replace_on_merge` - whether the setting should be replaced on the key conflict, otherwise, it will be deep merged (default);
 
 ```json
 // options.json
@@ -2319,6 +2335,7 @@ Config.new.to_h # => { "nonexistent_json" => {}, "another_key" => nil }
     - `false`:
         - file is not required;
         - root key with `:env` name is not required (if `via: :env_key` is used);
+- `:replace_on_merge` - whether the setting should be replaced on the key conflict, otherwise, it will be deep merged (default);
 
 #### Environment is defined as a root key of JSON file
 
@@ -2489,6 +2506,7 @@ config.settings['RUN_CI'] # => '1'
   - `format: :yaml` - **YAML** format;
   - `format: :json` - **JSON** format;
   - `format: :toml` - **TOML** format (via `toml`-plugin);
+- `:replace_on_merge` - whether the setting should be replaced on the key conflict, otherwise, it will be deep merged (default);
 
 ```ruby
 class Config < Qonfig::DataSet
@@ -2537,6 +2555,7 @@ connection_timeout:
   - `format: :yaml` - **YAML** format;
   - `format: :json` - **JSON** format;
   - `format: :toml` - **TOML** format (via `toml`-plugin);
+- `:replace_on_merge` - whether the setting should be replaced on the key conflict, otherwise, it will be deep merged (default);
 
 ```ruby
 class Config < Qonfig::DataSet
@@ -3310,6 +3329,8 @@ Qonfig.plugin(:vault)
 
 ## Roadmap
 
+- **General**:
+  - documentation rework;
 - **Major**:
   - support for Rails-like secrets;
   - support for persistent data storages (we want to store configs in multiple databases and files);
@@ -3323,7 +3344,9 @@ Qonfig.plugin(:vault)
   - External validation class with an importing api for better custom validations;
   - Setting value changement trace (in `anyway_config` manner);
   - Instantiation and reloading callbacks;
-
+  - File geneartors (.rb-files with a pre-filled code (and (maybe) with a pre-generated yaml/json/etc files));
+  - Setting value changement subscriptions and callbacks;
+  
 ## Build
 
 ```shell

data/gemfiles/with_external_deps.gemfile.lock

@@ -1,123 +1,149 @@
 PATH
   remote: ..
   specs:
-    qonfig (0.25.0)
+    qonfig (0.27.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.0)
+    activesupport (7.0.3)
       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)
-    aws-eventstream (1.1.0)
-    aws-sigv4 (1.2.2)
+    armitage-rubocop (1.30.1.1)
+      rubocop (= 1.30.1)
+      rubocop-performance (= 1.14.2)
+      rubocop-rails (= 2.15.0)
+      rubocop-rake (= 0.6.0)
+      rubocop-rspec (= 2.11.1)
+    ast (2.4.2)
+    aws-eventstream (1.2.0)
+    aws-sigv4 (1.5.0)
       aws-eventstream (~> 1, >= 1.0.2)
+    bundler-audit (0.9.1)
+      bundler (>= 1.2.0, < 3)
+      thor (~> 1.0)
+    ci-helper (0.5.0)
+      colorize (~> 0.8)
+      dry-inflector (~> 0.2)
+      umbrellio-sequel-plugins (~> 0.4)
     citrus (3.0.2)
     coderay (1.1.3)
-    concurrent-ruby (1.1.7)
-    diff-lcs (1.4.4)
-    docile (1.3.5)
-    ffi (1.14.2-java)
-    i18n (1.8.5)
+    colorize (0.8.1)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    dry-inflector (0.2.1)
+    ffi (1.15.5)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
+    language_server-protocol (3.16.0.3)
+    listen (3.7.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
     method_source (1.0.0)
-    minitest (5.14.2)
-    parallel (1.20.1)
-    parser (3.0.0.0)
+    minitest (5.16.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
-    pry (0.13.1)
+    pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    pry (0.13.1-java)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-      spoon (~> 0.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)
+    rack (2.2.3.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rb-fsevent (0.11.1)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rbs (2.5.0)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.0)
-    rubocop (1.7.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.30.1)
       parallel (~> 1.10)
-      parser (>= 2.7.1.5)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.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)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.14.2)
+      rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rails (2.9.1)
+    rubocop-rails (2.15.0)
       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.7.0, < 2.0)
+    rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
-    ruby-progressbar (1.10.1)
+    rubocop-rspec (2.11.1)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    sequel (5.57.0)
     simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov-lcov (0.8.0)
-    simplecov_json_formatter (0.1.2)
-    spoon (0.0.6)
-      ffi
-    toml-rb (2.0.1)
+    simplecov_json_formatter (0.1.4)
+    steep (1.0.0)
+      activesupport (>= 5.1)
+      language_server-protocol (>= 3.15, < 4.0)
+      listen (~> 3.0)
+      parallel (>= 1.0.0)
+      parser (>= 3.0)
+      rainbow (>= 2.2.2, < 4.0)
+      rbs (>= 2.3.2)
+      terminal-table (>= 2, < 4)
+    symbiont-ruby (0.7.0)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    thor (1.2.1)
+    toml-rb (2.1.2)
       citrus (~> 3.0, > 3.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (1.7.0)
-    vault (0.15.0)
+    umbrellio-sequel-plugins (0.6.0.36)
+      sequel
+      symbiont-ruby
+    unicode-display_width (2.1.0)
+    vault (0.17.0)
       aws-sigv4
-    zeitwerk (2.4.2)
 
 PLATFORMS
-  universal-java-1.8
-  x86_64-darwin-19
-  x86_64-linux
+  arm64-darwin-21
 
 DEPENDENCIES
-  armitage-rubocop (~> 1.7)
-  bundler
-  pry
+  armitage-rubocop (~> 1.30)
+  bundler (>= 1)
+  bundler-audit (~> 0.9)
+  ci-helper (~> 0.5)
+  pry (~> 0.14)
   qonfig!
   rake (>= 13)
-  rspec (~> 3.10)
-  simplecov (~> 0.20)
-  simplecov-lcov
+  rspec (~> 3.11)
+  simplecov (~> 0.21)
+  simplecov-lcov (~> 0.8)
+  steep (~> 1.0)
   toml-rb (>= 2)
   vault (>= 0.1)
 
 BUNDLED WITH
-   2.2.3
+   2.3.15