qonfig 0.19.1 → 0.20.0

data/lib/qonfig/dsl.rb

@@ -2,27 +2,36 @@
 
 # @api private
 # @since 0.1.0
-module Qonfig::DSL
+# @version 0.20.0
+module Qonfig::DSL # rubocop:disable Metrics/ModuleLength
   class << self
     # @param child_klass [Qonfig::DataSet]
     # @return [void]
     #
+    # @see Qonfig::DataSet::ClassBuilder
+    #
     # @api private
     # @since 0.1.0
-    # @version 0.19.0
+    # @version 0.20.0
+    # rubocop:disable Metrics/LineLength, Metrics/AbcSize
     def extended(child_klass)
       child_klass.instance_variable_set(:@definition_commands, Qonfig::CommandSet.new)
       child_klass.instance_variable_set(:@instance_commands, Qonfig::CommandSet.new)
+      child_klass.instance_variable_set(:@predefined_validators, Qonfig::Validation::Collections::PredefinedRegistry.new)
+      child_klass.instance_variable_set(:@validators, Qonfig::Validation::Collections::InstanceCollection.new)
 
       child_klass.singleton_class.prepend(Module.new do
         def inherited(child_klass)
           child_klass.instance_variable_set(:@definition_commands, Qonfig::CommandSet.new)
           child_klass.instance_variable_set(:@instance_commands, Qonfig::CommandSet.new)
+          child_klass.instance_variable_set(:@predefined_validators, Qonfig::Validation::Collections::PredefinedRegistry.new)
+          child_klass.instance_variable_set(:@validators, Qonfig::Validation::Collections::InstanceCollection.new)
           Qonfig::DataSet::ClassBuilder.inherit(base_klass: self, child_klass: child_klass)
           super
         end
       end)
     end
+    # rubocop:enable Metrics/LineLength, Metrics/AbcSize
   end
 
   # @return [Qonfig::CommandSet]
@@ -41,13 +50,71 @@ module Qonfig::DSL
     @instance_commands
   end
 
+  # @return [Qonfig::Validation::Collections::PredefinedRegistry]
+  #
+  # @api private
+  # @since 0.20.0
+  def predefined_validators
+    @predefined_validators
+  end
+
+  # @return [Qonfig::Validation::Collections::InstanceCollection]
+  #
+  # @api private
+  # @since 0.20.0
+  def validators
+    @validators
+  end
+
+  # @param setting_key_pattern [String, Symbol, NilClass]
+  # @param predefined [String, Symbol]
+  # @option by [String, Symbol, NilClass]
+  # @option stict [Boolean]
+  # @param custom_validation [Proc]
+  # @return [void]
+  #
+  # @see Qonfig::Validation::Building::InstanceBuilder
+  #
+  # @api public
+  # @since 0.20.0
+  def validate(
+    setting_key_pattern = nil,
+    predefined = nil,
+    strict: false,
+    by: nil,
+    &custom_validation
+  )
+    validators << Qonfig::Validation::Building::InstanceBuilder.build(
+      self,
+      setting_key_pattern: setting_key_pattern,
+      predefined_validator: predefined,
+      runtime_validation_method: by,
+      strict: strict,
+      validation_logic: custom_validation
+    )
+  end
+
+  # @param name [String, Symbol]
+  # @param validation_logic [Block]
+  # @return [void]
+  #
+  # @see Qonfig::Validation::Building::PredefinedBuilder
+  #
+  # @api public
+  # @since 0.20.0
+  def define_validator(name, &validation_logic)
+    Qonfig::Validation::Building::PredefinedBuilder.build(
+      name, validation_logic, predefined_validators
+    )
+  end
+
   # @param key [Symbol, String]
   # @param initial_value [Object]
   # @param nested_settings [Proc]
   # @return [void]
   #
-  # @see Qonfig::Commands::AddNestedOption
-  # @see Qonfig::Commands::AddOption
+  # @see Qonfig::Commands::Definition::AddNestedOption
+  # @see Qonfig::Commands::Definition::AddOption
   #
   # @api public
   # @since 0.1.0
@@ -59,10 +126,25 @@ module Qonfig::DSL
     end
   end
 
+  # @param key [Symbol, String]
+  # @param initial_value [Object]
+  # @param nested_settings [Proc]
+  # @return [void]
+  #
+  # @see Qonfig::Comamnds::Definition::ReDefineOption
+  #
+  # @api public
+  # @since 0.20.0
+  def re_setting(key, initial_value = nil, &nested_settings)
+    definition_commands << Qonfig::Commands::Definition::ReDefineOption.new(
+      key, initial_value, nested_settings
+    )
+  end
+
   # @param data_set_klass [Class<Qonfig::DataSet>]
   # @return [void]
   #
-  # @see Qonfig::Comamnds::Compose
+  # @see Qonfig::Comamnds::Definition::Compose
   #
   # @api private
   # @sine 0.1.0
@@ -74,7 +156,7 @@ module Qonfig::DSL
   # @option strict [Boolean]
   # @return [void]
   #
-  # @see Qonfig::Commands::LoadFromYAML
+  # @see Qonfig::Commands::Definition::LoadFromYAML
   #
   # @api public
   # @since 0.2.0
@@ -86,7 +168,7 @@ module Qonfig::DSL
 
   # @return [void]
   #
-  # @see Qonfig::Commands::LoadFromSelf
+  # @see Qonfig::Commands::Definition::LoadFromSelf
   #
   # @api public
   # @since 0.2.0
@@ -102,7 +184,7 @@ module Qonfig::DSL
   # @option prefix [NilClass, String, Regexp]
   # @return [void]
   #
-  # @see Qonfig::Commands::LoadFromENV
+  # @see Qonfig::Commands::Definition::LoadFromENV
   #
   # @api public
   # @since 0.2.0
@@ -118,6 +200,8 @@ module Qonfig::DSL
   # @option strict [Boolean]
   # @return [void]
   #
+  # @see Qonfig::Commands::Definition::LoadFromJSON
+  #
   # @api public
   # @since 0.5.0
   def load_from_json(file_path, strict: true)
@@ -130,6 +214,8 @@ module Qonfig::DSL
   # @option env [Symbol, String]
   # @return [void]
   #
+  # @see Qonfig::Commands::Definition::ExposeYAML
+  #
   # @api public
   # @since 0.7.0
   def expose_yaml(file_path, strict: true, via:, env:)
@@ -144,6 +230,8 @@ module Qonfig::DSL
   # @option env [Symbol, String]
   # @return [void]
   #
+  # @see Qonfig::Commands::Definition::ExposeJSON
+  #
   # @api public
   # @since 0.14.0
   def expose_json(file_path, strict: true, via:, env:)
@@ -155,7 +243,7 @@ module Qonfig::DSL
   # @option env [Symbol, String]
   # @return [void]
   #
-  # @see Qonfig::Commands::LoadFromSelf
+  # @see Qonfig::Commands::Definition::ExposeSelf
   #
   # @api public
   # @since 0.14.0
@@ -173,6 +261,8 @@ module Qonfig::DSL
   # @option expose [NilClass, String, Symbol] Environment key
   # @return [void]
   #
+  # @see Qonfig::Commands::Instantiation::ValuesFile
+  #
   # @api public
   # @since 0.17.0
   def values_file(file_path, format: :dynamic, strict: false, expose: nil)
@@ -185,6 +275,8 @@ module Qonfig::DSL
 
   # @return [void]
   #
+  # @see Qonfig::Commands::Instantiation::FreezeState
+  #
   # @api public
   # @since 0.19.0
   def freeze_state!

data/lib/qonfig/errors.rb

@@ -9,21 +9,26 @@ module Qonfig
   # @since 0.1.0
   ArgumentError = Class.new(ArgumentError)
 
-  # @see Qonfig::Validator::Builder::AttributeConsistency
-  # @see Qonfig::Validator::Predefined::Registry
+  # @see Qonfig::Validation::Validators::MethodBased
+  # @see Qonfig::Validation::Validators::ProcBased
+  # @see Qonfig::Validation::Validators::Predefined
   #
   # @api public
   # @since 0.13.0
-  ValidatorArgumentError = Class.new(ArgumentError)
+  ValidationError = Class.new(Error)
 
-  # @see Qonfig::Validator
-  # @see Qonfig::Validator::MethodBased
-  # @see Qonfig::Validator::ProcBased
-  # @see Qonfig::Validator::Predefined::Common
+  # @see Qonfig::Validation::Building::InstanceBuilder::AttributeConsistency
+  # @see Qonfig::Validation::Building::PredefinedBuilder
   #
   # @api public
   # @since 0.13.0
-  ValidationError = Class.new(Error)
+  ValidatorArgumentError = Class.new(ArgumentError)
+
+  # @see Qonfig::Validation::Collections::PredefinedRegistry
+  #
+  # @api public
+  # @since 0.20.0
+  ValidatorNotFoundError = Class.new(ValidatorArgumentError)
 
   # @api public
   # @since 0.12.0
@@ -63,6 +68,7 @@ module Qonfig
   # @see Qonfig::Settings::KeyGuard
   # @see Qonfig::Commands::Definition::AddOption
   # @see Qonfig::Commands::Definition::AddNestedOption
+  # @see Qonfig::Commands::Definition::ReDefineOption
   #
   # @api public
   # @since 0.2.0

data/lib/qonfig/plugins/toml/commands/{expose_toml.rb → definition/expose_toml.rb}

@@ -2,7 +2,11 @@
 
 # @api private
 # @since 0.12.0
-class Qonfig::Commands::ExposeTOML < Qonfig::Commands::Base
+# @version 0.20.0
+class Qonfig::Commands::Definition::ExposeTOML < Qonfig::Commands::Base
+  # @since 0.20.0
+  self.inheritable = true
+
   # @return [Hash]
   #
   # @api private

data/lib/qonfig/plugins/toml/commands/{load_from_toml.rb → definition/load_from_toml.rb}

@@ -2,7 +2,11 @@
 
 # @api private
 # @since 0.12.0
-class Qonfig::Commands::LoadFromTOML < Qonfig::Commands::Base
+# @version 0.20.0
+class Qonfig::Commands::Definition::LoadFromTOML < Qonfig::Commands::Base
+  # @since 0.20.0
+  self.inheritable = true
+
   # @return [String]
   #
   # @api private

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

@@ -7,10 +7,13 @@ module Qonfig::DSL
   # @option strict [Boolean]
   # @return [void]
   #
+  # @see Qonfig::Commands::Definition::LoadFromTOML
+  #
   # @api public
   # @since 0.12.0
+  # @version 0.20.0
   def load_from_toml(file_path, strict: true)
-    definition_commands << Qonfig::Commands::LoadFromTOML.new(
+    definition_commands << Qonfig::Commands::Definition::LoadFromTOML.new(
       file_path, strict: strict
     )
   end
@@ -21,10 +24,13 @@ module Qonfig::DSL
   # @option env [Symbol, String]
   # @return [void]
   #
+  # @see Qonfig::Commands::Definition::ExposeTOML
+  #
   # @api public
   # @since 0.12.0
+  # @version 0.20.0
   def expose_toml(file_path, strict: true, via:, env:)
-    definition_commands << Qonfig::Commands::ExposeTOML.new(
+    definition_commands << Qonfig::Commands::Definition::ExposeTOML.new(
       file_path, strict: strict, via: via, env: env
     )
   end

data/lib/qonfig/plugins/toml.rb

@@ -20,8 +20,8 @@ class Qonfig::Plugins::TOML < Qonfig::Plugins::Abstract
       require_relative 'toml/loaders/toml'
       require_relative 'toml/loaders/dynamic'
       require_relative 'toml/uploaders/toml'
-      require_relative 'toml/commands/load_from_toml'
-      require_relative 'toml/commands/expose_toml'
+      require_relative 'toml/commands/definition/load_from_toml'
+      require_relative 'toml/commands/definition/expose_toml'
       require_relative 'toml/data_set'
       require_relative 'toml/dsl'
     end

data/lib/qonfig/settings.rb

@@ -82,18 +82,20 @@ class Qonfig::Settings # NOTE: Layout/ClassStructure is disabled only for CORE_M
 
   # @param key [Symbol, String]
   # @param value [Object]
+  # @option with_redefinition [Boolean]
   # @return [void]
   #
   # @api private
   # @since 0.1.0
-  def __define_setting__(key, value) # rubocop:disable Metrics/AbcSize
+  # @version 0.20.0
+  def __define_setting__(key, value, with_redefinition: false) # rubocop:disable Metrics/AbcSize
     __lock__.thread_safe_definition do
       key = __indifferently_accessable_option_key__(key)
 
       __prevent_core_method_intersection__(key)
 
       case
-      when !__options__.key?(key)
+      when with_redefinition || !__options__.key?(key)
         __options__[key] = value
       when __is_a_setting__(__options__[key]) && __is_a_setting__(value)
         __options__[key].__append_settings__(value)

data/lib/qonfig/{validator/builder → validation/building/instance_builder}/attribute_consistency.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 # @api private
-# @since 0.13.0
+# @since 0.20.0
 # rubocop:disable Metrics/ClassLength
-class Qonfig::Validator::Builder::AttributeConsistency
+class Qonfig::Validation::Building::InstanceBuilder::AttributesConsistency
   class << self
     # @param setting_key_pattern [String, Symbol, NilClass]
     # @param predefined_validator [String, Symbol, NilClass]
@@ -13,7 +13,7 @@ class Qonfig::Validator::Builder::AttributeConsistency
     # @return [void]
     #
     # @api private
-    # @since 0.13.0
+    # @since 0.20.0
     def check!(
       setting_key_pattern,
       predefined_validator,
@@ -38,7 +38,7 @@ class Qonfig::Validator::Builder::AttributeConsistency
   # @return [void]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   def initialize(
     setting_key_pattern,
     predefined_validator,
@@ -58,7 +58,7 @@ class Qonfig::Validator::Builder::AttributeConsistency
   # @raise [Qonfig::ValidatorArgumentError]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   def check!
     consistent_strict_behaviour!
     consistent_method_choice!
@@ -73,19 +73,19 @@ class Qonfig::Validator::Builder::AttributeConsistency
   # @return [String, Symbol, NilClass]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   attr_reader :setting_key_pattern
 
   # @return [String, Symbol, NilClass]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   attr_reader :predefined_validator
 
   # @return [String, Symbol, NilClass]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   attr_reader :runtime_validation_method
 
   # @return [Boolean]
@@ -97,7 +97,7 @@ class Qonfig::Validator::Builder::AttributeConsistency
   # @return [Proc, NilClass]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   attr_reader :validation_logic
 
   # @return [void]
@@ -105,7 +105,7 @@ class Qonfig::Validator::Builder::AttributeConsistency
   # @raise [Qonfig::ValidatorArgumentError]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   def consistent_method_choice!
     unless runtime_validation_method || validation_logic || predefined_validator
       raise(
@@ -143,7 +143,7 @@ class Qonfig::Validator::Builder::AttributeConsistency
   # @raise [Qonfig::ValidatorArgumentError]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   def consistent_predefined_validator!
     return if predefined_validator.nil?
     return if predefined_validator.is_a?(Symbol)
@@ -160,7 +160,7 @@ class Qonfig::Validator::Builder::AttributeConsistency
   # @raise [Qonfig::ValidatorArgumentError]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   def cosnistent_runtime_validation_method!
     return if runtime_validation_method.nil?
     return if runtime_validation_method.is_a?(Symbol)
@@ -177,7 +177,7 @@ class Qonfig::Validator::Builder::AttributeConsistency
   # @raise [Qonfig::ValidatorArgumentError]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   def consistent_validation_logic!
     return if validation_logic.nil?
     return if validation_logic.is_a?(Proc)
@@ -195,7 +195,7 @@ class Qonfig::Validator::Builder::AttributeConsistency
   # @raise [Qonfig::ValidatorArgumentError]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   def consistent_setting_key_pattern!
     return if setting_key_pattern.nil?
     return if setting_key_pattern.is_a?(Symbol)

data/lib/qonfig/{validator/builder.rb → validation/building/instance_builder.rb}

@@ -1,32 +1,32 @@
 # frozen_string_literal: true
 
 # @api private
-# @since 0.13.0
-class Qonfig::Validator::Builder
-  require_relative 'builder/attribute_consistency'
+# @since 0.20.0
+class Qonfig::Validation::Building::InstanceBuilder
+  require_relative 'instance_builder/attribute_consistency'
 
   # @return [NilClass]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   EMPTY_SETTING_KEY_PATTERN = nil
 
   # @return [NilClass]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   NO_RUNTIME_VALIDATION_METHOD = nil
 
   # @return [NilClass]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   NO_VALIDATION_LOGIC = nil
 
   # @return [NilClass]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   NO_PREDEFINED_VALIDATOR = nil
 
   # @return [Boolean]
@@ -36,6 +36,7 @@ class Qonfig::Validator::Builder
   DEFAULT_STRICT_BEHAVIOUR = false
 
   class << self
+    # @param data_set_klass [Class<Qonfig::DataSet>]
     # @option setting_key_pattern [String, Symbol, NilClass]
     # @option predefined_validator [String, Symbol, NilClass]
     # @option runtime_validation_method [String, Symbol, NilClass]
@@ -44,8 +45,9 @@ class Qonfig::Validator::Builder
     # @return [Qonfig::Validator::MethodBased, Qonfig::Validator::ProcBased]
     #
     # @api private
-    # @since 0.13.0
+    # @since 0.20.0
     def build(
+      data_set_klass,
       setting_key_pattern: EMPTY_SETTING_KEY_PATTERN,
       runtime_validation_method: NO_RUNTIME_VALIDATION_METHOD,
       validation_logic: NO_VALIDATION_LOGIC,
@@ -53,6 +55,7 @@ class Qonfig::Validator::Builder
       predefined_validator: NO_PREDEFINED_VALIDATOR
     )
       new(
+        data_set_klass,
         setting_key_pattern,
         predefined_validator,
         runtime_validation_method,
@@ -62,6 +65,7 @@ class Qonfig::Validator::Builder
     end
   end
 
+  # @param data_set_klass [Class<Qonfig::DataSet>]
   # @param setting_key_pattern [String, Symbol, NilClass]
   # @param predefined_validator_name [String, Symbol, NilClass]
   # @param runtime_validation_method [String, Symbol, NilClass]
@@ -70,14 +74,16 @@ class Qonfig::Validator::Builder
   # @return [void]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   def initialize(
+    data_set_klass,
     setting_key_pattern,
     predefined_validator_name,
     runtime_validation_method,
     strict,
     validation_logic
   )
+    @data_set_klass = data_set_klass
     @setting_key_pattern = setting_key_pattern
     @predefined_validator_name = predefined_validator_name
     @runtime_validation_method = runtime_validation_method
@@ -85,10 +91,12 @@ class Qonfig::Validator::Builder
     @validation_logic = validation_logic
   end
 
-  # @return [Qonfig::Validator::MethodBased, Qonfig::Validator::ProcBased]
+  # @return [Qonfig::Validation::Validators::MethodBased]
+  # @return [Qonfig::Validation::Validators::ProcBased]
+  # @return [Qonfig::Validation::Validators::Predefined]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   def build
     validate_attributes!
     build_validator
@@ -96,22 +104,28 @@ class Qonfig::Validator::Builder
 
   private
 
+  # @return [Class<Qonfig::DataSet>]
+  #
+  # @api private
+  # @since 0.20.0
+  attr_reader :data_set_klass
+
   # @return [String, Symbol, NilClass]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   attr_reader :setting_key_pattern
 
   # @return [String, Symbol, NilClass]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   attr_reader :predefined_validator_name
 
   # @return [String, Symbol, NilClass]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   attr_reader :runtime_validation_method
 
   # @return [Boolean]
@@ -123,7 +137,7 @@ class Qonfig::Validator::Builder
   # @return [Proc, NilClass]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   attr_reader :validation_logic
 
   # @return [void]
@@ -131,9 +145,9 @@ class Qonfig::Validator::Builder
   # @raise [Qonfig::ArgumentError]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   def validate_attributes!
-    AttributeConsistency.check!(
+    AttributesConsistency.check!(
       setting_key_pattern,
       predefined_validator_name,
       runtime_validation_method,
@@ -142,10 +156,12 @@ class Qonfig::Validator::Builder
     )
   end
 
-  # @return [Qonfig::Validator::MethodBased, Qonfig::Validator::PorcBased]
+  # @return [Qonfig::Validation::Validators::MethodBased]
+  # @return [Qonfig::Validation::Validators::ProcBased]
+  # @return [Qonfig::Validation::Validators::Predefined]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   def build_validator
     case
     when predefined_validator_name then build_predefined_validator
@@ -157,38 +173,47 @@ class Qonfig::Validator::Builder
   # @return [Qonfig::Settings::KeyMatcher, NilClass]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   def build_setting_key_matcher
     Qonfig::Settings::KeyMatcher.new(setting_key_pattern.to_s) if setting_key_pattern
   end
 
-  # @return [Qonfig::Validator::MethodBased]
+  # @return [Qonfig::Validation::Validators::MethodBased]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   def build_method_based_validator
-    Qonfig::Validator::MethodBased.new(
+    Qonfig::Validation::Validators::MethodBased.new(
       build_setting_key_matcher, strict, runtime_validation_method
     )
   end
 
-  # @return [Qonfig::Validator::ProcBased]
+  # @return [Qonfig::Validation::Validators::ProcBased]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   def build_proc_based_validator
-    Qonfig::Validator::ProcBased.new(
+    Qonfig::Validation::Validators::ProcBased.new(
       build_setting_key_matcher, strict, validation_logic
     )
   end
 
-  # @return [Qonfig::Settings::Predefined]
+  # @return [Qonfig::Validation::Validators::Predefined]
+  #
+  # @see Qonfig::Validation::Collections::PredefinedRegistry
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   def build_predefined_validator
-    Qonfig::Validator::Predefined.build(
-      predefined_validator_name, build_setting_key_matcher, strict
+    predefined_validation_logic =
+      begin
+        data_set_klass.predefined_validators.resolve(predefined_validator_name)
+      rescue Qonfig::ValidatorNotFoundError
+        Qonfig::DataSet.predefined_validators.resolve(predefined_validator_name)
+      end
+
+    Qonfig::Validation::Validators::Predefined.new(
+      build_setting_key_matcher, strict, predefined_validation_logic
     )
   end
 end