Easily Get Environment Variables. This is the ruby-like version of env-utils
Add this line to your application's Gemfile:
gem 'env_utils'And then execute:
$ bundle install
Or install it yourself as:
$ gem install env_utils
Gets an environment variable. This returns nil if the environment variable isn't detected.
include EnvUtils
get_env_var(env_var_name, options)options.is_boolean- Forces the value to be a boolean
# returns true if the variable is 'true' else it returns false
shouldAcceptCoins = get_env_var('SHOULD_ACCEPT_COINS', { boolean: true })options.is_array- If your env variable is a comma separated string you can get back an array instead.
# PORTS='8080,9000,3000'
PORTS = get_env_var('PORTS', { isArray: true }) # returns ['8080', '9000', '3000'];In the event that the variable is separated by something other than a comma, you can define the separator using options.separator.
PORTS = '8080&9000&3000'
PORTS = get_env_var('PORTS', { isArray: true, separator: '&' }) # returns ['8080', '9000', '3000'];options.dev_default- used to specify a development-environment-only fallback for the variable. If the variable is nil, thedevDefaultis returned in it's stead. This only applies whenENV['RAILS_ENV'] is 'development'. Any other value ofRAILS_ENVwill not regard this option
PORT = get_env_var('PORT', { dev_default: '1234' })
# if ENV["PORT"] is not set, the value of PORT will be `1234`options.default- used to specify a default fallback for the variable. If the variable is nil, thedefaultis returned in it's stead, dev_default overides default in development environment
PORT = get_env_var('PORT', { default: '1234' })
# if ENV["PORT"] is not set, the value of PORT will be `1234`options.is_integer- used to convert numeric-like variables into integer. Note: This will return 0 if value is not numeric-like.
# if ENV["PORT"] = '8080'
PORT = get_env_var('PORT', { is_integer: true }) # returns 8080
# if ENV["PORT"] = 'smash' - returns 0
PORT = get_env_var('PORT', { is_integer: true }) # returns 0options.is_float- used to convert numeric-like variables into float. Note: This will return 0.0 if value is not a number
# if ENV["PORT"] = '8080.98'
PORT = get_env_var('PORT', { is_float: true }) # returns 8080.98
# if ENV["PORT"] = 'smash' - returns 0.0
PORT = get_env_var('PORT', { is_float: true }) # returns 0.0env-utils exports some utility functions that return variables in a certain type. This is just casting some variables to its type
# You can make use of the utility functions and they return the appropriate types
get_string_env('SENTRY_DSN') # will always return a string | undefinedN.B All utility functions have exactly the same signature as the get_env_var function.
ENVreturns an environment variable as a stringget_array_envreturns an environment variable as an arrayget_bool_envreturns an environment variable as a booleanget_integer_envreturns an environment variable as an integerget_float_envreturns an environment variable as a float
After checking out the repo, run bin/setup to install dependencies. 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.
Bug reports and pull requests are welcome on GitHub at https://github.com/danielshow/env_utils. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
The gem is available as open source under the terms of the MIT License.
Everyone interacting in the Env::Utils::Ruby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.