qonfig 0.19.1 → 0.20.0

data/lib/qonfig/validation/building/predefined_builder.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.20.0
+class Qonfig::Validation::Building::PredefinedBuilder
+  class << self
+    # @param name [String, Symbol]
+    # @param validation_logic [Proc]
+    # @param predefined_registry [Qonfig::Validation::Collections::PredefinedRegistry]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.20.0
+    def build(name, validation_logic, predefined_registry)
+      new(name, validation_logic, predefined_registry).build
+    end
+  end
+
+  # @param name [String, Symbol]
+  # @param validation_logic [Proc]
+  # @param predefined_registry [Qonfig::Validation::Collections::PredefinedRegistry]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.20.0
+  def initialize(name, validation_logic, predefined_registry)
+    @name = name
+    @validation_logic = validation_logic
+    @predefined_registry = predefined_registry
+  end
+
+  # @return [void]
+  #
+  # @api private
+  # @since 0.20.0
+  def build
+    validate_attributes!
+    predefine_validator
+  end
+
+  private
+
+  # @return [void]
+  #
+  # @raise [Qonfig::ValidatorArgumentError]
+  #
+  # @api private
+  # @since 0.20.0
+  def validate_attributes!
+    raise(
+      Qonfig::ValidatorArgumentError,
+      'Validator name should be a type of string or symbol'
+    ) unless name.is_a?(String) || name.is_a?(Symbol)
+
+    raise(
+      Qonfig::ValidatorArgumentError,
+      'Empty validation logic (block is not given)'
+    ) if validation_logic.nil? || !validation_logic.is_a?(Proc)
+  end
+
+  # @return [void]
+  #
+  # @api private
+  # @since 0.20.0
+  def predefine_validator
+    predefined_registry[name] = validation_logic
+  end
+
+  # @return [String]
+  #
+  # @api private
+  # @since 0.20.0
+  attr_reader :name
+
+  # @return [Proc]
+  #
+  # @api private
+  # @since 0.20.0
+  attr_reader :validation_logic
+
+  # @return [Qonfig::Validation::Collections::PredefinedRegistry]
+  #
+  # @api private
+  # @since 0.20.0
+  attr_reader :predefined_registry
+end

data/lib/qonfig/validation/building.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.20.0
+module Qonfig::Validation::Building
+  require_relative 'building/predefined_builder'
+  require_relative 'building/instance_builder'
+end

data/lib/qonfig/{validator/collection.rb → validation/collections/instance_collection.rb}

@@ -1,32 +1,32 @@
 # frozen_string_literal: true
 
 # @api private
-# @since 0.13.0
-class Qonfig::Validator::Collection
+# @since 0.20.0
+class Qonfig::Validation::Collections::InstanceCollection
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   include Enumerable
 
-  # @return [Array<Qonfig::Validator::MethodBased,Qonfig::Validator::ProcBased>]
+  # @return [Array<Qonfig::Validation::Validators::Base>]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   attr_reader :validators
 
   # @return [void]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   def initialize
     @validators = []
     @access_lock = Mutex.new
   end
 
-  # @param validator [Qonfig::Validator::MethodBased, Qonfig::Validator::ProcBased]
+  # @param validator [Qonfig::Validation::Validators::Base]
   # @return [void]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   def add_validator(validator)
     thread_safe { validators << validator }
   end
@@ -36,27 +36,29 @@ class Qonfig::Validator::Collection
   # @return [Enumerable]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   def each(&block)
     thread_safe { block_given? ? validators.each(&block) : validators.each }
   end
 
-  # @param collection [Qonfig::Validator::Collection]
+  # @param collection [Qonfig::Validation::Collections::InstanceCollection]
   # @return [void]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   def concat(collection)
     thread_safe { validators.concat(collection.validators) }
   end
 
-  # @return [Qonfig::Validator::Collection]
+  # @return [Qonfig::Validation::Collections::InstanceCollection]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   def dup
     thread_safe do
-      self.class.new.tap { |duplicate| duplicate.concat(self) }
+      Qonfig::Validation::Collections::InstanceCollection.new.tap do |duplicate|
+        duplicate.concat(self)
+      end
     end
   end
 

data/lib/qonfig/validation/collections/predefined_registry.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.20.0
+class Qonfig::Validation::Collections::PredefinedRegistry
+  # @since 0.20.0
+  include Enumerable
+
+  # @return [void]
+  #
+  # @api private
+  # @since 0.20.0
+  def initialize
+    @validators = {}
+    @lock = Mutex.new
+  end
+
+  # @param predefined_registry [Qonfig::Validation::Collections::PredefinedRegistry]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.20.0
+  def merge(predefined_registry)
+    thread_safe { concat(predefined_registry) }
+  end
+
+  # @param name [String, Symbol]
+  # @param validation [Proc]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.20.0
+  def register(name, validation)
+    thread_safe { apply(name, validation) }
+  end
+  alias_method :[]=, :register
+
+  # @param name [String, Symbol]
+  # @return [Proc]
+  #
+  # @api private
+  # @since 0.20.0
+  def resolve(name)
+    thread_safe { fetch(name) }
+  end
+  alias_method :[], :resolve
+
+  # @return [Qonfig::Validation::Collection::PredefinedRegistry]
+  #
+  # @api private
+  # @since 0.20.0
+  def dup
+    thread_safe { duplicate }
+  end
+
+  # @param block [Block]
+  # @yield [validator_name, validation_logic]
+  # @yieldparam validator_name [String]
+  # @yieldparam validation_logic [Proc]
+  # @return [Enumerable]
+  #
+  # @api private
+  # @since 0.20.0
+  def each(&block)
+    thread_safe do
+      block_given? ? validators.each_pair(&block) : validators.each_pair
+    end
+  end
+
+  private
+
+  # @return [Hash<String,Proc>]
+  #
+  # @api private
+  # @since 0.20.0
+  attr_reader :validators
+
+  # @param name [String, Symbol]
+  # @return [String]
+  #
+  # @api private
+  # @since 0.20.0
+  def indifferently_accessable_name(name)
+    name.to_s
+  end
+
+  # @param name [String, Symbol]
+  # @param validation [Proc]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.20.0
+  def apply(name, validation)
+    name = indifferently_accessable_name(name)
+    validators[name] = validation
+  end
+
+  # @param name [String, Symbol]
+  # @return [Proc]
+  #
+  # @raise [Qonfig::ValidatorNotFoundError]
+  #
+  # @api private
+  # @since 0.20.0
+  def fetch(name)
+    validators.fetch(indifferently_accessable_name(name))
+  rescue KeyError
+    raise(
+      Qonfig::ValidatorNotFoundError,
+      "Validator with name '#{name}' does not exist."
+    )
+  end
+
+  # @param predefined_registry [Qonfig::Validation::Collections::PredefinedRegistry]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.20.0
+  def concat(predefined_registry)
+    predefined_registry.dup.each do |validator_name, validation_logic|
+      validators[validator_name] = validation_logic
+    end
+  end
+
+  # @return [Qonfig::Validation::Collections::PredefinedRegistry]
+  #
+  # @api private
+  # @since 0.20.0
+  def duplicate
+    Qonfig::Validation::Collections::PredefinedRegistry.new.tap do |registry|
+      validators.each_pair do |validator_name, validation_logic|
+        registry.register(validator_name, validation_logic)
+      end
+    end
+  end
+
+  # @param block [Proc]
+  # @return [Any]
+  #
+  # @api private
+  # @since 0.20.0
+  def thread_safe(&block)
+    @lock.synchronize(&block)
+  end
+end

data/lib/qonfig/validation/collections.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.20.0
+module Qonfig::Validation::Collections
+  require_relative 'collections/predefined_registry'
+  require_relative 'collections/instance_collection'
+end

data/lib/qonfig/validation/predefinition_mixin.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.20.0
+module Qonfig::Validation::PredefinitionMixin
+  # @param name [String, Symbol]
+  # @param validation_logic [Block]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.20.0
+  def define_validator(name, &validation_logic)
+    Qonfig::DataSet.define_validator(name, &validation_logic)
+  end
+end

data/lib/qonfig/{validator → validation/validators}/basic.rb

@@ -1,18 +1,18 @@
 # frozen_string_literal: true
 
 # @api private
-# @since 0.13.0
-class Qonfig::Validator::Basic
+# @since 0.20.0
+class Qonfig::Validation::Validators::Basic
   # @return [String, Symbol, NilClass]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   attr_reader :setting_key_matcher
 
   # @return [Boolean]
   #
   # @api private
-  # @since 0.17.0
+  # @since 0.20.0
   attr_reader :strict
 
   # @param setting_key_matcher [Qonfig::Settings::KeyMatcher, NilClass]
@@ -20,7 +20,7 @@ class Qonfig::Validator::Basic
   # @return [void]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   def initialize(setting_key_matcher, strict)
     @setting_key_matcher = setting_key_matcher
     @strict = strict
@@ -30,7 +30,7 @@ class Qonfig::Validator::Basic
   # @return [Boolean]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   def validate(data_set)
     setting_key_provided? ? validate_concrete(data_set) : validate_full(data_set)
   end
@@ -40,7 +40,7 @@ class Qonfig::Validator::Basic
   # @return [Boolean]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   def setting_key_provided?
     !setting_key_matcher.nil?
   end
@@ -49,13 +49,13 @@ class Qonfig::Validator::Basic
   # @return [Any]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   def validate_full(data_set); end
 
   # @param data_set [Qonfig::DataSet]
   # @return [Any]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   def validate_concrete(data_set); end
 end

data/lib/qonfig/{validator.rb → validation/validators/composite.rb}

@@ -1,21 +1,13 @@
 # frozen_string_literal: true
 
 # @api private
-# @since 0.13.0
-class Qonfig::Validator
-  require_relative 'validator/basic'
-  require_relative 'validator/method_based'
-  require_relative 'validator/proc_based'
-  require_relative 'validator/builder'
-  require_relative 'validator/collection'
-  require_relative 'validator/predefined'
-  require_relative 'validator/dsl'
-
+# @since 0.20.0
+class Qonfig::Validation::Validators::Composite
   # @param data_set [Qonfig::DataSet]
   # @return [void]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   def initialize(data_set)
     @data_set = data_set
     @validators = data_set.class.validators.dup
@@ -24,7 +16,7 @@ class Qonfig::Validator
   # @return [void]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   def validate!
     validators.each do |validator|
       validator.validate(data_set)
@@ -34,7 +26,7 @@ class Qonfig::Validator
   # @return [Boolean]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   def valid?
     validate!
     true
@@ -47,12 +39,12 @@ class Qonfig::Validator
   # @return [Qonfig::DataSet]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   attr_reader :data_set
 
-  # @return [Qonfig::Validator::Collection]
+  # @return [Qonfig::Validation::Collections::InstanceCollection]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   attr_reader :validators
 end

data/lib/qonfig/{validator → validation/validators}/method_based.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 # @api private
-# @since 0.13.0
-class Qonfig::Validator::MethodBased < Qonfig::Validator::Basic
+# @since 0.20.0
+class Qonfig::Validation::Validators::MethodBased < Qonfig::Validation::Validators::Basic
   # @return [Symbol, String]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   attr_reader :runtime_validation_method
 
   # @param setting_key_matcher [Qonfig::Settings::KeyMatcher, NilClass]
@@ -15,7 +15,7 @@ class Qonfig::Validator::MethodBased < Qonfig::Validator::Basic
   # @return [void]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   def initialize(setting_key_matcher, strict, runtime_validation_method)
     super(setting_key_matcher, strict)
     @runtime_validation_method = runtime_validation_method
@@ -25,7 +25,7 @@ class Qonfig::Validator::MethodBased < Qonfig::Validator::Basic
   # @return [Boolean]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.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)
@@ -42,7 +42,7 @@ class Qonfig::Validator::MethodBased < Qonfig::Validator::Basic
   # @return [Boolean]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   def validate_full(data_set)
     unless data_set.__send__(runtime_validation_method)
       raise(Qonfig::ValidationError, 'Invalid config object')

data/lib/qonfig/{validator/predefined/common.rb → validation/validators/predefined.rb}

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 # @api private
-# @since 0.13.0
-class Qonfig::Validator::Predefined::Common < Qonfig::Validator::Basic
+# @since 0.20.0
+class Qonfig::Validation::Validators::Predefined < Qonfig::Validation::Validators::Basic
   # @return [Proc]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   attr_reader :validation
 
   # @param setting_key_matcher [Qonfig::Settings::KeyMatcher]
@@ -15,7 +15,7 @@ class Qonfig::Validator::Predefined::Common < Qonfig::Validator::Basic
   # @return [void]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   def initialize(setting_key_matcher, strict, validation)
     super(setting_key_matcher, strict)
     @validation = validation
@@ -27,7 +27,7 @@ class Qonfig::Validator::Predefined::Common < Qonfig::Validator::Basic
   # @raise [Qonfig::ValidationError]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.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)
@@ -46,10 +46,10 @@ class Qonfig::Validator::Predefined::Common < Qonfig::Validator::Basic
   # @raise [Qonfig::ValidationError]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   def validate_full(data_set)
     # :nocov:
-    raise Qonfig::Error, 'Predefined validator should be used only with a setting key'
+    raise Qonfig::Error, 'Predefined validator can be used with a setting key only'
     # :nocov:
   end
 end

data/lib/qonfig/{validator → validation/validators}/proc_based.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 # @api private
-# @since 0.13.0
-class Qonfig::Validator::ProcBased < Qonfig::Validator::Basic
+# @since 0.20.0
+class Qonfig::Validation::Validators::ProcBased < Qonfig::Validation::Validators::Basic
   # @return [Proc]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   attr_reader :validation
 
   # @param setting_key_matcher [Qonfig::Settings::KeyMatcher, NilClass]
@@ -15,7 +15,7 @@ class Qonfig::Validator::ProcBased < Qonfig::Validator::Basic
   # @return [void]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   def initialize(setting_key_matcher, strict, validation)
     super(setting_key_matcher, strict)
     @validation = validation
@@ -27,7 +27,7 @@ class Qonfig::Validator::ProcBased < Qonfig::Validator::Basic
   # @raise [Qonfig::ValidationError]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.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)
@@ -46,7 +46,7 @@ class Qonfig::Validator::ProcBased < Qonfig::Validator::Basic
   # @raise [Qonfig::ValidationError]
   #
   # @api private
-  # @since 0.13.0
+  # @since 0.20.0
   def validate_full(data_set)
     unless data_set.instance_eval(&validation)
       raise(Qonfig::ValidationError, 'Invalid config object')

data/lib/qonfig/validation/validators.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.20.0
+module Qonfig::Validation::Validators
+  require_relative 'validators/basic'
+  require_relative 'validators/method_based'
+  require_relative 'validators/proc_based'
+  require_relative 'validators/predefined'
+  require_relative 'validators/composite'
+end

data/lib/qonfig/validation.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.19.0
+module Qonfig::Validation
+  require_relative 'validation/validators'
+  require_relative 'validation/collections'
+  require_relative 'validation/building'
+  require_relative 'validation/predefinition_mixin'
+end

data/lib/qonfig/version.rb

@@ -5,5 +5,5 @@ module Qonfig
   #
   # @api public
   # @since 0.1.0
-  VERSION = '0.19.1'
+  VERSION = '0.20.0'
 end

data/lib/qonfig.rb

@@ -10,7 +10,7 @@ module Qonfig
   require_relative 'qonfig/uploaders'
   require_relative 'qonfig/commands'
   require_relative 'qonfig/command_set'
-  require_relative 'qonfig/validator'
+  require_relative 'qonfig/validation'
   require_relative 'qonfig/settings'
   require_relative 'qonfig/dsl'
   require_relative 'qonfig/data_set'
@@ -22,6 +22,39 @@ module Qonfig
   # @since 0.4.0
   extend Plugins::AccessMixin
 
+  # @api public
+  # @since 0.20.0
+  extend Validation::PredefinitionMixin
+
+  # @since 0.20.0
+  define_validator(:integer) { |value| value.is_a?(Integer) }
+  # @since 0.20.0
+  define_validator(:float) { |value| value.is_a?(Float) }
+  # @since 0.20.0
+  define_validator(:numeric) { |value| value.is_a?(Numeric) }
+  # @since 0.20.0
+  define_validator(:string) { |value| value.is_a?(String) }
+  # @since 0.20.0
+  define_validator(:symbol) { |value| value.is_a?(Symbol) }
+  # @since 0.20.0
+  define_validator(:text) { |value| value.is_a?(Symbol) || value.is_a?(String) }
+  # @since 0.20.0
+  define_validator(:array) { |value| value.is_a?(Array) }
+  # @since 0.20.0
+  define_validator(:hash) { |value| value.is_a?(Hash) }
+  # @since 0.20.0
+  define_validator(:big_decimal) { |value| value.is_a?(BigDecimal) }
+  # @since 0.20.0
+  define_validator(:boolean) { |value| value.is_a?(TrueClass) || value.is_a?(FalseClass) }
+  # @since 0.20.0
+  define_validator(:proc) { |value| value.is_a?(Proc) }
+  # @since 0.20.0
+  define_validator(:class) { |value| value.is_a?(Class) }
+  # @since 0.20.0
+  define_validator(:module) { |value| value.is_a?(Module) }
+  # @since 0.20.0
+  define_validator(:not_nil) { |value| !value.nil? }
+
   # @since 0.12.0
   register_plugin('toml', Qonfig::Plugins::TOML)
   # @since 0.19.0

data/qonfig.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'coveralls',        '~> 0.8'
   spec.add_development_dependency 'simplecov',        '~> 0.16'
   spec.add_development_dependency 'rspec',            '~> 3.8'
-  spec.add_development_dependency 'armitage-rubocop', '~> 0.76', '>= 0.76.0.3'
+  spec.add_development_dependency 'armitage-rubocop', '~> 0.77'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'