precursor 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bba5bce81c5c7e1d955c9f5c0acb4cf3898a5512f8fd66c1378469e6afe38081
-  data.tar.gz: 41f71f5e7a582aa678c1a62c5e453c31416de9d10706270b69cbae031ba98299
+  metadata.gz: 86985495bc3e48757e33837b70e20bd1a431f5e19ce750dd8a38cc6512ed0ffd
+  data.tar.gz: fecd720458ce41d39b8f000754500b0ebb9fc586a4cd7bf869657cc3b22391ec
 SHA512:
-  metadata.gz: 14d9ed609d3b9d5322fa42da86698b5e6e7eab865c8c190aafc69a10d76f2c47f6be3667281dd9847a1549ec7cb5c41dbaebd3ede2de5e095d3c47e69394c997
-  data.tar.gz: 4b6ec72589f67c6f701e49ec026a7dfc14208ee0632c5d23d25adff565502e3decd51b98ff37db6cd12544bd039441e532b776f42795ef9f19e04330feafe23e
+  metadata.gz: c582c2744224ddfb04b89eddfe0193bbb4b17ff789db6b3a1c56905806f3f769d1bbb3efe9f3f1e9211d1a0693cc262ca915991ea6ec3f5911ffa6df74ae5b41
+  data.tar.gz: 01e5f3bade8c2b1c16d7e630b299984a1abd5a752bf60a7ab0b2f2b0726e7fdb14709a5eeb23a5027587b663995fa1891afc4e3654aba3cea0b6dec8158a39c3

data/lib/argv_vault.rb

@@ -10,7 +10,9 @@ require_relative 'vault'
 module Precursor
   # Vault that parses command line arguments
   class ArgvVault < Vault
-    def initialize(argv)
+    def initialize(argv, priority:)
+      super(priority: priority)
+
       @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,33 +1,24 @@
 # frozen_string_literal: true
 
 module Precursor
+  # Root class to access config vaults
   class ConfigRoot
     def initialize(vaults, key_options)
-      @vaults = vaults
+      @vaults = vaults.sort_by(&:priority).reverse
       @key_options = key_options
     end
 
     def [](key)
-      found = false
-      value = nil
-      @vaults.each do |v|
-        if v.key? key
-          found = true
-          value = v.value key
-          break
-        end
-      end
-
-      if !found && @key_options.key?(key) && @key_options[key].key?(:default)
-        found = true
-        value = @key_options[key][:default]
-      end
+      key_vault = @vaults.find { |v| v.key? key }
 
-      raise KeyError, "key #{key} not found" unless found
+      value = key_vault.value key unless key_vault.nil?
+      value = get_default(key) if key_vault.nil?
 
-      value = resolve_variables(value) if value.is_a? String
+      value.is_a?(String) ? resolve_variables(value) : value
+    end
 
-      value
+    def add_vault(vault)
+      @vaults = @vaults.push(vault).sort_by(&:priority).reverse
     end
 
     private
@@ -35,6 +26,13 @@ module Precursor
     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?

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

@@ -8,13 +8,14 @@ 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(separator: '__', allow_list: [])
-      @separator = '__'
+    def initialize(priority:, separator: '__', allow_list: [])
+      super(priority: priority)
+      @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

@@ -3,8 +3,10 @@
 require_relative 'vault'
 
 module Precursor
+  # Vault that reads config data from passed hash
   class HashVault < Vault
-    def initialize(hash)
+    def initialize(hash, priority:)
+      super(priority: priority)
       @store = hash
     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
+    def initialize(priority:)
+      super(priority: priority)
       @vault_data = {}
     end
 

data/lib/precursor.rb

@@ -9,6 +9,7 @@ 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,8 +1,17 @@
-# frozen_string_literal
+# frozen_string_literal: true
 
 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
+
+    # Initializes new instance of [Precursor::Vault]
+    # @param priority [Integer] the vault priority
+    def initialize(priority:)
+      @priority = priority
+    end
+
     # Returns true if the vault has a value for the given key, otherwise false
     # @return [Boolean] true if the vault has a value for the given key, otherwise false
     def key?(key)
@@ -16,6 +25,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.5.0'
+  VERSION = '0.6.0'
 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))
+    def initialize(src, priority:)
+      super(priority: priority)
+      @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.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Andrey Maraev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-12 00:00:00.000000000 Z
+date: 2022-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: optparse
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: code-scanning-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'
 - !ruby/object:Gem::Dependency
   name: debug
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,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
@@ -60,7 +88,8 @@ files:
 homepage: https://github.com/the-vk/precursor
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths: