precursor 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86985495bc3e48757e33837b70e20bd1a431f5e19ce750dd8a38cc6512ed0ffd
-  data.tar.gz: fecd720458ce41d39b8f000754500b0ebb9fc586a4cd7bf869657cc3b22391ec
+  metadata.gz: cbc70ecd1d4be18a82e77b39dea4e6e93e5076dab9eab469e1a90d069e8a8dd0
+  data.tar.gz: a8b41e389d001346cfbe191c3900de5af73647b0742467863db4da388c3a5727
 SHA512:
-  metadata.gz: c582c2744224ddfb04b89eddfe0193bbb4b17ff789db6b3a1c56905806f3f769d1bbb3efe9f3f1e9211d1a0693cc262ca915991ea6ec3f5911ffa6df74ae5b41
-  data.tar.gz: 01e5f3bade8c2b1c16d7e630b299984a1abd5a752bf60a7ab0b2f2b0726e7fdb14709a5eeb23a5027587b663995fa1891afc4e3654aba3cea0b6dec8158a39c3
+  metadata.gz: 646c1c70e9f2ca03c6d39aa625d80f3cee5f34e35cbd63d0f2867de883618668608667f37f7924fdb1a2899600a7d2441bc94d272c04937ba0ae1d24e36c918a
+  data.tar.gz: bcb6624852cd7e8fcf6a93fe83b376cc3be9b34a5fd146b4c9fe7a01a50f27855b5a30c69fffceee82e7acd7ff1afd9321e2fc2f1459998dcbc31ae14d3c669f

data/lib/argv_vault.rb

@@ -10,9 +10,10 @@ require_relative 'vault'
 module Precursor
   # Vault that parses command line arguments
   class ArgvVault < Vault
-    def initialize(argv, priority:)
-      super(priority: priority)
+    def initialize(argv)
+      super()
 
+      @argv = argv
       @vault_data = {}
       @parser = OptionParser.new do |parser|
         parser.on('-h', '--help', 'Prints this help') do
@@ -21,7 +22,6 @@ module Precursor
         end
       end
       yield self
-      @parser.parse(argv)
     end
 
     def key(key_name)
@@ -32,7 +32,8 @@ module Precursor
 
     protected
 
-    def store
+    def load_store(_config_root)
+      @parser.parse(@argv)
       @vault_data
     end
 

data/lib/config_root.rb

@@ -4,8 +4,12 @@ module Precursor
   # Root class to access config vaults
   class ConfigRoot
     def initialize(vaults, key_options)
-      @vaults = vaults.sort_by(&:priority).reverse
+      @vaults = vaults
       @key_options = key_options
+
+      @vaults.each do |v|
+        v.load(self)
+      end
     end
 
     def [](key)
@@ -14,11 +18,17 @@ module Precursor
       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
+      value.is_a?(String) ? resolve(value) : value
     end
 
-    def add_vault(vault)
-      @vaults = @vaults.push(vault).sort_by(&:priority).reverse
+    def resolve(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
 
     private
@@ -32,15 +42,5 @@ module Precursor
 
       @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/env_vault.rb

@@ -8,21 +8,19 @@ module Precursor
     # Initializes new instance of [EnvVault]
     # @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(priority:, separator: '__', allow_list: [])
-      super(priority: priority)
+    def initialize(separator: '__', allow_list: [])
+      super()
       @separator = separator
 
-      allow_set = Set.new(allow_list)
-
-      @env_vars = ENV.select { |n, _| allow_set.empty? || allow_set.include?(n) }.transform_keys do |name|
-        name.sub(@separator, '.').to_sym
-      end
+      @allow_set = Set.new(allow_list)
     end
 
     protected
 
-    def store
-      @env_vars
+    def load_store(_config_root)
+      ENV.select { |n, _| @allow_set.empty? || @allow_set.include?(n) }.transform_keys do |name|
+        name.sub(@separator, '.').to_sym
+      end
     end
   end
 end

data/lib/hash_vault.rb

@@ -5,13 +5,15 @@ require_relative 'vault'
 module Precursor
   # Vault that reads config data from passed hash
   class HashVault < Vault
-    def initialize(hash, priority:)
-      super(priority: priority)
+    def initialize(hash)
+      super()
       @store = hash
     end
 
     protected
 
-    attr_reader :store
+    def load_store(_config_root)
+      @store
+    end
   end
 end

data/lib/override_vault.rb

@@ -1,13 +1,12 @@
 # frozen_string_literal: true
 
-require_relative 'vault'
+require_relative 'hash_vault'
 
 module Precursor
   # Vault that stores data in hash and allows to override config on the fly
   class OverrideVault < Vault
-    def initialize(priority:)
-      super(priority: priority)
-      @vault_data = {}
+    def initialize(hash = {})
+      super(hash)
     end
 
     def override(key, value)
@@ -17,11 +16,5 @@ module Precursor
     def clear(key)
       store.delete(key)
     end
-
-    protected
-
-    def store
-      @vault_data
-    end
   end
 end

data/lib/thread_local_override_vault.rb

@@ -8,7 +8,7 @@ module Precursor
     protected
 
     def store
-      Thread.current[:precursor_override_vault] ||= {}
+      Thread.current[:precursor_override_vault] ||= @store
     end
   end
 end

data/lib/vault.rb

@@ -3,13 +3,12 @@
 module Precursor
   # Base class for config vaults
   class Vault
-    # Priority of the vault. Vaults with higher priority are checked first when looking for config value
-    attr_reader :priority
+    attr_reader :store
 
-    # Initializes new instance of [Precursor::Vault]
-    # @param priority [Integer] the vault priority
-    def initialize(priority:)
-      @priority = priority
+    # Loads vault data from the source
+    # @param config_root [Precursor::ConfigRoot] A reference to config root to read values or resolve vars
+    def load(config_root)
+      @store = load_store(config_root)
     end
 
     # Returns true if the vault has a value for the given key, otherwise false
@@ -26,8 +25,7 @@ module Precursor
 
     protected
 
-    # Replace this method in descendant classes to return Hash-like store
-    def store
+    def load_store(_config_root)
       {}
     end
   end

data/lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Precursor
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 end

data/lib/yaml_file_vault.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative 'yaml_vault'
+
+module Precursor
+  # A vault that reads yaml data from a file
+  class YamlFileVault < YamlVault
+    def initialize(file_path)
+      super('')
+      @file_path = file_path
+    end
+
+    protected
+
+    def load_store(config_root)
+      file_path = config_root.resolve(@file_path)
+      @yaml = File.new(file_path).read if File.exist?(file_path)
+
+      super(config_root)
+    end
+  end
+end

data/lib/yaml_vault.rb

@@ -7,15 +7,15 @@ require_relative 'vault'
 module Precursor
   # Vault that reads config data from a string with Yaml
   class YamlVault < Vault
-    def initialize(src, priority:)
-      super(priority: priority)
-      @yaml = flat_hash(YAML.safe_load(src))
+    def initialize(yaml)
+      super()
+      @yaml = yaml
     end
 
     protected
 
-    def store
-      @yaml
+    def load_store(_config_root)
+      flat_hash(YAML.safe_load(@yaml))
     end
 
     private

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: precursor
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Andrey Maraev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-16 00:00:00.000000000 Z
+date: 2022-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: optparse
@@ -84,6 +84,7 @@ files:
 - lib/thread_local_override_vault.rb
 - lib/vault.rb
 - lib/version.rb
+- lib/yaml_file_vault.rb
 - lib/yaml_vault.rb
 homepage: https://github.com/the-vk/precursor
 licenses: