qonfig 0.0.0 → 0.12.0

data/lib/qonfig/loaders.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.2.0
+module Qonfig::Loaders
+  require_relative 'loaders/basic'
+  require_relative 'loaders/json'
+  require_relative 'loaders/yaml'
+end

data/lib/qonfig/loaders/basic.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.2.0
+class Qonfig::Loaders::Basic
+  class << self
+    # @param data [String]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.5.0
+    def load(data)
+      nil # NOTE: consciously return nil (for clarity)
+    end
+
+    # @return [void]
+    #
+    # @api private
+    # @since 0.5.0
+    def load_empty_data
+      nil # NOTE: consciously return nil (for clarity)
+    end
+
+    # @param file_path [String]
+    # @option fail_on_unexist [Boolean]
+    # @return [Object]
+    #
+    # @raise [Qonfig::FileNotFoundError]
+    #
+    # @api private
+    # @since 0.5.0
+    def load_file(file_path, fail_on_unexist: true)
+      load(::File.read(file_path))
+    rescue Errno::ENOENT => error
+      fail_on_unexist ? (raise Qonfig::FileNotFoundError, error.message) : load_empty_data
+    end
+  end
+end

data/lib/qonfig/loaders/json.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.5.0
+class Qonfig::Loaders::JSON < Qonfig::Loaders::Basic
+  class << self
+    # @param data [String]
+    # @return [Object]
+    #
+    # @api private
+    # @since 0.5.0
+    def load(data)
+      ::JSON.parse(data, max_nesting: false, allow_nan: true)
+    end
+
+    # @return [Object]
+    #
+    # @api private
+    # @since 0.5.0
+    def load_empty_data
+      load('{}')
+    end
+  end
+end

data/lib/qonfig/loaders/yaml.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.2.0
+class Qonfig::Loaders::YAML < Qonfig::Loaders::Basic
+  class << self
+    # @param data [String]
+    # @return [Object]
+    #
+    # @api private
+    # @since 0.2.0
+    def load(data)
+      ::YAML.load(ERB.new(data).result)
+    end
+
+    # @return [Object]
+    #
+    # @api private
+    # @since 0.5.0
+    def load_empty_data
+      load('{}')
+    end
+  end
+end

data/lib/qonfig/plugins.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+# @api public
+# @since 0.4.0
+module Qonfig::Plugins
+  require_relative 'plugins/registry'
+  require_relative 'plugins/access_mixin'
+  require_relative 'plugins/abstract'
+  require_relative 'plugins/toml'
+
+  # @since 0.4.0
+  @plugin_registry = Registry.new
+  # @since 0.4.0
+  @access_lock = Mutex.new
+
+  class << self
+    # @param plugin_name [Symbol, String]
+    # @return [void]
+    #
+    # @api public
+    # @since 0.4.0
+    def load(plugin_name)
+      thread_safe { plugin_registry[plugin_name].load! }
+    end
+
+    # @return [Array<String>]
+    #
+    # @api public
+    # @since 0.4.0
+    def names
+      thread_safe { plugin_registry.names }
+    end
+
+    # @param plugin_name [Symbol, String]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.4.0
+    def register_plugin(plugin_name, plugin_module)
+      thread_safe { plugin_registry[plugin_name] = plugin_module }
+    end
+
+    private
+
+    # @return [Qonfig::Plugins::Registry]
+    #
+    # @api private
+    # @since 0.4.0
+    attr_reader :plugin_registry
+
+    # @return [Mutex]
+    #
+    # @api private
+    # @since 0.4.0
+    attr_reader :access_lock
+
+    # @return [void]
+    #
+    # @api private
+    # @since 0.4.0
+    def thread_safe
+      access_lock.synchronize { yield if block_given? }
+    end
+  end
+end

data/lib/qonfig/plugins/abstract.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.4.0
+class Qonfig::Plugins::Abstract
+  class << self
+    # @return [void]
+    #
+    # @api private
+    # @since 0.4.0
+    def load!; end
+  end
+end

data/lib/qonfig/plugins/access_mixin.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.4.0
+module Qonfig::Plugins::AccessMixin
+  # @param plugin_name [Symbol, String]
+  # @return [void]
+  #
+  # @see Qonfig::Plugins
+  #
+  # @api public
+  # @since 0.4.0
+  def plugin(plugin_name)
+    Qonfig::Plugins.load(plugin_name)
+  end
+
+  # @return [Array<String>]
+  #
+  # @see Qonfig::Plugins
+  #
+  # @api public
+  # @since 0.4.0
+  def plugins
+    Qonfig::Plugins.names
+  end
+
+  # @param plugin_name [String, Symbol]
+  # @param plugin_klass [Class<Qonfig::Plugins::Abstract>]
+  # @return [void]
+  #
+  # @see Qonfig::Plugins
+  #
+  # @api public
+  # @since 0.12.0
+  def register_plugin(plugin_name, plugin_klass)
+    Qonfig::Plugins.register_plugin(plugin_name, plugin_klass)
+  end
+end

data/lib/qonfig/plugins/registry.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.4.0
+class Qonfig::Plugins::Registry
+  # @return [void]
+  #
+  # @api private
+  # @since 0.4.0
+  def initialize
+    @plugin_set = {}
+    @access_lock = Mutex.new
+  end
+
+  # @param plugin_name [Symbol, String]
+  # @return [Qonfig::Plugins::Abstract]
+  #
+  # @api private
+  # @since 0.4.0
+  def [](plugin_name)
+    thread_safe { fetch(plugin_name) }
+  end
+
+  # @param plugin_name [Symbol, String]
+  # @param plugin_module [Qonfig::Plugins::Abstract]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.4.0
+  def register(plugin_name, plugin_module)
+    thread_safe { apply(plugin_name, plugin_module) }
+  end
+  alias_method :[]=, :register
+
+  # @return [Array<String>]
+  #
+  # @api private
+  # @since 0.4.0
+  def names
+    thread_safe { plugin_names }
+  end
+
+  private
+
+  # @return [Hash]
+  #
+  # @api private
+  # @since 0.4.0
+  attr_reader :plugin_set
+
+  # @return [Mutex]
+  #
+  # @api private
+  # @since 0.4.0
+  attr_reader :access_lock
+
+  # @return [void]
+  #
+  # @api private
+  # @since 0.4.0
+  def thread_safe
+    access_lock.synchronize { yield if block_given? }
+  end
+
+  # @return [Array<String>]
+  #
+  # @api private
+  # @since 0.4.0
+  def plugin_names
+    plugin_set.keys
+  end
+
+  # @param plugin_name [String]
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.4.0
+  def registered?(plugin_name)
+    plugin_set.key?(plugin_name)
+  end
+
+  # @param plugin_name [Symbol, String]
+  # @param plugin_module [Qonfig::Plugins::Abstract]
+  # @return [void]
+  #
+  # @raise [Qonfig::AlreadyRegisteredPluginError]
+  #
+  # @api private
+  # @since 0.4.0
+  def apply(plugin_name, plugin_module)
+    plugin_name = indifferently_accessable_plugin_name(plugin_name)
+
+    if registered?(plugin_name)
+      raise Qonfig::AlreadyRegisteredPluginError, "#{plugin_name} plugin already exist"
+    end
+
+    plugin_set[plugin_name] = plugin_module
+  end
+
+  # @param plugin_name [Symbol, String]
+  # @return [Qonfig::Plugins::Abstract]
+  #
+  # @raise [Qonfig::UnregisteredPluginError]
+  #
+  # @api private
+  # @since 0.4.0
+  def fetch(plugin_name)
+    plugin_name = indifferently_accessable_plugin_name(plugin_name)
+
+    unless registered?(plugin_name)
+      raise Qonfig::UnregisteredPluginError, "#{plugin_name} plugin is not registered"
+    end
+
+    plugin_set[plugin_name]
+  end
+
+  # @param key [Symbol, String]
+  # @return [String]
+  #
+  # @api private
+  # @since 0.4.0
+  def indifferently_accessable_plugin_name(plugin_name)
+    plugin_name.to_s
+  end
+end

data/lib/qonfig/plugins/toml.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.12.0
+class Qonfig::Plugins::TOML < Qonfig::Plugins::Abstract
+  class << self
+    # @return [void]
+    #
+    # @api private
+    # @since 0.12.0
+    def load!
+      raise(
+        Qonfig::UnresolvedPluginDependencyError,
+        '::TomlRB does not exist or "toml-rb" gem is not loaded'
+      ) unless const_defined?('::TomlRB')
+
+      require_relative 'toml/tomlrb_fixes'
+      require_relative 'toml/loaders/toml'
+      require_relative 'toml/uploaders/toml'
+      require_relative 'toml/commands/load_from_toml'
+      require_relative 'toml/commands/expose_toml'
+      require_relative 'toml/data_set'
+      require_relative 'toml/dsl'
+    end
+  end
+end

data/lib/qonfig/plugins/toml/commands/expose_toml.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.12.0
+class Qonfig::Commands::ExposeTOML < Qonfig::Commands::Base
+  # @return [Hash]
+  #
+  # @api private
+  # @since 0.12.0
+  EXPOSERS = { file_name: :file_name, env_key: :env_key }.freeze
+
+  # @return [Hash]
+  #
+  # @api private
+  # @since 0.12.0
+  EMPTY_TOML_DATA = {}.freeze
+
+  # @return [String]
+  #
+  # @api private
+  # @since 0.12.0
+  attr_reader :file_path
+
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.12.0
+  attr_reader :strict
+
+  # @return [Symbol]
+  #
+  # @api private
+  # @since 0.12.0
+  attr_reader :via
+
+  # @return [Symbol, String]
+  #
+  # @api private
+  # @since 0.12.0
+  attr_reader :env
+
+  # @param file_path [String]
+  # @option strict [Boolean]
+  # @option via [Symbol]
+  # @option env [String, Symbol]
+  #
+  # @api private
+  # @since 0.12.0
+  def initialize(file_path, strict: true, via:, env:)
+    unless env.is_a?(Symbol) || env.is_a?(String) || env.is_a?(Numeric)
+      raise Qonfig::ArgumentError, ':env should be a string or a symbol'
+    end
+
+    raise Qonfig::ArgumentError, ':env should be provided'  if env.to_s.empty?
+    raise Qonfig::ArgumentError, 'used :via is unsupported' unless EXPOSERS.key?(via)
+
+    @file_path = file_path
+    @strict    = strict
+    @via       = via
+    @env       = env
+  end
+
+  # @param settings [Qonfig::Settings]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.12.0
+  def call(settings)
+    case via
+    when EXPOSERS[:file_name]
+      expose_file_name!(settings)
+    when EXPOSERS[:env_key]
+      expose_env_key!(settings)
+    end
+  end
+
+  private
+
+  # @param settings [Qonfig::Settings]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.12.0
+  # rubocop:disable Metrics/AbcSize
+  def expose_file_name!(settings)
+    # NOTE: transform file name (insert environment name into the file name)
+    #   from: path/to/file/file_name.file_extension
+    #   to:   path/to/file/file_name.env_name.file_extension
+
+    pathname = Pathname.new(file_path)
+    dirname  = pathname.dirname
+    extname  = pathname.extname.to_s
+    basename = pathname.basename.to_s.sub!(extname, '')
+    envname  = [env.to_s, extname].reject(&:empty?).join('')
+    envfile  = [basename, envname].reject(&:empty?).join('.')
+    realfile = dirname.join(envfile).to_s
+
+    toml_data = load_toml_data(realfile)
+    toml_based_settings = build_data_set_class(toml_data).new.settings
+
+    settings.__append_settings__(toml_based_settings)
+  end
+  # rubocop:enable Metrics/AbcSize
+
+  # @param settings [Qonfig::Settings]
+  # @return [void]
+  #
+  # @raise [Qonfig::ExposeError]
+  #
+  # @api private
+  # @since 0.12.0
+  # rubocop:disable Metrics/AbcSize
+  def expose_env_key!(settings)
+    toml_data       = load_toml_data(file_path)
+    toml_data_slice = toml_data[env] || toml_data[env.to_s] || toml_data[env.to_sym]
+    toml_data_slice = EMPTY_TOML_DATA.dup if toml_data_slice.nil? && !strict
+
+    raise(
+      Qonfig::ExposeError,
+      "#{file_path} file does not contain settings with <#{env}> environment key!"
+    ) unless toml_data_slice
+
+    toml_based_settings = build_data_set_class(toml_data_slice).new.settings
+
+    settings.__append_settings__(toml_based_settings)
+  end
+  # rubocop:enable Metrics/AbcSize
+
+  # @param file_path [String]
+  # @return [Hash]
+  #
+  # @api private
+  # @since 0.12.0
+  def load_toml_data(file_path)
+    Qonfig::Loaders::TOML.load_file(file_path, fail_on_unexist: strict)
+  end
+
+  # @param toml_data [Hash]
+  # @return [Class<Qonfig::DataSet>]
+  #
+  # @api private
+  # @since 0.12.0
+  def build_data_set_class(toml_data)
+    Qonfig::DataSet::ClassBuilder.build_from_hash(toml_data)
+  end
+end