zenv 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 438dd1e82c02275c21e289e689ee308e869f07fe
-  data.tar.gz: 98388f6bc62fae19cca7b588c6a7cf4ed7cbdad1
+  metadata.gz: b1df55652a6508cc08bf94d84a0387c6299db04d
+  data.tar.gz: 96ae5137953732b39513021bd14f4278ac5831ce
 SHA512:
-  metadata.gz: 066e17b3fde5ac7abcceb5f13a39230851c1f9737a372d9629fed2dbaf77bbba61366b3db594b5a5f07ace0266851504696c0e6ae5f942582ba39d268c1dde75
-  data.tar.gz: a1f33259b1697d7b370eb15947063f892b9054b125b79d6e6d0e67aa5f10ff0f59da08cc22c5563b78155a27e5ebe48f805c0c5227e9407deb417d53ef177571
+  metadata.gz: 044b22587347c9225a75b645337201f162676400f69bce4d5198f00020f1970f7eb6a1bad77587193901f2773a43f46ab59ecb765d58b711a74c0c393227765d
+  data.tar.gz: 7b6907ad555619e21768bef2f948f91c576412d59ab61c0ac73f105024f1e0e20fa0ffd7c6a2585242a43b2a93a48dafc2c5471f3c6cc260ee82a0b7c28dd831

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.zenv

@@ -0,0 +1,8 @@
+{
+  default: {
+    KEY: 'default value'
+  },
+  other: {
+    KEY: 'other value'
+  }
+}

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## 1.0.0 (2016-06-06)
+
+* Removed `Zenv.load` as a public method.
+* Added basic specs. Run with `rspec`.
+* Updated some docs to `README.md`.
+* Added `CHANGELOG.md`.

data/README.md

@@ -1,6 +1,6 @@
-# Zenv
+# ZEN ENV
 
-Simple and flexible approach to loading env vars
+Simple and flexible approach to loading environment variables.
 
 ## Installation
 
@@ -20,7 +20,41 @@ Or install it yourself as:
 
 ## Usage
 
-Coming soon.
+Create a '.zenv' file at the root of your project:
+
+```ruby
+{
+  default: {
+    KEY: 'value',
+    ...
+  },
+}
+```
+
+The `:default` namespace will be loaded into `ENV`.
+
+### Namespaces
+
+To load a different set of environment variables, add another "namespace":
+
+```ruby
+{
+  default: {
+    KEY: 'value',
+    ...
+  },
+  other: {
+    KEY: 'other value',
+    ...
+  }
+}
+```
+
+Specify the namespace in `ZENV`. E.g. `ZENV=other rails console`.
+
+### Pre-loading
+
+If environment variables need to be loaded _before_ your application is loaded, run the command with `zenv`. For example, if you're running the puma web server and it depends on `PORT`, run `zenv puma`.
 
 ## Development
 
@@ -30,4 +64,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/zenv.
+Bug reports and pull requests are welcome on GitHub at https://github.com/austinthecoder/zenv.

data/lib/zenv/version.rb

@@ -1,3 +1,3 @@
 module Zenv
-  VERSION = "0.2.0"
+  VERSION = "1.0.0"
 end

data/lib/zenv.rb

@@ -1,41 +1,44 @@
+require 'pathname'
 require "zenv/version"
 
 module Zenv
-  def self.load
-    namespace = ENV['ZENV']&.to_sym || :default
+  @pathname = Pathname.new '.zenv'
 
-    if @namespace_loaded
-      warn "[Zenv] skipping #{namespace.inspect}, already loaded #{@namespace_loaded.inspect}"
-    end
+  class << self
+    attr_writer :pathname
 
-    filename = '.zenv'
+    private
 
-    unless File.exist? filename
-      warn "[Zenv] .zenv file not found"
-      return
-    end
+    attr_reader :pathname, :namespace_loaded
 
-    data = begin
-      filepath = File.expand_path filename
-      ruby_code = File.read filepath
-      eval ruby_code
-    end
+    def load
+      namespace = ENV['ZENV']&.to_sym || :default
 
-    unless data.key? namespace
-      warn "[Zenv] missing #{namespace.inspect} in .zenv"
-      return
-    end
+      if namespace_loaded
+        warn "[Zenv] skipping #{namespace.inspect}, already loaded #{namespace_loaded.inspect}"
+      end
 
-    data[namespace].each do |key, value|
-      ENV[key.to_s] = value
-    end
+      unless pathname.exist?
+        warn "[Zenv] .zenv file not found"
+        return
+      end
 
-    @namespace_loaded = namespace
+      data = eval pathname.read
 
-    puts "[Zenv] loaded #{@namespace_loaded.inspect}"
+      unless data.key? namespace
+        warn "[Zenv] missing #{namespace.inspect} in .zenv"
+        return
+      end
 
-    @namespace_loaded
+      data[namespace].each do |key, value|
+        ENV[key.to_s] = value
+      end
+
+      namespace_loaded = namespace
+
+      puts "[Zenv] loaded #{namespace_loaded.inspect}"
+    end
   end
-end
 
-Zenv.load
+  load
+end

data/zenv.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.email         = ["me@austinschneider.com"]
 
   spec.summary       = 'Zen Env'
-  spec.description   = 'Simple and flexible approach to loading env vars'
-  spec.homepage      = ''
+  spec.description   = 'Simple and flexible approach to loading environment variables.'
+  spec.homepage      = 'https://github.com/austinthecoder/zenv'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = "exe"
@@ -20,4 +20,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zenv
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Austin Schneider
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-03 00:00:00.000000000 Z
+date: 2016-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,7 +38,21 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: Simple and flexible approach to loading env vars
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: Simple and flexible approach to loading environment variables.
 email:
 - me@austinschneider.com
 executables:
@@ -47,6 +61,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".zenv"
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
@@ -56,7 +73,7 @@ files:
 - lib/zenv.rb
 - lib/zenv/version.rb
 - zenv.gemspec
-homepage: ''
+homepage: https://github.com/austinthecoder/zenv
 licenses: []
 metadata: {}
 post_install_message: