envbash 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2bca49115032c8fb6edc53278935e9e42bd1a830
+  data.tar.gz: 181f42eadcbe69daf2359e035fe8de85538c8848
+SHA512:
+  metadata.gz: daf5b11dd39333d815e5f67c8ddef1bef3b635bea7fd19a8dab29b2da052e842ebc5032de8bb8512571d9ca3990c1b1cd3b855c05f9f6d0b334d919041a7ca2b
+  data.tar.gz: ccd7ab68ad8e5df0c4d23e81273204010501b248235757fcf5dbdf047c6e70e9e38f5203a570b00932d77560bcf3d046ea9f7b810f3c1e66eabe9724232afc10

data/.editorconfig

@@ -0,0 +1,18 @@
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 4
+tab_width = 8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{json,rb,yaml,yml}]
+indent_size = 2
+
+# Tab indents for Makefile
+[Makefile]
+indent_style = tab

data/.gitignore

@@ -0,0 +1,51 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/dest/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## 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

data/.travis.yml

@@ -0,0 +1,12 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+- 2.1
+- 2.2
+- 2.3.3
+- 2.4.0
+install:
+- bundle
+script:
+- rake

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Scampersand LLC
+
+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,71 @@
+# envbash
+
+[![gem](https://img.shields.io/gem/v/envbash.svg?style=plastic)](https://rubygems.org/gems/envbash)
+[![travis](https://img.shields.io/travis/scampersand/envbash-ruby/master.svg?style=plastic)](https://travis-ci.org/scampersand/envbash-ruby?branch=master)
+[![codecov](https://img.shields.io/codecov/c/github/scampersand/envbash-ruby/master.svg?style=plastic)](https://codecov.io/gh/scampersand/envbash-ruby/branch/master)
+
+Ruby gem for sourcing a bash script to augment the environment.
+
+## Rationale
+
+[12-factor apps](https://12factor.net/) require
+[configuration loaded from the environment](https://12factor.net/config).
+
+That's [easy on a platform like Heroku](https://devcenter.heroku.com/articles/config-vars),
+where the environment is preset by the user with commands like
+`heroku config:set`. But it's messier in development and non-Heroku
+deployments, where the environment might need to be loaded from a file.
+
+This package provides a mechanism for sourcing a Bash script to update
+Ruby's environment (`ENV`). There are reasons for using a Bash script
+instead of another configuration language:
+
+1. Environment variable keys and values should always be strings. Using a Bash
+   script to update the environment enforces that restriction, so there won't
+   be surprises when you deploy into something like Heroku later on.
+
+2. Using a script means that the values can be sourced into a Bash shell,
+   something that's non-trivial if you use a different config language.
+
+3. For better or worse, using a script means that environment variables can be
+   set using the full power of the shell, including reading from other files.
+
+Commonly the external file is called `env.bash`, hence the name of this project.
+
+## Installation
+
+Install from [RubyGems](https://rubygems.org/gems/envbash)
+
+    gem install envbash
+
+or in your Gemfile:
+
+    gem 'envbash'
+
+## Usage
+
+Call `EnvBash.load` to source a Bash script into the current Ruby process.
+Any variables that are set in the script, regardless of whether they are
+explicitly exported, will be added to the process environment.
+
+For example, given `env.bash` with the following content:
+
+```bash
+FOO='bar baz qux'
+```
+
+This can be loaded into Ruby:
+
+```ruby
+require 'envbash'
+
+EnvBash.load('env.bash')
+
+puts ENV['FOO']  #=> bar baz qux
+```
+
+## Legal
+
+Copyright 2017 [Scampersand LLC](https://scampersand.com)
+
+Released under the [MIT license](https://github.com/scampersand/envbash-ruby/blob/master/LICENSE)

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  # make sure helper.rb is loaded first, to start simplecov
+  test.test_files = FileList['test/helper.rb', 'test/test*.rb']
+end
+
+task :default => :test
+
+# this adds "rake build" to make pkg/envbash-*.gem
+require 'bundler/setup'
+Bundler::GemHelper.install_tasks

data/envbash.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |spec|
+  spec.name = "envbash"
+  spec.summary = "Source env.bash script to update environment"
+  spec.version = "1.0.1"
+  spec.authors = ["Aron Griffis"]
+  spec.email = "aron@scampersand.com"
+  spec.homepage = "https://github.com/scampersand/envbash-ruby"
+  spec.licenses = ["MIT"]
+
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "codecov"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-assert_errors"
+  spec.add_development_dependency "rake"
+end

data/lib/envbash.rb

@@ -0,0 +1,2 @@
+require_relative 'envbash/load'
+require_relative 'envbash/read'

data/lib/envbash/load.rb

@@ -0,0 +1,16 @@
+require_relative 'read'
+
+
+module EnvBash
+  def EnvBash.load(envbash, into: ENV, override: false, remove: false, **kwargs)
+    loaded = read(envbash, **kwargs)
+    is_env = into.equal? ENV
+    into = into.to_h if is_env
+    if loaded
+      into.select! {|k| loaded.include? k} if remove
+      loaded.reject! {|k| into.include? k} unless override
+      into.merge! loaded
+    end
+    ENV.replace into if is_env
+  end
+end

data/lib/envbash/read.rb

@@ -0,0 +1,62 @@
+require 'open3'
+require 'shellwords'
+
+
+module EnvBash
+
+  FIXUPS = %w{_ OLDPWD PWD SHLVL}
+
+  class ScriptExitedEarly < StandardError
+  end
+
+  def EnvBash.read(envbash, bash: 'bash', env: ENV, missing_ok: false, fixups: FIXUPS)
+    # make sure the file exists and is readable.
+    # alternatively we could test File.readable?(envbash) but this approach
+    # raises Errno::ENOENT or Errno::EACCES which is what we want.
+    begin
+      File.open(envbash).close
+    rescue Errno::ENOENT
+      return if missing_ok
+      raise
+    end
+
+    # construct an inline script which sources env.bash then prints the
+    # resulting environment so it can be eval'd back into this process.
+    inline = <<-EOT
+        set -a
+        source #{envbash.shellescape} >/dev/null
+        #{Gem.ruby.shellescape} -e 'p ENV'
+    EOT
+
+    # Process.spawn treats env as overriding ENV, and anything that should be
+    # omitted needs to have a nil value. If env == ENV then this is a noop.
+    env = Hash[ENV.keys.map {|k| [k, nil]}].merge(env)
+
+    # run the inline script with bash -c, capturing stdout. if there is any
+    # error output from env.bash, it will pass through to stderr.
+    # exit status is ignored.
+    output, _ = Open3.capture2(env, 'bash', '-c', inline, :in=>"/dev/null")
+
+    # the only stdout from the inline script should be
+    # `p ENV` so there should be no syntax errors eval'ing this. however there
+    # will be no output to eval if the sourced env.bash exited early, and that
+    # indicates script failure.
+    raise ScriptExitedEarly if output.empty?
+
+    # the eval'd output should return a hash.
+    nenv = eval(output)
+
+    # there are a few environment variables that vary between this process and
+    # running the inline script with bash -c, but are certainly not part of the
+    # intentional settings in env.bash.
+    for f in fixups
+      if env[f]  # not .include? because env might have nil values
+        nenv[f] = env[f]
+      else
+        nenv.delete(f)
+      end
+    end
+
+    nenv
+  end
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'simplecov'
+SimpleCov.start
+
+if ENV['CI'] == 'true'
+  require 'codecov'
+  SimpleCov.formatter = SimpleCov::Formatter::Codecov
+end
+
+require 'minitest/autorun'
+require 'minitest/assert_errors'

data/test/test_load.rb

@@ -0,0 +1,74 @@
+require_relative 'helper'
+require 'envbash'
+
+
+class TestLoad < Minitest::Test
+  def setup
+    @orig = ENV.to_h
+    ENV['A'] = 'A'
+    ENV['B'] = 'B'
+    ENV['C'] = 'C'
+    ENV.delete('D')
+    @loaded = ENV.to_h.merge('A'=>'a', 'D'=>'d')
+    @loaded.delete('B')
+  end
+
+  def teardown
+    ENV.replace(@orig)
+  end
+
+  def test_load_no_override_no_remove
+    EnvBash.stub :read, @loaded do
+      # the first argument doesn't matter since read is stubbed
+      EnvBash.load('')
+    end
+    assert_equal ENV['A'], 'A'  # NOT overridden
+    assert_equal ENV['B'], 'B'  # NOT removed
+    assert_equal ENV['C'], 'C'  # inherited
+    assert_equal ENV['D'], 'd'  # loaded
+  end
+
+  def test_load_override_no_remove
+    EnvBash.stub :read, @loaded do
+      # the first argument doesn't matter since read is stubbed
+      EnvBash.load('', override: true)
+    end
+    assert_equal ENV['A'], 'a'  # overridden
+    assert_equal ENV['B'], 'B'  # NOT removed
+    assert_equal ENV['C'], 'C'  # inherited
+    assert_equal ENV['D'], 'd'  # loaded
+  end
+
+  def test_load_no_override_remove
+    EnvBash.stub :read, @loaded do
+      # the first argument doesn't matter since read is stubbed
+      EnvBash.load('', remove: true)
+    end
+    assert_equal ENV['A'], 'A'  # NOT overridden
+    assert ! ENV.include?('B')  # removed
+    assert_equal ENV['C'], 'C'  # inherited
+    assert_equal ENV['D'], 'd'  # loaded
+  end
+
+  def test_load_override_remove
+    EnvBash.stub :read, @loaded do
+      # the first argument doesn't matter since read is stubbed
+      EnvBash.load('', override: true, remove: true)
+    end
+    assert_equal ENV['A'], 'a'  # overridden
+    assert ! ENV.include?('B')  # removed
+    assert_equal ENV['C'], 'C'  # inherited
+    assert_equal ENV['D'], 'd'  # loaded
+  end
+
+  def test_load_into
+    orig = ENV.to_h
+    into = {}
+    EnvBash.stub :read, {'A'=>'B'} do
+      # the first argument doesn't matter since read is stubbed
+      EnvBash.load('', into: into)
+    end
+    assert_equal into, {'A'=>'B'}
+    assert_equal ENV.to_h, orig
+  end
+end

data/test/test_read.rb

@@ -0,0 +1,95 @@
+require_relative 'helper'
+require 'fileutils'
+require 'tmpdir'
+require 'envbash'
+
+
+class TestRead < Minitest::Test
+  def setup
+    @tmpdir = Dir.mktmpdir
+    @envbash = File.join @tmpdir, 'env.bash'
+    @orig = ENV.to_h
+  end
+
+  def teardown
+    ENV.replace(@orig)
+    FileUtils.rm_rf(@tmpdir)
+  end
+
+  def test_read_missing_not_ok
+    assert_error_raised(nil, Errno::ENOENT) do
+      EnvBash.read @envbash
+    end
+  end
+
+  def test_read_missing_ok
+    assert_no_error do
+      EnvBash.read @envbash, missing_ok: true
+    end
+  end
+
+  def test_read_permission_error
+    FileUtils.chmod 0, @tmpdir
+    assert_error_raised(nil, Errno::EACCES) do
+      EnvBash.read @envbash
+    end
+  end
+
+  def test_read_empty
+    FileUtils.touch @envbash
+    result = EnvBash.read @envbash
+    assert_equal result, @orig
+  end
+
+  def test_read_normal
+    ENV.delete('FOO')
+    orig = ENV.to_h  # separate from @orig
+    File.open(@envbash, 'w') do |f|
+      f.write 'FOO=BAR'
+    end
+    result = EnvBash.read @envbash
+    assert_equal result['FOO'], 'BAR'
+    result.delete('FOO')
+    assert_equal result, orig
+  end
+
+  def test_read_error
+    File.open(@envbash, 'w') do |f|
+      # stderr doesn't matter, nor does final status.
+      f.write "echo 'okay!' >&2\nfalse"
+    end
+    result = EnvBash.read @envbash
+    assert_equal result, @orig
+  end
+
+  def test_read_exit
+    File.open(@envbash, 'w') do |f|
+      f.write 'exit'
+    end
+    assert_error_raised(nil, EnvBash::ScriptExitedEarly) do
+      EnvBash.read @envbash
+    end
+  end
+
+  def test_read_env
+    File.open(@envbash, 'w') do |f|
+      f.write 'FOO=BAR'
+    end
+    result = EnvBash.read @envbash, env: {}
+    assert_equal result, {'FOO'=>'BAR'}
+  end
+
+  def test_read_fixups
+    File.open(@envbash, 'w') do |f|
+      f.write 'A=B; C=D; E=F; G=H'
+    end
+    myenv = {'A'=>'Z', 'E'=>'F'}
+    result = EnvBash.read @envbash, env: myenv, fixups: ['A', 'C']
+    # there will be extra stuff in result since fixups is overridden, so can't
+    # test strict equality.
+    assert_equal result['A'], 'Z'  # fixups, myenv, env.bash
+    assert !result.include?('C')   # fixups, not myenv, env.bash
+    assert_equal result['E'], 'F'  # not fixups, myenv, env.bash
+    assert_equal result['G'], 'H'  # not fixups, not myenv, env.bash
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: envbash
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Aron Griffis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: codecov
+  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: minitest
+  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: minitest-assert_errors
+  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: rake
+  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: 
+email: aron@scampersand.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- envbash.gemspec
+- lib/envbash.rb
+- lib/envbash/load.rb
+- lib/envbash/read.rb
+- test/helper.rb
+- test/test_load.rb
+- test/test_read.rb
+homepage: https://github.com/scampersand/envbash-ruby
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Source env.bash script to update environment
+test_files:
+- test/helper.rb
+- test/test_load.rb
+- test/test_read.rb