env_var 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cf94c00f2ffad7cd60e6b0bb8ddc64244e99aadb4428cf55dc745f08a98b6bee
+  data.tar.gz: d43462325182d35213fcd594af9905f6a349d952ac0fd67d10fc939b5c1f401a
+SHA512:
+  metadata.gz: 4bc26fe36791b206c4e57e5c3f53be6f7f121265fd0703d33d7d14e8753345590385064ea6ce82c858defe08d291a0fc0513ee8337591d3dfaeb998f7a8612b1
+  data.tar.gz: 3f2e3f1a4e27da95c02e73e15fff8ead19c3d9e945037f8527e54951a73099a2084e3797d412e555eb06b298b224a031e361c21e42cd7e261b223f90fd96c575

data/.gitignore

@@ -0,0 +1,111 @@
+
+# Created by https://www.gitignore.io/api/emacs,ruby
+# Edit at https://www.gitignore.io/?templates=emacs,ruby
+
+### Emacs ###
+# -*- mode: gitignore; -*-
+*~
+\#*\#
+/.emacs.desktop
+/.emacs.desktop.lock
+*.elc
+auto-save-list
+tramp
+.\#*
+
+# Org-mode
+.org-id-locations
+*_archive
+
+# flymake-mode
+*_flymake.*
+
+# eshell files
+/eshell/history
+/eshell/lastdir
+
+# elpa packages
+/elpa/
+
+# reftex files
+*.rel
+
+# AUCTeX auto folder
+/auto/
+
+# cask packages
+.cask/
+dist/
+
+# Flycheck
+flycheck_*.el
+
+# server auth directory
+/server/
+
+# projectiles files
+.projectile
+
+# directory configuration
+.dir-locals.el
+
+# network security
+/network-security.data
+
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+/bin
+# End of https://www.gitignore.io/api/emacs,ruby

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,14 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+
+before_install: gem install bundler -v 1.16.4
+
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in env_var.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 sshaw
+
+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,131 @@
+# EnvVar
+
+[![Build Status](https://travis-ci.org/sshaw/env_var.svg?branch=master)](https://travis-ci.org/sshaw/env_var)
+
+Check if an environment variable is set to an enabled or disabled value.
+Fetch an environment variable as an Array of `String`s or `Symbol`s.
+
+## Usage
+
+### `enabled?`/`disabled?`
+
+Set an environment variable:
+```
+export VARIABLE_NAME=1     # enabled
+export VARIABLE_NAME=true  # enabled
+export VARIABLE_NAME=0     # disabled
+export VARIABLE_NAME=false # disabled
+```
+
+And check if it's enabled or disabled:
+```rb
+require "$ENV"
+
+enable_foo if $ENV.enabled?("VARIABLE_NAME")
+disable_foo if $ENV.disabled?("VARIABLE_NAME")
+```
+
+Note that if the environment variable **is not set** `enabled?` and `disabled?` **can both be `false`**.
+If something is not enabled that does not mean it was explicitly disabled.
+
+Don't do this:
+```rb
+if !$ENV.enabled?("VARIABLE_NAME")
+if !$ENV.disabled?("VARIABLE_NAME")
+```
+
+Do this:
+```rb
+if $ENV.disabled?("VARIABLE_NAME")
+if $ENV.enabled?("VARIABLE_NAME")
+```
+
+### `$ENV::W`
+
+Return an environment variable's value as an `Array` of words (`String`s):
+
+
+```
+export VARIABLE_NAME="a,b,c"
+export ANOTHER_VARIABLE=
+```
+
+Then in Ruby:
+
+```rb
+$ENV::W["VARIABLE_NAME"]     # ["a", "b", "c"]
+$ENV::W["ANOTHER_VARIABLE"]  # []
+
+# Or
+$ENV.W("VARIABLE_NAME")      # ["a", "b", "c"]
+$ENV.w("VARIABLE_NAME")      # ["a", "b", "c"]
+```
+
+Mnemonic `%w(a b c)`.
+
+### `$ENV::I`
+
+Return an environment variable's value as an `Array` of `Symbol`s:
+
+```rb
+$ENV::I["VARIABLE_NAME"]  # [:a, :b, :c]
+
+# Or
+$ENV.I("VARIABLE_NAME")   # [:a, :b, :c]
+$ENV.i("VARIABLE_NAME")   # [:a, :b, :c]
+```
+
+Mnemonic `%w(a b c)`.
+
+### Otherwise, Use it Like You Would `ENV`
+
+```rb
+p $ENV["VARIABLE_NAME"]
+p $ENV.delete("VARIABLE_NAME")
+$ENV.each { |name, value| ... }
+```
+
+## Without `$ENV`
+
+```rb
+require "env_var"
+
+enable_foo if EnvVar.enabled?("VARIABLE_NAME")
+disable_foo if EnvVar.disabled?("VARIABLE_NAME")
+p EnvVar["VARIABLE_NAME"]
+p EnvVar.delete("VARIABLE_NAME")
+EnvVar.each { |name, value| ... }
+```
+
+## Monkey Patch
+
+```rb
+require "env_var/env"
+
+enable_foo if ENV.enabled?("VARIABLE_NAME")
+disable_bar if ENV.disabled?("VARIABLE_NAME")
+p ENV::i["VARIABLE_NAME"]
+p ENV::w["VARIABLE_NAME"]
+
+# ENV::W, ENV::I do not work
+```
+
+## Why?
+
+Got tired of writing this over and over in various applications:
+
+```rb
+enable_foo if %w[true 1 on].include?(ENV["ENABLE_FOO"])
+```
+
+## See Also
+
+- [Envied](https://github.com/eval/envied) - Ensures presence and type of your app's ENV-variables
+
+## Author
+
+Skye Shaw (skye DOT shaw AT gmail )
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/env_var.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "env_var/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "env_var"
+  spec.version       = EnvVar::VERSION
+  spec.authors       = ["sshaw"]
+  spec.email         = ["skye.shaw@gmail.com"]
+
+  spec.summary       = %q{Check if an environment variable is set to an enabled or disabled value. Fetch an environment variable as an Array of Strings or Symbols.}
+  #spec.description   = %q{Check if an environment variable is set to an enabled or disabled value. Fetch an environment variable as an Array of Strings or Symbols.}
+  spec.homepage      = "https://github.com/sshaw/env_var"
+  spec.license       = "MIT"
+
+  # 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.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/$ENV.rb

@@ -0,0 +1,3 @@
+require "env_var"
+raise LoadError, "error: variable $ENV has been defined elsewhere" if defined?($ENV) && $ENV != EnvVar
+$ENV = EnvVar

data/lib/env_var.rb

@@ -0,0 +1,49 @@
+module EnvVar
+  module W
+    def self.[](name)
+      EnvVar[name] ? EnvVar[name].split(",") : []
+    end
+  end
+
+  module I
+    def self.[](name)
+      v = W[name]
+      v.empty? ? v : v.map(&:to_sym)
+    end
+  end
+
+  class << self
+    def I(name)
+      I[name]
+    end
+
+    alias i I
+
+    def W(name)
+      W[name]
+    end
+
+    alias w W
+
+    def enabled?(name)
+      %w[1 true on].freeze.include?(self[name])
+    end
+
+    def disabled?(name)
+      %w[0 false off].freeze.include?(self[name])
+    end
+
+    def [](name)
+      ENV[name]
+    end
+
+    def method_missing(name, *args)
+      return ENV.public_send(name, *args) if ENV.respond_to?(name)
+      super
+    end
+
+    def respond_to_missing?(name, all)
+      ENV.respond_to?(name, all) || super
+    end
+  end
+end

data/lib/env_var/env.rb

@@ -0,0 +1,26 @@
+require "env_var"
+
+def ENV.enabled?(name)
+  EnvVar.enabled?(name)
+end
+
+def ENV.disabled?(name)
+  EnvVar.enabled?(name)
+end
+
+def ENV.w(*a)
+  # Fake ENV::w["FOO"]
+  a.size == 0 ? EnvVar::W : EnvVar.w(*a)
+end
+
+def ENV.W(*a)
+  w(*a)
+end
+
+def ENV.i(*a)
+  a.size == 0 ? EnvVar::I : EnvVar.i(*a)
+end
+
+def ENV.I(*a)
+  i(*a)
+end

data/lib/env_var/version.rb

@@ -0,0 +1,3 @@
+module EnvVar
+  VERSION = "0.0.2"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: env_var
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- sshaw
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- skye.shaw@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- env_var.gemspec
+- lib/$ENV.rb
+- lib/env_var.rb
+- lib/env_var/env.rb
+- lib/env_var/version.rb
+homepage: https://github.com/sshaw/env_var
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Check if an environment variable is set to an enabled or disabled value.
+  Fetch an environment variable as an Array of Strings or Symbols.
+test_files: []