environment_helpers 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b923675b4ed251cc3ffe498b480923619622e9cb7a1ebbf2e3bde6bbae036e84
+  data.tar.gz: 63a23ba984f9f1e67c2e01651cc6d6d73538fc7e8eda26516b56e748209b2bd8
+SHA512:
+  metadata.gz: 7113d4d1727c3ffe4a1311c588105f5ebec6a9d877da6341ee4d5e12b998fbbb03bfd0543736dbacbdcb3fe38ebd19c4eb3eae5efe5b4352a86086dfadf47e53
+  data.tar.gz: 35228c708df18bce2b56c6779f6047da0c3eaf62d922010136779e9e5c958ae66a5002006f2888ebc25be014448ff6515311811f692a498c95075941fadc298e

data/.gitignore

@@ -0,0 +1,3 @@
+.ruby-version
+.ruby-gemset
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,55 @@
+# EnvironmentHelpers
+This gem adds a set of convenience helpers to `ENV`, allowing you to access environment variables
+in a more structures and consistent way. Have you seen any line like these?
+
+```
+enable_bar = ENV.fetch("ENABLE_BAR", "false") == "true"
+foo_count = ENV.fetch("FOO_TOTAL", "100").to_i
+```
+
+This works okay! And it's not really that complicated, working out what's going on here isn't
+that difficult. How about this?
+
+```
+enable_foo = ENV.fetch("ENABLE_FOO", "false") != "true"
+```
+
+That.. looks very similar, but means the opposite thing. Also not that tricky. You don't start
+to _wish_ for a tool like EnvironmentHelpers until these constructions get complex and compounded.
+But.. if you're using a 12-factor style of configuration, you probably have these ENV-fetches
+sprinkled _everywhere_, so making them moderately clearer or simpler can pay off fairly quickly.
+
+## Installation
+
+```
+gem "environment_helper"
+```
+
+There's not much to it - add the gem to your gemfile and when it's loaded it'll add some extra
+methods onto `ENV` for your use.
+
+## Usage
+
+```
+ENV.string("APP_NAME", default: "local")
+ENV.symbol("BUSINESS_DOMAIN", default: :engineering, required: true)
+ENV.boolean("ENABLE_FEATURE_FOO", default: false)
+ENV.integer("MAX_THREAD_COUNT", default: 5)
+```
+
+Each of the supplied methods takes a positional parameter for the name of the environment variable,
+and then two optional named parameters `default` and `required` (there's no point in supplying
+both, but nothing stops you from doing so). The `default` value is the value used if the variable
+isn't present in the environment. If `required` is set to a truthy value, then if the variable isn't
+present in the environment, an `EnvironmentHelpers::MissingVariableError` is raised.
+
+The available methods added to `ENV`:
+* `string` - environment values are already strings, so this is the simplest of the methods.
+* `symbol` - produces a symbol, and enforces that the default value is either `nil` or a Symbol.
+* `boolean` - produces `nil`, `true`, or `false` (and only allows those as defaults). Supports..
+  a fair variety of strings to map onto those boolean value, though you should probably just use
+  "true" and "false" really. If you specify `required: true` and get a value like "maybe?", it'll
+  raise an `EnvironmentHelpers::InvalidBooleanText` exception.
+* `integer` - produces an integer from the environment variable, by calling `to_i` on it (if it's
+  present). Note that this means that providing a value like "hello" means you'll get `0`, since
+  that's what ruby does when you call `"hello".to_i`.

data/environment_helpers.gemspec

@@ -0,0 +1,35 @@
+require_relative "lib/environment_helpers/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "environment_helpers"
+  spec.version = EnvironmentHelpers::VERSION
+  spec.authors = ["Eric Mueller"]
+  spec.email = ["nevinera@gmail.com"]
+
+  spec.summary = "A set of convenience methods for accessing environment data"
+  spec.description = <<~DESC
+    Convenience helpers for more simply accessing data passed to applications through the
+    environment that may have types and/or defaults
+  DESC
+  spec.homepage = "https://github.com/nevinera/environment_helpers"
+  spec.license = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`
+      .split("\x0")
+      .reject { |f| f.start_with?("spec") }
+  end
+
+  spec.bindir = "bin"
+  spec.executables = []
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rspec", ">= 3.10"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "standard"
+  spec.add_development_dependency "rubocop"
+end

data/lib/environment_helpers/access_helpers.rb

@@ -0,0 +1,22 @@
+module EnvironmentHelpers
+  module AccessHelpers
+    private
+
+    def fetch_value(name, required:)
+      required ? fetch(name) : fetch(name, nil)
+    rescue KeyError
+      fail(MissingVariableError, "The environment variable '#{name}' was required but not supplied")
+    end
+
+    def check_default_type(context, value, *types)
+      return if value.nil?
+      return if types.any? { |t| value.is_a?(t) }
+      fail(BadDefault, "Inappropriate default value for ENV.#{context}")
+    end
+
+    def check_default_value(context, value, allow:)
+      return if allow.include?(value)
+      fail(BadDefault, "Inappropriate default value for ENV.#{context}")
+    end
+  end
+end

data/lib/environment_helpers/boolean_helpers.rb

@@ -0,0 +1,33 @@
+require "set"
+
+module EnvironmentHelpers
+  module BooleanHelpers
+    TRUTHY_STRINGS = %w[true yes on enabled enable allow t y 1 ok okay].to_set
+    FALSEY_STRINGS = %w[false no off disabled disable deny f n 0 nope].to_set
+    BOOLEAN_VALUES = [true, false, nil].to_set
+
+    def boolean(name, default: nil, required: false)
+      check_default_value(:boolean, default, allow: [nil, true, false])
+      text = fetch_value(name, required: required)
+
+      return default if text.nil?
+      return true if truthy_text?(text)
+      return false if falsey_text?(text)
+
+      return default unless required
+      fail(InvalidBooleanText, "Required boolean environment variable #{name} had inappropriate content '#{text}'")
+    end
+
+    private
+
+    def truthy_text?(text)
+      return false if text.nil?
+      TRUTHY_STRINGS.include?(text.strip.downcase)
+    end
+
+    def falsey_text?(text)
+      return false if text.nil?
+      FALSEY_STRINGS.include?(text.strip.downcase)
+    end
+  end
+end

data/lib/environment_helpers/numeric_helpers.rb

@@ -0,0 +1,9 @@
+module EnvironmentHelpers
+  module NumericHelpers
+    def integer(name, default: nil, required: false)
+      check_default_type(:integer, default, Integer)
+      text = fetch_value(name, required: required)
+      text&.to_i || default
+    end
+  end
+end

data/lib/environment_helpers/string_helpers.rb

@@ -0,0 +1,12 @@
+module EnvironmentHelpers
+  module StringHelpers
+    def string(name, default: nil, required: false)
+      fetch_value(name, required: required) || default
+    end
+
+    def symbol(name, default: nil, required: false)
+      check_default_type(:symbol, default, Symbol)
+      string(name, default: default, required: required)&.to_sym
+    end
+  end
+end

data/lib/environment_helpers/version.rb

@@ -0,0 +1,3 @@
+module EnvironmentHelpers
+  VERSION = "0.0.1"
+end

data/lib/environment_helpers.rb

@@ -0,0 +1,21 @@
+require_relative "./environment_helpers/access_helpers"
+require_relative "./environment_helpers/string_helpers"
+require_relative "./environment_helpers/boolean_helpers"
+require_relative "./environment_helpers/numeric_helpers"
+
+module EnvironmentHelpers
+  Error = Class.new(::StandardError)
+  MissingVariableError = Class.new(Error)
+  BadDefault = Class.new(Error)
+
+  InvalidValue = Class.new(Error)
+  InvalidBooleanText = Class.new(InvalidValue)
+  InvalidIntegerText = Class.new(InvalidValue)
+
+  include AccessHelpers
+  include StringHelpers
+  include BooleanHelpers
+  include NumericHelpers
+end
+
+ENV.extend(EnvironmentHelpers)

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: environment_helpers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Eric Mueller
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: standard
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: |
+  Convenience helpers for more simply accessing data passed to applications through the
+  environment that may have types and/or defaults
+email:
+- nevinera@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README.md
+- environment_helpers.gemspec
+- lib/environment_helpers.rb
+- lib/environment_helpers/access_helpers.rb
+- lib/environment_helpers/boolean_helpers.rb
+- lib/environment_helpers/numeric_helpers.rb
+- lib/environment_helpers/string_helpers.rb
+- lib/environment_helpers/version.rb
+homepage: https://github.com/nevinera/environment_helpers
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/nevinera/environment_helpers
+  source_code_uri: https://github.com/nevinera/environment_helpers
+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.1.6
+signing_key:
+specification_version: 4
+summary: A set of convenience methods for accessing environment data
+test_files: []