env_value 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 20e781fcfcbecfa408f57df1d763d0d680a60704a62fe010f20dff84772881a8
+  data.tar.gz: 31bc9fb16a1750bfb1f6adffc8b35c3d07c86e1cceb9f7a2575017735dab585a
+SHA512:
+  metadata.gz: 9c3c6e167bed44c7d947261643176be54d6311f1a02189844c87be80b1414dee226c6e6f13f9a209a1d4f43edeb8342e35fcbd0f30b9a3f4be76bc10081d4b14
+  data.tar.gz: e47eb5eed1bcb1bc013383f90f5f945a46c43abf7e44c1b1aa41e400859f4d54974e0ccf05808e29d83a6a9bee170f8d43f219b415767b4de0b564df14496819

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/Gemfile.lock
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in env_value.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/License

@@ -0,0 +1,18 @@
+Copyright (c) 2021 Tyler Rick
+
+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/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/Readme.md

@@ -0,0 +1,69 @@
+# EnvValue
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'env_value'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+### `ENV_value`
+
+Get a boolean or string value from the specified ENV variable.  '1', 'true', '0', 'false' will
+be converted to boolean values; all values others as string values (returned as-is, since ENV
+only contains string values).
+
+```ruby
+  ENV_value('option', missing: :raise)  # raises 'Environment variable "option" was missing.'
+
+  ENV['option'] = 'sanely'
+  ENV_value('option')                   # => 'sanely'
+  ENV_value('option', convert: :to_sym) # => :sanely
+```
+
+```ruby
+  ENV['max_attempts'] = '3'
+  ENV_value('max_attempts')                 # => '3'
+  ENV_value('max_attempts', convert: :to_i) # =>  3
+```
+
+See ENV_boolean for more available options.
+
+### `ENV_boolean`
+
+Get a boolean value (true or false) from the specified ENV variable.
+
+By default, '1', 'true' will be treated as true values; '0', 'false' as false values;
+and all others as nil.
+
+You can configure that with the `true:`, `false:`, and `default:` (or
+`missing:`/`invalid:`) options.
+
+```ruby
+  ENV['enabled'] = '1'
+  ENV['skip_it'] = 'skip'
+
+  ENV_boolean('enabled')                 # => true
+  ENV_boolean('skip_it')                 # => nil
+  ENV_boolean('unknown')                 # => nil
+  ENV_boolean('unknown', default: true)  # => true
+  ENV_boolean('unknown', missing: true)  # => true
+
+  ENV_boolean('skip_it', default: false)    # => false
+  ENV_boolean('skip_it', false: ['skip'])   # => false
+  ENV_boolean('skip_it', true:  ['skip'])   # => true
+  ENV_boolean('skip_it', missing: true, invalid: :string)  # => 'skip'
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/TylerRick/env_value.
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "env_value"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/env_value.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/env_value/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "env_value"
+  spec.version       = EnvValue.version
+  spec.authors       = ["Tyler Rick"]
+  spec.email         = ["tyler@tylerrick.com"]
+  spec.license       = "MIT"
+
+  spec.summary       = %q{Easily get a boolean, string, or integer value from an ENV variable.}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/TylerRick/#{spec.name}"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"]    = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.metadata["source_code_uri"]}/blob/master/Changelog.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/env_value.rb

@@ -0,0 +1,105 @@
+require "env_value/version"
+
+module Kernel
+  # Get a boolean or string value from the specified ENV variable.  '1', 'true', '0', 'false' will
+  # be converted to boolean values; all values others as string values (returned as-is, since ENV
+  # only contains string values).
+  #
+  # See ENV_boolean for more available options.
+  #
+  def ENV_value(key, convert: :string, **options)
+    ENV_boolean(key, invalid: convert, **options)
+  end
+
+  # Get a boolean value (true or false) from the specified ENV variable.
+  #
+  # By default, '1', 'true' will be treated as true values; '0', 'false' as false values;
+  # and all others as nil.
+  # You can configure that with the `true:`, `false:`, and `default:` (or
+  # `missing:`/`invalid:`) options.
+  #
+  # @example
+  #   ENV['enabled'] = '1'
+  #   ENV['skip_it'] = 'skip'
+  #
+  #   ENV_boolean('enabled')                 # => true
+  #   ENV_boolean('skip_it')                 # => nil
+  #   ENV_boolean('unknown')                 # => nil
+  #   ENV_boolean('unknown', default: true)  # => true
+  #
+  #   ENV_boolean('skip_it', default: false)    # => false
+  #   ENV_boolean('skip_it', false: ['skip'])   # => false
+  #   ENV_boolean('skip_it', true:  ['skip'])   # => true
+  #   ENV_boolean('skip_it', invalid: :string)  # => 'skip'
+  #
+  # @example
+  #   You can rewrite this:
+  #     Capybara.javascript_driver = ENV['javascript_driver'].to_sym if ENV['javascript_driver']) || :firefox
+  #   into this slightly more readable and shorter:
+  #     Capybara.javascript_driver = ENV_value('javascript_driver', convert: :to_sym, default: :firefox)
+  #
+  def ENV_boolean(
+    key,
+    true:         [],
+    false:        [],
+    # By default the true: and false: options get appended to the internal defaults, but you can
+    # override internal defaults, too, if you want. 
+    true_values:  ['1', 'true' ] + Array(binding.local_variable_get('true')),
+    false_values: ['0', 'false'] + Array(binding.local_variable_get('false')),
+    default: nil,
+    missing: default,  # (missing_default)
+    invalid: default   # (invalid_default)
+  )
+    unless ENV.key?(key)
+      if [:raise, :fail, :abort].include? missing
+        message = %(Environment variable "#{key}" was missing.)
+        send(missing, message)
+      else
+        return missing
+      end
+    end
+
+    allowed_values = true_values + false_values
+    value = ENV[key]
+    case value
+    when *true_values; true
+    when *false_values; false
+    else
+      if    [:string, :to_s].include?(invalid)
+        value
+      elsif [:symbol, :to_sym].include?(invalid)
+        value.to_sym
+      elsif [:integer, :to_i].include?(invalid)
+        value.to_i
+      elsif [:raise, :fail, :abort].include?(invalid)
+        message = %(Environment variable "#{key}" (#{value.inspect}) was not one of the allowed values (#{allowed_values}).)
+        send(invalid, message)
+      else
+        invalid
+      end
+    end
+  end
+  alias_method :ENV_boolean_value, :ENV_boolean
+
+  # TODO: API idea, so you can use more natural [] index access syntax:
+  #   ENV.boolean['a']
+
+  # Previous version:
+  #
+  # (Probably don't need these if we have ENV_boolean.)
+  #
+  # def ENV_value_truthy?(key, default: nil)
+  #   return default unless ENV.key?(key)
+  #
+  #   value = ENV[key]
+  #   value.in? ['1', 'true']
+  # end
+  #
+  # def ENV_value_falsey?(key, default: nil)
+  #   return default unless ENV.key?(key)
+  #
+  #   value = ENV[key]
+  #   value.in? ['0', 'false']
+  # end
+
+end

data/lib/env_value/version.rb

@@ -0,0 +1,5 @@
+module EnvValue
+    def self.version
+      "0.1.0"
+    end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: env_value
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tyler Rick
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-06-11 00:00:00.000000000 Z
+dependencies: []
+description: Easily get a boolean, string, or integer value from an ENV variable.
+email:
+- tyler@tylerrick.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Changelog.md
+- Gemfile
+- License
+- Rakefile
+- Readme.md
+- bin/console
+- bin/setup
+- env_value.gemspec
+- lib/env_value.rb
+- lib/env_value/version.rb
+homepage: https://github.com/TylerRick/env_value
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/TylerRick/env_value
+  source_code_uri: https://github.com/TylerRick/env_value
+  changelog_uri: https://github.com/TylerRick/env_value/blob/master/Changelog.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Easily get a boolean, string, or integer value from an ENV variable.
+test_files: []