qonfig 0.12.0 → 0.13.0

data/lib/qonfig/commands/add_nested_option.rb

@@ -32,14 +32,16 @@ class Qonfig::Commands::AddNestedOption < Qonfig::Commands::Base
     end
   end
 
+  # @param data_set [Qonfig::DataSet]
   # @param settings [Qonfig::Settings]
   # @return [void]
   #
   # @api private
   # @since 0.1.0
-  def call(settings)
+  def call(data_set, settings)
     nested_settings = nested_data_set_klass.new.settings
 
+    nested_settings.__mutation_callbacks__.add(settings.__mutation_callbacks__)
     settings.__define_setting__(key, nested_settings)
   end
 end

data/lib/qonfig/commands/add_option.rb

@@ -30,12 +30,13 @@ class Qonfig::Commands::AddOption < Qonfig::Commands::Base
     @value = value
   end
 
+  # @param data_set [Qonfig::DataSet]
   # @param settings [Qonfig::Settings]
   # @return [void]
   #
   # @api private
   # @since 0.1.0
-  def call(settings)
+  def call(data_set, settings)
     settings.__define_setting__(key, value)
   end
 end

data/lib/qonfig/commands/base.rb

@@ -3,10 +3,11 @@
 # @api private
 # @since 0.1.0
 class Qonfig::Commands::Base
+  # @param data_set [Qonfig::DataSet]
   # @param settings [Qonfig::Settings]
   # @return [void]
   #
   # @api private
   # @since 0.1.0
-  def call(settings); end
+  def call(data_set, settings); end
 end

data/lib/qonfig/commands/compose.rb

@@ -7,31 +7,37 @@ class Qonfig::Commands::Compose < Qonfig::Commands::Base
   #
   # @api private
   # @since 0.1.0
-  attr_reader :data_set_klass
+  attr_reader :composable_data_set_klass
 
-  # @param data_set_klass [Qonfig::DataSet]
+  # @param composable_data_set_klass [Qonfig::DataSet]
   #
   # @raise [Qonfig::ArgumentError]
   #
   # @api private
   # @since 0.1.0
-  def initialize(data_set_klass)
-    raise(
-      Qonfig::ArgumentError,
-      'Composed config class should be a subtype of Qonfig::DataSet'
-    ) unless data_set_klass.is_a?(Class) && data_set_klass < Qonfig::DataSet
+  def initialize(composable_data_set_klass)
+    unless composable_data_set_klass.is_a?(Class) && composable_data_set_klass < Qonfig::DataSet
+      raise(
+        Qonfig::ArgumentError,
+        'Composed config class should be a subtype of Qonfig::DataSet'
+      )
+    end
 
-    @data_set_klass = data_set_klass
+    @composable_data_set_klass = composable_data_set_klass
   end
 
+  # @param data_set [Qonfig::DataSet]
   # @param settings [Qonfig::Settings]
   # @return [void]
   #
   # @api private
   # @since 0.1.0
-  def call(settings)
-    composite_settings = data_set_klass.new.settings
+  def call(data_set, settings)
+    # NOTE: append new validators
+    data_set.class.validators.concat(composable_data_set_klass.validators.dup)
 
+    # NOTE: append new settings
+    composite_settings = composable_data_set_klass.new.settings
     settings.__append_settings__(composite_settings)
   end
 end

data/lib/qonfig/commands/expose_yaml.rb

@@ -60,12 +60,13 @@ class Qonfig::Commands::ExposeYAML < Qonfig::Commands::Base
     @env       = env
   end
 
+  # @param data_set [Qonfig::DataSet]
   # @param settings [Qonfig::Settings]
   # @return [void]
   #
   # @api private
   # @since 0.7.0
-  def call(settings)
+  def call(data_set, settings)
     case via
     when EXPOSERS[:file_name]
       expose_file_name!(settings)

data/lib/qonfig/commands/load_from_env.rb

@@ -55,12 +55,13 @@ class Qonfig::Commands::LoadFromENV < Qonfig::Commands::Base
     @trim_pattern   = prefix.is_a?(Regexp) ? prefix : /\A(#{Regexp.escape(prefix.to_s)})/m
   end
 
+  # @param data_set [Qonfig::DataSet]
   # @param settings [Qonfig::Settings]
   # @return [void]
   #
   # @api private
   # @since 0.2.0
-  def call(settings)
+  def call(data_set, settings)
     env_data = extract_env_data
 
     env_based_settings = build_data_set_class(env_data).new.settings

data/lib/qonfig/commands/load_from_json.rb

@@ -25,12 +25,13 @@ class Qonfig::Commands::LoadFromJSON < Qonfig::Commands::Base
     @strict = strict
   end
 
+  # @param data_set [Qonfig::DataSet]
   # @param settings [Qonfig::Settings]
   # @return [void]
   #
   # @api private
   # @since 0.5.0
-  def call(settings)
+  def call(data_set, settings)
     json_data = Qonfig::Loaders::JSON.load_file(file_path, fail_on_unexist: strict)
 
     raise(

data/lib/qonfig/commands/load_from_self.rb

@@ -17,12 +17,13 @@ class Qonfig::Commands::LoadFromSelf < Qonfig::Commands::Base
     @caller_location = caller_location
   end
 
+  # @param data_set [Qonfig::DataSet]
   # @param settings [Qonfig::Settings]
   # @return [void]
   #
   # @api private
   # @since 0.2.0
-  def call(settings)
+  def call(data_set, settings)
     yaml_data = load_self_placed_yaml_data
 
     yaml_based_settings = build_data_set_klass(yaml_data).new.settings

data/lib/qonfig/commands/load_from_yaml.rb

@@ -25,6 +25,7 @@ class Qonfig::Commands::LoadFromYAML < Qonfig::Commands::Base
     @strict = strict
   end
 
+  # @param data_set [Qonfig::DataSet]
   # @param settings [Qonfig::Settings]
   # @return [void]
   #
@@ -32,7 +33,7 @@ class Qonfig::Commands::LoadFromYAML < Qonfig::Commands::Base
   #
   # @api private
   # @since 0.2.0
-  def call(settings)
+  def call(data_set, settings)
     yaml_data = Qonfig::Loaders::YAML.load_file(file_path, fail_on_unexist: strict)
 
     raise(

data/lib/qonfig/data_set/lock.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.13.0
+class Qonfig::DataSet::Lock
+  # @return [void]
+  #
+  # @api private
+  # @since 0.13.0
+  def initialize
+    @access_lock = Mutex.new
+    @definition_lock = Mutex.new
+  end
+
+  # @param instructions [Proc]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.13.0
+  def thread_safe_access(&instructions)
+    access_lock.owned? ? yield : access_lock.synchronize(&instructions)
+  end
+
+  # @param instructions [Proc]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.13.0
+  def thread_safe_definition(&instructions)
+    definition_lock.owned? ? yield : definition_lock.synchronize(&instructions)
+  end
+
+  private
+
+  # @return [Mutex]
+  #
+  # @api private
+  # @since 0.13.0
+  attr_reader :access_lock
+
+  # @return [Mutex]
+  #
+  # @api private
+  # @since 0.13.0
+  attr_reader :definition_lock
+end

data/lib/qonfig/data_set.rb

@@ -2,29 +2,30 @@
 
 # @api public
 # @since 0.1.0
-class Qonfig::DataSet
+class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
   require_relative 'data_set/class_builder'
-  require_relative 'data_set/validator'
+  require_relative 'data_set/lock'
 
   # @since 0.1.0
   extend Qonfig::DSL
 
+  # @since 0.13.0
+  extend Qonfig::Validator::DSL
+
   # @return [Qonfig::Settings]
   #
   # @api private
   # @since 0.1.0
   attr_reader :settings
 
-  # @param options_map [Hash]
+  # @param settings_map [Hash]
   # @param configurations [Proc]
   #
   # @api public
   # @since 0.1.0
-  def initialize(options_map = {}, &configurations)
-    @__access_lock__ = Mutex.new
-    @__definition_lock__ = Mutex.new
-
-    thread_safe_definition { load!(options_map, &configurations) }
+  def initialize(settings_map = {}, &configurations)
+    @__lock__ = Qonfig::DataSet::Lock.new
+    thread_safe_definition { load!(settings_map, &configurations) }
   end
 
   # @return [void]
@@ -43,7 +44,7 @@ class Qonfig::DataSet
     thread_safe_access { settings.__is_frozen__ }
   end
 
-  # @param options_map [Hash]
+  # @param settings_map [Hash]
   # @param configurations [Proc]
   # @return [void]
   #
@@ -51,22 +52,21 @@ class Qonfig::DataSet
   #
   # @api public
   # @since 0.2.0
-  def reload!(options_map = {}, &configurations)
+  def reload!(settings_map = {}, &configurations)
     thread_safe_definition do
       raise Qonfig::FrozenSettingsError, 'Frozen config can not be reloaded' if frozen?
-      load!(options_map, &configurations)
+      load!(settings_map, &configurations)
     end
   end
 
-  # @param options_map [Hash]
+  # @param settings_map [Hash]
   # @return [void]
   #
   # @api public
   # @since 0.1.0
-  def configure(options_map = {})
+  def configure(settings_map = {}, &configurations)
     thread_safe_access do
-      settings.__apply_values__(options_map)
-      yield(settings) if block_given?
+      apply_settings(settings_map, &configurations)
     end
   end
 
@@ -172,25 +172,94 @@ class Qonfig::DataSet
     thread_safe_access { settings.__clear__ }
   end
 
+  # @param block [Proc]
+  # @return [Enumerable]
+  #
+  # @yield [setting_key, setting_value]
+  # @yieldparam setting_key [String]
+  # @yieldparam setting_value [Object]
+  #
+  # @api public
+  # @since 0.13.0
+  def each_setting(&block)
+    thread_safe_access { settings.__each_setting__(&block) }
+  end
+
+  # @param block [Proc]
+  # @return [Enumerable]
+  #
+  # @yield [setting_key, setting_value]
+  # @yieldparam setting_key [String]
+  # @yieldparam setting_value [Object]
+  #
+  # @api public
+  # @since 0.13.0
+  def deep_each_setting(&block)
+    thread_safe_access { settings.__deep_each_setting__(&block) }
+  end
+
+  # @return [Boolean]
+  #
+  # @api public
+  # @since 0.13.0
+  def valid?
+    thread_safe_access { validator.valid? }
+  end
+
+  # @return [void]
+  #
+  # @api public
+  # @since 0.13.0
+  def validate!
+    thread_safe_access { validator.validate! }
+  end
+
   private
 
-  # @return [Qonfig::Settings]
+  # @return [Qonfig::Validator]
+  #
+  # @api private
+  # @since 0.13.0
+  attr_reader :validator
+
+  # @return [void]
   #
   # @api private
   # @since 0.2.0
   def build_settings
-    Qonfig::Settings::Builder.build(self.class.commands.dup)
+    @settings = Qonfig::Settings::Builder.build(self)
+    validator.validate!
+  end
+
+  # @return [void]
+  #
+  # @api private
+  # @since 0.13.0
+  def build_validator
+    @validator = Qonfig::Validator.new(self)
+  end
+
+  # @param settings_map [Hash]
+  # @param configurations [Proc]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.13.0
+  def apply_settings(settings_map = {}, &configurations)
+    settings.__apply_values__(settings_map)
+    yield(settings) if block_given?
   end
 
-  # @param options_map [Hash]
+  # @param settings_map [Hash]
   # @param configurations [Proc]
   # @return [void]
   #
   # @api private
   # @since 0.2.0
-  def load!(options_map = {}, &configurations)
-    @settings = build_settings
-    configure(options_map, &configurations)
+  def load!(settings_map = {}, &configurations)
+    build_validator
+    build_settings
+    apply_settings(settings_map, &configurations)
   end
 
   # @param instructions [Proc]
@@ -199,7 +268,7 @@ class Qonfig::DataSet
   # @api private
   # @since 0.2.0
   def thread_safe_access(&instructions)
-    @__access_lock__.synchronize(&instructions)
+    @__lock__.thread_safe_access(&instructions)
   end
 
   # @param instructions [Proc]
@@ -208,6 +277,6 @@ class Qonfig::DataSet
   # @api private
   # @since 0.2.0
   def thread_safe_definition(&instructions)
-    @__definition_lock__.synchronize(&instructions)
+    @__lock__.thread_safe_definition(&instructions)
   end
 end

data/lib/qonfig/errors.rb

@@ -9,6 +9,14 @@ module Qonfig
   # @since 0.1.0
   ArgumentError = Class.new(ArgumentError)
 
+  # @api public
+  # @since 0.13.0
+  ValidatorArgumentError = Class.new(ArgumentError)
+
+  # @api public
+  # @since 0.13.0
+  ValidationError = Class.new(Error)
+
   # @api public
   # @since 0.12.0
   PluginError = Class.new(Error)

data/lib/qonfig/plugins/toml/commands/expose_toml.rb

@@ -60,12 +60,13 @@ class Qonfig::Commands::ExposeTOML < Qonfig::Commands::Base
     @env       = env
   end
 
+  # @param data_set [Qonfig::DataSet]
   # @param settings [Qonfig::Settings]
   # @return [void]
   #
   # @api private
   # @since 0.12.0
-  def call(settings)
+  def call(data_set, settings)
     case via
     when EXPOSERS[:file_name]
       expose_file_name!(settings)

data/lib/qonfig/plugins/toml/commands/load_from_toml.rb

@@ -25,12 +25,13 @@ class Qonfig::Commands::LoadFromTOML < Qonfig::Commands::Base
     @strict = strict
   end
 
+  # @param data_set [Qonfig::DataSet]
   # @param settings [Qonfig::Settings]
   # @return [void]
   #
   # @api private
   # @since 0.12.0
-  def call(settings)
+  def call(data_set, settings)
     toml_data = Qonfig::Loaders::TOML.load_file(file_path, fail_on_unexist: strict)
     toml_based_settings = build_data_set_class(toml_data).new.settings
     settings.__append_settings__(toml_based_settings)

data/lib/qonfig/settings/builder.rb

@@ -4,14 +4,30 @@
 # @since 0.2.0
 module Qonfig::Settings::Builder
   class << self
-    # @param commands [Qonfig::CommandSet]
+    # @param data_set [Qonfig::DataSet]
     # @return [Qonfig::Settings]
     #
     # @api private
     # @since 0.2.0
-    def build(commands)
-      Qonfig::Settings.new.tap do |settings|
-        commands.each { |command| command.call(settings) }
+    def build(data_set)
+      Qonfig::Settings.new(build_mutation_callbacks(data_set)).tap do |settings|
+        data_set.class.commands.dup.each do |command|
+          command.call(data_set, settings)
+        end
+      end
+    end
+
+    private
+
+    # @param data_set [Qonfig::DataSet]
+    # @return [Qonfig::Settings::Callbacks]
+    #
+    # @api private
+    # @since 0.13.0
+    def build_mutation_callbacks(data_set)
+      Qonfig::Settings::Callbacks.new.tap do |callbacks|
+        # NOTE: validation callbacks
+        callbacks.add(proc { data_set.validate! })
       end
     end
   end

data/lib/qonfig/settings/callbacks.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.13.0
+class Qonfig::Settings::Callbacks
+  # @api private
+  # @since 0.13.0
+  include Enumerable
+
+  # @return [void]
+  #
+  # @api private
+  # @since 0.13.0
+  def initialize
+    @callbacks = []
+  end
+
+  # @return [void]
+  #
+  # @api private
+  # @since 0.13.0
+  def call
+    callbacks.each(&:call)
+  end
+
+  # @param callback [Proc, Qonfig::Settings::Callbacks, #call]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.13.0
+  def add(callback)
+    callbacks << callback
+  end
+  attr_reader :callback
+
+  private
+
+  # @return [Array<Proc>]
+  #
+  # @api private
+  # @since 0.13.0
+  attr_reader :callbacks
+end