envoker 2.0.0.rc1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 81577165e8bf17349e1df3aabc87de9dd8874f32
-  data.tar.gz: 3ef3c24fd474b137080cadc149ab08e98cd13086
+  metadata.gz: 52a59237ad5f9e60bb69a91c0a460ea59bb427b7
+  data.tar.gz: 4e77cc5d280838546ccc1b247a2e5480df711017
 SHA512:
-  metadata.gz: bc6ce2150ddbe6caec5c8678cde7ba2cc9592048dce8e616da5f7979cc702067ea852f72f3afe502cd3dd4de3319fe03461432400742e3f78f8a4e2f91bd855f
-  data.tar.gz: f89b711dad46757d35ba934166392016b938b55ca48a788e68d16cc0c5e4d2e77b16b0368b4e03e24f9a582e8ac675c7dd369213244797f2b436ddd0c263f42f
+  metadata.gz: 1c97352a13486711f18c5b5bf5a2a6b9431d32c5dc9cd0ddac0e0a0e686d525704cb17dc305a6c77f8daef0a1b1757bf7790723a3bb6425fd037a08d6eebfe6c
+  data.tar.gz: ecf7408ca2f993b8bff6610ca7171fb901da3c3b1c2f6ffb3dae91708537af4d3a9ed78d3905ae8327cbc96f695c08f806877551d17245367066e10cd8780f05

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+2.0.0 (29-11-2015)
+------------------
+
+- Add support for Rack environments.
+
+  ```ruby
+  ENV["RACK_ENV"] = "test"
+
+  # This will load `.env` and `.env.test`
+  Envoker::Rack.load
+  ```
+
+- Add support to override settings.
+
+  ```ruby
+  require "envoker"
+
+  Envoker.load(".env")
+  Envoker.overload(".env.local")
+  ```
+
+- Breaking change: Remove `Envoker#fetch`.

data/README.md

@@ -1,15 +1,90 @@
 envoker
 =======
 
-Load environment variables from .env files.
+Load environment variables from `.env` files.
 
 Usage
 -----
 
-This is a common pattern we use in our applications:
+Load your `.env` file in the application bootstrap
+process:
 
 ```ruby
+# .env
+RACK_ENV=development
+
+# boot.rb
 require "envoker"
+
+Envoker.load
+
+ENV["RACK_ENV"]
+# => "development"
+```
+
+You can use `Envoker#overload` to override
+existing values in `ENV`:
+
+```ruby
+# .env.test
+RACK_ENV=test
+
+# boot.rb
+# ...
+
+Envoker.overload(".env.test")
+
+ENV["RACK_ENV"]
+# => "test"
+```
+
+Multiple Environments
+---------------------
+
+`Envoker::Rack` adds support for multiple environments:
+
+```ruby
+require "envoker/rack"
+
+Envoker::Rack.load
+```
+
+You should store env vars that are general to
+all environments in `.env`, and store specific
+env vars in `.env.<environment>`.The default
+environment is `development`, but can be changed
+through `ENV["RACK_ENV"]`.
+
+```ruby
+ENV["RACK_ENV"] = "test"
+
+# This will load `.env` and `.env.test`
+Envoker::Rack.load
+```
+
+Settings
+--------
+
+This is a common pattern I use in my applications:
+
+```ruby
+require "envoker/rack"
+
+Envoker::Rack.load
+
+module Settings
+  def self.fetch(key)
+    return ENV.fetch(key) do
+      raise(sprintf("ENV[%p] not found", key))
+    end
+  end
+
+  REDIS_URL = fetch("REDIS_URL")
+  SMTP_URL  = fetch("SMTP_URL")
+end
+
+Settings::SMTP_URL
+# => redis://localhost:6379
 ```
 
 Installation

data/envoker.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.description = s.summary
   s.authors     = ["Francesco Rodríguez"]
   s.email       = ["frodsan@protonmail.ch"]
-  s.homepage    = "https://github.com/harmoni/envoker"
+  s.homepage    = "https://github.com/frodsan/envoker"
   s.license     = "MIT"
 
   s.files = `git ls-files`.split("\n")

data/lib/envoker.rb

@@ -1,8 +1,6 @@
 require_relative "envoker/version"
 
 module Envoker
-  KeyNotFound = Class.new(StandardError)
-
   def self.load(file)
     parse(file).each { |k, v| ENV[k] ||= v }
   rescue Errno::ENOENT
@@ -16,10 +14,4 @@ module Envoker
   def self.parse(file)
     return File.read(file).scan(/(.+)=(.*)$/)
   end
-
-  def self.fetch(key, default = nil)
-    return ENV.fetch(key) do
-      raise(KeyNotFound, sprintf("ENV[%p] not found", key))
-    end
-  end
 end

data/lib/envoker/rack.rb

@@ -5,7 +5,6 @@ module Envoker
     def self.load(file = ".env")
       Envoker.load(file)
       Envoker.overload(sprintf("%s.%s", file, environment))
-      Envoker.overload(sprintf("%s.local", file))
     end
 
     def self.environment

data/lib/envoker/version.rb

@@ -1,3 +1,3 @@
 module Envoker
-  VERSION = "2.0.0.rc1"
+  VERSION = "2.0.0"
 end

data/test/envoker_test.rb

@@ -46,24 +46,9 @@ scope "overload" do
   end
 end
 
-scope "fetch" do
-  test "return value from ENV" do
-    Envoker.load(FILE)
-
-    assert_equal "secret", Envoker.fetch("SECRET")
-  end
-
-  test "raise error if key not exists" do
-    assert_raise do
-      Envoker.fetch("notexists")
-    end
-  end
-end
-
 test "rack" do
   Envoker::Rack.load(FILE)
 
-  assert_equal "secret", Envoker.fetch("SECRET")
-  assert_equal "development", Envoker.fetch("ENVIRONMENT")
-  assert_equal "true", Envoker.fetch("OVERRIDED")
+  assert_equal "secret", ENV.fetch("SECRET")
+  assert_equal "development", ENV.fetch("ENVIRONMENT")
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: envoker
 version: !ruby/object:Gem::Version
-  version: 2.0.0.rc1
+  version: 2.0.0
 platform: ruby
 authors:
 - Francesco Rodríguez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-12 00:00:00.000000000 Z
+date: 2015-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cutest
@@ -32,6 +32,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gems"
+- CHANGELOG.md
 - LICENSE
 - README.md
 - envoker.gemspec
@@ -41,9 +42,8 @@ files:
 - makefile
 - test/.env.example
 - test/.env.example.development
-- test/.env.example.local
 - test/envoker_test.rb
-homepage: https://github.com/harmoni/envoker
+homepage: https://github.com/frodsan/envoker
 licenses:
 - MIT
 metadata: {}
@@ -58,9 +58,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.8

data/test/.env.example.local

@@ -1 +0,0 @@
-OVERRIDED=true