qonfig 0.22.0 → 0.26.0

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

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'pp'

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# NOTE: why not `.prepend` ?
+#  `prepend` in this case works incorrectly and sometimes this patch can not be correctly
+#  injected to the original module and it's children ancestors (Ruby-specific behaviour of
+#  module including and prepending).
+
+# @api public
+# @since 0.24.0
+module PP::PPMethods
+  # :nocov:
+  def pp(obj)
+    # If obj is a Delegator then use the object being delegated to for cycle
+    # detection
+
+    # NOTE: --- PATCH ---
+    if defined?(::Delegator) and (
+      begin
+        (class << obj; self; end) <= ::Delegator # patch
+      rescue ::TypeError
+        obj.is_a?(::Delegator)
+      end
+    )
+      obj = obj.__getobj__
+    end # instead of: obj = obj.__getobj__ if defined?(::Delegator) and obj.is_a?(::Delegator)
+    # NOTE:
+    #  Old implementation can not be used with BasicObject instances
+    #  (with Qonfig::Compacted in our case)
+    # NOTE: --- PATCH ---
+
+    if check_inspect_key(obj)
+      group { obj.pretty_print_cycle self }
+      return
+    end
+
+    begin
+      push_inspect_key(obj)
+      group { obj.pretty_print self }
+    ensure
+      pop_inspect_key(obj) unless PP.sharing_detection
+    end
+  end
+  # :nocov:
+end

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

@@ -19,7 +19,7 @@ class Qonfig::Commands::Definition::ExposeTOML < Qonfig::Commands::Base
   # @since 0.12.0
   EMPTY_TOML_DATA = {}.freeze
 
-  # @return [String]
+  # @return [String, Pathname]
   #
   # @api private
   # @since 0.12.0
@@ -101,7 +101,7 @@ class Qonfig::Commands::Definition::ExposeTOML < Qonfig::Commands::Base
     realfile = dirname.join(envfile).to_s
 
     toml_data = load_toml_data(realfile)
-    toml_based_settings = builde_data_set_klass(toml_data).new.settings
+    toml_based_settings = build_data_set_klass(toml_data).new.settings
 
     settings.__append_settings__(toml_based_settings)
   end
@@ -125,7 +125,7 @@ class Qonfig::Commands::Definition::ExposeTOML < Qonfig::Commands::Base
       "#{file_path} file does not contain settings with <#{env}> environment key!"
     ) unless toml_data_slice
 
-    toml_based_settings = builde_data_set_klass(toml_data_slice).new.settings
+    toml_based_settings = build_data_set_klass(toml_data_slice).new.settings
 
     settings.__append_settings__(toml_based_settings)
   end
@@ -145,7 +145,7 @@ class Qonfig::Commands::Definition::ExposeTOML < Qonfig::Commands::Base
   #
   # @api private
   # @since 0.12.0
-  def builde_data_set_klass(toml_data)
+  def build_data_set_klass(toml_data)
     Qonfig::DataSet::ClassBuilder.build_from_hash(toml_data)
   end
 end

data/lib/qonfig/plugins/toml/commands/definition/load_from_toml.rb

@@ -7,7 +7,7 @@ class Qonfig::Commands::Definition::LoadFromTOML < Qonfig::Commands::Base
   # @since 0.20.0
   self.inheritable = true
 
-  # @return [String]
+  # @return [String, Pathname]
   #
   # @api private
   # @since 0.12.0

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

@@ -3,7 +3,7 @@
 # @api public
 # @since 0.12.0
 class Qonfig::DataSet
-  # @option path [String]
+  # @option path [String, Pathname]
   # @option options [Hash<Symbol,Any>] Nothing, just for compatability and consistency
   # @param value_processor [Block]
   # @return [void]
@@ -17,7 +17,7 @@ class Qonfig::DataSet
   end
   alias_method :dump_to_toml, :save_to_toml
 
-  # @param file_path [String]
+  # @param file_path [String, Pathmame]
   # @option strict [Boolean]
   # @option expose [NilClass, String, Symbol] Environment key
   # @param configuration [Block]

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

@@ -3,7 +3,7 @@
 # @api private
 # @since 0.12.0
 module Qonfig::DSL
-  # @param file_path [String]
+  # @param file_path [String, Pathname]
   # @option strict [Boolean]
   # @return [void]
   #
@@ -18,7 +18,7 @@ module Qonfig::DSL
     )
   end
 
-  # @param file_path [String]
+  # @param file_path [String, Pathname]
   # @option strict [Boolean]
   # @option via [Symbol]
   # @option env [Symbol, String]

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