qonfig 0.0.0 → 0.12.0

data/lib/qonfig/data_set.rb

@@ -0,0 +1,213 @@
+# frozen_string_literal: true
+
+# @api public
+# @since 0.1.0
+class Qonfig::DataSet
+  require_relative 'data_set/class_builder'
+  require_relative 'data_set/validator'
+
+  # @since 0.1.0
+  extend Qonfig::DSL
+
+  # @return [Qonfig::Settings]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :settings
+
+  # @param options_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) }
+  end
+
+  # @return [void]
+  #
+  # @api public
+  # @since 0.1.0
+  def freeze!
+    thread_safe_access { settings.__freeze__ }
+  end
+
+  # @return [void]
+  #
+  # @api public
+  # @since 0.2.0
+  def frozen?
+    thread_safe_access { settings.__is_frozen__ }
+  end
+
+  # @param options_map [Hash]
+  # @param configurations [Proc]
+  # @return [void]
+  #
+  # @raise [Qonfig::FrozenSettingsError]
+  #
+  # @api public
+  # @since 0.2.0
+  def reload!(options_map = {}, &configurations)
+    thread_safe_definition do
+      raise Qonfig::FrozenSettingsError, 'Frozen config can not be reloaded' if frozen?
+      load!(options_map, &configurations)
+    end
+  end
+
+  # @param options_map [Hash]
+  # @return [void]
+  #
+  # @api public
+  # @since 0.1.0
+  def configure(options_map = {})
+    thread_safe_access do
+      settings.__apply_values__(options_map)
+      yield(settings) if block_given?
+    end
+  end
+
+  # @option key_transformer [Proc]
+  # @option value_transformer [Proc]
+  # @return [Hash]
+  #
+  # @api public
+  # @since 0.1.0
+  def to_h(
+    key_transformer: Qonfig::Settings::BASIC_SETTING_KEY_TRANSFORMER,
+    value_transformer: Qonfig::Settings::BASIC_SETTING_VALUE_TRANSFORMER
+  )
+    thread_safe_access do
+      settings.__to_hash__(
+        transform_key: key_transformer,
+        transform_value: value_transformer
+      )
+    end
+  end
+  alias_method :to_hash, :to_h
+
+  # @option path [String]
+  # @option options [Hash<Symbol|String,Any>] Native (ruby-stdlib) ::JSON#generate attributes
+  # @param value_processor [Block]
+  # @return [void]
+  #
+  # @api public
+  # @since 0.11.0
+  def save_to_json(path:, options: Qonfig::Uploaders::JSON::DEFAULT_OPTIONS, &value_processor)
+    thread_safe_access do
+      Qonfig::Uploaders::JSON.upload(settings, path: path, options: options, &value_processor)
+    end
+  end
+  alias_method :dump_to_json, :save_to_json
+
+  # @option path [String]
+  # @option symbolize_keys [Boolean]
+  # @option options [Hash<Symbol|String,Any>] Native (ruby-stdlib) ::YAML#dump attributes
+  # @param value_processor [Block]
+  # @return [void]
+  #
+  # @api public
+  # @since 0.11.0
+  def save_to_yaml(
+    path:,
+    symbolize_keys: false,
+    options: Qonfig::Uploaders::YAML::DEFAULT_OPTIONS,
+    &value_processor
+  )
+    thread_safe_access do
+      Qonfig::Uploaders::YAML.upload(
+        settings,
+        path: path,
+        options: options.merge(symbolize_keys: symbolize_keys),
+        &value_processor
+      )
+    end
+  end
+  alias_method :dump_to_yaml, :save_to_yaml
+
+  # @param key [String, Symbol]
+  # @return [Object]
+  #
+  # @api public
+  # @since 0.2.0
+  def [](key)
+    thread_safe_access { settings[key] }
+  end
+
+  # @param keys [Array<String, Symbol>]
+  # @return [Object]
+  #
+  # @api public
+  # @since 0.2.0
+  def dig(*keys)
+    thread_safe_access { settings.__dig__(*keys) }
+  end
+
+  # @param keys [Array<String, Symbol>]
+  # @return [Hash]
+  #
+  # @api public
+  # @since 0.9.0
+  def slice(*keys)
+    thread_safe_access { settings.__slice__(*keys) }
+  end
+
+  # @param keys [Array<String, Symbol>]
+  # @return [Hash,Any]
+  #
+  # @api public
+  # @since 0.10.0
+  def slice_value(*keys)
+    thread_safe_access { settings.__slice_value__(*keys) }
+  end
+
+  # @return [void]
+  #
+  # @api public
+  # @since 0.2.0
+  def clear!
+    thread_safe_access { settings.__clear__ }
+  end
+
+  private
+
+  # @return [Qonfig::Settings]
+  #
+  # @api private
+  # @since 0.2.0
+  def build_settings
+    Qonfig::Settings::Builder.build(self.class.commands.dup)
+  end
+
+  # @param options_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)
+  end
+
+  # @param instructions [Proc]
+  # @return [Object]
+  #
+  # @api private
+  # @since 0.2.0
+  def thread_safe_access(&instructions)
+    @__access_lock__.synchronize(&instructions)
+  end
+
+  # @param instructions [Proc]
+  # @return [Object]
+  #
+  # @api private
+  # @since 0.2.0
+  def thread_safe_definition(&instructions)
+    @__definition_lock__.synchronize(&instructions)
+  end
+end

data/lib/qonfig/data_set/class_builder.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.2.0
+module Qonfig::DataSet::ClassBuilder
+  class << self
+    # @param hash [Hash]
+    # @return [Class<Qonfig::DataSet>]
+    #
+    # @see Qonfig::DataSet
+    #
+    # @api private
+    # @since 0.2.0
+    def build_from_hash(hash)
+      Class.new(Qonfig::DataSet).tap do |data_set_klass|
+        hash.each_pair do |key, value|
+          if value.is_a?(Hash) && value.any?
+            sub_data_set_klass = build_from_hash(value)
+            data_set_klass.setting(key) { compose sub_data_set_klass }
+          else
+            data_set_klass.setting key, value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/qonfig/data_set/validator.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# @api public
+# @since 0.?.0
+class Qonfig::DataSet::Validator
+  # TODO: think about validation layer
+end

data/lib/qonfig/dsl.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+module Qonfig::DSL
+  class << self
+    # @param child_klass [Qonfig::DataSet]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    def extended(child_klass)
+      child_klass.instance_variable_set(:@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)
+          super
+        end
+      end)
+    end
+  end
+
+  # @return [Qonfig::CommandSet]
+  #
+  # @api private
+  # @since 0.1.0
+  def commands
+    @commands
+  end
+
+  # @param key [Symbol, String]
+  # @param initial_value [Object]
+  # @param nested_settings [Proc]
+  # @return [void]
+  #
+  # @see Qonfig::Commands::AddNestedOption
+  # @see Qonfig::Commands::AddOption
+  #
+  # @api public
+  # @since 0.1.0
+  def setting(key, initial_value = nil, &nested_settings)
+    if block_given?
+      commands << Qonfig::Commands::AddNestedOption.new(key, nested_settings)
+    else
+      commands << Qonfig::Commands::AddOption.new(key, initial_value)
+    end
+  end
+
+  # @param data_set_klass [Class<Qonfig::DataSet>]
+  # @return [void]
+  #
+  # @see Qonfig::Comamnds::Compose
+  #
+  # @api private
+  # @sine 0.1.0
+  def compose(data_set_klass)
+    commands << Qonfig::Commands::Compose.new(data_set_klass)
+  end
+
+  # @param file_path [String]
+  # @option strict [Boolean]
+  # @return [void]
+  #
+  # @see Qonfig::Commands::LoadFromYAML
+  #
+  # @api public
+  # @since 0.2.0
+  def load_from_yaml(file_path, strict: true)
+    commands << Qonfig::Commands::LoadFromYAML.new(file_path, strict: strict)
+  end
+
+  # @return [void]
+  #
+  # @see Qonfig::Commands::LoadFromSelf
+  #
+  # @api public
+  # @since 0.2.0
+  def load_from_self
+    caller_location = caller(1, 1).first
+    commands << Qonfig::Commands::LoadFromSelf.new(caller_location)
+  end
+
+  # @option convert_values [Boolean]
+  # @option prefix [NilClass, String, Regexp]
+  # @return [void]
+  #
+  # @see Qonfig::Commands::LoadFromENV
+  #
+  # @api public
+  # @since 0.2.0
+  def load_from_env(convert_values: false, prefix: nil, trim_prefix: false)
+    commands << Qonfig::Commands::LoadFromENV.new(
+      convert_values: convert_values,
+      prefix: prefix,
+      trim_prefix: trim_prefix
+    )
+  end
+
+  # @param file_path [String]
+  # @option strict [Boolean]
+  # @return [void]
+  #
+  # @api public
+  # @since 0.5.0
+  def load_from_json(file_path, strict: true)
+    commands << Qonfig::Commands::LoadFromJSON.new(file_path, strict: strict)
+  end
+
+  # @param file_path [String]
+  # @option strict [Boolean]
+  # @option via [Symbol]
+  # @option env [Symbol, String]
+  # @return [void]
+  #
+  # @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)
+  end
+end

data/lib/qonfig/errors.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module Qonfig
+  # @api public
+  # @since 0.1.0
+  Error = Class.new(StandardError)
+
+  # @api public
+  # @since 0.1.0
+  ArgumentError = Class.new(ArgumentError)
+
+  # @api public
+  # @since 0.12.0
+  PluginError = Class.new(Error)
+
+  # @api public
+  # @since 0.11.0
+  IncorrectHashTransformationError = Class.new(ArgumentError)
+
+  # @api public
+  # @since 0.11.0
+  IncorrectKeyTransformerError = Class.new(IncorrectHashTransformationError)
+
+  # @api public
+  # @since 0.11.0
+  IncorrectValueTransformerError = Class.new(IncorrectHashTransformationError)
+
+  # @see Qonfig::Settings
+  #
+  # @api public
+  # @since 0.1.0
+  UnknownSettingError = Class.new(Error)
+
+  # @see Qonfig::Settings
+  #
+  # @api public
+  # @since 0.2.0
+  AmbiguousSettingValueError = Class.new(Error)
+
+  # @see Qonfig::Settings
+  # @see Qonfig::Settings::KeyGuard
+  # @see Qonfig::Commands::AddOption
+  # @see Qonfig::Commands::AddNestedOption
+  #
+  # @api public
+  # @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
+    # :nocov:
+    if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.5.0')
+      Class.new(::FrozenError)
+    else
+      Class.new(::RuntimeError)
+    end
+    # :nocov:
+  end
+
+  # @see Qonfig::Commands::LoadFromYAML
+  #
+  # @api public
+  # @since 0.2.0
+  IncompatibleYAMLStructureError = Class.new(Error)
+
+  # @see Qonfig::Commands::LoadFromJSON
+  #
+  # @api public
+  # @since 0.5.0
+  IncompatibleJSONStructureError = Class.new(Error)
+
+  # @see Qonfig::Loaders::YAML
+  #
+  # @api public
+  # @since 0.2.0
+  FileNotFoundError = Class.new(Errno::ENOENT)
+
+  # @see Qonfig::Commands::LoadFromSelf
+  #
+  # @api public
+  # @since 0.2.0
+  SelfDataNotFoundError = Class.new(Error)
+
+  # @see Qonfig::Plugins::Regsitry
+  #
+  # @api private
+  # @since 0.4.0
+  AlreadyRegisteredPluginError = Class.new(Error)
+
+  # @see Qonfig::Plugins::Registry
+  #
+  # @api public
+  # @since 0.4.0
+  UnregisteredPluginError = Class.new(Error)
+
+  # @see Qonfig::Commands::ExposeYAML
+  #
+  # @api public
+  # @since 0.7.0
+  ExposeError = Class.new(Error)
+
+  # @see Qonfig::Plugin::TOMLFormat
+  #
+  # @api public
+  # @since 0.12.0
+  UnresolvedPluginDependencyError = Class.new(PluginError)
+end