en 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e0730bf3f441f312f51ca70db752865b50704ba
-  data.tar.gz: 55b33939420926b9b580ceaa3fb74372bd2ec5df
+  metadata.gz: 483651d5ac02c37ae6ea8ad520d222df5a6a529f
+  data.tar.gz: 8b1506b87f556a45d3f4f131dcaa4b942c998d80
 SHA512:
-  metadata.gz: 29803135f67434b9a02646c8f35697dd192814d1831c190ac15c52643151c6ff9ad17011062e09ca58a3012fc6d5328c4c16b57b972daa2cb86457eacbc11241
-  data.tar.gz: a2c082676f70a311cd37fe6dc5e22e1939389ff04be05d80695c78849044af4733efce0f622cd77d8587861e1c8c3c828c3260ba2da9adaa256f3bf207ef6f6f
+  metadata.gz: 212574b54996398ce89aff571b12ecbfaa951495cc7817178134e7a1f9f77bd373334de4c289f78c263d04cf5fa8aa92791187067cfe51f2bbe72dc037ff9be4
+  data.tar.gz: f6a323fb351ab17fb2c12f07fe9ac4aebc8e4e9da680f8638e795d7856201070ba348c1b84079abe2074952ed9389f2f51362d7aa216da2739ae447d1ba25755

data/README.md

@@ -0,0 +1,49 @@
+# EN
+
+[![Build Status](https://secure.travis-ci.org/rodrigues/en.png?branch=master)](https://travis-ci.org/rodrigues/en)
+
+A simple, namespaceable environment fetcher that supports optionally [dotenv](https://github.com/bkeepers/dotenv)
+
+To get a variable value, do:
+
+```ruby
+require 'en'
+
+EN[:key]      # looks for ENV['KEY']
+EN[:foo_bar]  # looks for ENV['FOO_BAR']
+```
+
+The `#fetch` method can give you more options:
+
+```ruby
+require 'en'
+
+EN.fetch(:key) { 'default_value' }
+
+EN.fetch_int(:key)   # fails if value is not a valid Integer
+EN.fetch_float(:key) # fails if value is not a valid Float
+```
+
+To load variables from a .env file via `dotenv`, do:
+
+```ruby
+# .env file
+KEY: value
+
+# ruby file
+require 'en'
+
+EN.load
+
+EN.fetch(:key)
+```
+
+To namespace your keys by a prefix, do:
+
+```ruby
+def redis_env
+  EN::Namespace.new(:redis)
+end
+
+port = redis_env.fetch_int(:port)
+```

data/lib/en.rb

@@ -1,18 +1,22 @@
 require 'en/version'
 
-require 'dotenv'
-
-Dotenv.load
-
 module EN
   extend self
 
+  def load
+    require 'dotenv'
+    Dotenv.load
+    self
+  end
+
   def fetch(variable)
     ENV[variable.to_s.upcase] || begin
       yield if block_given?
     end
   end
 
+  alias_method :[], :fetch
+
   TYPES = {
     int:     method(:Integer),
     integer: method(:Integer),

data/lib/en/version.rb

@@ -1,3 +1,3 @@
 module EN
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: en
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Victor Rodrigues
@@ -90,6 +90,7 @@ files:
 - ".gitignore"
 - Gemfile
 - LICENSE.txt
+- README.md
 - Rakefile
 - en.gemspec
 - lib/en.rb