envoker 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 67b033c2bd3051d5cb80c453f5b30a94622cab9b
+  data.tar.gz: b942adccacf02a36daa334496e7a595a2c12df20
+SHA512:
+  metadata.gz: 83fe89f611d068de214c9b6185235205a6a779ee24023db4dc4036ce4402a5067e46b1572aee49e8affc6f281bddd07098baabddb7756707a672587a134e2c5a
+  data.tar.gz: 9fae925702a80a405ea2d972bd2864f983971cb3675dc3887a57e16c8d8891d45b7d2fb223fdb2a55f9460def729156277b09c8ebd3e16b14135a020999abb97

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Francesco Rodríguez
+
+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,32 @@
+envoker
+=======
+
+Load environment variables from .env file.
+
+Usage
+-----
+
+This is a common pattern we use in our applications:
+
+```ruby
+require "envoker"
+
+module Settings
+  Envoker.load
+
+  DATABASE_URL = Envoker.fetch("DATABASE_URL")
+  RACK_ENV = Envoker.fetch("RACK_ENV", "development")
+
+  # ...
+end
+
+puts(Settings::RACK_ENV)
+# => "development"
+```
+
+Installation
+------------
+
+```
+$ gem install envoker
+```

data/envoker.gemspec

@@ -0,0 +1,17 @@
+require_relative "lib/envoker/version"
+
+Gem::Specification.new do |s|
+  s.name        = "envoker"
+  s.version     = Envoker::VERSION
+  s.summary     = "Load environment variables from `.env`"
+  s.description = s.summary
+  s.authors     = ["Francesco Rodríguez"]
+  s.email       = ["frodsan@protonmail.ch"]
+  s.homepage    = "https://github.com/harmoni/envoker"
+  s.license     = "MIT"
+
+  s.files = `git ls-files`.split("\n")
+
+  s.add_development_dependency "bundler", "~> 1.10"
+  s.add_development_dependency "cutest", "~> 1.2"
+end

data/lib/envoker.rb

@@ -0,0 +1,28 @@
+require_relative "envoker/version"
+
+module Envoker
+  DEFAULT = ".env"
+  SETTINGS = /(.+)=(.*)$/
+
+  class KeyNotFound < StandardError
+    MESSAGE = "%s not found in .env file or environment settings."
+
+    def initialize(key)
+      super(sprintf(MESSAGE, key.inspect))
+    end
+  end
+
+  def self.load(file = DEFAULT)
+    return unless File.exists?(file)
+
+    parse(file).each { |k, v| ENV[k] ||= k }
+  end
+
+  def self.parse(file)
+    return File.read(file).scan(SETTINGS)
+  end
+
+  def self.fetch(key, default = nil)
+    return ENV.fetch(key, default) || raise(KeyNotFound, key)
+  end
+end

data/lib/envoker/version.rb

@@ -0,0 +1,3 @@
+module Envoker
+  VERSION = "1.0.0"
+end

data/makefile

@@ -0,0 +1,5 @@
+default:
+	cutest test/*_test.rb
+
+gem:
+	gem build *.gemspec

data/test/.env.example

@@ -0,0 +1,4 @@
+secret=secret
+=invalid
+
+invalid

data/test/envoker_test.rb

@@ -0,0 +1,56 @@
+require "bundler/setup"
+require "cutest"
+require_relative "../lib/envoker"
+
+FILE = File.expand_path(".env.example", __dir__)
+
+def test(*)
+  defaults = ENV.to_hash
+  super
+ensure
+  ENV.replace(defaults)
+end
+
+scope "parse" do
+  test "ignore wrong environment lines" do
+    assert_equal 1, Envoker.parse(FILE).count
+  end
+end
+
+scope "load" do
+  test "don't raise if file doesn't exist" do
+    assert !Envoker.load(".notexists")
+  end
+
+  test "load environment vars" do
+    Envoker.load(FILE)
+
+    assert_equal "secret", ENV["secret"]
+  end
+
+  test "don't override environment vars" do
+    ENV["secret"] = "supersecret"
+
+    Envoker.load(FILE)
+
+    assert_equal "supersecret", ENV["secret"]
+  end
+end
+
+scope "fetch" do
+  test "return value from ENV" do
+    Envoker.load(FILE)
+
+    assert_equal "secret", Envoker.fetch("secret")
+  end
+
+  test "return default if not exists" do
+    assert_equal "secret", Envoker.fetch("notexists", "secret")
+  end
+
+  test "raise error if key not exists" do
+    assert_raise do
+      Envoker.fetch("notexists")
+    end
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: envoker
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Francesco Rodríguez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: cutest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: Load environment variables from `.env`
+email:
+- frodsan@protonmail.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- envoker.gemspec
+- lib/envoker.rb
+- lib/envoker/version.rb
+- makefile
+- test/.env.example
+- test/envoker_test.rb
+homepage: https://github.com/harmoni/envoker
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Load environment variables from `.env`
+test_files: []