qonfig 0.18.1 → 0.19.0

data/lib/qonfig/commands/definition/load_from_yaml.rb

@@ -3,6 +3,9 @@
 # @api private
 # @since 0.2.0
 class Qonfig::Commands::Definition::LoadFromYAML < Qonfig::Commands::Base
+  # @since 0.19.0
+  self.inheritable = true
+
   # @return [String]
   #
   # @api private

data/lib/qonfig/commands/instantiation/freeze_state.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.19.0
+class Qonfig::Commands::Instantiation::FreezeState < Qonfig::Commands::Base
+  # @since 0.19.0
+  self.inheritable = false
+
+  # @param data_set [Qonfig::DataSet]
+  # @param settings [Qonfig::Settings]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.19.0
+  def call(data_set, settings)
+    settings.__freeze__
+  end
+end

data/lib/qonfig/commands/instantiation/values_file.rb

@@ -3,6 +3,9 @@
 # @api private
 # @since 0.17.0
 class Qonfig::Commands::Instantiation::ValuesFile < Qonfig::Commands::Base
+  # @since 0.19.0
+  self.inheritable = true
+
   # @return [Symbol]
   #
   # @api private

data/lib/qonfig/commands/instantiation.rb

@@ -4,4 +4,5 @@
 # @since 0.17.0
 module Qonfig::Commands::Instantiation
   require_relative 'instantiation/values_file'
+  require_relative 'instantiation/freeze_state'
 end

data/lib/qonfig/data_set/class_builder.rb

@@ -23,5 +23,16 @@ 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?)
+    end
   end
 end

data/lib/qonfig/data_set.rb

@@ -26,6 +26,18 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
 
       Class.new(base_dataset_klass, &config_klass_definitions).new
     end
+
+    # @param configurations [Hash<Symbol|String,Any>]
+    # @return [Boolean]
+    #
+    # @api public
+    # @since 0.19.0
+    def valid_with?(configurations = {})
+      new(configurations)
+      true
+    rescue Qonfig::ValidationError
+      false
+    end
   end
 
   # @return [Qonfig::Settings]
@@ -302,6 +314,26 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
     thread_safe_access { validator.valid? }
   end
 
+  # @param configurations [Hash<String,Symbol|Any>]
+  # @return [Boolean]
+  #
+  # @api public
+  # @since 0.19.0
+  def valid_with?(configurations = {})
+    # NOTE:
+    #  'dup.configure(configurations)' has better thread-safety than 'with(configurations)'
+    #  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)
+    true
+  rescue Qonfig::ValidationError
+    false
+  end
+
   # @return [void]
   #
   # @api public
@@ -405,9 +437,11 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
   #
   # @api private
   # @since 0.2.0
+  # @version 0.19.0
   def build_settings
-    @settings = Qonfig::Settings::Builder.build(self)
+    @settings = Qonfig::Settings::Builder.build_definitions(self)
     validator.validate!
+    Qonfig::Settings::Builder.build_state(self)
   end
 
   # @return [void]
@@ -429,16 +463,6 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
     yield(settings) if block_given?
   end
 
-  # @return [void]
-  #
-  # @api private
-  # @since 0.17.0
-  def call_instance_management_commands
-    self.class.instance_commands.each do |instance_command|
-      instance_command.call(self, settings)
-    end
-  end
-
   # @param settings_map [Hash]
   # @param configurations [Proc]
   # @return [void]
@@ -448,7 +472,6 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
   def load!(settings_map = {}, &configurations)
     build_validator
     build_settings
-    call_instance_management_commands
     apply_settings(settings_map, &configurations)
   end
 
@@ -475,8 +498,8 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
     ).call(self, settings)
   end
 
-  # @param instructions [Proc]
-  # @return [Object]
+  # @param instructions [Block]
+  # @return [Any]
   #
   # @api private
   # @since 0.2.0
@@ -484,8 +507,8 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
     @__lock__.thread_safe_access(&instructions)
   end
 
-  # @param instructions [Proc]
-  # @return [Object]
+  # @param instructions [Block]
+  # @return [Any]
   #
   # @api private
   # @since 0.2.0
@@ -493,6 +516,11 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
     @__lock__.thread_safe_definition(&instructions)
   end
 
+  # @param instructions [Block]
+  # @return [Any]
+  #
+  # @api priavte
+  # @since 0.17.0
   def with_arbitary_access(&instructions)
     @__lock__.with_arbitary_access(&instructions)
   end

data/lib/qonfig/dsl.rb

@@ -9,6 +9,7 @@ module Qonfig::DSL
     #
     # @api private
     # @since 0.1.0
+    # @version 0.19.0
     def extended(child_klass)
       child_klass.instance_variable_set(:@definition_commands, Qonfig::CommandSet.new)
       child_klass.instance_variable_set(:@instance_commands, Qonfig::CommandSet.new)
@@ -17,9 +18,7 @@ module Qonfig::DSL
         def inherited(child_klass)
           child_klass.instance_variable_set(:@definition_commands, Qonfig::CommandSet.new)
           child_klass.instance_variable_set(:@instance_commands, Qonfig::CommandSet.new)
-
-          child_klass.definition_commands.concat(definition_commands)
-          child_klass.instance_commands.concat(instance_commands)
+          Qonfig::DataSet::ClassBuilder.inherit(base_klass: self, child_klass: child_klass)
           super
         end
       end)
@@ -183,4 +182,12 @@ module Qonfig::DSL
       file_path, caller_location, format: format, strict: strict, expose: expose
     )
   end
+
+  # @return [void]
+  #
+  # @api public
+  # @since 0.19.0
+  def freeze_state!
+    instance_commands << Qonfig::Commands::Instantiation::FreezeState.new
+  end
 end

data/lib/qonfig/errors.rb

@@ -9,10 +9,18 @@ module Qonfig
   # @since 0.1.0
   ArgumentError = Class.new(ArgumentError)
 
+  # @see Qonfig::Validator::Builder::AttributeConsistency
+  # @see Qonfig::Validator::Predefined::Registry
+  #
   # @api public
   # @since 0.13.0
   ValidatorArgumentError = Class.new(ArgumentError)
 
+  # @see Qonfig::Validator
+  # @see Qonfig::Validator::MethodBased
+  # @see Qonfig::Validator::ProcBased
+  # @see Qonfig::Validator::Predefined::Common
+  #
   # @api public
   # @since 0.13.0
   ValidationError = Class.new(Error)
@@ -39,6 +47,12 @@ module Qonfig
   # @since 0.1.0
   UnknownSettingError = Class.new(Error)
 
+  # @see Qonfig::Settings
+  #
+  # @api private
+  # @since 0.19.0
+  StrangeThingsError = Class.new(Error)
+
   # @see Qonfig::Settings
   #
   # @api public
@@ -54,12 +68,9 @@ module Qonfig
   # @since 0.2.0
   CoreMethodIntersectionError = Class.new(Error)
 
-  # @see Qonfig::Settings
-  # @see Qonfig::DataSet
-  #
   # @api public
-  # @since 0.1.0
-  FrozenSettingsError = begin # rubocop:disable Naming/ConstantName
+  # @since 0.19.0
+  FrozenError = begin # rubocop:disable Naming/ConstantName
     # :nocov:
     if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.5.0')
       Class.new(::FrozenError)
@@ -69,6 +80,14 @@ module Qonfig
     # :nocov:
   end
 
+  # @see Qonfig::Settings
+  # @see Qonfig::DataSet
+  #
+  # @api public
+  # @since 0.1.0
+  # @version 0.19.0
+  FrozenSettingsError = Class.new(FrozenError)
+
   # @see Qonfig::Commands::Instantiation::ValuesFile
   #
   # @api public

data/lib/qonfig/plugins/abstract.rb

@@ -4,10 +4,39 @@
 # @since 0.4.0
 class Qonfig::Plugins::Abstract
   class << self
+    # @param child_klass [Class]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.19.0
+    def inherited(child_klass)
+      child_klass.instance_variable_set(:@loaded, false)
+      super
+    end
+
     # @return [void]
     #
     # @api private
     # @since 0.4.0
-    def load!; end
+    def load!
+      @loaded = true
+      install!
+    end
+
+    # @return [Boolean]
+    #
+    # @api private
+    # @since 0.19.0
+    def loaded?
+      @loaded
+    end
+
+    private
+
+    # @return [void]
+    #
+    # @api private
+    # @since 0.19.0
+    def install!; end
   end
 end

data/lib/qonfig/plugins/access_mixin.rb

@@ -13,6 +13,8 @@ module Qonfig::Plugins::AccessMixin
   def plugin(plugin_name)
     Qonfig::Plugins.load(plugin_name)
   end
+  alias_method :enable, :plugin
+  alias_method :load, :plugin
 
   # @return [Array<String>]
   #
@@ -24,6 +26,15 @@ module Qonfig::Plugins::AccessMixin
     Qonfig::Plugins.names
   end
 
+  # @return [Array<String>]
+  #
+  # @api private
+  # @since 0.19.0
+  def loaded_plugins
+    Qonfig::Plugins.loaded_plugins
+  end
+  alias_method :enabled_plugins, :loaded_plugins
+
   # @param plugin_name [String, Symbol]
   # @param plugin_klass [Class<Qonfig::Plugins::Abstract>]
   # @return [void]

data/lib/qonfig/plugins/pretty_print/data_set.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# @api public
+# @since 0.19.0
+class Qonfig::DataSet
+  # @api public
+  # @since 0.19.0
+  include Qonfig::Plugins::PrettyPrint::Mixin
+end

data/lib/qonfig/plugins/pretty_print/mixin.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.19.0
+module Qonfig::Plugins::PrettyPrint::Mixin
+  # @param pp [?] Suitable for Ruby's PP module
+  # @return [void]
+  #
+  # @api public
+  # @since 0.19.0
+  def pretty_print(pp)
+    pp.object_address_group(self) do
+      pp.seplist(keys, proc { pp.text(',') }) do |key|
+        pp.breakable(' ')
+        pp.group(1) do
+          pp.text(key)
+          pp.text(':')
+          pp.breakable
+          pp.pp(self[key])
+        end
+      end
+    end
+  end
+end

data/lib/qonfig/plugins/pretty_print.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.19.0
+class Qonfig::Plugins::PrettyPrint < Qonfig::Plugins::Abstract
+  class << self
+    # @return [void]
+    #
+    # @api private
+    # @since 0.19.0
+    def install!
+      require_relative 'pretty_print/mixin'
+      require_relative 'pretty_print/data_set'
+    end
+  end
+end

data/lib/qonfig/plugins/registry.rb

@@ -3,6 +3,9 @@
 # @api private
 # @since 0.4.0
 class Qonfig::Plugins::Registry
+  # @since 0.19.0
+  include Enumerable
+
   # @return [void]
   #
   # @api private
@@ -40,6 +43,15 @@ class Qonfig::Plugins::Registry
     thread_safe { plugin_names }
   end
 
+  # @param block [Block]
+  # @return [Enumerable]
+  #
+  # @api private
+  # @since 0.19.0
+  def each(&block)
+    thread_safe { iterate(&block) }
+  end
+
   private
 
   # @return [Hash]
@@ -70,6 +82,15 @@ class Qonfig::Plugins::Registry
     plugin_set.keys
   end
 
+  # @param block [Block]
+  # @return [Enumerable]
+  #
+  # @api private
+  # @since 0.19.0
+  def iterate(&block)
+    block_given? ? plugin_set.each_pair(&block) : plugin_set.each_pair
+  end
+
   # @param plugin_name [String]
   # @return [Boolean]
   #

data/lib/qonfig/plugins/toml.rb

@@ -7,8 +7,8 @@ class Qonfig::Plugins::TOML < Qonfig::Plugins::Abstract
     # @return [void]
     #
     # @api private
-    # @since 0.12.0
-    def load!
+    # @since 0.19.0
+    def install!
       raise(
         Qonfig::UnresolvedPluginDependencyError,
         '::TomlRB does not exist or "toml-rb" gem is not loaded'

data/lib/qonfig/plugins.rb

@@ -7,6 +7,7 @@ module Qonfig::Plugins
   require_relative 'plugins/access_mixin'
   require_relative 'plugins/abstract'
   require_relative 'plugins/toml'
+  require_relative 'plugins/pretty_print'
 
   # @since 0.4.0
   @plugin_registry = Registry.new
@@ -23,6 +24,20 @@ module Qonfig::Plugins
       thread_safe { plugin_registry[plugin_name].load! }
     end
 
+    # @return [Array<String>]
+    #
+    # @api public
+    # @since 0.19.0
+    def loaded_plugins
+      thread_safe do
+        plugin_registry.select do |_plugin_name, plugin_module|
+          plugin_module.loaded?
+        end.map do |plugin_name, _plugin_module|
+          plugin_name
+        end
+      end
+    end
+
     # @return [Array<String>]
     #
     # @api public

data/lib/qonfig/settings/builder.rb

@@ -8,8 +8,8 @@ module Qonfig::Settings::Builder
     # @return [Qonfig::Settings]
     #
     # @api private
-    # @since 0.2.0
-    def build(data_set)
+    # @since 0.19.0
+    def build_definitions(data_set)
       Qonfig::Settings.new(build_mutation_callbacks(data_set)).tap do |settings|
         data_set.class.definition_commands.dup.each do |command|
           command.call(data_set, settings)
@@ -17,6 +17,17 @@ module Qonfig::Settings::Builder
       end
     end
 
+    # @param data_set [Qonfig::DataSet]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.19.0
+    def build_state(data_set)
+      data_set.class.instance_commands.dup.each do |command|
+        command.call(data_set, data_set.settings)
+      end
+    end
+
     private
 
     # @param data_set [Qonfig::DataSet]

data/lib/qonfig/settings.rb

@@ -22,6 +22,12 @@ class Qonfig::Settings # NOTE: Layout/ClassStructure is disabled only for CORE_M
   # @since 0.11.0
   BASIC_SETTING_VALUE_TRANSFORMER = (proc { |value| value }).freeze
 
+  # @return [String]
+  #
+  # @api private
+  # @since 0.19.0
+  DOT_NOTATION_SEPARATOR = '.'
+
   # @return [Hash]
   #
   # @api private
@@ -128,7 +134,13 @@ class Qonfig::Settings # NOTE: Layout/ClassStructure is disabled only for CORE_M
   # @api public
   # @since 0.1.0
   def [](key)
-    __lock__.thread_safe_access { __get_value__(key) }
+    __lock__.thread_safe_access do
+      begin
+        __get_value__(key)
+      rescue Qonfig::UnknownSettingError
+        __deep_access__(*__parse_dot_notated_key__(key))
+      end
+    end
   end
 
   # @param key [String, Symbol]
@@ -156,7 +168,17 @@ class Qonfig::Settings # NOTE: Layout/ClassStructure is disabled only for CORE_M
   # @api private
   # @since 0.2.0
   def __dig__(*keys)
-    __lock__.thread_safe_access { __deep_access__(*keys) }
+    __lock__.thread_safe_access do
+      begin
+        __deep_access__(*keys)
+      rescue Qonfig::UnknownSettingError
+        if keys.size == 1
+          __deep_access__(*__parse_dot_notated_key__(keys.first))
+        else
+          raise
+        end
+      end
+    end
   end
 
   # @param keys [Array<String, Symbol>]
@@ -342,7 +364,16 @@ class Qonfig::Settings # NOTE: Layout/ClassStructure is disabled only for CORE_M
   # @api private
   # @since 0.17.0
   def __is_key_exists__(*key_path)
-    __deep_access__(*key_path)
+    begin
+      __deep_access__(*key_path)
+    rescue Qonfig::UnknownSettingError
+      if key_path.size == 1
+        __deep_access__(*__parse_dot_notated_key__(key_path.first))
+      else
+        raise
+      end
+    end
+
     true
   rescue Qonfig::UnknownSettingError
     false
@@ -526,9 +557,21 @@ class Qonfig::Settings # NOTE: Layout/ClassStructure is disabled only for CORE_M
   # @since 0.9.0
   def __deep_slice__(*keys)
     {}.tap do |result|
-      __deep_access__(*keys).tap do |setting|
-        required_key = __indifferently_accessable_option_key__(keys.last)
-        result[required_key] = __is_a_setting__(setting) ? setting.__to_h__ : setting
+      begin
+        __deep_access__(*keys).tap do |setting|
+          required_key = __indifferently_accessable_option_key__(keys.last)
+          result[required_key] = __is_a_setting__(setting) ? setting.__to_h__ : setting
+        end
+      rescue Qonfig::UnknownSettingError
+        if keys.size == 1
+          key_set = __parse_dot_notated_key__(keys.first)
+          __deep_access__(*key_set).tap do |setting|
+            required_key = __indifferently_accessable_option_key__(key_set.last)
+            result[required_key] = __is_a_setting__(setting) ? setting.__to_h__ : setting
+          end
+        else
+          raise
+        end
       end
     end
   end
@@ -543,7 +586,22 @@ class Qonfig::Settings # NOTE: Layout/ClassStructure is disabled only for CORE_M
   # @since 0.1.0
   def __deep_slice_value__(*keys)
     required_key = __indifferently_accessable_option_key__(keys.last)
-    __deep_slice__(*keys)[required_key]
+    sliced_data = __deep_slice__(*keys)
+
+    case
+    when sliced_data.key?(required_key)
+      sliced_data[required_key]
+    when keys.size == 1
+      required_key = __parse_dot_notated_key__(required_key).last
+      sliced_data[required_key]
+    else # NOTE: possibly unreachable code
+      # :nocov:
+      raise(
+        Qonfig::StrangeThingsError,
+        "Strange things happpens with #{keys} keyset and value slicing"
+      )
+      # :nocov:
+    end
   end
 
   # @param keys [Array<String, Symbol, Array<String, Symbol>>]
@@ -662,6 +720,15 @@ class Qonfig::Settings # NOTE: Layout/ClassStructure is disabled only for CORE_M
     KeyGuard.new(key).prevent_core_method_intersection!
   end
 
+  # @param key [String, Symbol]
+  # @return [Array<String>]
+  #
+  # @api private
+  # @since 0.19.0
+  def __parse_dot_notated_key__(key)
+    __indifferently_accessable_option_key__(key).split(DOT_NOTATION_SEPARATOR)
+  end
+
   # @return [Array<String>]
   #
   # @api private
@@ -669,7 +736,7 @@ class Qonfig::Settings # NOTE: Layout/ClassStructure is disabled only for CORE_M
   CORE_METHODS = Array(
     instance_methods(false) |
     private_instance_methods(false) |
-    %i[super define_singleton_method self]
+    %i[super define_singleton_method self is_a?]
   ).map(&:to_s).freeze
 end
 # rubocop:enable Metrics/ClassLength, Layout/ClassStructure

data/lib/qonfig/version.rb

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

data/lib/qonfig.rb

@@ -24,4 +24,6 @@ module Qonfig
 
   # @since 0.12.0
   register_plugin('toml', Qonfig::Plugins::TOML)
+  # @since 0.19.0
+  register_plugin('pretty_print', Qonfig::Plugins::PrettyPrint)
 end

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'
+  spec.add_development_dependency 'armitage-rubocop', '~> 0.76', '>= 0.76.0.3'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'