precursor 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dbe652293d6dbc1fe13cd17330f59a9e37e36d89fa2ff60c4af4bba81d80598f
+  data.tar.gz: b98e83f130cf813c408c2fc416245f5a3b8cc16d58c17b0b9229db1c4c034f55
+SHA512:
+  metadata.gz: 9b30d56c17c3bf072687cce95343b49853c4ba57f90632694070c864adb7a5a1d2549556a2e086a843af554b1c1617c254cfa68c87b2df931a2689d8234d455c
+  data.tar.gz: 45f98b6fd91306ef418438968a98d4f2ad83a24160f31644f803c9cacad6d56ddb0aaf583cae4ec83436ebec921d810104a3bdc43af0a940c59077bc071a4b29

data/lib/config_key_builder.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Precursor
+  class ConfigKeyBuilder
+    def initialize
+      @key_options = {}
+    end
+
+    def default(value)
+      @key_options[:default] = value
+    end
+
+    def build
+      @key_options
+    end
+  end
+end

data/lib/config_root.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Precursor
+  class ConfigRoot
+    def initialize(vaults, key_options)
+      @vaults = vaults
+      @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
+
+      raise KeyError, "key #{key} not found" unless found
+      value
+    end
+  end
+end

data/lib/config_root_builder.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative 'config_key_builder'
+require_relative 'config_root'
+
+module Precursor
+  class ConfigRootBuilder
+    def initialize
+      @vaults = []
+      @key_builders = {}
+    end
+
+    def vault(vault)
+      @vaults.push(vault)
+    end
+
+    def key(key_name)
+      builder = ConfigKeyBuilder.new
+      @key_builders[key_name] = builder
+      yield builder
+    end
+
+    def build
+      key_options = @key_builders.transform_values(&:build)
+      ConfigRoot.new(@vaults, key_options)
+    end
+  end
+end

data/lib/env_vault.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'vault'
+
+module Precursor
+  # Vault that provides config values from environment variables
+  class EnvVault < Vault
+    # 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 = '__'
+
+      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]
+      end
+    end
+
+    def key?(key)
+      @env_vars.key? key
+    end
+
+    def value(key)
+      @env_vars[key]
+    end
+  end
+end

data/lib/precursor.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative 'config_root_builder'
+
+require_relative 'env_vault'
+require_relative 'yaml_vault'
+
+module Precursor
+  class << self
+    # Creates a new instance of [Precursor::ConfigRoot]
+    def create
+      builder = ConfigRootBuilder.new
+      yield builder
+      builder.build
+    end
+  end
+end

data/lib/vault.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal
+
+module Precursor
+  # Base class for config vaults
+  class Vault
+    # 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?
+      false
+    end
+
+    # Returns a value fot the given key, nil if key is not available
+    # @return [Object|Nil] a value for the given key
+    def value(key)
+      nil
+    end
+  end
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module Precursor
+  VERSION = '0.3.0'
+end

data/lib/yaml_vault.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+require_relative 'vault'
+
+module Precursor
+  class YamlVault < Vault
+    def initialize(src)
+      @yaml = flat_hash(YAML.load(src))
+    end
+
+    def key?(key)
+      @yaml.key? key
+    end
+
+    def value(key)
+      @yaml[key]
+    end
+
+    private
+
+    def flat_hash(hash, prefix = nil)
+      flat_hash = hash.flat_map do |k, v|
+        k = "#{prefix}.#{k}" unless prefix.nil?
+        if v.is_a? Hash
+          flat_hash(v, k)
+        else
+          { k => v }
+        end
+      end
+      flat_hash.reduce(:merge).transform_keys { |k| k.to_sym }
+    end
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: precursor
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Andrey Maraev
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: debug
+  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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/config_key_builder.rb
+- lib/config_root.rb
+- lib/config_root_builder.rb
+- lib/env_vault.rb
+- lib/precursor.rb
+- lib/vault.rb
+- lib/version.rb
+- lib/yaml_vault.rb
+homepage: https://github.com/the-vk/precursor
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Extensible config system
+test_files: []