precursor 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e106154712ad13288b622f2c6fcdded80b583a68387c259f136d1b0c448fdfe0
-  data.tar.gz: c99dc664e48950a6d6de38a0bd7f56c257f505d6065337f57c7d6021adc086e1
+  metadata.gz: 0e3304cac9ee21759234bd745095460b9dc71573f4cb6a0f54ba8ca7862c0b0a
+  data.tar.gz: b1995f5395d1b767e08d61db569c40995b277f69f4b516646fed026a000acdb6
 SHA512:
-  metadata.gz: 405695b440d4202e2c1a0678a92d5f17bb63fe9404774cf0f9d33dfff20c6c2c64322cfccd90f61bb06894325ea4edd3633dc08d71698459950b5aa37827cd08
-  data.tar.gz: 7b843d26c18872d5174ae6fef796ffaf63c2deaeec4726d0948a5a2a18181748942757066949e9633edaa78657b11fc69bf14baf0b6db9d4c624615ddee802b9
+  metadata.gz: 4b3bb038529d96de309c2cf16e7acf1918310944612bd002dfa272e612c2a584c42fdea929cfe1a06f19999dc7b01b4f805c607891cbfb2621eebdd11a3724b6
+  data.tar.gz: d73549d136b50202dd4b222a4e0145851ba78927f3677e9ff55259057a8599018e1494cee40941c7ceafdff745d79f41447aad01f7d7b13c2d1867bad7fc0a6d

data/lib/argv_vault.rb

@@ -11,6 +11,8 @@ module Precursor
   # Vault that parses command line arguments
   class ArgvVault < Vault
     def initialize(argv)
+      super()
+
       @vault_data = {}
       @parser = OptionParser.new do |parser|
         parser.on('-h', '--help', 'Prints this help') do
@@ -34,6 +36,7 @@ module Precursor
       @vault_data
     end
 
+    # A builder to configure ArgvVault key options
     class ArgvKeyBuilder
       def initialize(key_name)
         @key_name = key_name

data/lib/config_key_builder.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Precursor
+  # A builder to provide Precursor key options
   class ConfigKeyBuilder
     def initialize
       @key_options = {}

data/lib/config_root.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Precursor
+  # Root class to access config vaults
   class ConfigRoot
     def initialize(vaults, key_options)
       @vaults = vaults
@@ -8,23 +9,34 @@ module Precursor
     end
 
     def [](key)
-      found = false
-      value = nil
-      @vaults.each do |v|
-        if v.key? key
-          found = true
-          value = v.value key
-          break
-        end
-      end
+      key_vault = @vaults.find { |v| v.key? key }
 
-      if !found && @key_options.key?(key) && @key_options[key].key?(:default)
-        found = true
-        value = @key_options[key][:default]
-      end
+      value = key_vault.value key unless key_vault.nil?
+      value = get_default(key) if key_vault.nil?
+
+      value.is_a?(String) ? resolve_variables(value) : value
+    end
+
+    private
 
-      raise KeyError, "key #{key} not found" unless found
-      value
+    VAR_PATTERN = /\$\{(?<var_name>[a-zA-Z]+[\w.]+)\}/
+    MAX_DEPTH = 16
+
+    def get_default(key)
+      has_default = @key_options.key?(key) && @key_options[key].key?(:default)
+      raise KeyError, "key #{key} not found" unless has_default
+
+      @key_options[key][:default]
+    end
+
+    def resolve_variables(str)
+      res = str
+      until (m = res.match(VAR_PATTERN)).nil?
+        k = m[1]
+        v = self[k.to_sym]
+        res = res.sub("${#{k}}", v.to_s)
+      end
+      res
     end
   end
 end

data/lib/config_root_builder.rb

@@ -4,6 +4,7 @@ require_relative 'config_key_builder'
 require_relative 'config_root'
 
 module Precursor
+  # A builder to set up Precurcor
   class ConfigRootBuilder
     def initialize
       @vaults = []

data/lib/env_vault.rb

@@ -9,12 +9,13 @@ module Precursor
     # @param separator [String] separator for hierarchical config entries
     # @param allow_list [Array<String>] list of allowed env vars to prevent leaking of sensitive or unrelated vars
     def initialize(separator: '__', allow_list: [])
-      @separator = '__'
+      super()
+      @separator = separator
 
       allow_set = Set.new(allow_list)
 
-      @env_vars = ENV.select { |n, _| allow_set.empty? || allow_set.include?(n) }.to_h do |name, value|
-        [name.sub(@separator, '.').to_sym, value]
+      @env_vars = ENV.select { |n, _| allow_set.empty? || allow_set.include?(n) }.transform_keys do |name|
+        name.sub(@separator, '.').to_sym
       end
     end
 

data/lib/hash_vault.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative 'vault'
+
+module Precursor
+  # Vault that reads config data from passed hash
+  class HashVault < Vault
+    def initialize(hash)
+      super()
+      @store = hash
+    end
+
+    protected
+
+    attr_reader :store
+  end
+end

data/lib/override_vault.rb

@@ -3,8 +3,10 @@
 require_relative 'vault'
 
 module Precursor
+  # Vault that stores data in hash and allows to override config on the fly
   class OverrideVault < Vault
     def initialize
+      super()
       @vault_data = {}
     end
 

data/lib/precursor.rb

@@ -4,10 +4,12 @@ require_relative 'config_root_builder'
 
 require_relative 'argv_vault'
 require_relative 'env_vault'
+require_relative 'hash_vault'
 require_relative 'override_vault'
 require_relative 'thread_local_override_vault'
 require_relative 'yaml_vault'
 
+# Entry point to Precursor
 module Precursor
   class << self
     # Creates a new instance of [Precursor::ConfigRoot]

data/lib/thread_local_override_vault.rb

@@ -3,6 +3,7 @@
 require_relative 'override_vault'
 
 module Precursor
+  # Extension of [Precursor::OverrideVault] that stored data in thread-local variable
   class ThreadLocalOverrideVault < OverrideVault
     protected
 

data/lib/vault.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal
+# frozen_string_literal: true
 
 module Precursor
   # Base class for config vaults
@@ -16,6 +16,7 @@ module Precursor
     end
 
     protected
+
     # Replace this method in descendant classes to return Hash-like store
     def store
       {}

data/lib/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Precursor
-  VERSION = '0.4.0'
+  VERSION = '0.5.1'
 end

data/lib/yaml_vault.rb

@@ -5,9 +5,11 @@ require 'yaml'
 require_relative 'vault'
 
 module Precursor
+  # Vault that reads config data from a string with Yaml
   class YamlVault < Vault
     def initialize(src)
-      @yaml = flat_hash(YAML.load(src))
+      super()
+      @yaml = flat_hash(YAML.safe_load(src))
     end
 
     protected
@@ -27,7 +29,7 @@ module Precursor
           { k => v }
         end
       end
-      flat_hash.reduce(:merge).transform_keys { |k| k.to_sym }
+      flat_hash.reduce(:merge).transform_keys(&:to_sym)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: precursor
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Andrey Maraev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-08 00:00:00.000000000 Z
+date: 2022-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: optparse
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email:
 - the_vk@thevk.net
@@ -50,6 +64,7 @@ files:
 - lib/config_root.rb
 - lib/config_root_builder.rb
 - lib/env_vault.rb
+- lib/hash_vault.rb
 - lib/override_vault.rb
 - lib/precursor.rb
 - lib/thread_local_override_vault.rb
@@ -59,7 +74,8 @@ files:
 homepage: https://github.com/the-vk/precursor
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths: