dotenv 2.2.2 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '079d89e03db53d20559c906bba1df9b109b8b413'
-  data.tar.gz: 03cdc7e8319aee4eadcbedeab9f42b57d742b32e
+  metadata.gz: cbd76e5c6ca084e248496b42e52b9108a0107e2d
+  data.tar.gz: d59561a4c5ece858dc36bf61194b8eda14064770
 SHA512:
-  metadata.gz: 6ac9590786f3f371c1e4e856fa3a9f8a5447dff0922389e12d6a9d893e1d9244eaa39104d1ad8f15f49a81dc0299f196a59256c829c6981135c5d120a2df0db5
-  data.tar.gz: ad9f0a6f301755e4116b133188a30ae31273991c815d3bb0ca42e471954bdc7fda6405f00a3a89228c847d5796bcf433064d62933e529ca78094597d8be03c5d
+  metadata.gz: 1c2fa80964b37fb1dfefb578945b93f0b2bac3476ddfb8429ab72835db67bec5d8c197ec27949a84769bca3895fd9c51916a1bc78eb864d76ce172634ffff7b5
+  data.tar.gz: f8caadc5aec3fef268b085a99cc032d7e102deb2121239fe2cb5d721414a71d1b428de288d15b8cb51989559b9fac96de245489ba9f1f27c94a5534d8ecae78f

data/README.md

@@ -1,6 +1,4 @@
-# dotenv [![Build Status](https://secure.travis-ci.org/bkeepers/dotenv.png?branch=master)](https://travis-ci.org/bkeepers/dotenv)
-
-[![Join the chat at https://gitter.im/bkeepers/dotenv](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/bkeepers/dotenv?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+# dotenv [![Build Status](https://secure.travis-ci.org/bkeepers/dotenv.png?branch=master)](https://travis-ci.org/bkeepers/dotenv) [![Gem Version](https://badge.fury.io/rb/dotenv.svg)](https://badge.fury.io/rb/dotenv) [![Join the chat at https://gitter.im/bkeepers/dotenv](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/bkeepers/dotenv?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 Shim to load environment variables from `.env` into `ENV` in *development*.
 
@@ -75,6 +73,12 @@ Alternatively, you can use the `dotenv` executable to launch your application:
 $ dotenv ./script.rb
 ```
 
+The `dotenv` executable also accepts a single flag, `-f`. Its value should be a comma-separated list of configuration files, in the order of most important to least. All of the files must exist. There _must_ be a space between the flag and its value.
+
+```
+$ dotenv -f ".env.local,.env" ./script.rb
+```
+
 To ensure `.env` is loaded in rake, load the tasks:
 
 ```ruby
@@ -112,9 +116,21 @@ export SECRET_KEY=YOURSECRETKEYGOESHERE
 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"
+PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----\nHkVN9...\n-----END DSA PRIVATE KEY-----\n"
 ```
 
+Alternatively, multi-line values with line breaks are now supported for quoted values.
+
+```shell
+PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----
+...
+HkVN9...
+...
+-----END DSA PRIVATE KEY-----"
+```
+
+This is particularly helpful when using the Heroku command line plugin [`heroku-config`](https://github.com/xavdid/heroku-config) to pull configuration variables down that may have line breaks.
+
 ### Command Substitution
 
 You need to add the output of a command in one of your variables? Simply add it with `$(your_command)`:

data/lib/dotenv.rb

@@ -12,7 +12,7 @@ module Dotenv
   def load(*filenames)
     with(*filenames) do |f|
       ignoring_nonexistent_files do
-        env = Environment.new(f)
+        env = Environment.new(f, true)
         instrument("dotenv.load", env: env) { env.apply }
       end
     end
@@ -21,7 +21,7 @@ module Dotenv
   # same as `load`, but raises Errno::ENOENT if any files don't exist
   def load!(*filenames)
     with(*filenames) do |f|
-      env = Environment.new(f)
+      env = Environment.new(f, true)
       instrument("dotenv.load", env: env) { env.apply }
     end
   end
@@ -30,7 +30,7 @@ module Dotenv
   def overload(*filenames)
     with(*filenames) do |f|
       ignoring_nonexistent_files do
-        env = Environment.new(f)
+        env = Environment.new(f, false)
         instrument("dotenv.overload", env: env) { env.apply! }
       end
     end

data/lib/dotenv/environment.rb

@@ -4,13 +4,13 @@ module Dotenv
   class Environment < Hash
     attr_reader :filename
 
-    def initialize(filename)
+    def initialize(filename, is_load)
       @filename = filename
-      load
+      load(is_load)
     end
 
-    def load
-      update Parser.call(read)
+    def load(is_load)
+      update Parser.call(read, is_load)
     end
 
     def read

data/lib/dotenv/parser.rb

@@ -12,38 +12,42 @@ module Dotenv
       [Dotenv::Substitutions::Variable, Dotenv::Substitutions::Command]
 
     LINE = /
-      \A
       \s*
       (?:export\s+)?    # optional export
       ([\w\.]+)         # key
       (?:\s*=\s*|:\s+?) # separator
       (                 # optional value begin
-        '(?:\'|[^'])*'  #   single quoted value
+        '(?:\\'|[^'])*'  #   single quoted value
         |               #   or
-        "(?:\"|[^"])*"  #   double quoted value
+        "(?:\\"|[^"])*"  #   double quoted value
         |               #   or
-        [^#\n]+         #   unquoted value
+        [^#\r\n]+         #   unquoted value
       )?                # value end
       \s*
       (?:\#.*)?         # optional comment
-      \z
     /x
 
     class << self
       attr_reader :substitutions
 
-      def call(string)
-        new(string).call
+      def call(string, is_load)
+        new(string, is_load).call
       end
     end
 
-    def initialize(string)
+    def initialize(string, is_load)
       @string = string
       @hash = {}
+      @is_load = is_load
     end
 
     def call
-      @string.split(/[\n\r]+/).each do |line|
+      # Process matches
+      @string.scan(LINE).each do |key, value|
+        @hash[key] = parse_value(value || "")
+      end
+      # Process non-matches
+      @string.gsub(LINE, "").split(/[\n\r]+/).each do |line|
         parse_line(line)
       end
       @hash
@@ -52,21 +56,16 @@ module Dotenv
     private
 
     def parse_line(line)
-      if (match = line.match(LINE))
-        key, value = match.captures
-        @hash[key] = parse_value(value || "")
-      elsif line.split.first == "export"
+      if line.split.first == "export"
         if variable_not_set?(line)
           raise FormatError, "Line #{line.inspect} has an unset variable"
         end
-      elsif line !~ /\A\s*(?:#.*)?\z/ # not comment or blank line
-        raise FormatError, "Line #{line.inspect} doesn't match format"
       end
     end
 
     def parse_value(value)
       # Remove surrounding quotes
-      value = value.strip.sub(/\A(['"])(.*)\1\z/, '\2')
+      value = value.strip.sub(/\A(['"])(.*)\1\z/m, '\2')
 
       if Regexp.last_match(1) == '"'
         value = unescape_characters(expand_newlines(value))
@@ -74,7 +73,7 @@ module Dotenv
 
       if Regexp.last_match(1) != "'"
         self.class.substitutions.each do |proc|
-          value = proc.call(value, @hash)
+          value = proc.call(value, @hash, @is_load)
         end
       end
       value

data/lib/dotenv/substitutions/command.rb

@@ -20,7 +20,7 @@ module Dotenv
           )
         /x
 
-        def call(value, _env)
+        def call(value, _env, _is_load)
           # Process interpolated shell commands
           value.gsub(INTERPOLATED_SHELL_COMMAND) do |*|
             # Eliminate opening and closing parentheses

data/lib/dotenv/substitutions/variable.rb

@@ -18,17 +18,27 @@ module Dotenv
           \}?           # closing brace
         /xi
 
-        def call(value, env)
+        def call(value, env, is_load)
+          combined_env = if is_load
+                           env.merge(ENV)
+                         else
+                           ENV.to_h.merge(env)
+                         end
           value.gsub(VARIABLE) do |variable|
             match = $LAST_MATCH_INFO
+            substitute(match, variable, combined_env)
+          end
+        end
+
+        private
 
-            if match[1] == '\\'
-              variable[1..-1]
-            elsif match[3]
-              env.fetch(match[3]) { ENV[match[3]] }
-            else
-              variable
-            end
+        def substitute(match, variable, env)
+          if match[1] == '\\'
+            variable[1..-1]
+          elsif match[3]
+            env.fetch(match[3], "")
+          else
+            variable
           end
         end
       end

data/lib/dotenv/version.rb

@@ -1,3 +1,3 @@
 module Dotenv
-  VERSION = "2.2.2".freeze
+  VERSION = "2.3.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dotenv
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 2.3.0
 platform: ruby
 authors:
 - Brandon Keepers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-09 00:00:00.000000000 Z
+date: 2018-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -92,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Loads environment variables from `.env`.