dotenv-rails 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 464e9c021f470a45e9bd8a38ac9bf351a45d4241
-  data.tar.gz: edd0ee2c6d46c8b000cfcc659477d84606e6dba7
+  metadata.gz: 7e3538ec3b2d9ddf456640c6bbc5784de19204b8
+  data.tar.gz: 1da62894cf429e9c10bc168478d023f7b84dfcb0
 SHA512:
-  metadata.gz: b0f43fdcf6c01f2619c86fc6dd27e73aa5a79fd462a5be05eb6443976e79cb5a15d0c617a8c7c354c805b681156b46ea447f74bdc3d35cb4a1c49995c80df233
-  data.tar.gz: 706f7a36681dc279ef7c5876b7c3b1d01ca2850c730c24abb1fa9a6ad645292965c3fb74a7b9a4591c0a187425898b2dbe7f0de0bec9cc1b240c66324a2c3425
+  metadata.gz: a8391f94ba1cf3af34a577925094cc1444ade302de874d7bf9573a335e22e3c7dd828e5a89d1b75f48821891de03a00bab66df921a33e9c45d3b0f15110139c8
+  data.tar.gz: aa4b640e4f01d91b46bcfb38ad1c8ef312f4c0b1a0af070f7373844676d86fa53f9ed23224583ac6091691563fb3a3b543348bd824ef1e5e7596eba27ebdb41e

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/rails-now.rb

@@ -2,7 +2,7 @@
 # loaded, then list `dotenv-rails` in the `Gemfile` before those other gems and
 # require `dotenv/rails-now`.
 #
-#     gem "dotenv-rails", :require => "dotenv/rails-now"
+#     gem "dotenv-rails", require: "dotenv/rails-now"
 #     gem "gem-that-requires-env-variables"
 #
 

data/lib/dotenv/rails.rb

@@ -1,10 +1,23 @@
 require "dotenv"
 
+# Fix for rspec rake tasks loading in development
+#
+# Dotenv loads environment variables when the Rails application is initialized.
+# When running `rake`, the Rails application is initialized in development.
+# Rails includes some hacks to set `RAILS_ENV=test` when running `rake test`,
+# but rspec does not include the same hacks.
+#
+# See https://github.com/bkeepers/dotenv/issues/219
+if defined?(Rake.application)
+  is_running_specs = Rake.application.top_level_tasks.grep(/^spec(:|$)/).any?
+  Rails.env = ENV["RAILS_ENV"] ||= "test" if is_running_specs
+end
+
 Dotenv.instrumenter = ActiveSupport::Notifications
 
 # Watch all loaded env files with Spring
 begin
-  require "spring/watcher"
+  require "spring/commands"
   ActiveSupport::Notifications.subscribe(/^dotenv/) do |*args|
     event = ActiveSupport::Notifications::Event.new(*args)
     Spring.watch event.payload[:env].filename if Rails.application
@@ -17,18 +30,12 @@ module Dotenv
   # Dotenv Railtie for using Dotenv to load environment from a file into
   # Rails applications
   class Railtie < Rails::Railtie
-    config.before_configuration { load }
-
     # Public: Load dotenv
     #
     # This will get called during the `before_configuration` callback, but you
     # can manually call `Dotenv::Railtie.load` if you needed it sooner.
     def load
-      Dotenv.load(
-        root.join(".env.local"),
-        root.join(".env.#{Rails.env}"),
-        root.join(".env")
-      )
+      Dotenv.load(*dotenv_files)
     end
 
     # Internal: `Rails.root` is nil in Rails 4.1 before the application is
@@ -43,5 +50,18 @@ module Dotenv
     def self.load
       instance.load
     end
+
+    config.before_configuration { load }
+
+    private
+
+    def dotenv_files
+      [
+        root.join(".env.#{Rails.env}.local"),
+        (root.join(".env.local") unless Rails.env.test?),
+        root.join(".env.#{Rails.env}"),
+        root.join(".env")
+      ].compact
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dotenv-rails
 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: dotenv
@@ -16,21 +16,21 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '3.2'
     - - "<"
       - !ruby/object:Gem::Version
         version: '5.1'
@@ -40,7 +40,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '3.2'
     - - "<"
       - !ruby/object:Gem::Version
         version: '5.1'
@@ -90,7 +90,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: Autoload dotenv in Rails.