qonfig 0.28.0 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 218eb4aa48a675227a5548f404040988e28e900d8099789ad3569adf10bdf11a
-  data.tar.gz: b008b73ceede53055f136c686ada92be85d309ead704f1328785e5f2ae4d12f8
+  metadata.gz: e9b55fb2c5f21d55b75ee61a82898e5b7c00edeb28b11f652d717bbde6dbdc77
+  data.tar.gz: 1ed16479237bfeb2d373561c075dce564c98bac9b70380b677918450b9050e0b
 SHA512:
-  metadata.gz: 15da249e905655b1a749fabc6b4b62cdaeb63f0ad04be8ad4e7ae1dc6ff7a949ef34c2900aa9f423abd6be1e381940c4539cc2d89a2a1ce3e4c358afc013a49c
-  data.tar.gz: '00949bf3bb13ed5cf32d47ed6a608627828284217b6549fb4eb239562274336b99a7469ca6bc613eaebe0865d7a8c9f7a2dbe3cb90922cd8dcf19b0c5893d54d'
+  metadata.gz: dae870ef416e6ab02f9321c6b57a4383aa98b9fb99d82e47bef73a94d139b3c4d07b3b38c70a275d76fecae966bd254dbec33609e54f8db3fb3f02d30099e106
+  data.tar.gz: f593bbc8e6a4c5ced747181c10c11e061f45f4a6ac679636b98c9c9abe02d0b6d95d4eb9454211930e47c7a0f927b5a8055cfcd57e7c1820a2da1af23e6071a5

data/CHANGELOG.md

@@ -1,11 +1,15 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
-## [0.28.0]
+## [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;
-- Adopt the code to the new rubocop cops;
+- Existing code base was adopted to the new rubocop ruleset;
 
 ## [0.27.0] - 2022-01-12
 ### Changed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    qonfig (0.27.0)
+    qonfig (0.29.0)
 
 GEM
   remote: https://rubygems.org/
@@ -123,6 +123,7 @@ GEM
 
 PLATFORMS
   arm64-darwin-21
+  arm64-darwin-23
 
 DEPENDENCIES
   activesupport (~> 6.0)

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**.
+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
@@ -3326,7 +3345,8 @@ Qonfig.plugin(:vault)
   - 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/lib/qonfig/commands/definition/expose_json.rb

@@ -2,6 +2,7 @@
 
 # @api private
 # @since 0.14.0
+# @version 0.29.0
 class Qonfig::Commands::Definition::ExposeJSON < Qonfig::Commands::Base
   # @since 0.19.0
   self.inheritable = true
@@ -42,14 +43,22 @@ class Qonfig::Commands::Definition::ExposeJSON < Qonfig::Commands::Base
   # @since 0.14.0
   attr_reader :env
 
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.29.0
+  attr_reader :replace_on_merge
+
   # @param file_path [String, Pathname]
-  # @option strict [Boolean]
   # @option via [Symbol]
   # @option env [String, Symbol]
+  # @option strict [Boolean]
+  # @option replace_on_merge [Boolean]
   #
   # @api private
   # @since 0.14.0
-  def initialize(file_path, strict: true, via:, env:)
+  # @version 0.29.0
+  def initialize(file_path, via:, env:, strict: true, replace_on_merge: false)
     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
@@ -58,9 +67,10 @@ class Qonfig::Commands::Definition::ExposeJSON < Qonfig::Commands::Base
     raise Qonfig::ArgumentError, 'used :via is unsupported' unless EXPOSERS.key?(via)
 
     @file_path = file_path
-    @strict    = strict
-    @via       = via
-    @env       = env
+    @via = via
+    @env = env
+    @strict = strict
+    @replace_on_merge = replace_on_merge
   end
 
   # @param data_set [Qonfig::DataSet]
@@ -85,6 +95,7 @@ class Qonfig::Commands::Definition::ExposeJSON < Qonfig::Commands::Base
   #
   # @api private
   # @since 0.14.0
+  # @version 0.29.0
   # rubocop:disable Metrics/AbcSize
   def expose_file_name!(settings)
     # NOTE: transform file name (insert environment name into the file name)
@@ -102,7 +113,7 @@ class Qonfig::Commands::Definition::ExposeJSON < Qonfig::Commands::Base
     json_data = load_json_data(realfile)
     json_based_settings = build_data_set_klass(json_data).new.settings
 
-    settings.__append_settings__(json_based_settings)
+    settings.__append_settings__(json_based_settings, with_redefinition: replace_on_merge)
   end
   # rubocop:enable Metrics/AbcSize
 
@@ -114,9 +125,10 @@ class Qonfig::Commands::Definition::ExposeJSON < Qonfig::Commands::Base
   #
   # @api private
   # @since 0.14.0
+  # @version 0.29.0
   # rubocop:disable Metrics/AbcSize
   def expose_env_key!(settings)
-    json_data       = load_json_data(file_path)
+    json_data = load_json_data(file_path)
     json_data_slice = json_data[env] || json_data[env.to_s] || json_data[env.to_sym]
     json_data_slice = EMPTY_JSON_DATA.dup if json_data_slice.nil? && !strict
 
@@ -132,7 +144,7 @@ class Qonfig::Commands::Definition::ExposeJSON < Qonfig::Commands::Base
 
     json_based_settings = build_data_set_klass(json_data_slice).new.settings
 
-    settings.__append_settings__(json_based_settings)
+    settings.__append_settings__(json_based_settings, with_redefinition: replace_on_merge)
   end
   # rubocop:enable Metrics/AbcSize
 

data/lib/qonfig/commands/definition/expose_self.rb

@@ -2,6 +2,7 @@
 
 # @api private
 # @since 0.14.0
+# @version 0.29.0
 class Qonfig::Commands::Definition::ExposeSelf < Qonfig::Commands::Base
   # @since 0.19.0
   self.inheritable = true
@@ -24,13 +25,21 @@ class Qonfig::Commands::Definition::ExposeSelf < Qonfig::Commands::Base
   # @since 0.14.0
   attr_reader :env
 
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.29.0
+  attr_reader :replace_on_merge
+
   # @param caller_location [String]
   # @option env [String, Symbol]
   # @option format [String, Symbol]
+  # @option replace_on_merge [Boolean]
   #
   # @api private
   # @since 0.14.0
-  def initialize(caller_location, env:, format:)
+  # @version 0.29.0
+  def initialize(caller_location, env:, format:, replace_on_merge: false)
     unless env.is_a?(Symbol) || env.is_a?(String)
       raise Qonfig::ArgumentError, ':env should be a string or a symbol'
     end
@@ -44,6 +53,7 @@ class Qonfig::Commands::Definition::ExposeSelf < Qonfig::Commands::Base
     @caller_location = caller_location
     @env = env
     @format = format.tap { Qonfig::Loaders.resolve(format) }
+    @replace_on_merge = replace_on_merge
   end
 
   # @param data_set [Qonfig::DataSet]
@@ -52,6 +62,8 @@ class Qonfig::Commands::Definition::ExposeSelf < Qonfig::Commands::Base
   #
   # @api private
   # @since 0.14.0
+  # @version 0.29.0
+  # rubocop:disable Metrics/AbcSize
   def call(data_set, settings)
     self_placed_data = load_self_placed_end_data
     env_based_data_slice =
@@ -68,8 +80,9 @@ class Qonfig::Commands::Definition::ExposeSelf < Qonfig::Commands::Base
     ) unless env_based_data_slice.is_a?(Hash)
 
     self_placed_settings = build_data_set_klass(env_based_data_slice).new.settings
-    settings.__append_settings__(self_placed_settings)
+    settings.__append_settings__(self_placed_settings, with_redefinition: replace_on_merge)
   end
+  # rubocop:enable Metrics/AbcSize
 
   private
 

data/lib/qonfig/commands/definition/expose_yaml.rb

@@ -2,6 +2,7 @@
 
 # @api private
 # @since 0.7.0
+# @version 0.29.0
 class Qonfig::Commands::Definition::ExposeYAML < Qonfig::Commands::Base
   # @since 0.19.0
   self.inheritable = true
@@ -42,14 +43,22 @@ class Qonfig::Commands::Definition::ExposeYAML < Qonfig::Commands::Base
   # @since 0.7.0
   attr_reader :env
 
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.29.0
+  attr_reader :replace_on_merge
+
   # @param file_path [String, Pathname]
-  # @option strict [Boolean]
   # @option via [Symbol]
   # @option env [String, Symbol]
+  # @option strict [Boolean]
+  # @option replace_on_merge [Boolean]
   #
   # @api private
   # @since 0.7.0
-  def initialize(file_path, strict: true, via:, env:)
+  # @version 0.29.0
+  def initialize(file_path, via:, env:, strict: true, replace_on_merge: false)
     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
@@ -58,9 +67,10 @@ class Qonfig::Commands::Definition::ExposeYAML < Qonfig::Commands::Base
     raise Qonfig::ArgumentError, 'used :via is unsupported' unless EXPOSERS.key?(via)
 
     @file_path = file_path
-    @strict    = strict
-    @via       = via
-    @env       = env
+    @strict = strict
+    @via = via
+    @env = env
+    @replace_on_merge = replace_on_merge
   end
 
   # @param data_set [Qonfig::DataSet]
@@ -85,6 +95,7 @@ class Qonfig::Commands::Definition::ExposeYAML < Qonfig::Commands::Base
   #
   # @api private
   # @since 0.7.0
+  # @version 0.29.0
   # rubocop:disable Metrics/AbcSize
   def expose_file_name!(settings)
     # NOTE: transform file name (insert environment name into the file name)
@@ -102,7 +113,7 @@ class Qonfig::Commands::Definition::ExposeYAML < Qonfig::Commands::Base
     yaml_data = load_yaml_data(realfile)
     yaml_based_settings = build_data_set_klass(yaml_data).new.settings
 
-    settings.__append_settings__(yaml_based_settings)
+    settings.__append_settings__(yaml_based_settings, with_redefinition: replace_on_merge)
   end
   # rubocop:enable Metrics/AbcSize
 
@@ -114,6 +125,7 @@ class Qonfig::Commands::Definition::ExposeYAML < Qonfig::Commands::Base
   #
   # @api private
   # @since 0.7.0
+  # @version 0.29.0
   # rubocop:disable Metrics/AbcSize
   def expose_env_key!(settings)
     yaml_data       = load_yaml_data(file_path)
@@ -132,7 +144,7 @@ class Qonfig::Commands::Definition::ExposeYAML < Qonfig::Commands::Base
 
     yaml_based_settings = build_data_set_klass(yaml_data_slice).new.settings
 
-    settings.__append_settings__(yaml_based_settings)
+    settings.__append_settings__(yaml_based_settings, with_redefinition: replace_on_merge)
   end
   # rubocop:enable Metrics/AbcSize
 

data/lib/qonfig/commands/definition/load_from_json.rb

@@ -2,6 +2,7 @@
 
 # @api private
 # @since 0.5.0
+# @version 0.29.0
 class Qonfig::Commands::Definition::LoadFromJSON < Qonfig::Commands::Base
   # @since 0.19.0
   self.inheritable = true
@@ -18,14 +19,23 @@ class Qonfig::Commands::Definition::LoadFromJSON < Qonfig::Commands::Base
   # @sicne 0.5.0
   attr_reader :strict
 
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.29.0
+  attr_reader :replace_on_merge
+
   # @param file_path [String, Pathname]
   # @option strict [Boolean]
+  # @option replace_on_merge [Boolean]
   #
   # @api private
   # @since 0.5.0
-  def initialize(file_path, strict: true)
+  # @version 0.29.0
+  def initialize(file_path, strict: true, replace_on_merge: false)
     @file_path = file_path
     @strict = strict
+    @replace_on_merge = replace_on_merge
   end
 
   # @param data_set [Qonfig::DataSet]
@@ -34,6 +44,7 @@ class Qonfig::Commands::Definition::LoadFromJSON < Qonfig::Commands::Base
   #
   # @api private
   # @since 0.5.0
+  # @version 0.29.0
   def call(data_set, settings)
     json_data = Qonfig::Loaders::JSON.load_file(file_path, fail_on_unexist: strict)
 
@@ -43,7 +54,7 @@ class Qonfig::Commands::Definition::LoadFromJSON < Qonfig::Commands::Base
     ) unless json_data.is_a?(Hash)
 
     json_based_settings = build_data_set_klass(json_data).new.settings
-    settings.__append_settings__(json_based_settings)
+    settings.__append_settings__(json_based_settings, with_redefinition: replace_on_merge)
   end
 
   private

data/lib/qonfig/commands/definition/load_from_self.rb

@@ -2,6 +2,7 @@
 
 # @api private
 # @since 0.2.0
+# @version 0.29.0
 class Qonfig::Commands::Definition::LoadFromSelf < Qonfig::Commands::Base
   # @since 0.19.0
   self.inheritable = true
@@ -18,18 +19,27 @@ class Qonfig::Commands::Definition::LoadFromSelf < Qonfig::Commands::Base
   # @since 0.2.0
   attr_reader :caller_location
 
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.29.0
+  attr_reader :replace_on_merge
+
   # @param caller_location [String]
   # @option format [String, Symbol]
+  # @option replace_on_merge [Boolean]
   #
   # @api private
   # @since 0.2.0
-  def initialize(caller_location, format:)
+  # @version 0.29.0
+  def initialize(caller_location, format:, replace_on_merge: false)
     unless format.is_a?(String) || format.is_a?(Symbol)
       raise Qonfig::ArgumentError, 'Format should be a symbol or a string'
     end
 
     @caller_location = caller_location
     @format = format.tap { Qonfig::Loaders.resolve(format) }
+    @replace_on_merge = replace_on_merge
   end
 
   # @param data_set [Qonfig::DataSet]
@@ -38,11 +48,12 @@ class Qonfig::Commands::Definition::LoadFromSelf < Qonfig::Commands::Base
   #
   # @api private
   # @since 0.2.0
+  # @version 0.29.0
   def call(data_set, settings)
     self_placed_end_data = load_self_placed_end_data
     self_placed_settings = build_data_set_klass(self_placed_end_data).new.settings
 
-    settings.__append_settings__(self_placed_settings)
+    settings.__append_settings__(self_placed_settings, with_redefinition: replace_on_merge)
   end
 
   private

data/lib/qonfig/commands/definition/load_from_yaml.rb

@@ -2,6 +2,7 @@
 
 # @api private
 # @since 0.2.0
+# @version 0.29.0
 class Qonfig::Commands::Definition::LoadFromYAML < Qonfig::Commands::Base
   # @since 0.19.0
   self.inheritable = true
@@ -18,14 +19,23 @@ class Qonfig::Commands::Definition::LoadFromYAML < Qonfig::Commands::Base
   # @since 0.2.0
   attr_reader :strict
 
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.29.0
+  attr_reader :replace_on_merge
+
   # @param file_path [String, Pathname]
   # @option strict [Boolean]
+  # @option replace_on_merge [Boolean]
   #
   # @api private
   # @since 0.2.0
-  def initialize(file_path, strict: true)
+  # @version 0.29.0
+  def initialize(file_path, strict: true, replace_on_merge: false)
     @file_path = file_path
     @strict = strict
+    @replace_on_merge = replace_on_merge
   end
 
   # @param data_set [Qonfig::DataSet]
@@ -36,6 +46,7 @@ class Qonfig::Commands::Definition::LoadFromYAML < Qonfig::Commands::Base
   #
   # @api private
   # @since 0.2.0
+  # @version 0.29.0
   def call(data_set, settings)
     yaml_data = Qonfig::Loaders::YAML.load_file(file_path, fail_on_unexist: strict)
 
@@ -45,7 +56,7 @@ class Qonfig::Commands::Definition::LoadFromYAML < Qonfig::Commands::Base
     ) unless yaml_data.is_a?(Hash)
 
     yaml_based_settings = build_data_set_klass(yaml_data).new.settings
-    settings.__append_settings__(yaml_based_settings)
+    settings.__append_settings__(yaml_based_settings, with_redefinition: replace_on_merge)
   end
 
   private

data/lib/qonfig/dsl.rb

@@ -2,7 +2,7 @@
 
 # @api private
 # @since 0.1.0
-# @version 0.20.0
+# @version 0.29.0
 module Qonfig::DSL # rubocop:disable Metrics/ModuleLength
   require_relative 'dsl/inheritance'
 
@@ -156,42 +156,47 @@ module Qonfig::DSL # rubocop:disable Metrics/ModuleLength
 
   # @param file_path [String, Pathname]
   # @option strict [Boolean]
+  # @option replace_on_merge [Boolean]
   # @return [void]
   #
   # @see Qonfig::Commands::Definition::LoadFromYAML
   #
   # @api public
   # @since 0.2.0
-  def load_from_yaml(file_path, strict: true)
+  # @version 0.29.0
+  def load_from_yaml(file_path, strict: true, replace_on_merge: false)
     definition_commands << Qonfig::Commands::Definition::LoadFromYAML.new(
-      file_path, strict: strict
+      file_path, strict: strict, replace_on_merge: replace_on_merge
     )
   end
 
   # @option format [Symbol, String]
+  # @option replace_on_merge [Boolean]
   # @return [void]
   #
   # @see Qonfig::Commands::Definition::LoadFromSelf
   #
   # @api public
   # @since 0.2.0
-  # @version 0.21.0
-  def load_from_self(format: :dynamic)
+  # @version 0.29.0
+  def load_from_self(format: :dynamic, replace_on_merge: false)
     caller_location = ::Kernel.caller(1, 1).first
 
     definition_commands << Qonfig::Commands::Definition::LoadFromSelf.new(
-      caller_location, format: format
+      caller_location, format: format, replace_on_merge: replace_on_merge
     )
   end
 
   # @option convert_values [Boolean]
   # @option prefix [NilClass, String, Regexp]
+  # @option replace_on_merge [Boolean]
   # @return [void]
   #
   # @see Qonfig::Commands::Definition::LoadFromENV
   #
   # @api public
   # @since 0.2.0
+  # @version 0.29.0
   def load_from_env(convert_values: false, prefix: nil, trim_prefix: false)
     definition_commands << Qonfig::Commands::Definition::LoadFromENV.new(
       convert_values: convert_values,
@@ -202,62 +207,71 @@ module Qonfig::DSL # rubocop:disable Metrics/ModuleLength
 
   # @param file_path [String, Pathname]
   # @option strict [Boolean]
+  # @option replace_on_merge [Boolean]
   # @return [void]
   #
   # @see Qonfig::Commands::Definition::LoadFromJSON
   #
   # @api public
   # @since 0.5.0
-  def load_from_json(file_path, strict: true)
-    definition_commands << Qonfig::Commands::Definition::LoadFromJSON.new(file_path, strict: strict)
+  # @version 0.29.0
+  def load_from_json(file_path, strict: true, replace_on_merge: false)
+    definition_commands << Qonfig::Commands::Definition::LoadFromJSON.new(
+      file_path, strict: strict, replace_on_merge: replace_on_merge
+    )
   end
 
   # @param file_path [String, Pathname]
-  # @option strict [Boolean]
   # @option via [Symbol]
   # @option env [Symbol, String]
+  # @option strict [Boolean]
+  # @option replace_on_merge [Boolean]
   # @return [void]
   #
   # @see Qonfig::Commands::Definition::ExposeYAML
   #
   # @api public
   # @since 0.7.0
-  def expose_yaml(file_path, strict: true, via:, env:)
+  # @version 0.29.0
+  def expose_yaml(file_path, via:, env:, strict: true, replace_on_merge: false)
     definition_commands << Qonfig::Commands::Definition::ExposeYAML.new(
-      file_path, strict: strict, via: via, env: env
+      file_path, via: via, env: env, strict: strict, replace_on_merge: replace_on_merge
     )
   end
 
   # @param file_path [String, Pathname]
-  # @option strict [Boolean]
   # @option via [Symbol]
   # @option env [Symbol, String]
+  # @option strict [Boolean]
+  # @option replace_on_merge [Boolean]
   # @return [void]
   #
   # @see Qonfig::Commands::Definition::ExposeJSON
   #
   # @api public
   # @since 0.14.0
-  def expose_json(file_path, strict: true, via:, env:)
+  # @version 0.29.0
+  def expose_json(file_path, via:, env:, strict: true, replace_on_merge: false)
     definition_commands << Qonfig::Commands::Definition::ExposeJSON.new(
-      file_path, strict: strict, via: via, env: env
+      file_path, via: via, env: env, strict: strict, replace_on_merge: replace_on_merge
     )
   end
 
   # @option env [Symbol, String]
   # @option format [Symbol, String]
+  # @option replace_on_merge [Boolean]
   # @return [void]
   #
   # @see Qonfig::Commands::Definition::ExposeSelf
   #
   # @api public
   # @since 0.14.0
-  # @version 0.21.0
-  def expose_self(env:, format: :dynamic)
+  # @version 0.29.0
+  def expose_self(env:, format: :dynamic, replace_on_merge: false)
     caller_location = ::Kernel.caller(1, 1).first
 
     definition_commands << Qonfig::Commands::Definition::ExposeSelf.new(
-      caller_location, env: env, format: format
+      caller_location, env: env, format: format, replace_on_merge: replace_on_merge
     )
   end