dotenv 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97b35237fb293817afb2b3fb79b08b21a5425b65
-  data.tar.gz: f1ec39284e95bcf5a9b96e5cf3cd4aaa1e4d9e67
+  metadata.gz: 709d168c1067da71893c77f0095e2926234c1563
+  data.tar.gz: f5dfdff21d1c187969960c117f4e4c34b50c586b
 SHA512:
-  metadata.gz: aab63b855e90cb05ceedcc3877f425e2af3cdb94327423f3ce8f253b5da5e392a64f5b00b9114480ed83b42ad72a3ffdc1ec2bfaa0f3d94fed1c5d0858c0d459
-  data.tar.gz: 4e097555c5daa7e2bcb800d771da52936298906ba5e3affa6b5835c50921690191d2610ceae5a1de329fa51ed64f494ea66ff5d80cc917fd34e5065019c73d4c
+  metadata.gz: 171cc72b428e5c94ce1d212799374473892c17c18f2ec71ffac6a52561fc0cd1b35919e2fd4450efec15b454bca794b26c427ef7ccecea56cb3544171db1bd45
+  data.tar.gz: 7e09916cd51b2f1e42f8fee2814c2a11c9fc72d4abb30b4e4dcfb311776ca9180fbd68cb731696ceb48802adb1c24ce3d9af0a100c3ab2cf9ba05e5596b8f7d5

data/README.md

@@ -15,7 +15,7 @@ But it is not always practical to set environment variables on development machi
 Add this line to the top of your application's Gemfile:
 
 ```ruby
-gem 'dotenv-rails', :groups => [:development, :test]
+gem 'dotenv-rails', groups: [:development, :test]
 ```
 
 And then execute:
@@ -40,7 +40,7 @@ HOSTNAME = ENV['HOSTNAME']
 If you use gems that require environment variables to be set before they are loaded, then list `dotenv-rails` in the `Gemfile` before those other gems and require `dotenv/rails-now`.
 
 ```ruby
-gem 'dotenv-rails', :require => 'dotenv/rails-now'
+gem 'dotenv-rails', require: 'dotenv/rails-now'
 gem 'gem-that-requires-env-variables'
 ```
 
@@ -55,10 +55,20 @@ $ gem install dotenv
 As early as possible in your application bootstrap process, load `.env`:
 
 ```ruby
+require 'dotenv/load'
+
+# or
 require 'dotenv'
 Dotenv.load
 ```
 
+By default, `load` will look for a file called `.env` in the current working directory. Pass in multiple files and they will be loaded in order. The first value set for a variable will win.
+
+```
+require 'dotenv'
+Dotenv.load('file1.env', 'file2.env')
+```
+
 Alternatively, you can use the `dotenv` executable to launch your application:
 
 ```shell
@@ -70,7 +80,7 @@ To ensure `.env` is loaded in rake, load the tasks:
 ```ruby
 require 'dotenv/tasks'
 
-task :mytask => :dotenv do
+task mytask: :dotenv do
     # things that require .env
 end
 ```
@@ -84,30 +94,51 @@ S3_BUCKET=YOURS3BUCKET
 SECRET_KEY=YOURSECRETKEYGOESHERE
 ```
 
+Whenever your application loads, these variables will be available in `ENV`:
+
+```ruby
+config.fog_directory  = ENV['S3_BUCKET']
+```
+
+You may also add `export` in front of each line so you can `source` the file in bash:
+
+```shell
+export S3_BUCKET=YOURS3BUCKET
+export SECRET_KEY=YOURSECRETKEYGOESHERE
+```
+
+### Multi-line values
+
 If you need multiline variables, for example private keys, you can double quote strings and use the `\n` character for newlines:
 
 ```shell
 PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----\nHkVN9…\n-----END DSA PRIVATE KEY-----\n"
 ```
 
+### Command Substitution
+
 You need to add the output of a command in one of your variables? Simply add it with `$(your_command)`:
+
 ```shell
 DATABASE_URL="postgres://$(whoami)@localhost/my_database"
 ```
 
-You may also add `export` in front of each line so you can `source` the file in bash:
+### Variable Substitution
+
+You need to add the value of another variable in one of your variables? You can reference the variable with `${VAR}` or often just `$VAR` in unqoted or double-quoted values.
 
 ```shell
-export S3_BUCKET=YOURS3BUCKET
-export SECRET_KEY=YOURSECRETKEYGOESHERE
+DATABASE_URL="postgres://${USER}@localhost/my_database"
 ```
 
-Whenever your application loads, these variables will be available in `ENV`:
+If a value contains a `$` and it is not intended to be a variable, wrap it in single quotes.
 
-```ruby
-config.fog_directory  = ENV['S3_BUCKET']
+```shell
+PASSWORD='pas$word'
 ```
 
+### Comments
+
 Comments may be added to your file as such:
 
 ```shell
@@ -116,24 +147,35 @@ SECRET_KEY=YOURSECRETKEYGOESHERE # comment
 SECRET_HASH="something-with-a-#-hash"
 ```
 
-Variable names may not contain the `#` symbol. Values can use the `#` if they are enclosed in quotes.
+## Frequently Answered Questions
 
-## Multiple Rails Environments
+### Can I use dotenv in production?
 
 dotenv was originally created to load configuration variables into `ENV` in *development*. There are typically better ways to manage configuration in production environments - such as `/etc/environment` managed by [Puppet](https://github.com/puppetlabs/puppet) or [Chef](https://github.com/chef/chef), `heroku config`, etc.
 
 However, some find dotenv to be a convenient way to configure Rails applications in staging and production environments, and you can do that by defining environment-specific files like `.env.production` or `.env.test`.
 
-You can also use `.env.local` for local overrides.
+If you use this gem to handle env vars for multiple Rails environments (development, test, production, etc.), please note that env vars that are general to all environments should be stored in `.env`. Then, environment specific env vars should be stored in `.env.<that environment's name>`.
 
-If you use this gem to handle env vars for multiple Rails environments (development, test, production, etc.), please note that env vars that are general to all environments should be stored in `.env`. Then, environment specific env vars should be stored in `.env.<that environment's name>`. When you load a certain environment, dotenv will first load general env vars from `.env`, then load environment specific env vars from `.env.<current environment>`. Variables defined in `.env.<current environment>` will override any values set in `.env` or already defined in the environment.
+### What other .env* files can I use?
 
-## Should I commit my .env file?
+`dotenv-rails` will load the following files, starting from the bottom. The first value set (or those already defined in the environment) take precedence:
+
+- `.env` - The Original®
+- `.env.development`, `.env.test`, `.env.production` - Environment-specific settings.
+- `.env.local` - Local overrides. This file is loaded for all environments _except_ `test`.
+- `.env.development.local`, `.env.test.local`, `.env.production.local` - Local overrides of environment-specific settings.
+
+### Should I commit my .env file?
 
 Credentials should only be accessible on the machines that need access to them. Never commit sensitive information to a repository that is not needed by every development machine and server.
 
 Personally, I prefer to commit the `.env` file with development-only settings. This makes it easy for other developers to get started on the project without compromising credentials for other environments. If you follow this advice, make sure that all the credentials for your development environment are different from your other deployments and that the development credentials do not have access to any confidential data.
 
+### Why is it not overriding existing `ENV` variables?
+
+By default, it **won't** overwrite existing environment variables as dotenv assumes the deployment environment has more knowledge about configuration than the application does. To overwrite existing environment variables you can use `Dotenv.overload`.
+
 ## Contributing
 
 If you want a better idea of how dotenv works, check out the [Ruby Rogues Code Reading of dotenv](https://www.youtube.com/watch?v=lKmY_0uY86s).

data/lib/dotenv/environment.rb

@@ -14,7 +14,7 @@ module Dotenv
     end
 
     def read
-      File.open(@filename, "rb:bom|utf-8") { |file| file.read }
+      File.open(@filename, "rb:bom|utf-8", &:read)
     end
 
     def apply

data/lib/dotenv/load.rb

@@ -0,0 +1,2 @@
+require "dotenv"
+Dotenv.load

data/lib/dotenv/parser.rb

@@ -9,10 +9,11 @@ module Dotenv
   # exporting of variables.
   class Parser
     @substitutions =
-      Substitutions.constants.map { |const| Substitutions.const_get(const) }
+      [Dotenv::Substitutions::Variable, Dotenv::Substitutions::Command]
 
     LINE = /
       \A
+      \s*
       (?:export\s+)?    # optional export
       ([\w\.]+)         # key
       (?:\s*=\s*|:\s+?) # separator
@@ -23,7 +24,8 @@ module Dotenv
         |               #   or
         [^#\n]+         #   unquoted value
       )?                # value end
-      (?:\s*\#.*)?      # optional comment
+      \s*
+      (?:\#.*)?         # optional comment
       \z
     /x
 
@@ -55,10 +57,10 @@ module Dotenv
         @hash[key] = parse_value(value || "")
       elsif line.split.first == "export"
         if variable_not_set?(line)
-          fail FormatError, "Line #{line.inspect} has an unset variable"
+          raise FormatError, "Line #{line.inspect} has an unset variable"
         end
       elsif line !~ /\A\s*(?:#.*)?\z/ # not comment or blank line
-        fail FormatError, "Line #{line.inspect} doesn't match format"
+        raise FormatError, "Line #{line.inspect} doesn't match format"
       end
     end
 

data/lib/dotenv/tasks.rb

@@ -4,4 +4,4 @@ task :dotenv do
   Dotenv.load
 end
 
-task :environment => :dotenv
+task environment: :dotenv

data/lib/dotenv/version.rb

@@ -1,3 +1,3 @@
 module Dotenv
-  VERSION = "2.1.0"
+  VERSION = "2.2.0".freeze
 end

data/lib/dotenv.rb

@@ -13,7 +13,7 @@ module Dotenv
     with(*filenames) do |f|
       ignoring_nonexistent_files do
         env = Environment.new(f)
-        instrument("dotenv.load", :env => env) { env.apply }
+        instrument("dotenv.load", env: env) { env.apply }
       end
     end
   end
@@ -22,7 +22,7 @@ module Dotenv
   def load!(*filenames)
     with(*filenames) do |f|
       env = Environment.new(f)
-      instrument("dotenv.load", :env => env) { env.apply }
+      instrument("dotenv.load", env: env) { env.apply }
     end
   end
 
@@ -31,7 +31,7 @@ module Dotenv
     with(*filenames) do |f|
       ignoring_nonexistent_files do
         env = Environment.new(f)
-        instrument("dotenv.overload", :env => env) { env.apply! }
+        instrument("dotenv.overload", env: env) { env.apply! }
       end
     end
   end
@@ -39,11 +39,11 @@ module Dotenv
   # Internal: Helper to expand list of filenames.
   #
   # Returns a hash of all the loaded environment variables.
-  def with(*filenames, &block)
+  def with(*filenames)
     filenames << ".env" if filenames.empty?
 
     filenames.reduce({}) do |hash, filename|
-      hash.merge! block.call(File.expand_path(filename)) || {}
+      hash.merge!(yield(File.expand_path(filename)) || {})
     end
   end
 
@@ -51,7 +51,7 @@ module Dotenv
     if instrumenter
       instrumenter.instrument(name, payload, &block)
     else
-      block.call
+      yield
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dotenv
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Brandon Keepers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-14 00:00:00.000000000 Z
+date: 2017-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -42,16 +42,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.40.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.40.0
 description: Loads environment variables from `.env`.
 email:
 - brandon@opensoul.org
@@ -66,6 +66,7 @@ files:
 - lib/dotenv.rb
 - lib/dotenv/cli.rb
 - lib/dotenv/environment.rb
+- lib/dotenv/load.rb
 - lib/dotenv/parser.rb
 - lib/dotenv/substitutions/command.rb
 - lib/dotenv/substitutions/variable.rb
@@ -91,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Loads environment variables from `.env`.