qonfig 0.16.0 → 0.17.0

data/lib/qonfig/data_set.rb

@@ -13,19 +13,24 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
   extend Qonfig::Validator::DSL
 
   class << self
+    # @param base_dataset_klass [Class<Qonfig::DataSet>]
     # @param config_klass_definitions [Proc]
     # @return [Qonfig::DataSet]
     #
     # @api public
     # @since 0.16.0
-    def build(&config_klass_definitions)
-      Class.new(self, &config_klass_definitions).new
+    def build(base_dataset_klass = self, &config_klass_definitions)
+      unless base_dataset_klass <= Qonfig::DataSet
+        raise(Qonfig::ArgumentError, 'Base inherited class should be a type of Qonfig::DataSet')
+      end
+
+      Class.new(base_dataset_klass, &config_klass_definitions).new
     end
   end
 
   # @return [Qonfig::Settings]
   #
-  # @api private
+  # @api public
   # @since 0.1.0
   attr_reader :settings
 
@@ -70,6 +75,65 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
     end
   end
 
+  # @param file_path [String, Symbol]
+  # @option format [String, Symbol]
+  # @option strict [Boolean]
+  # @option expose [NilClass, String, Symbol] Environment key
+  # @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)
+    thread_safe_access do
+      load_setting_values_from_file(file_path, format: format, strict: strict, expose: expose)
+    end
+  end
+
+  # @param file_path [String]
+  # @option strict [Boolean]
+  # @option expose [NilClass, String, Symbol] Environment key
+  # @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)
+  end
+
+  # @param file_path [String]
+  # @option strict [Boolean]
+  # @option expose [NilClass, String, Symbol] Environment key
+  # @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)
+  end
+
+  # @option format [String, Symbol]
+  # @option strict [Boolean]
+  # @option expose [NilClass, String, Symbol]
+  # @return [void]
+  #
+  # @api public
+  # @since 0.17.0
+  def load_from_self(format: :dynamic, strict: true, expose: nil)
+    caller_location = caller(1, 1).first
+
+    thread_safe_access do
+      load_setting_values_from_file(
+        :self, format: format, strict: strict, expose: expose, caller_location: caller_location
+      )
+    end
+  end
+
   # @param settings_map [Hash]
   # @return [void]
   #
@@ -184,6 +248,17 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
     thread_safe_access { settings.__subset__(*keys) }
   end
 
+  # @param key_path [Array<String, Symbol>]
+  # @return [Boolean]
+  #
+  # @api public
+  # @since 0.17.0
+  def key?(*key_path)
+    thread_safe_access { settings.__has_key__(*key_path) }
+  end
+  alias_method :option?, :key?
+  alias_method :setting?, :key?
+
   # @return [void]
   #
   # @api public
@@ -234,6 +309,41 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
     thread_safe_access { validator.validate! }
   end
 
+  # @param temporary_configurations [Hash<Symbol|String,Any>]
+  # @param arbitary_code [Block]
+  # @return [void]
+  #
+  # @api public
+  # @since 0.17.0
+  def with(temporary_configurations = {}, &arbitary_code)
+    with_arbitary_access do
+      begin
+        original_settings = @settings
+
+        temporary_settings = self.class.build.dup.tap do |copied_config|
+          copied_config.configure(temporary_configurations)
+        end.settings
+
+        @settings = temporary_settings
+        yield if block_given?
+      ensure
+        @settings = original_settings
+      end
+    end
+  end
+
+  # @return [Qonfig::DataSet]
+  #
+  # @api public
+  # @since 0.17.0
+  def dup
+    thread_safe_definition do
+      self.class.build.tap do |duplicate|
+        duplicate.configure(to_h)
+      end
+    end
+  end
+
   private
 
   # @return [Qonfig::Validator]
@@ -270,6 +380,16 @@ 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]
@@ -279,9 +399,33 @@ 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
 
+  # @param file_path [String, Symbol]
+  # @option format [String, Symbol]
+  # @option strict [Boolean]
+  # @option expose [NilClass, String, Symbol]
+  # @option callcer_location [NilClass, String]
+  # @return [void]
+  #
+  # @see Qonfig::Commands::Instantiation::ValuesFile
+  #
+  # @api private
+  # @since 0.17.0
+  def load_setting_values_from_file(
+    file_path,
+    format: :dynamic,
+    strict: true,
+    expose: nil,
+    caller_location: nil
+  )
+    Qonfig::Commands::Instantiation::ValuesFile.new(
+      file_path, caller_location, format: format, strict: strict, expose: expose
+    ).call(self, settings)
+  end
+
   # @param instructions [Proc]
   # @return [Object]
   #
@@ -299,4 +443,8 @@ class Qonfig::DataSet # rubocop:disable Metrics/ClassLength
   def thread_safe_definition(&instructions)
     @__lock__.thread_safe_definition(&instructions)
   end
+
+  def with_arbitary_access(&instructions)
+    @__lock__.with_arbitary_access(&instructions)
+  end
 end

data/lib/qonfig/dsl.rb

@@ -10,12 +10,16 @@ module Qonfig::DSL
     # @api private
     # @since 0.1.0
     def extended(child_klass)
-      child_klass.instance_variable_set(:@commands, Qonfig::CommandSet.new)
+      child_klass.instance_variable_set(:@definition_commands, Qonfig::CommandSet.new)
+      child_klass.instance_variable_set(:@instance_commands, Qonfig::CommandSet.new)
 
       child_klass.singleton_class.prepend(Module.new do
         def inherited(child_klass)
-          child_klass.instance_variable_set(:@commands, Qonfig::CommandSet.new)
-          child_klass.commands.concat(commands)
+          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)
           super
         end
       end)
@@ -25,9 +29,17 @@ module Qonfig::DSL
   # @return [Qonfig::CommandSet]
   #
   # @api private
-  # @since 0.1.0
-  def commands
-    @commands
+  # @since 0.17.0
+  def definition_commands
+    @definition_commands
+  end
+
+  # @return [Qonfig::CommandSet]
+  #
+  # @api private
+  # @since 0.17.0
+  def instance_commands
+    @instance_commands
   end
 
   # @param key [Symbol, String]
@@ -42,9 +54,9 @@ module Qonfig::DSL
   # @since 0.1.0
   def setting(key, initial_value = nil, &nested_settings)
     if block_given?
-      commands << Qonfig::Commands::AddNestedOption.new(key, nested_settings)
+      definition_commands << Qonfig::Commands::Definition::AddNestedOption.new(key, nested_settings)
     else
-      commands << Qonfig::Commands::AddOption.new(key, initial_value)
+      definition_commands << Qonfig::Commands::Definition::AddOption.new(key, initial_value)
     end
   end
 
@@ -56,7 +68,7 @@ module Qonfig::DSL
   # @api private
   # @sine 0.1.0
   def compose(data_set_klass)
-    commands << Qonfig::Commands::Compose.new(data_set_klass)
+    definition_commands << Qonfig::Commands::Definition::Compose.new(data_set_klass)
   end
 
   # @param file_path [String]
@@ -68,7 +80,9 @@ module Qonfig::DSL
   # @api public
   # @since 0.2.0
   def load_from_yaml(file_path, strict: true)
-    commands << Qonfig::Commands::LoadFromYAML.new(file_path, strict: strict)
+    definition_commands << Qonfig::Commands::Definition::LoadFromYAML.new(
+      file_path, strict: strict
+    )
   end
 
   # @return [void]
@@ -79,7 +93,10 @@ module Qonfig::DSL
   # @since 0.2.0
   def load_from_self(format: :yaml)
     caller_location = caller(1, 1).first
-    commands << Qonfig::Commands::LoadFromSelf.new(caller_location, format: format)
+
+    definition_commands << Qonfig::Commands::Definition::LoadFromSelf.new(
+      caller_location, format: format
+    )
   end
 
   # @option convert_values [Boolean]
@@ -91,7 +108,7 @@ module Qonfig::DSL
   # @api public
   # @since 0.2.0
   def load_from_env(convert_values: false, prefix: nil, trim_prefix: false)
-    commands << Qonfig::Commands::LoadFromENV.new(
+    definition_commands << Qonfig::Commands::Definition::LoadFromENV.new(
       convert_values: convert_values,
       prefix: prefix,
       trim_prefix: trim_prefix
@@ -105,7 +122,7 @@ module Qonfig::DSL
   # @api public
   # @since 0.5.0
   def load_from_json(file_path, strict: true)
-    commands << Qonfig::Commands::LoadFromJSON.new(file_path, strict: strict)
+    definition_commands << Qonfig::Commands::Definition::LoadFromJSON.new(file_path, strict: strict)
   end
 
   # @param file_path [String]
@@ -117,7 +134,9 @@ module Qonfig::DSL
   # @api public
   # @since 0.7.0
   def expose_yaml(file_path, strict: true, via:, env:)
-    commands << Qonfig::Commands::ExposeYAML.new(file_path, strict: strict, via: via, env: env)
+    definition_commands << Qonfig::Commands::Definition::ExposeYAML.new(
+      file_path, strict: strict, via: via, env: env
+    )
   end
 
   # @param file_path [String]
@@ -129,7 +148,9 @@ module Qonfig::DSL
   # @api public
   # @since 0.14.0
   def expose_json(file_path, strict: true, via:, env:)
-    commands << Qonfig::Commands::ExposeJSON.new(file_path, strict: strict, via: via, env: env)
+    definition_commands << Qonfig::Commands::Definition::ExposeJSON.new(
+      file_path, strict: strict, via: via, env: env
+    )
   end
 
   # @option env [Symbol, String]
@@ -141,6 +162,25 @@ module Qonfig::DSL
   # @since 0.14.0
   def expose_self(env:, format: :yaml)
     caller_location = caller(1, 1).first
-    commands << Qonfig::Commands::ExposeSelf.new(caller_location, env: env, format: format)
+
+    definition_commands << Qonfig::Commands::Definition::ExposeSelf.new(
+      caller_location, env: env, format: format
+    )
+  end
+
+  # @param file_path [String]
+  # @option format [String, Symbol]
+  # @option strict [Boolean]
+  # @option expose [NilClass, String, Symbol] Environment key
+  # @return [void]
+  #
+  # @api public
+  # @since 0.17.0
+  def values_file(file_path, format: :dynamic, strict: false, expose: nil)
+    caller_location = caller(1, 1).first
+
+    instance_commands << Qonfig::Commands::Instantiation::ValuesFile.new(
+      file_path, caller_location, format: format, strict: strict, expose: expose
+    )
   end
 end

data/lib/qonfig/errors.rb

@@ -47,8 +47,8 @@ module Qonfig
 
   # @see Qonfig::Settings
   # @see Qonfig::Settings::KeyGuard
-  # @see Qonfig::Commands::AddOption
-  # @see Qonfig::Commands::AddNestedOption
+  # @see Qonfig::Commands::Definition::AddOption
+  # @see Qonfig::Commands::Definition::AddNestedOption
   #
   # @api public
   # @since 0.2.0
@@ -69,24 +69,30 @@ module Qonfig
     # :nocov:
   end
 
-  # @see Qonfig::Commands::LoadFromYAML
+  # @see Qonfig::Commands::Instantiation::ValuesFile
+  #
+  # @api public
+  # @since 0.17.0
+  IncompatibleDataStructureError = Class.new(Error)
+
+  # @see Qonfig::Commands::Definition::LoadFromYAML
   #
   # @api public
   # @since 0.2.0
-  IncompatibleYAMLStructureError = Class.new(Error)
+  IncompatibleYAMLStructureError = Class.new(IncompatibleDataStructureError)
 
-  # @see Qonfig::Commands::LoadFromJSON
+  # @see Qonfig::Commands::Definition::LoadFromJSON
   #
   # @api public
   # @since 0.5.0
-  IncompatibleJSONStructureError = Class.new(Error)
+  IncompatibleJSONStructureError = Class.new(IncompatibleDataStructureError)
 
-  # @see Qonfig::Commands::LoadFromSelf
-  # @see Qonfig::Commands::ExposeSelf
+  # @see Qonfig::Commands::Definition::LoadFromSelf
+  # @see Qonfig::Commands::Definition::ExposeSelf
   #
   # @api public
   # @since 0.15.0
-  IncompatibleEndDataStructureError = Class.new(Error)
+  IncompatibleEndDataStructureError = Class.new(IncompatibleDataStructureError)
 
   # @see Qonfig::Loaders::YAML
   #
@@ -94,12 +100,33 @@ module Qonfig
   # @since 0.2.0
   FileNotFoundError = Class.new(Errno::ENOENT)
 
-  # @see Qonfig::Commands::LoadFromSelf
+  # @see Qonfig::Commands::Definition::LoadFromSelf
+  # @see Qonfig::Loaders::EndData
   #
   # @api public
   # @since 0.2.0
   SelfDataNotFoundError = Class.new(Error)
 
+  # @see Qonfig::Loaders::JSON
+  # @see Qonfig::Loaders::Dynamic
+  #
+  # @api public
+  # @since 0.17.0
+  JSONLoaderParseError = Class.new(::JSON::ParserError)
+
+  # @see Qonfig::Loaders::YAML
+  # @see Qonfig::Loaders::Dynamic
+  #
+  # @api public
+  # @since 0.17.0
+  YAMLLoaderParseError = Class.new(::Psych::SyntaxError)
+
+  # @see Qonfig::Loaders::Dynamic
+  #
+  # @api public
+  # @since 0.17.0
+  DynamicLoaderParseError = Class.new(Error)
+
   # @see Qonfig::Plugins::Regsitry
   #
   # @api private
@@ -112,7 +139,7 @@ module Qonfig
   # @since 0.4.0
   UnregisteredPluginError = Class.new(Error)
 
-  # @see Qonfig::Commands::ExposeYAML
+  # @see Qonfig::Commands::Definition::ExposeYAML
   #
   # @api public
   # @since 0.7.0

data/lib/qonfig/loaders/dynamic.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.17.0
+class Qonfig::Loaders::Dynamic < Qonfig::Loaders::Basic
+  class << self
+    # @param data [String]
+    # @return [Object]
+    #
+    # @raise [Qonfig::DynamicLoaderParseError]
+    #
+    # @api private
+    # @since 0.17.0
+    def load(data)
+      try_to_load_json_data(data)
+    rescue Qonfig::JSONLoaderParseError
+      begin
+        try_to_load_yaml_data(data)
+      rescue Qonfig::YAMLLoaderParseError
+        raise Qonfig::DynamicLoaderParseError, 'File data has unknown format'
+      end
+    end
+
+    # @return [Hash]
+    #
+    # @api private
+    # @since 0.17.0
+    def load_empty_data
+      {}
+    end
+
+    private
+
+    # @param data [String]
+    # @return [Object]
+    #
+    # @api private
+    # @since 0.17.0
+    def try_to_load_yaml_data(data)
+      Qonfig::Loaders::YAML.load(data)
+    end
+
+    # @param data [String]
+    # @return [Object]
+    #
+    # @api private
+    # @since 0.17.0
+    def try_to_load_json_data(data)
+      Qonfig::Loaders::JSON.load(data)
+    end
+  end
+end

data/lib/qonfig/loaders/json.rb

@@ -7,10 +7,16 @@ class Qonfig::Loaders::JSON < Qonfig::Loaders::Basic
     # @param data [String]
     # @return [Object]
     #
+    # @raise [Qonfig::JSONLoaderParseError]
+    #
     # @api private
     # @since 0.5.0
     def load(data)
       ::JSON.parse(data, max_nesting: false, allow_nan: true)
+    rescue ::JSON::ParserError => error
+      raise(Qonfig::JSONLoaderParseError.new(error.message).tap do |exception|
+        exception.set_backtrace(error.backtrace)
+      end)
     end
 
     # @return [Object]

data/lib/qonfig/loaders/yaml.rb

@@ -7,10 +7,23 @@ class Qonfig::Loaders::YAML < Qonfig::Loaders::Basic
     # @param data [String]
     # @return [Object]
     #
+    # @raise [Qonfig::YAMLLoaderParseError]
+    #
     # @api private
     # @since 0.2.0
     def load(data)
       ::YAML.load(ERB.new(data).result)
+    rescue ::Psych::SyntaxError => error
+      raise(
+        Qonfig::YAMLLoaderParseError.new(
+          error.file,
+          error.line,
+          error.column,
+          error.offset,
+          error.problem,
+          error.context
+        ).tap { |exception| exception.set_backtrace(error.backtrace) }
+      )
     end
 
     # @return [Object]

data/lib/qonfig/loaders.rb

@@ -6,6 +6,7 @@ module Qonfig::Loaders
   require_relative 'loaders/basic'
   require_relative 'loaders/json'
   require_relative 'loaders/yaml'
+  require_relative 'loaders/dynamic'
   require_relative 'loaders/end_data'
 
   class << self
@@ -22,6 +23,8 @@ module Qonfig::Loaders
         Qonfig::Loaders::YAML
       when 'json'
         Qonfig::Loaders::JSON
+      when 'dynamic'
+        Qonfig::Loaders::Dynamic
       else
         raise(Qonfig::UnsupportedLoaderFormatError, "<#{format}> format is not supported.")
       end

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

@@ -16,4 +16,17 @@ class Qonfig::DataSet
     end
   end
   alias_method :dump_to_toml, :save_to_toml
+
+  # @param file_path [String]
+  # @option strict [Boolean]
+  # @option expose [NilClass, String, Symbol] Environment key
+  # @return [void]
+  #
+  # @see Qonfig::DataSet#load_from_file
+  #
+  # @api public
+  # @since 0.17.0
+  def load_from_toml(file_path, strict: true, expose: nil)
+    load_from_file(file_path, format: :toml, strict: strict, expose: expose)
+  end
 end

data/lib/qonfig/plugins/toml/dsl.rb

@@ -10,7 +10,9 @@ module Qonfig::DSL
   # @api public
   # @since 0.12.0
   def load_from_toml(file_path, strict: true)
-    commands << Qonfig::Commands::LoadFromTOML.new(file_path, strict: strict)
+    definition_commands << Qonfig::Commands::LoadFromTOML.new(
+      file_path, strict: strict
+    )
   end
 
   # @param file_path [String]
@@ -22,6 +24,8 @@ module Qonfig::DSL
   # @api public
   # @since 0.12.0
   def expose_toml(file_path, strict: true, via:, env:)
-    commands << Qonfig::Commands::ExposeTOML.new(file_path, strict: strict, via: via, env: env)
+    definition_commands << Qonfig::Commands::ExposeTOML.new(
+      file_path, strict: strict, via: via, env: env
+    )
   end
 end

data/lib/qonfig/plugins/toml/errors.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# @api public
+# @since 0.17.0
+module Qonfig
+  # @see Qonfig::Loaders::TOML
+  # @see Qondig::Loaders::Dynamic
+  #
+  # @api public
+  # @since 0.17.0
+  TOMLLoaderParseError = Class.new(::TomlRB::ParseError)
+end

data/lib/qonfig/plugins/toml/loaders/dynamic.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.17.0
+class Qonfig::Loaders::Dynamic < Qonfig::Loaders::Basic
+  class << self
+    prepend(Module.new do
+      # @param data [String]
+      # @return [Object]
+      #
+      # @api private
+      # @since 0.17.0
+      def load(data)
+        try_to_load_toml_data(data)
+      rescue Qonfig::TOMLLoaderParseError
+        super(data)
+      end
+
+      private
+
+      # @param data [String]
+      # @return [Object]
+      #
+      # @api private
+      # @since 0.17.0
+      def try_to_load_toml_data(data)
+        Qonfig::Loaders::TOML.load(data)
+      end
+    end)
+  end
+end

data/lib/qonfig/plugins/toml/loaders/toml.rb

@@ -7,10 +7,16 @@ class Qonfig::Loaders::TOML < Qonfig::Loaders::Basic
     # @param data [String]
     # @return [Object]
     #
+    # @raise [Qonfig::TOMLLoaderParseError]
+    #
     # @api private
     # @since 0.12.0
     def load(data)
       ::TomlRB.parse(ERB.new(data).result)
+    rescue ::TomlRB::ParseError => error
+      raise(Qonfig::TOMLLoaderParseError.new(error.message).tap do |exception|
+        exception.set_backtrace(error.backtrace)
+      end)
     end
 
     # @return [Object]

data/lib/qonfig/plugins/toml.rb

@@ -15,8 +15,10 @@ class Qonfig::Plugins::TOML < Qonfig::Plugins::Abstract
       ) unless const_defined?('::TomlRB')
 
       require_relative 'toml/tomlrb_fixes'
+      require_relative 'toml/errors'
       require_relative 'toml/loaders'
       require_relative 'toml/loaders/toml'
+      require_relative 'toml/loaders/dynamic'
       require_relative 'toml/uploaders/toml'
       require_relative 'toml/commands/load_from_toml'
       require_relative 'toml/commands/expose_toml'

data/lib/qonfig/settings/builder.rb

@@ -11,7 +11,7 @@ module Qonfig::Settings::Builder
     # @since 0.2.0
     def build(data_set)
       Qonfig::Settings.new(build_mutation_callbacks(data_set)).tap do |settings|
-        data_set.class.commands.dup.each do |command|
+        data_set.class.definition_commands.dup.each do |command|
           command.call(data_set, settings)
         end
       end