dotenv 2.7.3 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b740f417d40477078789125a03eafd06c1c8398a014f5760e609238d661c7a24
-  data.tar.gz: c7a53ef47fb24998a9ed63bb4ef7565d4f10040d187827f23ccb4e9e162168d9
+  metadata.gz: 53a782f20ccb8d0ed6e70eb3f6e626313a96460297e75dfc02356da40bea9ef1
+  data.tar.gz: 7dee9ae1c761ad5f069883443f8ccb0c3e8540187e432fc184783c88f1844ac6
 SHA512:
-  metadata.gz: dc1efb88938da1dca0bd4f7d50296177b23bb349f0c3aa566b284fff950e83bfd1827e9c9fd6bab008ea4e5811d91777920445ecc4b59312b42ac62e2898cde4
-  data.tar.gz: ca8827d32698f274232af990871b7e8396d9a6c0c7b9887fe28ab0af10d3ec1fb7c9ccefe6d228436103c03e5a7a3f259a2bf9ced2e8523699befecc3de4936b
+  metadata.gz: 0425caeb0f6321954bc8731438793f3d24306b72e0bf17c7de14e45c093bd2af892899d9b91780e0b688371e5db03a819eead8fe2475a7550fb1fc4762989e23
+  data.tar.gz: 52414dd28acab5d41879dc1740c08f8fe4265c66476dd04e1580291104701c0c5b5dcda87575d9aa4433f92587efcee87bf3aa7bb32eab35685b2fa2dd580855

data/README.md

@@ -1,4 +1,4 @@
-# dotenv [![Build Status](https://secure.travis-ci.org/bkeepers/dotenv.svg?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)
+# 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*.
 
@@ -30,7 +30,10 @@ dotenv is initialized in your Rails app during the `before_configuration` callba
 # config/application.rb
 Bundler.require(*Rails.groups)
 
-Dotenv::Railtie.load
+# Load dotenv only in development or test environment
+if ['development', 'test'].include? ENV['RAILS_ENV']
+  Dotenv::Railtie.load
+end
 
 HOSTNAME = ENV['HOSTNAME']
 ```
@@ -62,7 +65,7 @@ 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.
 
-```
+```ruby
 require 'dotenv'
 Dotenv.load('file1.env', 'file2.env')
 ```
@@ -223,7 +226,7 @@ You can use the `-t` or `--template` flag on the dotenv cli to create a template
 ```shell
 $ dotenv -t .env
 ```
-A template will be created in your working directory named `{FINAME}.template`. So in the above example, it would create a `.env.template` file. 
+A template will be created in your working directory named `{FINAME}.template`. So in the above example, it would create a `.env.template` file.
 
 The template will contain all the environment variables in your `.env` file but with their values set to the variable names.
 
@@ -233,7 +236,7 @@ S3_BUCKET=YOURS3BUCKET
 SECRET_KEY=YOURSECRETKEYGOESHERE
 ```
 
-Would become 
+Would become
 
 ```shell
 # .env.template
@@ -247,6 +250,11 @@ Personally, I prefer to commit the `.env` file with development-only settings. T
 
 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`.
 
+You can also use the `-o` or `--overload` flag on the dotenv cli to override existing `ENV` variables.
+```shell
+$ dotenv -o -f ".env.local,.env"
+```
+
 ## 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/cli.rb

@@ -4,77 +4,54 @@ require "dotenv/template"
 require "optparse"
 
 module Dotenv
-  # The CLI is a class responsible of handling all the command line interface
-  # logic.
-  class CLI
-    attr_reader :argv, :filenames
+  # The command line interface
+  class CLI < OptionParser
+    attr_reader :argv, :filenames, :overload
 
     def initialize(argv = [])
       @argv = argv.dup
       @filenames = []
-    end
+      @overload = false
 
-    def run
-      parse_argv!(@argv)
+      super "Usage: dotenv [options]"
+      separator ""
 
-      begin
-        Dotenv.load!(*@filenames)
-      rescue Errno::ENOENT => e
-        abort e.message
-      else
-        exec(*@argv) if @argv.present?
+      on("-f FILES", Array, "List of env files to parse") do |list|
+        @filenames = list
       end
-    end
-
-    private
-
-    def parse_argv!(argv)
-      parser = create_option_parser
-      add_options(parser)
-      parser.order!(argv)
-
-      @filenames
-    end
 
-    def add_options(parser)
-      add_files_option(parser)
-      add_help_option(parser)
-      add_version_option(parser)
-      add_template_option(parser)
-    end
-
-    def add_files_option(parser)
-      parser.on("-f FILES", Array, "List of env files to parse") do |list|
-        @filenames = list
+      on("-o", "--overload", "override existing ENV variables") do
+        @overload = true
       end
-    end
 
-    def add_help_option(parser)
-      parser.on("-h", "--help", "Display help") do
-        puts parser
+      on("-h", "--help", "Display help") do
+        puts self
         exit
       end
-    end
 
-    def add_version_option(parser)
-      parser.on("-v", "--version", "Show version") do
+      on("-v", "--version", "Show version") do
         puts "dotenv #{Dotenv::VERSION}"
         exit
       end
-    end
 
-    def add_template_option(parser)
-      parser.on("-t", "--template=FILE", "Create a template env file") do |file|
+      on("-t", "--template=FILE", "Create a template env file") do |file|
         template = Dotenv::EnvTemplate.new(file)
         template.create_template
       end
+
+      order!(@argv)
     end
 
-    def create_option_parser
-      OptionParser.new do |parser|
-        parser.banner = "Usage: dotenv [options]"
-        parser.separator ""
+    def run
+      if @overload
+        Dotenv.overload!(*@filenames)
+      else
+        Dotenv.load!(*@filenames)
       end
+    rescue Errno::ENOENT => e
+      abort e.message
+    else
+      exec(*@argv) unless @argv.empty?
     end
   end
 end

data/lib/dotenv/missing_keys.rb

@@ -3,7 +3,7 @@ module Dotenv
 
   class MissingKeys < Error # :nodoc:
     def initialize(keys)
-      key_word = "key#{keys.size > 1 ? 's' : ''}"
+      key_word = "key#{keys.size > 1 ? "s" : ""}"
       super("Missing required configuration #{key_word}: #{keys.inspect}")
     end
   end

data/lib/dotenv/parser.rb

@@ -12,21 +12,21 @@ module Dotenv
       [Dotenv::Substitutions::Variable, Dotenv::Substitutions::Command]
 
     LINE = /
-      (?:^|\A)           # beginning of line
-      \s*                # leading whitespace
-      (?:export\s+)?     # optional export
-      ([\w\.]+)          # key
-      (?:\s*=\s*?|:\s+?) # separator
-      (                  # optional value begin
-        '(?:\\'|[^'])*'  #   single quoted value
-        |                #   or
-        "(?:\\"|[^"])*"  #   double quoted value
-        |                #   or
-        [^\#\r\n]+       #   unquoted value
-      )?                 # value end
-      \s*                # trailing whitespace
-      (?:\#.*)?          # optional comment
-      (?:$|\z)           # end of line
+      (?:^|\A)              # beginning of line
+      \s*                   # leading whitespace
+      (?:export\s+)?        # optional export
+      ([\w.]+)              # key
+      (?:\s*=\s*?|:\s+?)    # separator
+      (                     # optional value begin
+        \s*'(?:\\'|[^'])*'  #   single quoted value
+        |                   #   or
+        \s*"(?:\\"|[^"])*"  #   double quoted value
+        |                   #   or
+        [^\#\r\n]+          #   unquoted value
+      )?                    # value end
+      \s*                   # trailing whitespace
+      (?:\#.*)?             # optional comment
+      (?:$|\z)              # end of line
     /x
 
     class << self
@@ -70,17 +70,9 @@ module Dotenv
     def parse_value(value)
       # Remove surrounding quotes
       value = value.strip.sub(/\A(['"])(.*)\1\z/m, '\2')
-
-      if Regexp.last_match(1) == '"'
-        value = unescape_characters(expand_newlines(value))
-      end
-
-      if Regexp.last_match(1) != "'"
-        self.class.substitutions.each do |proc|
-          value = proc.call(value, @hash, @is_load)
-        end
-      end
-      value
+      maybe_quote = Regexp.last_match(1)
+      value = unescape_value(value, maybe_quote)
+      perform_substitutions(value, maybe_quote)
     end
 
     def unescape_characters(value)
@@ -92,7 +84,26 @@ module Dotenv
     end
 
     def variable_not_set?(line)
-      !line.split[1..-1].all? { |var| @hash.member?(var) }
+      !line.split[1..].all? { |var| @hash.member?(var) }
+    end
+
+    def unescape_value(value, maybe_quote)
+      if maybe_quote == '"'
+        unescape_characters(expand_newlines(value))
+      elsif maybe_quote.nil?
+        unescape_characters(value)
+      else
+        value
+      end
+    end
+
+    def perform_substitutions(value, maybe_quote)
+      if maybe_quote != "'"
+        self.class.substitutions.each do |proc|
+          value = proc.call(value, @hash, @is_load)
+        end
+      end
+      value
     end
   end
 end

data/lib/dotenv/substitutions/command.rb

@@ -13,7 +13,7 @@ module Dotenv
           \$                  # literal $
           (?<cmd>             # collect command content for eval
             \(                # require opening paren
-            ([^()]|\g<cmd>)+  # allow any number of non-parens, or balanced
+            (?:[^()]|\g<cmd>)+  # allow any number of non-parens, or balanced
                               # parens (by nesting the <cmd> expression
                               # recursively)
             \)                # require closing paren
@@ -28,7 +28,7 @@ module Dotenv
 
             if $LAST_MATCH_INFO[:backslash]
               # Command is escaped, don't replace it.
-              $LAST_MATCH_INFO[0][1..-1]
+              $LAST_MATCH_INFO[0][1..]
             else
               # Execute the command and return the value
               `#{command}`.chomp

data/lib/dotenv/substitutions/variable.rb

@@ -19,11 +19,7 @@ module Dotenv
         /xi
 
         def call(value, env, is_load)
-          combined_env = if is_load
-                           env.merge(ENV)
-                         else
-                           ENV.to_h.merge(env)
-                         end
+          combined_env = is_load ? env.merge(ENV) : ENV.to_h.merge(env)
           value.gsub(VARIABLE) do |variable|
             match = $LAST_MATCH_INFO
             substitute(match, variable, combined_env)
@@ -33,8 +29,8 @@ module Dotenv
         private
 
         def substitute(match, variable, env)
-          if match[1] == '\\'
-            variable[1..-1]
+          if match[1] == "\\"
+            variable[1..]
           elsif match[3]
             env.fetch(match[3], "")
           else

data/lib/dotenv/template.rb

@@ -1,4 +1,5 @@
 module Dotenv
+  EXPORT_COMMAND = "export ".freeze
   # Class for creating a template from a env file
   class EnvTemplate
     def initialize(env_file)
@@ -9,11 +10,17 @@ module Dotenv
       File.open(@env_file, "r") do |env_file|
         File.open("#{@env_file}.template", "w") do |env_template|
           env_file.each do |line|
-            variable = line.split("=").first
-            env_template.puts "#{variable}=#{variable}"
+            env_template.puts template_line(line)
           end
         end
       end
     end
+
+    def template_line(line)
+      var, value = line.split("=")
+      template = var.gsub(EXPORT_COMMAND, "")
+      is_a_comment = var.strip[0].eql?("#")
+      value.nil? || is_a_comment ? line : "#{var}=#{template}"
+    end
   end
 end

data/lib/dotenv/version.rb

@@ -1,3 +1,3 @@
 module Dotenv
-  VERSION = "2.7.3".freeze
+  VERSION = "2.8.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dotenv
 version: !ruby/object:Gem::Version
-  version: 2.7.3
+  version: 2.8.0
 platform: ruby
 authors:
 - Brandon Keepers
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-06-22 00:00:00.000000000 Z
+date: 2022-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -39,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: '0'
 description: Loads environment variables from `.env`.
 email:
 - brandon@opensoul.org
@@ -78,7 +78,7 @@ homepage: https://github.com/bkeepers/dotenv
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -93,8 +93,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Loads environment variables from `.env`.
 test_files: []