envp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9eadb093aedd1cb1d4720e048601211b6add41b9de3e1807f8467f1ef706b6fb
+  data.tar.gz: f836d9dcb8a009713ed99026b32a15bf0688b1f6329afb892aa35351a6b38501
+SHA512:
+  metadata.gz: ea40c61d340de298b22ec9990348b0910f62eef4acd1f75c3c34d682859c38d88e5336aae246c384c4ee3e11598b33624e4d88f5e8c031149c8976a9a57519ce
+  data.tar.gz: 3e024daebc2dd670e05c2aa411fc981789f96f8cfd62df60a04f9848588d9b13990c28088719949fcd9682bd6182d0231ea6949543996a72b1c19b2817b8386c

data/.rubocop.yml

@@ -0,0 +1,31 @@
+AllCops:
+  TargetRubyVersion: 3.2
+  SuggestExtensions: false
+  NewCops: enable
+
+Metrics/CyclomaticComplexity:
+  Max: 9
+
+Metrics/PerceivedComplexity:
+  Max: 9
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 12
+
+Metrics/ClassLength:
+  Exclude:
+    - test/**/test_*.rb

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-05-03
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at arjan@arjanvandergaag.nl. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "minitest", "~> 5.0"
+gem "rake", "~> 13.0"
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    envp (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    json (2.6.3)
+    minitest (5.18.0)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rubocop (1.50.2)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.1)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  envp!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.4.10

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Arjan van der Gaag
+
+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,119 @@
+# Envp
+
+A Ruby gem for working with environment variables much like OptionParser does with command-line arguments.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add envp
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install envp
+
+## Usage
+
+`Envp` allows you to write expectations for environment variables for your program.
+
+### Simple example
+
+Define a program in a new file `app.rb`:
+
+``` ruby
+reqiure 'envp'
+
+pp Envp.parse do |e|
+  e.required("FOO")
+end
+```
+
+Run the program without any special environment variables:
+
+``` sh
+$ ruby app.rb
+app.rb:47:in `handle_errors': FOO: missing required value (Envp::Failure)
+  from app.rb:26:in `parse'
+  from -e:1:in `<main>'
+```
+
+Rather then let the program continue with missing required values, an exception is raised immediately.
+
+Run the program with the required environment variables:
+
+``` sh
+$ FOO=bar ruby app.rb
+{"FOO"=>"bar"}
+```
+
+The specified environment variables are parsed into a Ruby hash for use in your program.
+
+### Coercions
+
+Environment variables can be coerced from string values into richer types. For example, to parse a value into an integer:
+
+``` ruby
+reqiure 'envp'
+
+pp Envp.parse do |e|
+  e.required("FOO", Integer)
+end
+```
+
+Will result in:
+
+``` sh
+$ FOO=123 ruby app.rb
+{"FOO"=>123}
+```
+
+Along with various predefined coercions, you can define your own coercions:
+
+``` ruby
+reqiure 'envp'
+
+pp Envp.parse do |e|
+  e.accept(User) do |id|
+    User.find(id)
+  end
+  e.required("USER_ID", User)
+end
+```
+
+### Full example
+
+The following example demonstrates all features:
+
+``` ruby
+Envp.parse(constants: true, symbolize: true, normalize: true) do |e|
+  e.accept(User) do |id|
+    User.find(id)
+  end
+  e.required("USER_ID", User)
+  e.required("API_KEY", allow_blank: false) do |value|
+    DEFAULT_LOGGER.debug("using API_KEY #{value}")
+  end
+  e.optional("DEBUG", :bool, default: false)
+end
+# => {:user_id=>#<User...>, :api_key=>"abc123", :debug=>false}
+Envp::DEBUG # => false
+Envp::API_KEY # => "abc123"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/avdgaag/envp. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/avdgaag/envp/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Envp project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/avdgaag/envp/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+require "rubocop/rake_task"
+
+Minitest::TestTask.create(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_globs = FileList["test/**/test_*.rb"]
+end
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/envp/coercions/all.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative "integer"
+require_relative "float"
+require_relative "big_decimal"
+require_relative "pathname"
+require_relative "time"
+require_relative "datetime"
+require_relative "date"
+require_relative "uri"
+require_relative "array"
+require_relative "regexp"
+require_relative "string"
+require_relative "bool"
+require_relative "json"
+require_relative "symbol"

data/lib/envp/coercions/array.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "registry"
+
+module Envp
+  module Coercions
+    Registry.default.register(Array) do |value|
+      String(value).split(",").map(&:strip)
+    end
+  end
+end

data/lib/envp/coercions/big_decimal.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bigdecimal"
+require_relative "registry"
+
+module Envp
+  module Coercions
+    Registry.default.register(BigDecimal) do |value|
+      BigDecimal(value)
+    end
+  end
+end

data/lib/envp/coercions/bool.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative "registry"
+
+module Envp
+  module Coercions
+    Registry.default.register(:bool) do |value|
+      case value
+      when "1", "true" then true
+      else false
+      end
+    end
+  end
+end

data/lib/envp/coercions/date.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "time"
+require_relative "registry"
+
+module Envp
+  module Coercions
+    Registry.default.register(Date) do |value|
+      Date.parse(value)
+    end
+  end
+end

data/lib/envp/coercions/datetime.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "time"
+require_relative "registry"
+
+module Envp
+  module Coercions
+    Registry.default.register(DateTime) do |value|
+      DateTime.parse(value)
+    end
+  end
+end

data/lib/envp/coercions/float.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "registry"
+
+module Envp
+  module Coercions
+    Registry.default.register(Float) do |value|
+      Float(value)
+    end
+  end
+end

data/lib/envp/coercions/integer.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "registry"
+
+module Envp
+  module Coercions
+    Registry.default.register(Integer) do |value|
+      Integer(value)
+    end
+  end
+end

data/lib/envp/coercions/json.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "registry"
+
+module Envp
+  module Coercions
+    Registry.default.register(JSON) do |value|
+      JSON.parse(value)
+    end
+  end
+end

data/lib/envp/coercions/pathname.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "pathname"
+require_relative "registry"
+
+module Envp
+  module Coercions
+    Registry.default.register(Pathname) do |value|
+      Pathname(value)
+    end
+  end
+end

data/lib/envp/coercions/regexp.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "registry"
+
+module Envp
+  module Coercions
+    Registry.default.register(Regexp) do |value|
+      Regexp.new(value)
+    end
+  end
+end

data/lib/envp/coercions/registry.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "forwardable"
+require_relative "../errors"
+
+module Envp
+  module Coercions
+    class Registry
+      extend Forwardable
+      def_delegator :@coercions, :empty?
+      def_delegator :@coercions, :key?, :coerces?
+
+      def self.default
+        @default ||= new
+      end
+
+      def initialize
+        @coercions = {}
+      end
+
+      def register(target, &block)
+        @coercions[target] = block
+      end
+
+      def coerce(target, value)
+        raise UnknownCoercion unless coerces?(target)
+
+        @coercions.fetch(target).call(value)
+      end
+    end
+  end
+end

data/lib/envp/coercions/string.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "registry"
+
+module Envp
+  module Coercions
+    Registry.default.register(String) do |value|
+      String(value)
+    end
+  end
+end

data/lib/envp/coercions/symbol.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "registry"
+
+module Envp
+  module Coercions
+    Registry.default.register(Symbol) do |value|
+      String(value).to_sym
+    end
+  end
+end

data/lib/envp/coercions/time.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "time"
+require_relative "registry"
+
+module Envp
+  module Coercions
+    Registry.default.register(Time) do |value|
+      Time.parse(value)
+    end
+  end
+end

data/lib/envp/coercions/uri.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "uri"
+require_relative "registry"
+
+module Envp
+  module Coercions
+    Registry.default.register(URI) do |value|
+      URI.parse(value)
+    end
+  end
+end

data/lib/envp/coercions.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Envp
+  # Coercions allow you to transform string values read from the environment and
+  # parse them into rich values. THere are various pre-defined coercions and you
+  # can define you own.
+  #
+  # ## Pre-defined coercions
+  #
+  # * `Array`
+  # * `BigDecimal`
+  # * `Date`
+  # * `DateTime`
+  # * `Time`
+  # * `Float`
+  # * `Integer`
+  # * `Pathname`
+  # * `Regexp`
+  # * `String`
+  # * `URI`
+  # * `:bool`
+  # * `JSON`
+  # * `Symbol`
+  #
+  # These coercions might require standard libraries. You can load exactly
+  # those you require or load all of them at once:
+  #
+  #     require 'envp/coercions/array'
+  #     require 'envp/coercions/all'
+  #
+  # ## Defining custom coercions
+  #
+  # See `Envp::Parser#accept`.
+  module Coercions
+  end
+end

data/lib/envp/errors.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Envp
+  class Error < StandardError
+  end
+
+  class Failure < Error
+  end
+
+  class UnknownCoercion < Error
+  end
+end

data/lib/envp/parser.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require_relative "coercions/registry"
+require_relative "results"
+require_relative "vars"
+require_relative "errors"
+
+module Envp
+  # The `Parser` defines environment variable requirements along with custom
+  # available coercions, and then uses those requirements to read environment
+  # variables into a single result value.
+  class Parser
+    # @param vars [Set] initial set of vars.
+    # @param coercion_registry [ParserEnv::Coercions::Registry]
+    def initialize(vars = Set.new, coercion_registry = Coercions::Registry.default)
+      @vars = vars
+      @coercion_registry = coercion_registry
+    end
+
+    # Require an enviroment variable.
+    #
+    # @param name [String] the name of the environment variable to fetch.
+    # @param coercion [Object] what to coerce the fetched value to.
+    # @param allow_blank [Boolean] whether to fail when the value is empty (defaults to `true`)
+    # @yield value [Object] the coerced value fetched from the environment
+    # @return [void]
+    def required(name, coercion = nil, allow_blank: true, &block)
+      var = Vars::Base.new(name)
+      var = Vars::Required.new(var)
+      var = Vars::NonBlank.new(var) unless allow_blank
+      var = Vars::Coerced.new(var, coercion, @coercion_registry) if coercion
+      var = Vars::Block.new(var, &block) if block
+      @vars << var
+    end
+
+    # Get an enviroment variable, if it exists.
+    #
+    # @param name [String] the name of the environment variable to fetch.
+    # @param coercion [Object] what to coerce the fetched value to.
+    # @param default [Object] value to use when the value is not set (defaults to `nil`)
+    # @yield value [Object] the coerced value fetched from the environment
+    # @return [void]
+    def optional(name, coercion = nil, default: nil, &block)
+      var = Vars::Base.new(name)
+      var = Vars::DefaultValue.new(var, default)
+      var = Vars::Coerced.new(var, coercion, @coercion_registry) if coercion
+      var = Vars::Block.new(var, &block) if block
+      @vars << var
+    end
+
+    # Actually parse the specified variables from the given hash-like value
+    # (probably `ENV`).
+    #
+    # @param env [#to_h]
+    # @return [Envp::Results]
+    def parse(env)
+      @vars.each_with_object(Results.new) do |spec, r|
+        r[spec] = spec.from(env)
+      rescue StandardError => e
+        r[spec] = Result.error(e)
+      end
+    end
+
+    # Define a custom coercion target. This can then be used in variable
+    # requirements as a coercion strategy.
+    #
+    # @example
+    #   parser = Parser.new
+    #   parser.accept(User) { |id| User.find(id) }
+    #   parser.require("USER", User)
+    #   parser.parse({ "USER" => "1" }) => { ok: { "USER" => user }}
+    #   user # => #<User ...>
+    #
+    # @param target [Object]
+    # @yield value [String]
+    # @return [void]
+    def accept(target, &)
+      @coercion_registry.register(target, &)
+    end
+  end
+end

data/lib/envp/result.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Envp
+  # Work with special values representing successful and unsuccessful
+  # operations.
+  module Result
+    # Tag a value as being a failed result.
+    #
+    # @param value [Object]
+    # @return [Hash<Symbol, Object>]
+    def self.error(value)
+      { error: value }
+    end
+
+    # Tag a value as being a succesful result.
+    #
+    # @param value [Object]
+    # @return [Hash<Symbol, Object>]
+    def self.ok(value)
+      { ok: value }
+    end
+
+    # Apply a block to an ok-value, ignoring error-values.
+    #
+    # @param result [Hash<Symbol, Object>]
+    # @yield value [Object]
+    # @return [Hash<Symbol, Object>]
+    def self.map(result)
+      case result
+      in {ok: value}
+        ok(yield(value))
+      in {error: _}
+        result
+      end
+    end
+
+    # Apply a block to an error-value, ignoring ok-values.
+    #
+    # @param result [Hash<Symbol, Object>]
+    # @yield value [Object]
+    # @return [Hash<Symbol, Object>]
+    def self.map_error(result)
+      case result
+      in {ok: _}
+        result
+      in {error: err}
+        error(yield(err))
+      end
+    end
+
+    # Chain a block returning a result value to a result value.
+    #
+    # @param result [Hash<Symbol, Object>]
+    # @yield value [Object]
+    # @return [Hash<Symbol, Object>]
+    def self.then(result)
+      case result
+      in {ok: value}
+        yield(value)
+      in {error: _}
+        result
+      end
+    end
+  end
+end

data/lib/envp/results.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "forwardable"
+require_relative "result"
+
+module Envp
+  # A container for parsing results. Each known var is combined with a Result
+  # value. It then provides a single Result value representing either the
+  # successful parsings, or, if there are error values, all errors.
+  class Results
+    extend Forwardable
+
+    def_delegators :@vars, :empty?, :[], :[]=
+
+    # @param vars [Hash<Envp::Vars::Base, Hash<Symbol, Object>>]
+    def initialize(vars = {})
+      @vars = vars
+    end
+
+    # A single Result value for all ok vars or all error vars.
+    #
+    # @see Envp::Result
+    # @return [Hash<Symbol, Hash<String, Object>>]
+    def result
+      @vars.inject(Result.ok({})) do |acc, (key, value)|
+        case [acc, value]
+        in [{ok: _}, { error: error }]
+          Result.error(key.name => error)
+        in [{error: hash}, {error: error}]
+          Result.error(hash.merge(key.name => error))
+        in [{ok: hash}, {ok: value}]
+          Result.ok(hash.merge(key.name => value))
+        in [{error: _}, {ok: _}]
+          acc
+        end
+      end
+    end
+  end
+end

data/lib/envp/vars/base.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "../result"
+
+module Envp
+  module Vars
+    # A base specification for an environment variable to read.
+    class Base
+      # @return [String]
+      attr_reader :name
+
+      # @param name [String] name of the variable the read
+      def initialize(name)
+        @name = name
+      end
+
+      # Read the named variable from the given hash-like value.
+      #
+      # @param env [#to_h]
+      # @return [Hash<Symbol, Object>]
+      def from(env)
+        Result.ok(env.to_h[@name])
+      end
+    end
+  end
+end

data/lib/envp/vars/block.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "delegate"
+require_relative "base"
+require_relative "../result"
+
+module Envp
+  module Vars
+    # A `Var` that is read and than has a block applied to it, returning the
+    # block return value.
+    class Block < DelegateClass(Base)
+      def initialize(var, &block)
+        super(var)
+        @block = block
+      end
+
+      def from(env)
+        Result.map(__getobj__.from(env), &@block)
+      end
+    end
+  end
+end

data/lib/envp/vars/coerced.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "delegate"
+require_relative "base"
+require_relative "../result"
+
+module Envp
+  module Vars
+    # A `Var` that is coerced using available transformations in the given
+    # coercions registry.
+    class Coerced < DelegateClass(Base)
+      # @param name [Base]
+      # @param target [Object]
+      # @param coercions [Envp::Coercions::Registry]
+      def initialize(var, target, coercions)
+        super(var)
+        @target = target
+        @coercions = coercions
+      end
+
+      def from(env)
+        Result.then(__getobj__.from(env)) do |value|
+          if @coercions.coerces?(@target)
+            Result.ok(@coercions.coerce(@target, value))
+          else
+            Result.error("unknown coercion #{@target.inspect}")
+          end
+        rescue StandardError => e
+          Result.error(e.message)
+        end
+      end
+    end
+  end
+end

data/lib/envp/vars/default_value.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "delegate"
+require_relative "base"
+require_relative "../result"
+
+module Envp
+  module Vars
+    # A `Var` that provides a default value when the value read from the
+    # environment is `nil`.
+    class DefaultValue < DelegateClass(Base)
+      # @param var [Base]
+      # @param default [Object] the default value to return.
+      def initialize(var, default)
+        super(var)
+        @default = default
+      end
+
+      def from(env)
+        Result.map(__getobj__.from(env)) do |value|
+          value || @default
+        end
+      end
+    end
+  end
+end

data/lib/envp/vars/non_blank.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "delegate"
+require_relative "base"
+require_relative "../result"
+
+module Envp
+  module Vars
+    # A `Var` that fails when the fetched value is empty.
+    class NonBlank < DelegateClass(Base)
+      def from(env)
+        Result.then(__getobj__.from(env)) do |value|
+          if value.nil? || value.strip.empty?
+            Result.error("disallowed blank value")
+          else
+            Result.ok(value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/envp/vars/required.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "delegate"
+require_relative "base"
+require_relative "../result"
+
+module Envp
+  module Vars
+    # A `Var` that fails when the fetched value is not present.
+    class Required < DelegateClass(Base)
+      def from(env)
+        Result.then(__getobj__.from(env)) do |value|
+          if value
+            Result.ok(value)
+          else
+            Result.error("missing required value")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/envp/vars.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "vars/base"
+require_relative "vars/required"
+require_relative "vars/non_blank"
+require_relative "vars/default_value"
+require_relative "vars/block"
+require_relative "vars/coerced"
+
+module Envp
+  module Vars
+  end
+end

data/lib/envp/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Envp
+  VERSION = "0.1.0"
+end

data/lib/envp.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require_relative "envp/version"
+require_relative "envp/parser"
+require_relative "envp/errors"
+
+module Envp
+  # @param env [#to_h] (defaults to `ENV`)
+  # @param constants [Boolean, Object] whether to define constants for the
+  #   loaded environment variables. When `true`, constants are defined on the
+  #   `Envp` module. If any other object, that will be used to define
+  #   constants in. Defaults to `false`.
+  # @param symbolize [Boolean] whether to transform loaded environment variables
+  #   to symbols in the returned result. Defaults to `false`.
+  # @param normalize [Boolean] whether to rename loaded environment variables
+  #   from UPPER_SNAKE_CASE to lower_snake_case. Defaults to `false`.
+  # @raise [Failure]
+  # @return [Hash]
+  def self.parse(env: ENV, constants: false, symbolize: false, normalize: false)
+    parser = Parser.new
+    yield parser
+    case parser.parse(env).result
+    in { ok: results }
+      handle_ok(results, constants, symbolize, normalize)
+    in { error: errors }
+      handle_errors(errors)
+    end
+  end
+
+  def self.handle_ok(results, constants, symbolize, normalize)
+    if constants == true
+      define_constants(Envp, results)
+    elsif constants.respond_to?(:const_set)
+      define_constants(constants, results)
+    elsif constants
+      raise "Cannot define new constants on #{constants.inspect}"
+    end
+    results = results.transform_keys(&:downcase) if normalize
+    results = results.transform_keys(&:to_sym) if symbolize
+    results
+  end
+
+  private_class_method :handle_ok
+
+  def self.handle_errors(errors)
+    msg = errors.map { |key, value| "#{key}: #{value}" }
+    raise Failure, msg.join("\n")
+  end
+
+  private_class_method :handle_errors
+
+  def self.define_constants(obj, results)
+    results.each do |key, value|
+      obj.const_set(key, value)
+    end
+  end
+
+  private_class_method :define_constants
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: envp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Arjan van der Gaag
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-05-09 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- arjan@arjanvandergaag.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/envp.rb
+- lib/envp/coercions.rb
+- lib/envp/coercions/all.rb
+- lib/envp/coercions/array.rb
+- lib/envp/coercions/big_decimal.rb
+- lib/envp/coercions/bool.rb
+- lib/envp/coercions/date.rb
+- lib/envp/coercions/datetime.rb
+- lib/envp/coercions/float.rb
+- lib/envp/coercions/integer.rb
+- lib/envp/coercions/json.rb
+- lib/envp/coercions/pathname.rb
+- lib/envp/coercions/regexp.rb
+- lib/envp/coercions/registry.rb
+- lib/envp/coercions/string.rb
+- lib/envp/coercions/symbol.rb
+- lib/envp/coercions/time.rb
+- lib/envp/coercions/uri.rb
+- lib/envp/errors.rb
+- lib/envp/parser.rb
+- lib/envp/result.rb
+- lib/envp/results.rb
+- lib/envp/vars.rb
+- lib/envp/vars/base.rb
+- lib/envp/vars/block.rb
+- lib/envp/vars/coerced.rb
+- lib/envp/vars/default_value.rb
+- lib/envp/vars/non_blank.rb
+- lib/envp/vars/required.rb
+- lib/envp/version.rb
+homepage: https://github.com/avdgaag/envp
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/avdgaag/envp
+  source_code_uri: https://github.com/avdgaag/envp
+  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: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Work with environment variables effectively.
+test_files: []