qonfig 0.12.0 → 0.13.0

data/lib/qonfig/validator/builder/attribute_consistency.rb

@@ -0,0 +1,181 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.13.0
+class Qonfig::Validator::Builder::AttributeConsistency
+  class << self
+    # @param setting_key_pattern [String, Symbol, NilClass]
+    # @param predefined_validator [String, Symbol, NilClass]
+    # @param runtime_validation_method [String, Symbol, NilClass]
+    # @param validation_logic [Proc, NilClass]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.13.0
+    def check!(
+      setting_key_pattern,
+      predefined_validator,
+      runtime_validation_method,
+      validation_logic
+    )
+      new(
+        setting_key_pattern,
+        predefined_validator,
+        runtime_validation_method,
+        validation_logic
+      ).check!
+    end
+  end
+
+  # @param setting_key_pattern [String, Symbol, NilClass]
+  # @param predefined_validator [String, Symbol, NilClass]
+  # @param runtime_validation_method [String, Symbol, NilClass]
+  # @param validation_logic [Proc, NilClass]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.13.0
+  def initialize(
+    setting_key_pattern,
+    predefined_validator,
+    runtime_validation_method,
+    validation_logic
+  )
+    @setting_key_pattern = setting_key_pattern
+    @predefined_validator = predefined_validator
+    @runtime_validation_method = runtime_validation_method
+    @validation_logic = validation_logic
+  end
+
+  # @return [void]
+  #
+  # @raise [Qonfig::ValidatorArgumentError]
+  #
+  # @api private
+  # @since 0.13.0
+  def check!
+    consistent_method_choice!
+    consistent_predefined_validator!
+    cosnistent_runtime_validation_method!
+    consistent_validation_logic!
+    consistent_setting_key_pattern!
+  end
+
+  private
+
+  # @return [String, Symbol, NilClass]
+  #
+  # @api private
+  # @since 0.13.0
+  attr_reader :setting_key_pattern
+
+  # @return [String, Symbol, NilClass]
+  #
+  # @api private
+  # @since 0.13.0
+  attr_reader :predefined_validator
+
+  # @return [String, Symbol, NilClass]
+  #
+  # @api private
+  # @since 0.13.0
+  attr_reader :runtime_validation_method
+
+  # @return [Proc, NilClass]
+  #
+  # @api private
+  # @since 0.13.0
+  attr_reader :validation_logic
+
+  # @return [void]
+  #
+  # @raise [Qonfig::ValidatorArgumentError]
+  #
+  # @api private
+  # @since 0.13.0
+  def consistent_method_choice!
+    unless runtime_validation_method || validation_logic || predefined_validator
+      raise(
+        Qonfig::ValidatorArgumentError,
+        'Empty validation (you should provide: dataset method OR proc OR predefined validator)'
+      )
+    end
+
+    if ((runtime_validation_method && validation_logic) ||
+       (predefined_validator && (runtime_validation_method || validation_logic)))
+      raise(
+        Qonfig::ValidatorArgumentError,
+        'Incosistent validation (you should use: dataset method OR proc OR predefined validator)'
+      )
+    end
+  end
+
+  # @return [void]
+  #
+  # @raise [Qonfig::ValidatorArgumentError]
+  #
+  # @api private
+  # @since 0.13.0
+  def consistent_predefined_validator!
+    return if predefined_validator.nil?
+    return if predefined_validator.is_a?(Symbol)
+    return if predefined_validator.is_a?(String)
+
+    raise(
+      Qonfig::ValidatorArgumentError,
+      'Incorrect name of predefined validator (should be a symbol or a string)'
+    )
+  end
+
+  # @return [void]
+  #
+  # @raise [Qonfig::ValidatorArgumentError]
+  #
+  # @api private
+  # @since 0.13.0
+  def cosnistent_runtime_validation_method!
+    return if runtime_validation_method.nil?
+    return if runtime_validation_method.is_a?(Symbol)
+    return if runtime_validation_method.is_a?(String)
+
+    raise(
+      Qonfig::ValidatorArgumentError,
+      'Incompatible validation method name (should be a symbol or a string)'
+    )
+  end
+
+  # @return [void]
+  #
+  # @raise [Qonfig::ValidatorArgumentError]
+  #
+  # @api private
+  # @since 0.13.0
+  def consistent_validation_logic!
+    return if validation_logic.nil?
+    return if validation_logic.is_a?(Proc)
+
+    # :nocov:
+    raise(
+      Qonfig::ValidatorArgumentError,
+      'Incompatible validation object (should be a proc)'
+    )
+    # :nocov:
+  end
+
+  # @return [void]
+  #
+  # @raise [Qonfig::ValidatorArgumentError]
+  #
+  # @api private
+  # @since 0.13.0
+  def consistent_setting_key_pattern!
+    return if setting_key_pattern.nil?
+    return if setting_key_pattern.is_a?(Symbol)
+    return if setting_key_pattern.is_a?(String)
+
+    raise(
+      Qonfig::ValidatorArgumentError,
+      'Incompatible setting key pattern (should be a string or a symbol)'
+    )
+  end
+end

data/lib/qonfig/validator/builder.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.13.0
+class Qonfig::Validator::Builder
+  require_relative 'builder/attribute_consistency'
+
+  # @return [NilClass]
+  #
+  # @api private
+  # @since 0.13.0
+  EMPTY_SETTING_KEY_PATTERN = nil
+
+  # @return [NilClass]
+  #
+  # @api private
+  # @since 0.13.0
+  NO_RUNTIME_VALIDATION_METHOD = nil
+
+  # @return [NilClass]
+  #
+  # @api private
+  # @since 0.13.0
+  NO_VALIDATION_LOGIC = nil
+
+  # @return [NilClass]
+  #
+  # @api private
+  # @since 0.13.0
+  NO_PREDEFINED_VALIDATOR = nil
+
+  class << self
+    # @option setting_key_pattern [String, Symbol, NilClass]
+    # @option predefined_validator [String, Symbol, NilClass]
+    # @option runtime_validation_method [String, Symbol, NilClass]
+    # @option validation_logic [Proc, NilClass]
+    # @return [Qonfig::Validator::MethodBased, Qonfig::Validator::ProcBased]
+    #
+    # @api private
+    # @since 0.13.0
+    def build(
+      setting_key_pattern: EMPTY_SETTING_KEY_PATTERN,
+      runtime_validation_method: NO_RUNTIME_VALIDATION_METHOD,
+      validation_logic: NO_VALIDATION_LOGIC,
+      predefined_validator: NO_PREDEFINED_VALIDATOR
+    )
+      new(
+        setting_key_pattern,
+        predefined_validator,
+        runtime_validation_method,
+        validation_logic
+      ).build
+    end
+  end
+
+  # @param setting_key_pattern [String, Symbol, NilClass]
+  # @param predefined_validator [String, Symbol, NilClass]
+  # @param runtime_validation_method [String, Symbol, NilClass]
+  # @param validation_logic [Proc, NilClass]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.13.0
+  def initialize(
+    setting_key_pattern,
+    predefined_validator,
+    runtime_validation_method,
+    validation_logic
+  )
+    @setting_key_pattern = setting_key_pattern
+    @predefined_validator = predefined_validator
+    @runtime_validation_method = runtime_validation_method
+    @validation_logic = validation_logic
+  end
+
+  # @return [Qonfig::Validator::MethodBased, Qonfig::Validator::ProcBased]
+  #
+  # @api private
+  # @since 0.13.0
+  def build
+    validate_attributes!
+    build_validator
+  end
+
+  private
+
+  # @return [String, Symbol, NilClass]
+  #
+  # @api private
+  # @since 0.13.0
+  attr_reader :setting_key_pattern
+
+  # @return [String, Symbol, NilClass]
+  #
+  # @api private
+  # @since 0.13.0
+  attr_reader :predefined_validator
+
+  # @return [String, Symbol, NilClass]
+  #
+  # @api private
+  # @since 0.13.0
+  attr_reader :runtime_validation_method
+
+  # @return [Proc, NilClass]
+  #
+  # @api private
+  # @since 0.13.0
+  attr_reader :validation_logic
+
+  # @return [void]
+  #
+  # @raise [Qonfig::ArgumentError]
+  #
+  # @api private
+  # @since 0.13.0
+  def validate_attributes!
+    AttributeConsistency.check!(
+      setting_key_pattern,
+      predefined_validator,
+      runtime_validation_method,
+      validation_logic
+    )
+  end
+
+  # @return [Qonfig::Validator::MethodBased, Qonfig::Validator::PorcBased]
+  #
+  # @api private
+  # @since 0.13.0
+  def build_validator
+    case
+    when predefined_validator      then build_predefined
+    when runtime_validation_method then build_method_based
+    when validation_logic          then build_proc_based
+    end
+  end
+
+  # @return [Qonfig::Settings::KeyMatcher, NilClass]
+  #
+  # @api private
+  # @since 0.13.0
+  def build_setting_key_matcher
+    Qonfig::Settings::KeyMatcher.new(setting_key_pattern.to_s) if setting_key_pattern
+  end
+
+  # @return [Qonfig::Validator::MethodBased]
+  #
+  # @api private
+  # @since 0.13.0
+  def build_method_based
+    Qonfig::Validator::MethodBased.new(build_setting_key_matcher, runtime_validation_method)
+  end
+
+  # @return [Qonfig::Validator::ProcBased]
+  #
+  # @api private
+  # @since 0.13.0
+  def build_proc_based
+    Qonfig::Validator::ProcBased.new(build_setting_key_matcher, validation_logic)
+  end
+
+  # @return [Qonfig::Settings::Predefined]
+  #
+  # @api private
+  # @since 0.13.0
+  def build_predefined
+    Qonfig::Validator::Predefined.build(predefined_validator, build_setting_key_matcher)
+  end
+end

data/lib/qonfig/validator/collection.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.13.0
+class Qonfig::Validator::Collection
+  # @api private
+  # @since 0.13.0
+  include Enumerable
+
+  # @return [Array<Qonfig::Validator::MethodBased,Qonfig::Validator::ProcBased>]
+  #
+  # @api private
+  # @since 0.13.0
+  attr_reader :validators
+
+  # @return [void]
+  #
+  # @api private
+  # @since 0.13.0
+  def initialize
+    @validators = []
+    @access_lock = Mutex.new
+  end
+
+  # @param validator [Qonfig::Validator::MethodBased, Qonfig::Validator::ProcBased]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.13.0
+  def add_validator(validator)
+    thread_safe { validators << validator }
+  end
+  alias_method :<<, :add_validator
+
+  # @param block [Proc]
+  # @return [Enumerable]
+  #
+  # @api private
+  # @since 0.13.0
+  def each(&block)
+    thread_safe { block_given? ? validators.each(&block) : validators.each }
+  end
+
+  # @param collection [Qonfig::Validator::Collection]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.13.0
+  def concat(collection)
+    thread_safe { validators.concat(collection.validators) }
+  end
+
+  # @return [Qonfig::Validator::Collection]
+  #
+  # @api private
+  # @since 0.13.0
+  def dup
+    thread_safe do
+      self.class.new.tap { |duplicate| duplicate.concat(self) }
+    end
+  end
+
+  private
+
+  # @param block [Proc]
+  # @return [Any]
+  #
+  # @api private
+  # @since 0.13.0
+  def thread_safe(&block)
+    @access_lock.synchronize(&block)
+  end
+end

data/lib/qonfig/validator/dsl.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.13.0
+module Qonfig::Validator::DSL
+  class << self
+    # @param child_klass [Qonfig::DataSet]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.13.0
+    def extended(child_klass)
+      child_klass.instance_variable_set(:@validators, Qonfig::Validator::Collection.new)
+
+      child_klass.singleton_class.prepend(Module.new do
+        def inherited(child_klass)
+          child_klass.instance_variable_set(:@validators, Qonfig::Validator::Collection.new)
+          child_klass.validators.concat(validators)
+          super
+        end
+      end)
+    end
+  end
+
+  # @return [Qonfig::Validator::Collection]
+  #
+  # @api private
+  # @since 0.13.0
+  def validators
+    @validators
+  end
+
+  # @param setting_key_pattern [String, Symbol, NilClass]
+  # @param predefined [String, Symbol]
+  # @option by [String, Symbol, NilClass]
+  # @param custom_validation [Proc]
+  # @return [void]
+  #
+  # @see Qonfig::Validator::Builder
+  #
+  # @api private
+  # @since 0.13.0
+  def validate(setting_key_pattern = nil, predefined = nil, by: nil, &custom_validation)
+    validators << Qonfig::Validator::Builder.build(
+      setting_key_pattern: setting_key_pattern,
+      predefined_validator: predefined,
+      runtime_validation_method: by,
+      validation_logic: custom_validation
+    )
+  end
+end

data/lib/qonfig/validator/method_based.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.13.0
+class Qonfig::Validator::MethodBased < Qonfig::Validator::Basic
+  # @return [Symbol, String]
+  #
+  # @api private
+  # @since 0.13.0
+  attr_reader :runtime_validation_method
+
+  # @param setting_key_matcher [Qonfig::Settings::KeyMatcher, NilClass]
+  # @param runtime_validation_method [String, Symbol]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.13.0
+  def initialize(setting_key_matcher, runtime_validation_method)
+    super(setting_key_matcher)
+    @runtime_validation_method = runtime_validation_method
+  end
+
+  # @param data_set [Qonfig::DataSet]
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.13.0
+  def validate_concrete(data_set)
+    data_set.settings.__deep_each_setting__ do |setting_key, setting_value|
+      next unless setting_key_matcher.match?(setting_key)
+
+      raise(
+        Qonfig::ValidationError,
+        "Invalid value of setting <#{setting_key}> (#{setting_value})"
+      ) unless data_set.__send__(runtime_validation_method, setting_value)
+    end
+  end
+
+  # @param data_set [Qonfig::DataSet]
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.13.0
+  def validate_full(data_set)
+    unless data_set.__send__(runtime_validation_method)
+      raise(Qonfig::ValidationError, 'Invalid config object')
+    end
+  end
+end

data/lib/qonfig/validator/predefined/common.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.13.0
+class Qonfig::Validator::Predefined::Common < Qonfig::Validator::Basic
+  # @return [Proc]
+  #
+  # @api private
+  # @since 0.13.0
+  attr_reader :validation
+
+  # @param setting_key_matcher [Qonfig::Settings::KeyMatcher]
+  # @param validation [Proc]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.13.0
+  def initialize(setting_key_matcher, validation)
+    super(setting_key_matcher)
+    @validation = validation
+  end
+
+  # @param data_set [Qonfig::DataSet]
+  # @return [void]
+  #
+  # @raise [Qonfig::ValidationError]
+  #
+  # @api private
+  # @since 0.13.0
+  def validate_concrete(data_set)
+    data_set.settings.__deep_each_setting__ do |setting_key, setting_value|
+      next unless setting_key_matcher.match?(setting_key)
+
+      raise(
+        Qonfig::ValidationError,
+        "Invalid value of setting <#{setting_key}> (#{setting_value})"
+      ) unless validation.call(setting_value)
+    end
+  end
+
+  # @param data_set [Qonfig::DataSet]
+  # @return [void]
+  #
+  # @raise [Qonfig::ValidationError]
+  #
+  # @api private
+  # @since 0.13.0
+  def validate_full(data_set)
+    # :nocov:
+    raise Qonfig::Error, 'Predefined validator should be used only with a setting key'
+    # :nocov:
+  end
+end

data/lib/qonfig/validator/predefined/registry.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.13.0
+class Qonfig::Validator::Predefined::Registry
+  # @return [void]
+  #
+  # @api private
+  # @since 0.13.0
+  def initialize
+    @validators = {}
+    @lock = Mutex.new
+  end
+
+  # @param name [String, Symbol]
+  # @param validation [Proc]
+  # @return [void]
+  #
+  # @raise [Qonfig::ValidatorArgumentError]
+  #
+  # @api private
+  # @since 0.13.0
+  def register(name, &validation)
+    thread_safe do
+      name = indifferently_accessable_name(name)
+
+      raise(
+        Qonfig::ValidatorArgumentError,
+        "Predefined validator with name '#{name}' already exists."
+      ) if validators.key?(name)
+
+      validators[name] = validation
+    end
+  end
+
+  # @param name [String, Symbol]
+  # @return [Qonfig::Validator::ProcBased, Qonfig::Validator::MethodBased]
+  #
+  # @raise [Qonfig::ValidatorArgumentError]
+  #
+  # @api private
+  # @since 0.13.0
+  def resolve(name)
+    thread_safe do
+      # rubocop:disable Style/RedundantBegin
+      begin
+        validators.fetch(indifferently_accessable_name(name))
+      rescue KeyError
+        raise(
+          Qonfig::ValidatorArgumentError,
+          "Predefined validator with name '#{name}' does not exist."
+        )
+      end
+      # rubocop:enable Style/RedundantBegin
+    end
+  end
+
+  private
+
+  # @return [Hash<String,Proc>]
+  #
+  # @api private
+  # @since 0.13.0
+  attr_reader :validators
+
+  # @param name [String, Symbol]
+  # @return [String]
+  #
+  # @api private
+  # @since 0.13.0
+  def indifferently_accessable_name(name)
+    name.to_s
+  end
+
+  # @param block [Proc]
+  # @return [Any]
+  #
+  # @api private
+  # @since 0.13.0
+  def thread_safe(&block)
+    @lock.synchronize(&block)
+  end
+end

data/lib/qonfig/validator/predefined/registry_control_mixin.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.13.0
+module Qonfig::Validator::Predefined::RegistryControlMixin
+  class << self
+    # @param basic_klass [Class, Module]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.13.0
+    def extended(basic_klass)
+      basic_klass.instance_variable_set(:@registry, Qonfig::Validator::Predefined::Registry.new)
+    end
+  end
+
+  # @return [Qonfig::Validator::Predefined::Registry]
+  #
+  # @api private
+  # @since 0.13.0
+  attr_reader :registry
+
+  # @param name [String, Symbol]
+  # @param validation [Proc]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.13.0
+  def predefine(name, &validation)
+    registry.register(name, &validation)
+  end
+
+  # @param name [String, Symbol]
+  # @param setting_key_matcher [Qonfig::Setting::KeyMatcher]
+  # @return [Qonfig::Validator::Predefined::Common]
+  #
+  # @api private
+  # @since 0.13.0
+  def build(name, setting_key_matcher)
+    validation = registry.resolve(name)
+    Qonfig::Validator::Predefined::Common.new(setting_key_matcher, validation)
+  end
+end