qonfig 0.21.0 → 0.25.0

data/lib/qonfig/plugins/vault.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.25.0
+class Qonfig::Plugins::Vault < Qonfig::Plugins::Abstract
+  class << self
+    # @return [void]
+    #
+    # @api private
+    # @since 0.25.0
+    def install!
+      raise(
+        Qonfig::UnresolvedPluginDependencyError,
+        '::Vault does not exist or "vault" gem is not loaded'
+      ) unless const_defined?('::Vault')
+
+      require_relative 'vault/errors'
+      require_relative 'vault/loaders/vault'
+      require_relative 'vault/commands/definition/load_from_vault'
+      require_relative 'vault/commands/definition/expose_vault'
+      require_relative 'vault/dsl'
+    end
+  end
+end

data/lib/qonfig/plugins/vault/commands/definition/expose_vault.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.25.0
+class Qonfig::Commands::Definition::ExposeVault < Qonfig::Commands::Base
+  # @since 0.25.0
+  self.inheritable = true
+
+  # @return [Hash<Symbol,Symbol>]
+  #
+  # @api private
+  # @since 0.25.0
+  EXPOSERS = { path: :path, env_key: :env_key }.freeze
+
+  # @return [Hash]
+  #
+  # @api private
+  # @since 0.25.0
+  EMPTY_VAULT_DATA = {}.freeze
+
+  # @return [String, Pathname]
+  #
+  # @api private
+  # @since 0.25.0
+  attr_reader :path
+
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.25.0
+  attr_reader :strict
+
+  # @return [Symbol]
+  #
+  # @api private
+  # @since 0.25.0
+  attr_reader :via
+
+  # @return [Symbol, String]
+  #
+  # @api private
+  # @since 0.25.0
+  attr_reader :env
+
+  # @param path [String Pathname]
+  # @option strict [Boolean]
+  # @option via [Symbol]
+  # @option env [String, Symbol]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.25.0
+  def initialize(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)
+
+    @path   = path
+    @strict = strict
+    @via    = via
+    @env    = env
+  end
+
+  # @param data_set [Qonfig::DataSet]
+  # @param settings [Qonfig::Settings]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.25.0
+  def call(_data_set, settings)
+    case via
+    when EXPOSERS[:path]
+      expose_path!(settings)
+    when EXPOSERS[:env_key]
+      expose_env_key!(settings)
+    end
+  end
+
+  private
+
+  # @param settings [Qonfig::Settings]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.25.0
+  def expose_path!(settings)
+    # NOTE: transform path (insert environment name into a secret name)
+    #   from: kv/data/secret_name
+    #   to:   kv/data/env_name/secret_name
+
+    splitted_path = path.split('/')
+    real_path = splitted_path.insert(-2, env.to_s).join('/')
+
+    vault_data = load_vault_data(real_path)
+    vault_based_settings = build_data_set_class(vault_data).new.settings
+
+    settings.__append_settings__(vault_based_settings)
+  end
+
+  # @param settings [Qonfig::Settings]
+  # @return [void]
+  #
+  # @raise [Qonfig::ExposeError]
+  #
+  # @api private
+  # @since 0.25.0
+  def expose_env_key!(settings)
+    vault_data       = load_vault_data(path)
+    vault_data_slice = vault_data[env.to_sym]
+    vault_data_slice = EMPTY_VAULT_DATA.dup if vault_data_slice.nil? && !strict
+
+    raise(
+      Qonfig::ExposeError,
+      "#{path} does not contain settings with <#{env}> environment key!"
+    ) unless vault_data_slice
+
+    vault_based_settings = build_data_set_class(vault_data_slice).new.settings
+
+    settings.__append_settings__(vault_based_settings)
+  end
+
+  # @param path [String]
+  # @return [Hash]
+  #
+  # @api private
+  # @since 0.25.0
+  def load_vault_data(path)
+    Qonfig::Loaders::Vault.load_file(path, fail_on_unexist: strict)
+  end
+
+  # @param vault_data [Hash]
+  # @return [Class<Qonfig::DataSet>]
+  #
+  # @api private
+  # @since 0.25.0
+  def build_data_set_class(vault_data)
+    Qonfig::DataSet::ClassBuilder.build_from_hash(vault_data)
+  end
+end

data/lib/qonfig/plugins/vault/commands/definition/load_from_vault.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.25.0
+class Qonfig::Commands::Definition::LoadFromVault < Qonfig::Commands::Base
+  # @since 0.25.0
+  self.inheritable = true
+
+  # @return [String, Pathname]
+  #
+  # @api private
+  # @since 0.25.0
+  attr_reader :path
+
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.25.0
+  attr_reader :strict
+
+  # @param path [String]
+  # @option strict [Boolean]
+  #
+  # @api private
+  # @since 0.25.0
+  def initialize(path, strict: true)
+    @path = path
+    @strict = strict
+  end
+
+  # @param data_set [Qonfig::DataSet]
+  # @param settings [Qonfig::Settings]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.25.0
+  def call(_data_set, settings)
+    vault_data = Qonfig::Loaders::Vault.load_file(path, fail_on_unexist: strict)
+    vault_based_settings = build_data_set_klass(vault_data).new.settings
+    settings.__append_settings__(vault_based_settings)
+  end
+
+  private
+
+  # @param toml_data [Hash]
+  # @return [Class<Qonfig::DataSet>]
+  #
+  # @api private
+  # @since 0.25.0
+  def build_data_set_klass(toml_data)
+    Qonfig::DataSet::ClassBuilder.build_from_hash(toml_data)
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.25.0
+module Qonfig::DSL
+  # @param path [String, Pathname]
+  # @option strict [Boolean]
+  # @return [void]
+  #
+  # @see Qonfig::Commands::Definition::LoadFromVault
+  #
+  # @api public
+  # @since 0.25.0
+  def load_from_vault(path, strict: true)
+    definition_commands << Qonfig::Commands::Definition::LoadFromVault.new(
+      path, strict: strict
+    )
+  end
+
+  # @param path [String, Pathname]
+  # @option strict [Boolean]
+  # @option via [Symbol]
+  # @option env [Symbol, String]
+  # @return [void]
+  #
+  # @see Qonfig::Commands::Definition::ExposeVault
+  #
+  # @api public
+  # @since 0.25.0
+  def expose_vault(path, strict: true, via:, env:)
+    definition_commands << Qonfig::Commands::Definition::ExposeVault.new(
+      path, strict: strict, via: via, env: env
+    )
+  end
+end

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# @api public
+# @since 0.25.0
+module Qonfig
+  # @api public
+  # @since 0.25.0
+  VaultLoaderError = Class.new(Vault::VaultError)
+end

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.25.0
+class Qonfig::Loaders::Vault < Qonfig::Loaders::Basic
+  # @return [Binding]
+  #
+  # @api private
+  # @since 0.25.0
+  VAULT_EXPR_EVAL_SCOPE = BasicObject.new.__binding__.tap do |binding|
+    Object.new.method(:freeze).unbind.bind(binding.receiver).call
+  end
+
+  class << self
+    # @param path [String, Pathname]
+    # @option fail_on_unexist [Boolean]
+    # @return [Object]
+    #
+    # @raise [Qonfig::FileNotFoundError]
+    #
+    # @api private
+    # @since 0.25.0
+    def load_file(path, fail_on_unexist: true)
+      data = ::Vault.with_retries(Vault::HTTPError) do
+        ::Vault.logical.read(path.to_s)&.data&.dig(:data)
+      end
+      raise Qonfig::FileNotFoundError, "Path #{path} not exist" if data.nil? && fail_on_unexist
+      result = data || empty_data
+      deep_transform_values(result)
+    rescue Vault::VaultError => error
+      raise(Qonfig::VaultLoaderError.new(error.message).tap do |exception|
+        exception.set_backtrace(error.backtrace)
+      end)
+    end
+
+    # @return [Hash]
+    #
+    # @api private
+    # @since 0.25.0
+    def empty_data
+      {}
+    end
+
+    private
+
+    # @param vault_data [Hash<Object,Object>]
+    # @return [Object]
+    #
+    # @api private
+    # @since 0.25.0
+    def deep_transform_values(vault_data)
+      return vault_data unless vault_data.is_a?(Hash)
+
+      vault_data.transform_values do |value|
+        next safely_evaluate(value) if value.is_a?(String)
+
+        deep_transform_values(value)
+      end
+    end
+
+    # @param vault_expr [String]
+    # @return [Object]
+    #
+    # @api private
+    # @since 0.25.0
+    def safely_evaluate(vault_expr)
+      parsed_expr = ::ERB.new(vault_expr).result
+      VAULT_EXPR_EVAL_SCOPE.eval(parsed_expr)
+    rescue StandardError, ScriptError
+      parsed_expr
+    end
+  end
+end

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 [Boolean]
+  #
+  # @api private
+  # @since 0.25.0
+  REPRESENT_HASH_IN_DOT_STYLE = false
+
   # @return [String]
   #
   # @api private
@@ -133,16 +139,13 @@ class Qonfig::Settings # NOTE: Layout/ClassStructure is disabled only for CORE_M
   # @param key [Symbol, String]
   # @return [Object]
   #
+  # @raise [Qonfig::ArgumentError]
+  #
   # @api public
   # @since 0.1.0
-  def [](key)
-    __lock__.thread_safe_access do
-      begin
-        __get_value__(key)
-      rescue Qonfig::UnknownSettingError
-        __deep_access__(*__parse_dot_notated_key__(key))
-      end
-    end
+  # @version 0.25.0
+  def [](*keys)
+    __dig__(*keys)
   end
 
   # @param key [String, Symbol]
@@ -211,27 +214,47 @@ class Qonfig::Settings # NOTE: Layout/ClassStructure is disabled only for CORE_M
     __lock__.thread_safe_access { __deep_subset__(*keys) }
   end
 
+  # @option dot_notation [Boolean]
   # @option transform_key [Proc]
   # @option transform_value [Proc]
   # @return [Hash]
   #
   # @api private
   # @since 0.1.0
-  # rubocop:disable Metrics/LineLength
-  def __to_hash__(transform_key: BASIC_SETTING_KEY_TRANSFORMER, transform_value: BASIC_SETTING_VALUE_TRANSFORMER)
+  # @version 0.25.0
+  def __to_hash__(
+    dot_notation: REPRESENT_HASH_IN_DOT_STYLE,
+    transform_key: BASIC_SETTING_KEY_TRANSFORMER,
+    transform_value: BASIC_SETTING_VALUE_TRANSFORMER
+  )
     unless transform_key.is_a?(Proc)
-      ::Kernel.raise(Qonfig::IncorrectKeyTransformerError, 'Key transformer should be a type of proc')
+      ::Kernel.raise(
+        Qonfig::IncorrectKeyTransformerError,
+        'Key transformer should be a type of proc'
+      )
     end
 
     unless transform_value.is_a?(Proc)
-      ::Kernel.raise(Qonfig::IncorrectValueTransformerError, 'Value transformer should be a type of proc')
+      ::Kernel.raise(
+        Qonfig::IncorrectValueTransformerError,
+        'Value transformer should be a type of proc'
+      )
     end
 
     __lock__.thread_safe_access do
-      __build_hash_representation__(transform_key: transform_key, transform_value: transform_value)
+      if dot_notation
+        __build_dot_notated_hash_representation__(
+          transform_key: transform_key,
+          transform_value: transform_value
+        )
+      else
+        __build_basic_hash_representation__(
+          transform_key: transform_key,
+          transform_value: transform_value
+        )
+      end
     end
   end
-  # rubocop:enable Metrics/LineLength
   alias_method :__to_h__, :__to_hash__
 
   # @option all_variants [Boolean]
@@ -496,7 +519,7 @@ class Qonfig::Settings # NOTE: Layout/ClassStructure is disabled only for CORE_M
   #
   # @api private
   # @since 0.21.0
-  # rubocop:disable Naming/RescuedExceptionsVariableName
+  # rubocop:disable Naming/RescuedExceptionsVariableName, Style/SlicingWithRange
   def __assign_value__(key, value)
     key = __indifferently_accessable_option_key__(key)
     __set_value__(key, value)
@@ -507,6 +530,7 @@ class Qonfig::Settings # NOTE: Layout/ClassStructure is disabled only for CORE_M
     raise(initial_error) if key_set.size == 1
 
     begin
+      # TODO: rewrite with __deep_access__-like key resolving functionality
       setting_value = __get_value__(key_set.first)
       required_key = key_set[1..-1].join(DOT_NOTATION_SEPARATOR)
       setting_value[required_key] = value # NOTE: pseudo-recoursive assignment
@@ -514,7 +538,7 @@ class Qonfig::Settings # NOTE: Layout/ClassStructure is disabled only for CORE_M
       raise(initial_error)
     end
   end
-  # rubocop:enable Naming/RescuedExceptionsVariableName
+  # rubocop:enable Naming/RescuedExceptionsVariableName, Style/SlicingWithRange
 
   # @param key [String, Symbol]
   # @param value [Object]
@@ -557,11 +581,24 @@ class Qonfig::Settings # NOTE: Layout/ClassStructure is disabled only for CORE_M
   #
   # @api private
   # @since 0.2.0
+  # rubocop:disable Metrics/AbcSize, Style/SlicingWithRange
   def __deep_access__(*keys)
     ::Kernel.raise(Qonfig::ArgumentError, 'Key list can not be empty') if keys.empty?
 
-    result = __get_value__(keys.first)
-    rest_keys = Array(keys[1..-1])
+    result = nil
+    rest_keys = nil
+    key_parts_boundary = keys.size - 1
+
+    0.upto(key_parts_boundary) do |key_parts_slice_boundary|
+      begin
+        setting_key = keys[0..key_parts_slice_boundary].join(DOT_NOTATION_SEPARATOR)
+        result = __get_value__(setting_key)
+        rest_keys = Array(keys[(key_parts_slice_boundary + 1)..-1])
+        break
+      rescue Qonfig::UnknownSettingError => error
+        key_parts_boundary == key_parts_slice_boundary ? raise(error) : next
+      end
+    end
 
     case
     when rest_keys.empty?
@@ -575,6 +612,7 @@ class Qonfig::Settings # NOTE: Layout/ClassStructure is disabled only for CORE_M
       result.__dig__(*rest_keys)
     end
   end
+  # rubocop:enable Metrics/AbcSize, Style/SlicingWithRange
 
   # @param keys [Array<Symbol, String>]
   # @return [Hash]
@@ -667,14 +705,15 @@ class Qonfig::Settings # NOTE: Layout/ClassStructure is disabled only for CORE_M
   # @return [Hash]
   #
   # @api private
-  # @since 0.2.0
-  def __build_hash_representation__(options_part = __options__, transform_key:, transform_value:)
+  # @since 0.25.0
+  # rubocop:disable Layout/LineLength
+  def __build_basic_hash_representation__(options_part = __options__, transform_key:, transform_value:)
     options_part.each_with_object({}) do |(key, value), hash|
       final_key = transform_key.call(key)
 
       case
       when value.is_a?(Hash)
-        hash[final_key] = __build_hash_representation__(
+        hash[final_key] = __build_basic_hash_representation__(
           value,
           transform_key: transform_key,
           transform_value: transform_value
@@ -690,6 +729,24 @@ class Qonfig::Settings # NOTE: Layout/ClassStructure is disabled only for CORE_M
       end
     end
   end
+  # rubocop:enable Layout/LineLength
+
+  # @option transform_key [Proc]
+  # @option transform_value [Proc]
+  # @return [Hash]
+  #
+  # @api private
+  # @since 0.25.0
+  def __build_dot_notated_hash_representation__(transform_key:, transform_value:)
+    {}.tap do |hash|
+      __deep_each_key_value_pair__ do |setting_key, setting_value|
+        final_key = transform_key.call(setting_key)
+        final_value = transform_value.call(setting_value)
+
+        hash[final_key] = final_value
+      end
+    end
+  end
 
   # @param key [Symbol, String]
   # @return [void]