unifig-env 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6dd90ff75c3bdc6a91214a289e1075f3c99c55e77ab6c7cbecc6a972a1e6a933
-  data.tar.gz: 1865d23646a0377f368880ec973404e2ddc50d467d343f4cb723062f585b363c
+  metadata.gz: 4f2d1338c397c1f5c2ceaa7819cb67e06ed6eea4c54e225c8ed398dcc82bc107
+  data.tar.gz: 6a8df43fd3c7cab42cea78a768749d5ab83fbc60cc0570397d77efbcf5d09802
 SHA512:
-  metadata.gz: 2cd00b09159eb1311ac39de13c259109af5d6b349026f51786eb23b55649a1232cc575573bcb1f85517383e1cf605ad5d577f0786e05c2e3f5c6d539583ca0ef
-  data.tar.gz: 6f55ca98475a3265c7bd8b88cd8f258960a1844a3b5854a02f10dfa2a277595c9e7032c31ec17a609d12d431bb33c81a74961fd4e5b0c21cacfa29a14390f530
+  metadata.gz: febd724191f72d90b8f26d075cb3f939803e0a8f975c3afb4e77836068fd41f5535d31401b697cdd18df986c4736f7c8757d84b6dacb8c70f1deca48cbd4e818
+  data.tar.gz: 75208b5aa9ffdac96cd7ab6f4bd91a7afacb7679720ef2fc9654d6331570e0f88f10297127c48ee304c6c892c54e82c6b3f53d14bbf0c7deac596b182ebd80d7

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# [0.3.1][] (2022-10-18)
+
+## Added
+
+- An `env-file` provider for dotenv (e.g. `.env`) files.
+
 # [0.3.0][] (2022-09-01)
 
 ## Changed
@@ -14,6 +20,7 @@
 
 Initial release.
 
+[0.3.1]: https://github.com/AaronLasseigne/unifig-env/compare/v0.3.0...v0.3.1
 [0.3.0]: https://github.com/AaronLasseigne/unifig-env/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/AaronLasseigne/unifig-env/compare/v0.1.0...v0.2.0
 [0.1.0]: https://github.com/AaronLasseigne/unifig-env/compare/v0.0.0...v0.1.0

data/README.md

@@ -10,13 +10,13 @@ Adds a provider to support loading environment variables to [Unifig][].
 Add it to your Gemfile:
 
 ``` rb
-gem 'unifig-env', '~> 0.3.0'
+gem 'unifig-env', '~> 0.3.1'
 ```
 
 Or install it manually:
 
 ``` sh
-$ gem install unifig-env --version '~> 0.3.0'
+$ gem install unifig-env --version '~> 0.3.1'
 ```
 
 This project uses [Semantic Versioning][].
@@ -24,6 +24,8 @@ Check out [GitHub releases][] for a detailed list of changes.
 
 ## Usage
 
+### Environment
+
 Use `env` as your provider or add it to your list of providers:
 
 ``` yml
@@ -35,6 +37,27 @@ HOST:
 
 This will pull `"HOST"` from `ENV` and add it to Unifig.
 
+### Environment File
+
+Use `env-file` as your provider or add it to your list of providers:
+
+``` yml
+unifig:
+  providers: env-file
+```
+
+By default, it looks for `.env` in the local directory.
+The file can be specified by passing `file` to the configuration.
+
+``` yml
+unifig:
+  providers:
+    list: env-file
+    config:
+      env-file:
+        file: my.env
+```
+
 ## Contributing
 
 If you want to contribute to Unifig:Env, please read [our contribution guidelines][].

data/lib/unifig/env/parser.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'strscan'
+
+module Unifig
+  module Env
+    # @private
+    module Parser
+      Error = Class.new(Unifig::Error)
+
+      WHITESPACE = /\s*/.freeze
+      COMMENT = /\#.*$/.freeze
+      EXPORT = /export\s+/.freeze
+      KEY = /[^=\s]+/.freeze
+      ASSIGNMENT = /\s*=\s*/.freeze
+      SINGLE_LINE_VALUE = /\S+/.freeze
+      QUOTE = /['"]/.freeze
+      TO_END_OF_LINE = /\s*(?:\#.*)?$/.freeze
+
+      class << self
+        def call(file_path)
+          content = File.read(file_path)
+
+          vars = {}
+          parser = StringScanner.new(content.strip)
+          until parser.eos?
+            parser.skip(WHITESPACE)
+
+            next if parser.skip(COMMENT)
+
+            parser.skip(EXPORT)
+            key = extract!(parser, KEY, 'Missing env key on line %i')
+            extract!(parser, ASSIGNMENT, 'Missing env var assignment on line %i')
+            quote = parser.scan(QUOTE)
+            value =
+              if quote
+                parser.scan(/.*?#{quote}/m).chop
+              else
+                parser.scan(SINGLE_LINE_VALUE)
+              end
+
+            extract!(parser, TO_END_OF_LINE, 'Invalid env var value on line %i')
+
+            vars[key] = value
+          end
+
+          vars
+        end
+
+        private
+
+        def line(parser)
+          parser.string[0...parser.pos].scan(/$/).count
+        end
+
+        def extract!(parser, pattern, error_msg)
+          parser.scan(pattern).tap do |match|
+            raise Error, error_msg % line(parser) if match.nil?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unifig/env/version.rb

@@ -2,6 +2,6 @@
 
 module Unifig
   module Env
-    VERSION = '0.3.0'
+    VERSION = '0.3.1'
   end
 end

data/lib/unifig/env.rb

@@ -1,7 +1,11 @@
 # frozen_string_literal: true
 
+require 'unifig'
+
 require_relative 'env/version'
+require_relative 'env/parser'
 require_relative 'providers/env'
+require_relative 'providers/env-file'
 
 module Unifig
   # @private

data/lib/unifig/providers/env-file.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Unifig
+  module Providers
+    # @private
+    module EnvFile
+      PATH = File.join(Dir.pwd, '.env')
+      private_constant :PATH
+
+      class << self
+        def name
+          :'env-file'
+        end
+
+        def retrieve(var_names, config)
+          env_vars = Unifig::Env::Parser.call(config.fetch(:file, PATH))
+
+          var_names.to_h do |name|
+            [name, env_vars[name.to_s]]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unifig/providers/env.rb

@@ -8,7 +8,7 @@ module Unifig
         :env
       end
 
-      def self.retrieve(var_names)
+      def self.retrieve(var_names, _config)
         var_names.to_h do |name|
           [name, ::ENV[name.to_s]]
         end

data/spec/unifig/env/parser_spec.rb

@@ -0,0 +1,89 @@
+require 'tempfile'
+
+RSpec.describe Unifig::Env::Parser do
+  describe '.call' do
+    let(:file_content) do
+      <<~ENV
+        # standalone comment
+        ONE=1
+        export TWO=2
+          THREE = 3 # in-line comment
+
+        MULTI_LINE="
+        first
+        second
+        "
+      ENV
+    end
+    let(:file) do
+      file = Tempfile.new('.env', Dir.pwd)
+      file.write(file_content)
+      file.close
+      file
+    end
+    let(:config) { { file: file.path } }
+
+    after do
+      file.unlink
+    end
+
+    it 'returns a hash representing the env vars loaded from the file' do
+      result = described_class.call(file.path)
+
+      expect(result).to be_an_instance_of(Hash)
+      expect(result.keys.size).to be 4
+      expect(result['ONE']).to eql '1'
+      expect(result['TWO']).to eql '2'
+      expect(result['THREE']).to eql '3'
+      expect(result['MULTI_LINE']).to eql "\nfirst\nsecond\n"
+    end
+
+    context 'with a missing key' do
+      let(:file_content) { '=1' }
+
+      it 'throws an error' do
+        expect do
+          described_class.call(file.path)
+        end.to raise_error Unifig::Env::Parser::Error, 'Missing env key on line 1'
+      end
+    end
+
+    context 'with no equal sign' do
+      let(:file_content) { 'ONE' }
+
+      it 'throws an error' do
+        expect do
+          described_class.call(file.path)
+        end.to raise_error Unifig::Env::Parser::Error, 'Missing env var assignment on line 1'
+      end
+    end
+
+    context 'with an invalid value' do
+      let(:file_content) { 'ONE=1 2' }
+
+      it 'throws an error' do
+        expect do
+          described_class.call(file.path)
+        end.to raise_error Unifig::Env::Parser::Error, 'Invalid env var value on line 1'
+      end
+    end
+
+    context 'an error later in the file' do
+      let(:file_content) do
+        <<~ENV
+          ONE=1
+          TWO=2
+
+          FOUR=4 invalid
+          FIVE=5
+        ENV
+      end
+
+      it 'puts the correct line' do
+        expect do
+          described_class.call(file.path)
+        end.to raise_error Unifig::Env::Parser::Error, 'Invalid env var value on line 4'
+      end
+    end
+  end
+end

data/spec/unifig/providers/env-file_spec.rb

@@ -0,0 +1,45 @@
+require 'tempfile'
+
+RSpec.describe Unifig::Providers::EnvFile do
+  describe '.name' do
+    it 'returns the provider name' do
+      expect(described_class.name).to be :'env-file'
+    end
+  end
+
+  describe '.retrieve' do
+    let(:file) do
+      file = Tempfile.new('.env', Dir.pwd)
+      file.write <<~ENV
+        # standalone comment
+        ONE=1
+        export TWO=2
+          THREE = 3 # in-line comment
+
+        MULTI_LINE="
+        first
+        second
+        "
+      ENV
+      file.close
+      file
+    end
+    let(:config) { { file: file.path } }
+
+    after do
+      file.unlink
+    end
+
+    it 'returns a hash of only the available vars' do
+      result = described_class.retrieve(%i[ONE TWO THREE MULTI_LINE INVALID], config)
+
+      expect(result).to be_an_instance_of(Hash)
+      expect(result.keys.size).to be 5
+      expect(result[:ONE]).to eql '1'
+      expect(result[:TWO]).to eql '2'
+      expect(result[:THREE]).to eql '3'
+      expect(result[:MULTI_LINE]).to eql "\nfirst\nsecond\n"
+      expect(result[:INVALID]).to be_nil
+    end
+  end
+end

data/spec/unifig/providers/env_spec.rb

@@ -8,18 +8,18 @@ RSpec.describe Unifig::Providers::Env do
   describe '.retrieve' do
     before do
       allow(ENV).to receive(:[]).and_return(nil)
-      allow(ENV).to receive(:[]).with('FOO').and_return('foo')
-      allow(ENV).to receive(:[]).with('BAR').and_return('bar')
+      allow(ENV).to receive(:[]).with('ONE').and_return('1')
+      allow(ENV).to receive(:[]).with('TWO').and_return('2')
     end
 
     it 'returns a hash of only the available vars' do
-      result = described_class.retrieve(%i[FOO BAR BAZ])
+      result = described_class.retrieve(%i[ONE TWO INVALID], {})
 
       expect(result).to be_an_instance_of(Hash)
       expect(result.keys.size).to be 3
-      expect(result[:FOO]).to eql 'foo'
-      expect(result[:BAR]).to eql 'bar'
-      expect(result[:BAZ]).to be_nil
+      expect(result[:ONE]).to eql '1'
+      expect(result[:TWO]).to eql '2'
+      expect(result[:INVALID]).to be_nil
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unifig-env
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Aaron Lasseigne
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-01 00:00:00.000000000 Z
+date: 2022-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: unifig
@@ -36,9 +36,13 @@ files:
 - LICENSE.txt
 - README.md
 - lib/unifig/env.rb
+- lib/unifig/env/parser.rb
 - lib/unifig/env/version.rb
+- lib/unifig/providers/env-file.rb
 - lib/unifig/providers/env.rb
 - spec/spec_helper.rb
+- spec/unifig/env/parser_spec.rb
+- spec/unifig/providers/env-file_spec.rb
 - spec/unifig/providers/env_spec.rb
 homepage: https://github.com/AaronLasseigne/unifig-env
 licenses:
@@ -69,4 +73,6 @@ specification_version: 4
 summary: Adds a provider to support loading environment variables to Unifig.
 test_files:
 - spec/spec_helper.rb
+- spec/unifig/env/parser_spec.rb
+- spec/unifig/providers/env-file_spec.rb
 - spec/unifig/providers/env_spec.rb