qonfig 0.20.0 → 0.21.0

data/lib/qonfig/data_set/class_builder.rb

@@ -23,18 +23,5 @@ module Qonfig::DataSet::ClassBuilder
         end
       end
     end
-
-    # @option base_klass [Class<Qonfig::DataSet>]
-    # @option child_klass [Class<Qonfig::DataSet>]
-    # @return [void]
-    #
-    # @api private
-    # @since 0.19.0
-    def inherit(base_klass:, child_klass:)
-      child_klass.definition_commands.concat(base_klass.definition_commands)
-      child_klass.instance_commands.concat(base_klass.instance_commands, &:inheritable?)
-      child_klass.predefined_validators.merge(base_klass.predefined_validators)
-      child_klass.validators.concat(base_klass.validators)
-    end
   end
 end

data/lib/qonfig/dsl.rb

@@ -4,8 +4,10 @@
 # @since 0.1.0
 # @version 0.20.0
 module Qonfig::DSL # rubocop:disable Metrics/ModuleLength
+  require_relative 'dsl/inheritance'
+
   class << self
-    # @param child_klass [Qonfig::DataSet]
+    # @param child_klass [Class<Qonfig::DataSet>]
     # @return [void]
     #
     # @see Qonfig::DataSet::ClassBuilder
@@ -26,7 +28,7 @@ module Qonfig::DSL # rubocop:disable Metrics/ModuleLength
           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)
+          Qonfig::DSL::Inheritance.inherit(base: self, child: child_klass)
           super
         end
       end)
@@ -166,14 +168,16 @@ module Qonfig::DSL # rubocop:disable Metrics/ModuleLength
     )
   end
 
+  # @option format [Symbol, String]
   # @return [void]
   #
   # @see Qonfig::Commands::Definition::LoadFromSelf
   #
   # @api public
   # @since 0.2.0
-  def load_from_self(format: :yaml)
-    caller_location = caller(1, 1).first
+  # @version 0.21.0
+  def load_from_self(format: :dynamic)
+    caller_location = ::Kernel.caller(1, 1).first
 
     definition_commands << Qonfig::Commands::Definition::LoadFromSelf.new(
       caller_location, format: format
@@ -241,14 +245,16 @@ module Qonfig::DSL # rubocop:disable Metrics/ModuleLength
   end
 
   # @option env [Symbol, String]
+  # @option format [Symbol, String]
   # @return [void]
   #
   # @see Qonfig::Commands::Definition::ExposeSelf
   #
   # @api public
   # @since 0.14.0
-  def expose_self(env:, format: :yaml)
-    caller_location = caller(1, 1).first
+  # @version 0.21.0
+  def expose_self(env:, format: :dynamic)
+    caller_location = ::Kernel.caller(1, 1).first
 
     definition_commands << Qonfig::Commands::Definition::ExposeSelf.new(
       caller_location, env: env, format: format
@@ -266,7 +272,7 @@ module Qonfig::DSL # rubocop:disable Metrics/ModuleLength
   # @api public
   # @since 0.17.0
   def values_file(file_path, format: :dynamic, strict: false, expose: nil)
-    caller_location = caller(1, 1).first
+    caller_location = ::Kernel.caller(1, 1).first
 
     instance_commands << Qonfig::Commands::Instantiation::ValuesFile.new(
       file_path, caller_location, format: format, strict: strict, expose: expose

data/lib/qonfig/dsl/inheritance.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.21.0
+module Qonfig::DSL::Inheritance
+  class << self
+    # @option base [Class<Qonfig::DataSet>, Class<Qonfig::Compacted>]
+    # @option child [Class<Qonfig::DataSet>, Class<Qonfig::Compacted>]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.21.0
+    def inherit(base:, child:)
+      child.definition_commands.concat(base.definition_commands)
+      child.instance_commands.concat(base.instance_commands, &:inheritable?)
+      child.predefined_validators.merge(base.predefined_validators)
+      child.validators.concat(base.validators)
+    end
+  end
+end

data/lib/qonfig/imports/abstract.rb

@@ -15,19 +15,34 @@ class Qonfig::Imports::Abstract
   # @since 0.18.0
   DEFAULT_RAW_BEHAVIOR = false
 
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.21.0
+  AS_ACCESSOR = false
+
   # @param seeded_klass [Class]
   # @param imported_config [Qonfig::DataSet]
   # @option prefix [String, Symbol]
   # @option raw [Boolean]
+  # @option accessor [Boolean]
   # @return [void]
   #
   # @api private
   # @since 0.18.0
-  def initialize(seeded_klass, imported_config, prefix: EMPTY_PREFIX, raw: DEFAULT_RAW_BEHAVIOR)
+  # @version 0.21.0
+  def initialize(
+    seeded_klass,
+    imported_config,
+    prefix: EMPTY_PREFIX,
+    raw: DEFAULT_RAW_BEHAVIOR,
+    accessor: AS_ACCESSOR
+  )
     @seeded_klass = seeded_klass
     @imported_config = imported_config
     @prefix = prefix
     @raw = !!raw
+    @accessor = !!accessor
   end
 
   # @param settings_interface [Module]
@@ -67,6 +82,12 @@ class Qonfig::Imports::Abstract
   # @since 0.18.0
   attr_reader :imported_config
 
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.21.0
+  attr_reader :accessor
+
   # @param imported_config [Qonfig::DataSet]
   # @param prefix [String, Symbol]
   # @return [void]

data/lib/qonfig/imports/direct_key.rb

@@ -8,19 +8,22 @@ class Qonfig::Imports::DirectKey < Qonfig::Imports::Abstract
   # @param keys [Array<String,Symbol>]
   # @option prefix [String, Symbol]
   # @option raw [Boolean]
+  # @option accessor [Boolean]
   # @return [void]
   #
   # @api private
-  # @since 0.18.8
+  # @since 0.18.0
+  # @version 0.21.0
   def initialize(
     seeded_klass,
     imported_config,
     *keys,
     prefix: EMPTY_PREFIX,
-    raw: DEFAULT_RAW_BEHAVIOR
+    raw: DEFAULT_RAW_BEHAVIOR,
+    accessor: AS_ACCESSOR
   )
     prevent_incompatible_import_params!(imported_config, prefix, keys)
-    super(seeded_klass, imported_config, prefix: prefix, raw: raw)
+    super(seeded_klass, imported_config, prefix: prefix, raw: raw, accessor: accessor)
     @keys = keys
     @key_matchers = build_setting_key_matchers(keys)
   end
@@ -30,14 +33,16 @@ class Qonfig::Imports::DirectKey < Qonfig::Imports::Abstract
   #
   # @api private
   # @since 0.18.0
-  def import!(settings_interface = Module.new) # rubocop:disable Metrics/AbcSize
+  # @version 0.21.0
+  # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/BlockLength
+  def import!(settings_interface = Module.new)
     key_matchers.each do |key_matcher|
       raise(
         Qonfig::UnknownSettingError,
         "Setting with <#{key_matcher.scope_pattern}> key does not exist!"
       ) unless (imported_config.keys(all_variants: true).any? do |setting_key|
         key_matcher.match?(setting_key)
-      end)
+      end || key_matcher.generic?)
 
       imported_config.keys(all_variants: true).each do |setting_key|
         next unless key_matcher.match?(setting_key)
@@ -46,7 +51,9 @@ class Qonfig::Imports::DirectKey < Qonfig::Imports::Abstract
         access_method_name = setting_key_path_sequence.last
         access_method_name = "#{prefix}#{access_method_name}" unless prefix.empty?
 
-        settings_interface.module_exec(raw, imported_config) do |raw, imported_config|
+        settings_interface.module_exec(
+          raw, imported_config, accessor
+        ) do |raw, imported_config, accessor|
           unless raw
             # NOTE: get setting value via slice_value
             define_method(access_method_name) do
@@ -58,10 +65,22 @@ class Qonfig::Imports::DirectKey < Qonfig::Imports::Abstract
               imported_config.dig(*setting_key_path_sequence)
             end
           end
+
+          define_method("#{access_method_name}?") do
+            # NOTE: based on Qonfig::Settings#__define_option_predicate__ realization
+            !!imported_config[setting_key]
+          end
+
+          if accessor
+            define_method("#{access_method_name}=") do |value|
+              imported_config[setting_key] = value
+            end
+          end
         end
       end
     end
   end
+  # rubocop:enable Metrics/AbcSize, Metrics/MethodLength, Metrics/BlockLength
 
   private
 

data/lib/qonfig/imports/dsl.rb

@@ -22,16 +22,19 @@ module Qonfig::Imports::DSL
     # @option prefix [String, Symbol]
     # @option raw [Boolean]
     # @option mappings [Hash<String|Symbol,String|Symbol>]
+    # @option accessor [Boolean]
     # @return [void]
     #
     # @api public
     # @since 0.18.0
+    # @version 0.21.0
     def import_settings(
       imported_config,
       *imported_setting_keys,
       prefix: Qonfig::Imports::Abstract::EMPTY_PREFIX,
       raw: Qonfig::Imports::Abstract::DEFAULT_RAW_BEHAVIOR,
-      mappings: Qonfig::Imports::Mappings::EMPTY_MAPPINGS
+      mappings: Qonfig::Imports::Mappings::EMPTY_MAPPINGS,
+      accessor: Qonfig::Imports::Abstract::AS_ACCESSOR
     )
       Qonfig::Imports::General.import!(
         self,
@@ -39,7 +42,8 @@ module Qonfig::Imports::DSL
         *imported_setting_keys,
         prefix: prefix,
         raw: raw,
-        mappings: mappings
+        mappings: mappings,
+        accessor: accessor
       )
     end
   end

data/lib/qonfig/imports/export.rb

@@ -10,20 +10,31 @@ module Qonfig::Imports::Export
     # @option mappings [Hash<String|Symbol,String|Symbol>]
     # @option raw [Boolean]
     # @option prefix [String, Symbol]
+    # @option accessor [Boolean]
     # @return [void]
     #
     # @api private
     # @since 0.18.0
+    # @version 0.21.0
     def export!(
       exportable_object,
       exported_config,
       *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
     )
-      unless exportable_object.is_a?(Module)
-        exportable_object = exportable_object.singleton_class
+      exportable_is_a_module = exportable_object.is_a?(Module) rescue false
+      # NOTE: (rescue false (rescue NoMethodError for #is_a?))
+      #   it means that #is_a? is not defined for exportable_object.
+      #   it happens only with BasicObject instances.
+
+      unless exportable_is_a_module
+        # NOTE:
+        #   << is a universal way for extrating the singleton class of an object
+        #   cuz BasicObject has no #singelton_class method;
+        exportable_object = (class << exportable_object; self; end)
       end
 
       Qonfig::Imports::General.import!(
@@ -32,7 +43,8 @@ module Qonfig::Imports::Export
         *exported_setting_keys,
         prefix: prefix,
         raw: raw,
-        mappings: mappings
+        mappings: mappings,
+        accessor: accessor
       )
     end
   end

data/lib/qonfig/imports/general.rb

@@ -10,17 +10,20 @@ class Qonfig::Imports::General
     # @option mappings [Hash<String|Symbol,String|Symbol>]
     # @option prefix [String, Symbol]
     # @option raw [Boolean]
+    # @option accessor [Boolean]
     # @return void]
     #
     # @api private
     # @since 0.18.0
+    # @version 0.21.0
     def import!(
       seeded_klass,
       imported_config,
       *imported_keys,
       mappings: Qonfig::Imports::Mappings::EMPTY_MAPPINGS,
       prefix: Qonfig::Imports::Abstract::EMPTY_PREFIX,
-      raw: false
+      raw: Qonfig::Imports::Abstract::DEFAULT_RAW_BEHAVIOR,
+      accessor: Qonfig::Imports::Abstract::AS_ACCESSOR
     )
       new(
         seeded_klass,
@@ -28,7 +31,8 @@ class Qonfig::Imports::General
         *imported_keys,
         mappings: mappings,
         prefix: prefix,
-        raw: raw
+        raw: raw,
+        accessor: accessor
       ).import!
     end
   end
@@ -39,24 +43,39 @@ class Qonfig::Imports::General
   # @option mappings [Hash<String|Symbol,String|Symbol>]
   # @option prefix [String, Symbol]
   # @option raw [Boolean]
+  # @option accessor [Boolean]
   # @return void]
   #
   # @api private
   # @since 0.18.0
+  # @version 0.21.0
   def initialize(
     seeded_klass,
     imported_config,
     *imported_keys,
     mappings: Qonfig::Imports::Mappings::EMPTY_MAPPINGS,
     prefix: Qonfig::Imports::Abstract::EMPTY_PREFIX,
-    raw: false
+    raw: Qonfig::Imports::Abstract::DEFAULT_RAW_BEHAVIOR,
+    accessor: Qonfig::Imports::Abstract::AS_ACCESSOR
   )
     @seeded_klass = seeded_klass
+
     @direct_key_importer = build_direct_key_importer(
-      seeded_klass, imported_config, *imported_keys, prefix: prefix, raw: raw
+      seeded_klass,
+      imported_config,
+      *imported_keys,
+      prefix: prefix,
+      raw: raw,
+      accessor: accessor
     )
+
     @mappings_importer = build_mappings_importer(
-      seeded_klass, imported_config, mappings: mappings, prefix: prefix, raw: raw
+      seeded_klass,
+      imported_config,
+      mappings: mappings,
+      prefix: prefix,
+      raw: raw,
+      accessor: accessor
     )
   end
 
@@ -96,17 +115,27 @@ class Qonfig::Imports::General
   # @param imported_keys [Array<String,Symbol>]
   # @option prefix [String, Symbol]
   # @option raw [Boolean]
+  # @option accessor [Boolean]
   # @return [Qonfig::Imports::DirectKey]
   #
   # @api private
   # @since 0.18.0
-  def build_direct_key_importer(seeded_klass, imported_config, *imported_keys, prefix:, raw:)
+  # @version 0.21.0
+  def build_direct_key_importer(
+    seeded_klass,
+    imported_config,
+    *imported_keys,
+    prefix:,
+    raw:,
+    accessor:
+  )
     Qonfig::Imports::DirectKey.new(
       seeded_klass,
       imported_config,
       *imported_keys,
       prefix: prefix,
-      raw: raw
+      raw: raw,
+      accessor: accessor
     )
   end
 
@@ -115,17 +144,27 @@ class Qonfig::Imports::General
   # @option mappings [Hash<Symbol|String,Symbol|String>]
   # @option prefix [String, Symbol]
   # @option raw [Boolean]
+  # @option accessor [Boolean]
   # @return [Qonfig::Imports::Mappings]
   #
   # @api private
   # @since 0.18.0
-  def build_mappings_importer(seeded_klass, imported_config, mappings:, prefix:, raw:)
+  # @version 0.21.0
+  def build_mappings_importer(
+    seeded_klass,
+    imported_config,
+    mappings:,
+    prefix:,
+    raw:,
+    accessor:
+  )
     Qonfig::Imports::Mappings.new(
       seeded_klass,
       imported_config,
       mappings: mappings,
       prefix: prefix,
-      raw: raw
+      raw: raw,
+      accessor: accessor
     )
   end
 end

data/lib/qonfig/imports/mappings.rb

@@ -14,19 +14,22 @@ class Qonfig::Imports::Mappings < Qonfig::Imports::Abstract
   # @option prefix [String, Symbol]
   # @option raw [Boolean]
   # @option mappings [Hash<Symbol|String,Symbol|String>]
+  # @option accessor [Boolean]
   # @return [void]
   #
   # @api private
   # @since 0.18.0
+  # @version 0.21.0
   def initialize(
     seeded_klass,
     imported_config,
     mappings: EMPTY_MAPPINGS,
     prefix: EMPTY_PREFIX,
-    raw: DEFAULT_RAW_BEHAVIOR
+    raw: DEFAULT_RAW_BEHAVIOR,
+    accessor: AS_ACCESSOR
   )
     prevent_incompatible_import_params!(imported_config, prefix, mappings)
-    super(seeded_klass, imported_config, prefix: prefix, raw: raw)
+    super(seeded_klass, imported_config, prefix: prefix, raw: raw, accessor: accessor)
     @mappings = mappings
     @key_matchers = build_setting_key_matchers(mappings)
   end
@@ -36,6 +39,8 @@ class Qonfig::Imports::Mappings < Qonfig::Imports::Abstract
   #
   # @api private
   # @since 0.18.0
+  # @version 0.21.0
+  # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/BlockLength
   def import!(settings_interface = Module.new) # rubocop:disable Metrics/AbcSize
     key_matchers.each_pair do |(mapped_method_name, key_matcher)|
       raise(
@@ -43,7 +48,7 @@ class Qonfig::Imports::Mappings < Qonfig::Imports::Abstract
         "Setting with <#{key_matcher.scope_pattern}> key does not exist!"
       ) unless (imported_config.keys(all_variants: true).any? do |setting_key|
         key_matcher.match?(setting_key)
-      end)
+      end || key_matcher.generic?)
 
       imported_config.keys(all_variants: true).each do |setting_key|
         next unless key_matcher.match?(setting_key)
@@ -51,7 +56,9 @@ class Qonfig::Imports::Mappings < Qonfig::Imports::Abstract
         setting_key_path_sequence = setting_key.split('.')
         mapped_method_name = "#{prefix}#{mapped_method_name}" unless prefix.empty?
 
-        settings_interface.module_exec(raw, imported_config) do |raw, imported_config|
+        settings_interface.module_exec(
+          raw, imported_config, accessor
+        ) do |raw, imported_config, accessor|
           unless raw
             # NOTE: get setting value via slice_value
             define_method(mapped_method_name) do
@@ -63,10 +70,22 @@ class Qonfig::Imports::Mappings < Qonfig::Imports::Abstract
               imported_config.dig(*setting_key_path_sequence)
             end
           end
+
+          define_method("#{mapped_method_name}?") do
+            # NOTE: based on Qonfig::Settings#__define_option_predicate__ realization
+            !!imported_config[setting_key]
+          end
+
+          if accessor
+            define_method("#{mapped_method_name}=") do |value|
+              imported_config[setting_key] = value
+            end
+          end
         end
       end
     end
   end
+  # rubocop:enable Metrics/AbcSize, Metrics/MethodLength, Metrics/BlockLength
 
   private