unifig-env 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9faeed8441b6f3300f41b2be7c25892be0d73090b326050071a6074ff97a6d1a
+  data.tar.gz: 59f2b0fd7ab2017d004d7ed42e1ea0aa3556c5289e141205163326993d80f87d
+SHA512:
+  metadata.gz: 6ec302bbe6cad0828dae3e959a355bb15db7b14582950d49a6cd2d544e100bc03033b86bbbe0e74f0496c5eaca6837f59983fe0418718ef216611605928354cc
+  data.tar.gz: df5be543d4480f335c20c1f37e3f0dc514dfd8e2725ca22983c3fe7250608db02a5cdc82ae7c1f5b83f0473c551e13288acf3cadeee2c48bb76dbff871699356

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# [0.1.0][] (2022-07-24)
+
+Initial release.
+
+[0.1.0]: https://github.com/AaronLasseigne/unifig-env/compare/v0.0.0...v0.1.0

data/CONTRIBUTING.md

@@ -0,0 +1,19 @@
+# Contributing
+
+For features please open a [discussion][] and we can make sure the feature fits with the gem before working on it.
+
+## Steps
+
+1. [Fork][] the repo.
+2. Add a breaking test for your change.
+3. Make the tests pass.
+4. Push your fork.
+5. Submit a pull request against the `next` branch.
+
+## Code Style
+
+Running the tests using `rake` (with no args) will also check for style issues in the code.
+If you have a failure you cannot figure out push the PR and ask for help.
+
+[fork]: https://github.com/AaronLasseigne/unifig-env/fork
+[discussion]: https://github.com/AaronLasseigne/unifig-env/discussions/categories/ideas

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Aaron Lasseigne
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+# [Unifig::Env][]
+
+Adds a provider to support loading environment variables to [Unifig][].
+
+[![Version](https://img.shields.io/gem/v/unifig-env.svg?style=flat-square)](https://rubygems.org/gems/unifig-env)
+[![Test](https://img.shields.io/github/workflow/status/AaronLasseigne/unifig-env/Test?label=Test&style=flat-square)](https://github.com/AaronLasseigne/unifig-env/actions?query=workflow%3ATest)
+
+## Installation
+
+Add it to your Gemfile:
+
+``` rb
+gem 'unifig-env', '~> 0.1.0'
+```
+
+Or install it manually:
+
+``` sh
+$ gem install unifig-env --version '~> 0.1.0'
+```
+
+This project uses [Semantic Versioning][].
+Check out [GitHub releases][] for a detailed list of changes.
+
+## Usage
+
+Use `env` as your provider or add it to your list of providers:
+
+``` yml
+config:
+  providers: env
+
+HOST:
+```
+
+This will pull `"HOST"` from `ENV` and add it to Unifig.
+
+## Contributing
+
+If you want to contribute to Unifig:Env, please read [our contribution guidelines][].
+A [complete list of contributors][] is available on GitHub.
+
+## License
+
+Unifig is licensed under [the MIT License][].
+
+[Unifig::Env]: https://github.com/AaronLasseigne/unifig-env
+[Unifig]: https://github.com/AaronLasseigne/unifig
+[Semantic Versioning]: http://semver.org/spec/v2.0.0.html
+[GitHub releases]: https://github.com/AaronLasseigne/unifig-env/releases
+[our contribution guidelines]: CONTRIBUTING.md
+[complete list of contributors]: https://github.com/AaronLasseigne/unifig-env/graphs/contributors
+[the MIT License]: LICENSE.txt

data/lib/unifig/env/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Unifig
+  module Env
+    VERSION = '0.1.0'
+  end
+end

data/lib/unifig/env.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'env/version'
+require_relative 'providers/env'
+
+module Unifig
+  # @private
+  module Env
+  end
+end

data/lib/unifig/providers/env.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Unifig
+  module Providers
+    # @private
+    module Env
+      def self.name
+        :env
+      end
+
+      def self.retrieve(var_names)
+        env_values = var_names.to_h do |name|
+          [name, ::ENV[name.to_s]]
+        end
+        env_values.compact!
+        env_values
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+require 'unifig/env'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+    expectations.on_potential_false_positives = :nothing
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  config.filter_run_when_matching :focus
+
+  config.example_status_persistence_file_path = 'spec/examples.txt'
+
+  config.disable_monkey_patching!
+
+  config.warnings = true
+
+  config.default_formatter = 'doc' if config.files_to_run.one?
+
+  config.order = :random
+  Kernel.srand config.seed
+
+  # clear Unifg methods
+  config.before do
+    Unifig.methods(false).each do |name|
+      Unifig.singleton_class.remove_method(name)
+    end
+  end
+end

data/spec/unifig/providers/env_spec.rb

@@ -0,0 +1,24 @@
+RSpec.describe Unifig::Providers::Env do
+  describe '.name' do
+    it 'returns the provider name' do
+      expect(described_class.name).to be :env
+    end
+  end
+
+  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')
+    end
+
+    it 'returns a hash of only the available vars' do
+      result = described_class.retrieve(%i[FOO BAR BAZ])
+
+      expect(result).to be_an_instance_of(Hash)
+      expect(result.keys.size).to be 2
+      expect(result[:FOO]).to eql 'foo'
+      expect(result[:BAR]).to eql 'bar'
+    end
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: unifig-env
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aaron Lasseigne
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: unifig
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+description: Adds a provider to support loading environment variables to Unifig.
+email:
+- aaron.lasseigne@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTING.md
+- LICENSE.txt
+- README.md
+- lib/unifig/env.rb
+- lib/unifig/env/version.rb
+- lib/unifig/providers/env.rb
+- spec/spec_helper.rb
+- spec/unifig/providers/env_spec.rb
+homepage: https://github.com/AaronLasseigne/unifig-env
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/AaronLasseigne/unifig-env
+  source_code_uri: https://github.com/AaronLasseigne/unifig-env
+  changelog_uri: https://github.com/AaronLasseigne/unifig-env/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Adds a provider to support loading environment variables to Unifig.
+test_files:
+- spec/spec_helper.rb
+- spec/unifig/providers/env_spec.rb