module ENV

Get an array value from an ENV variable

@param var_name [String] ENV variable name @param sep [String] string to split ENV value on @return [Array] array of strings representing the ENV value. Defaults to [] if value is blank.

# File lib/env_helpers/ext/env.rb, line 39
def array(var_name, sep = ',')
  EnvHelpers.array(var_name, sep)
end

Get an boolean value from an ENV variable or return a default. Will return the default if there is a non-boolean like value for the ENV variable.

@param var_name [String] ENV variable name @param default [Object] retured when ENV is blank or doesn't represent a numeric value @return [Boolean] boolean representing the ENV value

# File lib/env_helpers/ext/env.rb, line 59
def bool(var_name, default = nil)
  EnvHelpers.bool(var_name, default)
end

Compare the value of an ENV variable to a given string.

@param var_name [String] ENV variable name @param value [String] comparison string @return [Boolean] `true` if the value of the ENV variable is the same as value

# File lib/env_helpers/ext/env.rb, line 11
def equal?(var_name, value)
  EnvHelpers.equal?(var_name, value)
end

Check if an ENV variable represents `false`. ('false', 'f', or '0'). Returns false if environment variable isn't defined.

@param var_name [String] ENV variable name @return [Boolean]

# File lib/env_helpers/ext/env.rb, line 77
def false?(var_name)
  EnvHelpers.false?(var_name)
end

Get an integer value from an ENV variable or return a default.

@param var_name [String] ENV variable name @param default [Object] retured when ENV is blank or doesn't exist @return [Integer] integer representing the ENV value

# File lib/env_helpers/ext/env.rb, line 29
def int(var_name, default = nil)
  EnvHelpers.int(var_name, default)
end

Get a JSON value from an ENV variable

@param var_name [String] ENV variable name @raise [JSON::ParserError] if value is invalid JSON @return [Object] array of strings representing the ENV value.

# File lib/env_helpers/ext/env.rb, line 48
def json(var_name, default = nil)
  EnvHelpers.json(var_name, default)
end

Get a number value from an ENV variable or return a default.

@param var_name [String] ENV variable name @param default [Object] retured when ENV is blank or doesn't exist @return [Float] float representing the ENV value

# File lib/env_helpers/ext/env.rb, line 20
def num(var_name, default = nil)
  EnvHelpers.num(var_name, default)
end

Check if an ENV variable represents `true`. ('true', 't', or '1'). Returns false if environment variable isn't defined.

@param var_name [String] ENV variable name @return [Boolean]

# File lib/env_helpers/ext/env.rb, line 68
def true?(var_name)
  EnvHelpers.true?(var_name)
end