qonfig 0.20.0 → 0.21.0

data/Rakefile

@@ -3,11 +3,11 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop'
+require 'rubocop/rake_task'
 require 'rubocop-rails'
 require 'rubocop-performance'
 require 'rubocop-rspec'
 require 'rubocop-rake'
-require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new(:rubocop) do |t|
   config_path = File.expand_path(File.join('.rubocop.yml'), __dir__)

data/lib/qonfig.rb

@@ -4,6 +4,8 @@ require 'yaml'
 require 'json'
 require 'erb'
 
+# @api public
+# @since 0.1.0
 module Qonfig
   require_relative 'qonfig/errors'
   require_relative 'qonfig/loaders'
@@ -17,6 +19,7 @@ module Qonfig
   require_relative 'qonfig/configurable'
   require_relative 'qonfig/imports'
   require_relative 'qonfig/plugins'
+  require_relative 'qonfig/compacted'
 
   # @api public
   # @since 0.4.0

data/lib/qonfig/compacted.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+# @api public
+# @since 0.21.0
+class Qonfig::Compacted < BasicObject
+  require_relative 'compacted/constructor'
+
+  # @since 0.21.0
+  extend ::Qonfig::DSL
+
+  class << self
+    # @param base_config_klass [Class<Qonfig::Compacted>]
+    # @param config_klass_definitions [Block]
+    # @return [Qonfig::Compacted]
+    #
+    # @api public
+    # @since 0.21.0
+    def build(base_config_klass = self, &config_klass_definitions)
+      raise(
+        ::Qonfig::ArgumentError,
+        'Base class should be a type of Qonfig::Compacted'
+      ) unless base_config_klass <= ::Qonfig::Compacted
+
+      Class.new(base_config_klass, &config_klass_definitions).new
+    end
+
+    # @param data_set [Qonfig::DataSet]
+    # @param configurations [Block]
+    # @return [Qonfig::Compacted]
+    #
+    # @api public
+    # @since 0.21.0
+    def build_from(
+      data_set = ::Qonfig::Compacted::Constructor::NO_INITIAL_DATA_SET,
+      &configurations
+    )
+      compacted_config = allocate # NOTE: #tap does not exist on BasicObject :(
+      ::Qonfig::Compacted::Constructor.construct(compacted_config, data_set, &configurations)
+      compacted_config
+    end
+
+    # @param settings_map [Hash<Symbol|String,Any>]
+    # @option init_from [NilClass, Qonfig::DataSet]
+    # @param configurations [Block]
+    # @return [Boolean]
+    #
+    # @api public
+    # @since 0.21.0
+    def valid_with?(settings_map = {}, &configurations)
+      new(settings_map, &configurations)
+      true
+    rescue ::Qonfig::ValidationError
+      false
+    end
+  end
+
+  # @return [Qonfig::DataSet]
+  #
+  # @api private
+  # @since 0.21.0
+  attr_reader :____data_set____
+
+  # @param settings_map [Hash<Symbol|String,Any>]
+  # @param configuration [Block]
+  # @return [void]
+  #
+  # @see Qonfig::Compacted::Constructor
+  #
+  # @api public
+  # @since 0.21.0
+  def initialize(settings_map = {}, &configuration)
+    ::Qonfig::Compacted::Constructor.construct(
+      self,
+      ::Qonfig::Compacted::Constructor::NO_INITIAL_DATA_SET,
+      settings_map: settings_map,
+      &configuration
+    )
+  end
+
+  # @param key [String, Symbol]
+  # @return [Any]
+  #
+  # @api public
+  # @since 0.21.0
+  def [](key)
+    ____data_set____[key]
+  end
+
+  # @param key [String, Symbol]
+  # @param value [Any]
+  # @return [void]
+  #
+  # @api public
+  # @since 0.21.0
+  def []=(key, value)
+    ____data_set____[key] = value
+  end
+end

data/lib/qonfig/compacted/constructor.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.21.0
+module Qonfig::Compacted::Constructor
+  # @return [NilClass]
+  #
+  # @api private
+  # @since 0.21.0
+  NO_INITIAL_DATA_SET = nil
+
+  class << self
+    # @param compacted_config [Qonfig::Compacted]
+    # @param initial_data_set [NilClass, Qonfig::DataSet]
+    #   Notice: cant define NO_INITIAL_DATA_SET (`nil`) as default value cuz Ruby will autoamtically
+    #   transform any Qonfig::DataSet to Hash (thx for kwargs, Ruby >:()
+    # @option settings_map [Hash<String,Symbol|Any>]
+    # @param configuration [Block]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.21.0
+    def construct(compacted_config, initial_data_set, settings_map: {}, &configuration)
+      prevent_incompatible_attributes!(compacted_config, initial_data_set)
+
+      if initial_data_set
+        construct_instance_from_data_set(
+          compacted_config,
+          initial_data_set,
+          settings_map,
+          &configuration
+        )
+      else
+        construct_isntance_from_commands(
+          compacted_config,
+          settings_map,
+          &configuration
+        )
+      end
+    end
+
+    private
+
+    # @param compacted_config [Qonfig::Compacted]
+    # @param initial_data_set [Qonfig::DataSet]
+    # @param settings_map [Hash<String,Symbol|Any>]
+    # @param configuration [Block]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.21.0
+    def construct_instance_from_data_set(
+      compacted_config,
+      initial_data_set,
+      settings_map,
+      &configuration
+    )
+      compacted_config.instance_eval do
+        @____data_set____ = initial_data_set
+        @____data_set____.configure(settings_map, &configuration)
+        @____data_set____.export_settings(self, '*', accessor: true, raw: true)
+      end
+    end
+
+    # @param compacted_config [Qonfig::Compacted]
+    # @param settings_map [Hash<String,Symbol|Any>]
+    # @param configuration [Block]
+    # @return [void]
+    #
+    # @see #construct_instance_from_data_set
+    #
+    # @api private
+    # @since 0.21.0
+    def construct_isntance_from_commands(
+      compacted_config,
+      settings_map,
+      &configuration
+    )
+      compacted_config_klass = (class << compacted_config; self; end).superclass
+      target_data_set_klass = Class.new(Qonfig::DataSet)
+      Qonfig::DSL::Inheritance.inherit(base: compacted_config_klass, child: target_data_set_klass)
+      target_data_set = target_data_set_klass.new
+
+      construct_instance_from_data_set(
+        compacted_config,
+        target_data_set,
+        settings_map,
+        &configuration
+      )
+    end
+
+    # @param compacted_config [Qonfig::Compacted]
+    # @param initial_data_set [NilClass, Qonfig::DataSet]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.21.0
+    def prevent_incompatible_attributes!(compacted_config, initial_data_set)
+      unless (class << compacted_config; self; end).superclass <= Qonfig::Compacted
+        # :nocov:
+        raise(Qonfig::ArgumentError, 'Compacted config should be a type of Qonfig::Compacted')
+        # :nocov:
+      end
+
+      unless initial_data_set.nil? || initial_data_set.is_a?(Qonfig::DataSet)
+        raise(Qonfig::ArgumentError, 'Initial config should be a type of Qonfig::DataSet')
+      end
+    end
+  end
+end

data/lib/qonfig/data_set.rb

@@ -25,13 +25,25 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
       Class.new(base_dataset_klass, &config_klass_definitions).new
     end
 
-    # @param configurations [Hash<Symbol|String,Any>]
+    # @param base_dataset_klass [Class<Qonfig::DataSet>]
+    # @param config_klass_definitions [Proc]
+    # @return [Qonfig::Compacted]
+    #
+    # @api public
+    # @since 0.21.0
+    def build_compacted(base_dataset_klass = self, &config_klass_definitions)
+      build(base_dataset_klass, &config_klass_definitions).compacted
+    end
+
+    # @param settings_map [Hash<Symbol|String,Any>]
+    # @param configurations [Block]
     # @return [Boolean]
     #
     # @api public
     # @since 0.19.0
-    def valid_with?(configurations = {})
-      new(configurations)
+    # @version 0.21.0
+    def valid_with?(settings_map = {}, &configurations)
+      new(settings_map, &configurations)
       true
     rescue Qonfig::ValidationError
       false
@@ -89,62 +101,79 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
   # @option format [String, Symbol]
   # @option strict [Boolean]
   # @option expose [NilClass, String, Symbol] Environment key
+  # @param configurations [Block]
   # @return [void]
   #
   # @see Qonfig::DataSet#load_setting_values_from_file
   #
   # @api public
   # @since 0.17.0
-  def load_from_file(file_path, format: :dynamic, strict: true, expose: nil)
+  # @version 0.21.0
+  def load_from_file(file_path, format: :dynamic, strict: true, expose: nil, &configurations)
     thread_safe_access do
-      load_setting_values_from_file(file_path, format: format, strict: strict, expose: expose)
+      load_setting_values_from_file(
+        file_path, format: format, strict: strict, expose: expose, &configurations
+      )
     end
   end
 
   # @param file_path [String]
   # @option strict [Boolean]
   # @option expose [NilClass, String, Symbol] Environment key
+  # @param configurations [Block]
   # @return [void]
   #
   # @see Qonfig::DataSet#load_from_file
   #
   # @api public
   # @since 0.17.0
-  def load_from_yaml(file_path, strict: true, expose: nil)
-    load_from_file(file_path, format: :yml, strict: strict, expose: expose)
+  # @version 0.21.0
+  def load_from_yaml(file_path, strict: true, expose: nil, &configurations)
+    load_from_file(file_path, format: :yml, strict: strict, expose: expose, &configurations)
   end
 
   # @param file_path [String]
   # @option strict [Boolean]
   # @option expose [NilClass, String, Symbol] Environment key
+  # @param configurations [Block]
   # @return [void]
   #
   # @see Qonfig::DataSet#load_from_file
   #
   # @api public
   # @since 0.17.0
-  def load_from_json(file_path, strict: true, expose: nil)
-    load_from_file(file_path, format: :json, strict: strict, expose: expose)
+  # @version 0.21.0
+  def load_from_json(file_path, strict: true, expose: nil, &configurations)
+    load_from_file(file_path, format: :json, strict: strict, expose: expose, &configurations)
   end
 
   # @option format [String, Symbol]
   # @option strict [Boolean]
   # @option expose [NilClass, String, Symbol]
+  # @param configurations [Block]
   # @return [void]
   #
   # @api public
   # @since 0.17.0
-  def load_from_self(format: :dynamic, strict: true, expose: nil)
-    caller_location = caller(1, 1).first
+  # @version 0.21.0
+  def load_from_self(format: :dynamic, strict: true, expose: nil, &configurations)
+    caller_location = ::Kernel.caller(1, 1).first
 
     thread_safe_access do
       load_setting_values_from_file(
-        :self, format: format, strict: strict, expose: expose, caller_location: caller_location
+        :self,
+        format: format,
+        strict: strict,
+        expose: expose,
+        caller_location: caller_location,
+        &configurations
       )
     end
   end
 
   # @param settings_map [Hash]
+  # @yield [cofnig]
+  # @yieldparam config [Qonfig::Settings]
   # @return [void]
   #
   # @api public
@@ -222,6 +251,20 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
     thread_safe_access { settings[key] }
   end
 
+  # @param key [String, Symbol]
+  # @param value [Any]
+  # @return [void]
+  #
+  # @raise [Qonfig::UnknownSettingError]
+  # @raise [Qonfig::FrozenSettingsError]
+  # @raise [Qonfig::AmbiguousSettingValueError]
+  #
+  # @api public
+  # @since 0.21.0
+  def []=(key, value)
+    thread_safe_access { settings[key] = value }
+  end
+
   # @param keys [Array<String, Symbol>]
   # @return [Object]
   #
@@ -312,21 +355,22 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
     thread_safe_access { validator.valid? }
   end
 
-  # @param configurations [Hash<String,Symbol|Any>]
+  # @param settings_map [Hash<String,Symbol|Any>]
   # @return [Boolean]
   #
   # @api public
   # @since 0.19.0
-  def valid_with?(configurations = {})
+  # @version 0.21.0
+  def valid_with?(settings_map = {}, &configurations)
     # NOTE:
-    #  'dup.configure(configurations)' has better thread-safety than 'with(configurations)'
+    #  'dup.configure(settings_map)' has better thread-safety than 'with(settings_map)'
     #  pros:
     #    - no arbitrary lock is obtained;
     #    - all threads can read and work :)
     #  cons:
     #    - useless ton of objects (new dataset, new settings, new locks, and etc);
     #    - useless setting options assignment steps (self.dup + self.to_h + configure(to_h))
-    dup.configure(configurations)
+    dup.configure(settings_map, &configurations)
     true
   rescue Qonfig::ValidationError
     false
@@ -400,6 +444,7 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
   # @option mappings [Hash<String|Symbol,String|Symbol>]
   # @option raw [Boolean]
   # @option prefix [String, Symbol]
+  # @option accessor [Boolean]
   # @return [void]
   #
   # @api public
@@ -408,8 +453,9 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
     exportable_object,
     *exported_setting_keys,
     mappings: Qonfig::Imports::Mappings::EMPTY_MAPPINGS,
-    raw: false,
-    prefix: Qonfig::Imports::Abstract::EMPTY_PREFIX
+    raw: Qonfig::Imports::Abstract::DEFAULT_RAW_BEHAVIOR,
+    prefix: Qonfig::Imports::Abstract::EMPTY_PREFIX,
+    accessor: Qonfig::Imports::Abstract::AS_ACCESSOR
   )
     thread_safe_access do
       Qonfig::Imports::Export.export!(
@@ -418,11 +464,20 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
         *exported_setting_keys,
         prefix: prefix,
         raw: raw,
-        mappings: mappings
+        mappings: mappings,
+        accessor: accessor
       )
     end
   end
 
+  # @return [Qonfig::Compacted]
+  #
+  # @api public
+  # @since 0.21.0
+  def compacted
+    Qonfig::Compacted.build_from(self)
+  end
+
   private
 
   # @return [Qonfig::Validation::Validators::Composite]
@@ -432,26 +487,6 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
   # @version 0.20.0
   attr_reader :validator
 
-  # @return [void]
-  #
-  # @api private
-  # @since 0.2.0
-  # @version 0.19.0
-  def build_settings
-    @settings = Qonfig::Settings::Builder.build_definitions(self)
-    validator.validate!
-    Qonfig::Settings::Builder.build_state(self)
-  end
-
-  # @return [void]
-  #
-  # @api private
-  # @since 0.13.0
-  # @version 0.20.0
-  def build_validator
-    @validator = Qonfig::Validation::Validators::Composite.new(self)
-  end
-
   # @param settings_map [Hash]
   # @param configurations [Proc]
   # @return [void]
@@ -469,9 +504,12 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
   #
   # @api private
   # @since 0.2.0
+  # @version 0.21.0
   def load!(settings_map = {}, &configurations)
-    build_validator
-    build_settings
+    Qonfig::Settings::Builder.build(self) do |settings, validator|
+      @settings = settings
+      @validator = validator
+    end
     apply_settings(settings_map, &configurations)
   end
 
@@ -480,6 +518,7 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
   # @option strict [Boolean]
   # @option expose [NilClass, String, Symbol]
   # @option callcer_location [NilClass, String]
+  # @param configurations [Block]
   # @return [void]
   #
   # @see Qonfig::Commands::Instantiation::ValuesFile
@@ -491,11 +530,13 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
     format: :dynamic,
     strict: true,
     expose: nil,
-    caller_location: nil
+    caller_location: nil,
+    &configurations
   )
     Qonfig::Commands::Instantiation::ValuesFile.new(
       file_path, caller_location, format: format, strict: strict, expose: expose
     ).call(self, settings)
+    apply_settings(&configurations)
   end
 
   # @param instructions [Block]