unifig 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2daa78635ee2bccb9232401f2d8c26ad3845069ec0445ffbadf2657ac0ea85bd
-  data.tar.gz: 196d2431dc1025377ca12c5108dc6398c7c473b11d3daaf204dd3621a13cf4f7
+  metadata.gz: b77565f94f0a6c120bd7e8b2168fcd09186ca66fc0973a73cf0b6c238656eba7
+  data.tar.gz: e48489beb9e543a1c22e6e8e449124074a1d0eb957acc03f5e795eef81bd8387
 SHA512:
-  metadata.gz: 81359820cd6783317b0697ca4bac3161cd59650e76449d60a17e3b69eab1e5f46f7910643af53229859ebaa32886c9724728fbd490ddb7d76142593f1bae483a
-  data.tar.gz: d2f52f43b879df6941bcc790e22de92bc4ee75d5a0115b59b3b38454882481e525ff01847f09e009d6f3b0407fe66814426764981112a89d87b27996474b3cd5
+  metadata.gz: fd21aca175ebf8f3ab9254b4028147a6c3f138d0ea1c43fadf7457a8345acf935dc4044679a3fd7f7943c2479062da0f1e70eccb4acaae1b6cd21e0b89f7f08e
+  data.tar.gz: c2850b58cca17dfac8bc9e0d0dbbf0b875a32613558f5aedd8d5b92d30b465aa8a37babd8911e6d9478c46cf27e7c22d6d11f443c19895c2d471e2cc7ed45831

data/CHANGELOG.md

@@ -1,4 +1,19 @@
-# [0.2.0][] (TBD)
+# [0.3.0][] (2022-07-31)
+
+## Changed
+
+- Renamed some errors so they all end in `Error`.
+
+## Added
+
+- Raise an error if a two or more variable names result in the same method name.
+- Any `nil` values are now handled here so providers don't have to worry about it.
+- Variable substituion
+- `Unifig::Vars` will now contain information about the loaded variables.
+
+# [0.2.0][] (2022-07-24)
+
+## Changed
 
 - An environment is no longer required.
 
@@ -6,5 +21,6 @@
 
 Initial release.
 
+[0.3.0]: https://github.com/AaronLasseigne/unifig/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/AaronLasseigne/unifig/compare/v0.1.0...v0.2.0
 [0.1.0]: https://github.com/AaronLasseigne/unifig/compare/v0.0.0...v0.1.0

data/README.md

@@ -7,16 +7,24 @@ Unifig is a pluggable system for loading external variables from one or more pro
 
 ## Installation
 
+If you are using a framework you should install the associated gem:
+
+| Framework | Gem              |
+| --------- | ---------------- |
+| Rails     | [unifig-rails][] |
+
+If you want to use Unifig outside of a framework listed above you can manually add it to your project.
+
 Add it to your Gemfile:
 
 ``` rb
-gem 'unifig', '~> 0.2.0'
+gem 'unifig', '~> 0.3.0'
 ```
 
 Or install it manually:
 
 ``` sh
-$ gem install unifig --version '~> 0.2.0'
+$ gem install unifig --version '~> 0.3.0'
 ```
 
 This project uses [Semantic Versioning][].
@@ -61,6 +69,17 @@ HELLO:
       value: "dlrow"
 ```
 
+### Variable Substitutions
+
+Variables can be used in other variables with `${VAR}`.
+
+```rb
+USER:
+SERVICE_USERNAME: "${USER}_at_service"
+```
+
+Order of the variables does not matter but cyclical dependencies will throw an error.
+
 ### Loading
 
 Loading a configuration is handled through the `Unifig::Init` class.
@@ -70,7 +89,7 @@ All variables are assumed to be required (not `nil` or a blank string).
 Variables can be made optional by using the `:optional` setting.
 If there is a required variable without a value, Unifig will throw an error when loading.
 
-``` rb
+```rb
 Unifig::Init.load(<<~YAML, env: :production)
   config:
     providers: local
@@ -99,7 +118,7 @@ YAML
 
 If we replaced `:development` with `:production` inside the `load` call we'd get:
 
-``` rb
+```rb
 > Unifig.host?
 # true
 > Unifig.host
@@ -112,7 +131,7 @@ If we replaced `:development` with `:production` inside the `load` call we'd get
 
 You can load from a configuration file by using `load_file`.
 
-``` rb
+```rb
 Unifig::Init.load_file('unifig.yml', env: :production)
 ```
 
@@ -131,9 +150,15 @@ This is the case for the overall configuration as well as any variable configura
 
 ### Providers
 
-| Provider | Gem      |
-| -------- | -------- |
-| Local    | Built-in |
+| Provider | Gem            |
+| -------- | -------------- |
+| Local    | Built-in       |
+| ENV      | [unifig-env][] |
+
+### Unifig::Vars
+
+After loading the configuration you can use `Unifig::Vars` to check on what happened.
+It will return a list of `Unifig::Var`s with information such as which provider supplied the value.
 
 ## Contributing
 
@@ -145,10 +170,12 @@ A [complete list of contributors][] is available on GitHub.
 Unifig is licensed under [the MIT License][].
 
 [Unifig]: https://github.com/AaronLasseigne/unifig
+[unifig-rails]: https://github.com/AaronLasseigne/unifig-rails
 [Semantic Versioning]: http://semver.org/spec/v2.0.0.html
 [GitHub releases]: https://github.com/AaronLasseigne/unifig/releases
 [YAML configuration]: #yaml-configuration
 [API Documentation]: http://rubydoc.info/github/AaronLasseigne/unifig
 [our contribution guidelines]: CONTRIBUTING.md
+[unifig-env]: https://github.com/AaronLasseigne/unifig-env
 [complete list of contributors]: https://github.com/AaronLasseigne/unifig/graphs/contributors
 [the MIT License]: LICENSE.txt

data/lib/unifig/config.rb

@@ -3,7 +3,10 @@
 module Unifig
   # @private
   class Config
+    # @raise [MissingConfigError] - No config section was provided.
     def initialize(config, env: nil)
+      raise MissingConfigError, 'no configuration provided' unless config
+
       @env_config = config.slice(:providers)
       @env = env
 

data/lib/unifig/errors.rb

@@ -8,11 +8,20 @@ module Unifig
   YAMLSyntaxError = Class.new(Error)
 
   # Raised if there is no config at the start of the YAML.
-  MissingConfig = Class.new(Error)
+  MissingConfigError = Class.new(Error)
 
   # Raised if there is no provider that matches the one given in the config.
-  MissingProvider = Class.new(Error)
+  MissingProviderError = Class.new(Error)
 
   # Raised if a required var is blank.
-  MissingRequired = Class.new(Error)
+  MissingRequiredError = Class.new(Error)
+
+  # Raised if a variable produces a duplicate method name.
+  DuplicateNameError = Class.new(Error)
+
+  # Raised if substitutions result in a cyclical dependency.
+  CyclicalSubstitutionError = Class.new(Error)
+
+  # Raised if a substitution does not exist.
+  MissingSubstitutionError = Class.new(Error)
 end

data/lib/unifig/init.rb

@@ -4,128 +4,134 @@ require 'yaml'
 
 module Unifig
   # Initializes Unifig with methods based on YAML.
-  class Init
-    # Loads a string of YAML to configure Unifig.
-    #
-    # @example
-    #   Unifig::Init.load(<<~YML, env: :development)
-    #     config:
-    #       envs:
-    #         development:
-    #           providers: local
-    #
-    #     FOO_BAR:
-    #       value: "baz"
-    #   YML
-    #
-    # @param str [String] A YAML config.
-    # @param env [Symbol] An environment name to load.
-    #
-    # @raise [YAMLSyntaxError] - Invalid YAML
-    # @raise (see #initialize)
-    # @raise (see Unifig::Providers.list)
-    def self.load(str, env: nil)
-      yml = Psych.load(str, symbolize_names: true)
-      new(yml, env: env).exec!
-    rescue Psych::SyntaxError, Psych::BadAlias => e
-      raise YAMLSyntaxError, e.message
-    end
+  module Init
+    class << self
+      # Loads a string of YAML to configure Unifig.
+      #
+      # @example
+      #   Unifig::Init.load(<<~YML, env: :development)
+      #     config:
+      #       envs:
+      #         development:
+      #           providers: local
+      #
+      #     FOO_BAR:
+      #       value: "baz"
+      #   YML
+      #
+      # @param str [String] A YAML config.
+      # @param env [Symbol] An environment name to load.
+      #
+      # @raise [YAMLSyntaxError] - Invalid YAML
+      # @raise (see .exec!)
+      def load(str, env: nil)
+        yml = Psych.load(str, symbolize_names: true)
+        exec!(yml, env: env)
+      rescue Psych::SyntaxError, Psych::BadAlias => e
+        raise YAMLSyntaxError, e.message
+      end
 
-    # Loads a YAML file to configure Unifig.
-    #
-    # @example
-    #   Unifig::Init.load_file('config.yml', env: :development)
-    #
-    # @param file_path [String] The path to a YAML config file.
-    # @param env [Symbol] An environment name to load.
-    #
-    # @raise (see Unifig::Init.load)
-    def self.load_file(file_path, env: nil)
-      # Ruby 2.7 Psych.load_file doesn't support the :symbolize_names flag.
-      # After Ruby 2.7 this can be changed to Psych.load_file if that's faster.
-      load(File.read(file_path), env: env)
-    end
+      # Loads a YAML file to configure Unifig.
+      #
+      # @example
+      #   Unifig::Init.load_file('config.yml', env: :development)
+      #
+      # @param file_path [String] The path to a YAML config file.
+      # @param env [Symbol] An environment name to load.
+      #
+      # @raise (see Unifig::Init.load)
+      def load_file(file_path, env: nil)
+        # Ruby 2.7 Psych.load_file doesn't support the :symbolize_names flag.
+        # After Ruby 2.7 this can be changed to Psych.load_file if that's faster.
+        load(File.read(file_path), env: env)
+      end
 
-    # @private
-    #
-    # @raise [MissingConfig] - No config section was provided in the YAML.
-    def initialize(yml, env: nil)
-      @yml = yml
-      @env = env
+      private
 
-      config = @yml.delete(:config)
-      raise MissingConfig unless config
+      # @raise [MissingRequiredError] - One or more required variables are missing values.
+      # @raise (see Unifig::Config#initialize)
+      # @raise (see Unifig::Providers.list)
+      # @raise (see Unifig::Var.load!)
+      # @raise (see .complete_substitutions!)
+      def exec!(yml, env: nil)
+        config = Config.new(yml.delete(:config), env: env)
 
-      @config = Config.new(config, env: @env)
-    end
+        providers = Providers.list(config.providers)
+        return if providers.empty?
 
-    # @private
-    def exec!
-      providers = Providers.list(@config.providers)
-      return if providers.empty?
+        Vars.load!(yml, env)
 
-      vars = vars_and_set_local
+        fetch_from_providers!(providers)
 
-      providers.each do |provider|
-        vars = fetch_and_set_methods(provider, vars)
-      end
+        check_required_vars
 
-      required_vars, optional_vars = vars.values.partition(&:required?)
-      if required_vars.any?
-        raise MissingRequired, <<~MSG
-          Missing Required Vars: #{required_vars.map(&:name).join(', ')}
-        MSG
+        complete_substitutions!
+
+        missing_vars, vars = Vars.list.partition { |var| var.value.nil? }
+        attach_methods!(vars)
+        attach_missing_optional_methods!(missing_vars)
       end
 
-      attach_optional_methods(optional_vars)
-    end
+      def fetch_from_providers!(providers)
+        providers.each do |provider|
+          remaining_vars = Vars.list.filter_map { |var| var.name if var.value.nil? }
+          result = provider.retrieve(remaining_vars)
 
-    private
+          Vars.write_results!(result, provider)
+        end
+      end
 
-    def vars_and_set_local
-      vars = {}
-      local_values = {}
-      @yml.each do |name, local_config|
-        local_config = {} if local_config.nil?
+      def check_required_vars
+        missing_required_vars = Vars.list.select { |var| var.required? && var.value.nil? }
+        return if missing_required_vars.empty?
 
-        vars[name] = Var.new(name, local_config, @env)
-        local_values[name] = vars[name].local_value
+        raise MissingRequiredError, <<~MSG
+          variables without a value: #{missing_required_vars.map(&:name).join(', ')}
+        MSG
       end
-      Unifig::Providers::Local.load(local_values)
-      vars
-    end
 
-    def fetch_and_set_methods(provider, vars)
-      values = provider.retrieve(vars.keys)
-      values.each do |name, value|
-        next values.delete(name) if blank_string?(value)
-
-        attach_method(vars[name], value)
-        attach_predicate(vars[name], true)
+      # @raise [CyclicalSubstitutionError] - Subtitutions resulted in a cyclical dependency.
+      # @raise [MissingSubstitutionError] - A substitution does not exist.
+      def complete_substitutions!
+        Vars.tsort.each do |name|
+          var = Vars[name]
+          next unless var.value.is_a?(String)
+
+          var.value.gsub!(/\${[^}]+}/) do |match|
+            name = match[2..-2].to_sym
+            Vars[name].value
+          end
+        end
+      rescue TSort::Cyclic => e
+        names = e.message.scan(/:([^ \],]+)/).flatten
+
+        raise CyclicalSubstitutionError, "cyclical dependency: #{names.join(', ')}"
       end
-      vars.slice(*(vars.keys - values.keys)) # switch to except after 2.7
-    end
 
-    def blank_string?(value)
-      value.respond_to?(:to_str) && value.to_str.strip.empty?
-    end
+      def attach_methods!(vars)
+        vars.each do |var|
+          attach_method!(var)
+          attach_predicate!(var, true)
+        end
+      end
 
-    def attach_optional_methods(vars)
-      vars.each do |var|
-        attach_method(var, nil)
-        attach_predicate(var, false)
+      def attach_missing_optional_methods!(vars)
+        vars.each do |var|
+          attach_method!(var)
+          attach_predicate!(var, false)
+        end
       end
-    end
 
-    def attach_method(var, value)
-      Unifig.define_singleton_method(var.method) do
-        value
+      def attach_method!(var)
+        Unifig.define_singleton_method(var.method) do
+          var.value
+        end
       end
-    end
 
-    def attach_predicate(var, bool)
-      Unifig.define_singleton_method(:"#{var.method}?") do
-        bool
+      def attach_predicate!(var, bool)
+        Unifig.define_singleton_method(:"#{var.method}?") do
+          bool
+        end
       end
     end
   end

data/lib/unifig/providers/local.rb

@@ -8,17 +8,10 @@ module Unifig
         :local
       end
 
-      # @private
-      def self.load(data)
-        @data = data
-      end
-
       def self.retrieve(var_names)
-        local_values = var_names.to_h do |name|
-          [name, @data[name]]
+        var_names.to_h do |name|
+          [name, Vars[name].local_value]
         end
-        local_values.compact!
-        local_values
       end
     end
   end

data/lib/unifig/providers.rb

@@ -3,14 +3,24 @@
 module Unifig
   # @private
   module Providers
-    # @raise [MissingProvider] - The given provider is not in the list of available providers.
+    # @raise [MissingProviderError] - The given provider is not in the list of available providers.
     def self.list(providers = nil)
       return all if providers.nil?
 
       providers.map do |provider|
-        all.detect { |pp| pp.name == provider }.tap do |found|
-          raise MissingProvider, %("#{provider}" is not in the list of available providers) unless found
-        end
+        all
+          .detect { |pp| pp.name == provider }
+          .tap do |found|
+            unless found
+              msg = %("#{provider}" is not in the list of available providers)
+
+              dym = DidYouMean::SpellChecker.new(dictionary: all.map(&:name))
+              correction = dym.correct(provider).first
+              msg += "\nDid you mean? #{correction}" if correction
+
+              raise MissingProviderError, msg
+            end
+          end
       end
     end
 

data/lib/unifig/var.rb

@@ -1,29 +1,60 @@
 # frozen_string_literal: true
 
 module Unifig
-  # @private
+  # A variable created after loading a configuration.
   class Var
+    # @private
     def initialize(name, config, env)
       @name = name
       @config = config
       @env = env
+      @value = nil
+      @provider = nil
     end
 
-    attr_reader :name, :config, :env
+    # The variable name.
+    #
+    # @return [Symbol]
+    attr_reader :name
 
+    # The provider that supplied the value.
+    #
+    # @return [Symbol]
+    attr_reader :provider # rubocop:disable Style/BisectedAttrAccessor
+
+    # @private
+    attr_writer :provider # rubocop:disable Style/BisectedAttrAccessor
+
+    # The value of the variable.
+    #
+    # @return [Object]
+    attr_reader :value
+
+    # @private
+    def value=(obj)
+      @value = blank?(obj) ? nil : obj
+    end
+
+    # The name of the method this variable can be found using.
+    #
+    # @return [Symbol]
     def method
       @method ||= name.to_s.downcase.tr('-', '_').to_sym
     end
 
+    # @private
     def local_value
-      @local_value ||= env_config(:value) || config[:value]
+      @local_value ||= env_config(:value) || @config[:value]
     end
 
+    # Returns whether or not this is a required variable.
+    #
+    # @return [Boolean]
     def required?
       return @required if defined?(@required)
 
       optional = env_config(:optional)
-      optional = config[:optional] if optional.nil?
+      optional = @config[:optional] if optional.nil?
       optional = false if optional.nil?
       @required = !optional
     end
@@ -31,7 +62,11 @@ module Unifig
     private
 
     def env_config(key)
-      config.dig(:envs, env, key)
+      @config.dig(:envs, @env, key)
+    end
+
+    def blank?(value)
+      value.nil? || (value.respond_to?(:to_str) && value.to_str.strip.empty?)
     end
   end
 end

data/lib/unifig/vars.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Unifig
+  # Information about variables after loading a configuration.
+  module Vars
+    class << self
+      include TSort
+
+      # @raise [DuplicateNameError] - A variable produces a duplicate method name.
+      # @private
+      def load!(yml, env)
+        vars = yml.to_h do |name, config|
+          [name, Var.new(name, config || {}, env)]
+        end
+
+        vars
+          .values
+          .group_by(&:method)
+          .each do |method_name, list|
+            next unless list.size > 1
+
+            names = list.map { |var| %("#{var.name}") }.join(', ')
+            raise DuplicateNameError, "variables all result in the same method name (Unifig.#{method_name}): #{names}"
+          end
+
+        @map = vars
+      end
+
+      # @private
+      def write_results!(results, provider)
+        results.each do |name, value|
+          @map[name].value = value
+          @map[name].provider = provider unless @map[name].value.nil?
+        end
+      end
+
+      # Returns a list the variables.
+      #
+      # @return [Array<Unifig::Var>]
+      def list
+        @map.values
+      end
+
+      # Retrieve a variable by name unless it does not exist.
+      #
+      # @param name [Symbol] The name of the variable.
+      #
+      # @return [Unifig::Var or nil]
+      def [](name)
+        @map ||= {}
+        @map[name]
+      end
+
+      private
+
+      def tsort_each_node(&block)
+        @map.each_key(&block)
+      end
+
+      def tsort_each_child(node, &block)
+        var = @map.fetch(node) { raise_missing_substituion_error(node) }
+
+        return unless var.value.is_a?(String)
+
+        var.value.scan(/\${([^}]+)}/).flatten.map(&:to_sym).each(&block)
+      end
+
+      def raise_missing_substituion_error(name)
+        msg = "variable not found: #{name}"
+
+        dym = DidYouMean::SpellChecker.new(dictionary: @map.keys)
+        correction = dym.correct(name).first
+        msg += "\nDid you mean? #{correction}" if correction
+
+        raise MissingSubstitutionError, msg
+      end
+    end
+  end
+end

data/lib/unifig/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Unifig
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/unifig.rb

@@ -1,13 +1,16 @@
 # frozen_string_literal: true
 
+require 'tsort'
+
 require_relative 'unifig/version'
 
 require_relative 'unifig/errors'
 require_relative 'unifig/config'
 require_relative 'unifig/var'
-require_relative 'unifig/init'
+require_relative 'unifig/vars'
 require_relative 'unifig/providers'
 require_relative 'unifig/providers/local'
+require_relative 'unifig/init'
 
 # Handle all your configuration variables.
 module Unifig

data/spec/unifig/config_spec.rb

@@ -13,6 +13,16 @@ RSpec.describe Unifig::Config do
     }
   end
 
+  describe '#new' do
+    context 'without a config' do
+      let(:config_hash) { nil }
+
+      it 'raises an error' do
+        expect { config }.to raise_error Unifig::MissingConfigError
+      end
+    end
+  end
+
   describe '#providers' do
     it 'returns a list of providers for the selected env' do
       expect(config.providers).to eql %i[local]

data/spec/unifig/init_spec.rb

@@ -17,20 +17,7 @@ RSpec.shared_examples 'basic load tests' do
     end
   end
 
-  context 'without a config' do
-    let(:str) do
-      <<~YML
-        ONE:
-          value: 1
-      YML
-    end
-
-    it 'throws an error' do
-      expect { subject }.to raise_error Unifig::MissingConfig
-    end
-  end
-
-  context 'with a config' do
+  context 'with a valid config' do
     let(:str) do
       <<~YML
         config:
@@ -179,7 +166,7 @@ RSpec.describe Unifig::Init do
         end
 
         it 'throws an error' do
-          expect { load }.to raise_error Unifig::MissingRequired
+          expect { load }.to raise_error Unifig::MissingRequiredError
         end
       end
 
@@ -195,7 +182,105 @@ RSpec.describe Unifig::Init do
         end
 
         it 'throws an error' do
-          expect { load }.to raise_error Unifig::MissingRequired
+          expect { load }.to raise_error Unifig::MissingRequiredError
+        end
+      end
+    end
+
+    context 'with substitutions' do
+      let(:str) do
+        <<~YML
+          config:
+            providers: local
+
+          NAME:
+            value: "world"
+          GREETING:
+            value: "Hello, ${NAME}!"
+        YML
+      end
+
+      it 'replaces the substitution' do
+        load
+
+        expect(Unifig.greeting).to eql 'Hello, world!'
+      end
+
+      context 'when they are out of order' do
+        let(:str) do
+          <<~YML
+            config:
+              providers: local
+
+            GREETING:
+              value: "Hello, ${NAME}!"
+            NAME:
+              value: "world"
+          YML
+        end
+
+        it 'replaces the substitution' do
+          load
+
+          expect(Unifig.greeting).to eql 'Hello, world!'
+        end
+      end
+
+      context 'when they chain' do
+        let(:str) do
+          <<~YML
+            config:
+              providers: local
+
+            INTRO:
+              value: "${GREETING} I'm Aaron."
+            NAME:
+              value: "world"
+            GREETING:
+              value: "Hello, ${NAME}!"
+          YML
+        end
+
+        it 'replaces the substitutions in order' do
+          load
+
+          expect(Unifig.intro).to eql "Hello, world! I'm Aaron."
+        end
+      end
+
+      context 'when they cause a cycle' do
+        let(:str) do
+          <<~YML
+            config:
+              providers: local
+
+            A:
+              value: "${B}"
+            B:
+              value: "${C}"
+            C:
+              value: "${A}"
+          YML
+        end
+
+        it 'raises an error' do
+          expect { load }.to raise_error Unifig::CyclicalSubstitutionError, 'cyclical dependency: A, B, C'
+        end
+      end
+
+      context 'when they do not exist' do
+        let(:str) do
+          <<~YML
+            config:
+              providers: local
+
+            A:
+              value: "${B}"
+          YML
+        end
+
+        it 'raises an error' do
+          expect { load }.to raise_error Unifig::MissingSubstitutionError
         end
       end
     end

data/spec/unifig/providers_spec.rb

@@ -32,5 +32,13 @@ RSpec.describe Unifig::Providers do
       list = described_class.list([Unifig::Providers::FortyTwo.name, Unifig::Providers::Local.name])
       expect(list).to eql [Unifig::Providers::FortyTwo, Unifig::Providers::Local]
     end
+
+    context 'with an invalid provider' do
+      it 'raises an error' do
+        expect do
+          described_class.list([Unifig::Providers::Local.name, :invalid])
+        end.to raise_error Unifig::MissingProviderError
+      end
+    end
   end
 end

data/spec/unifig/var_spec.rb

@@ -13,6 +13,20 @@ RSpec.describe Unifig::Var do
     end
   end
 
+  describe '#value=' do
+    it 'writes the value' do
+      var.value = 'a'
+
+      expect(var.value).to eql 'a'
+    end
+
+    it 'write blank strings as nil' do
+      var.value = '   '
+
+      expect(var.value).to be_nil
+    end
+  end
+
   describe '#local_value' do
     context 'with no value' do
       it 'returns nil' do

data/spec/unifig/vars_spec.rb

@@ -0,0 +1,41 @@
+RSpec.describe Unifig::Vars do
+  let(:yml) do
+    {
+      one: {
+        value: 1
+      },
+      two: {
+        value: 2
+      }
+    }
+  end
+  let(:env) { :development }
+  let(:results) { { one: 1, two: 2 } }
+
+  before do
+    described_class.load!(yml, env)
+    described_class.write_results!(results, :local)
+  end
+
+  describe '.list' do
+    it 'returns all of the vars' do
+      vars = described_class.list
+
+      expect(vars.size).to be 2
+      vars.each.with_index(1) do |var, value|
+        expect(var).to be_an_instance_of Unifig::Var
+        expect(var.value).to be value
+        expect(var.provider).to be :local
+      end
+    end
+  end
+
+  describe '.[]' do
+    it 'returns the Var based on the name' do
+      var = described_class[:one]
+
+      expect(var).to be_an_instance_of Unifig::Var
+      expect(var.value).to be 1
+    end
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: unifig
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Aaron Lasseigne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-24 00:00:00.000000000 Z
-dependencies: []
+date: 2022-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tsort
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 description: A pluggable system for loading external variables from one or more providers
   (e.g. ENV).
 email:
@@ -29,12 +43,14 @@ files:
 - lib/unifig/providers.rb
 - lib/unifig/providers/local.rb
 - lib/unifig/var.rb
+- lib/unifig/vars.rb
 - lib/unifig/version.rb
 - spec/spec_helper.rb
 - spec/unifig/config_spec.rb
 - spec/unifig/init_spec.rb
 - spec/unifig/providers_spec.rb
 - spec/unifig/var_spec.rb
+- spec/unifig/vars_spec.rb
 homepage: https://github.com/AaronLasseigne/unifig
 licenses:
 - MIT
@@ -69,3 +85,4 @@ test_files:
 - spec/unifig/init_spec.rb
 - spec/unifig/providers_spec.rb
 - spec/unifig/var_spec.rb
+- spec/unifig/vars_spec.rb