dotenv 3.1.2 → 3.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93520ca26942608e2d61ddae13f7b6d1cdd16e83e36d6cd9c770282149b2f441
-  data.tar.gz: bd58a9b3c59d7b6bad8327c1af4a69532ce5a4febb5a408f8a3a3874d3de6925
+  metadata.gz: a4ad122f937755147ff0cc52552f17b1e1cf8f9a290ff791ac5ba2f8ef8b43c7
+  data.tar.gz: 3116d767ea5dc67adca867395ea7effbc1b4ee30769223961f8d041d5c34482d
 SHA512:
-  metadata.gz: 178f4451234c97f3ad1d1601b62164d9f59fb52a35ad1393d3a924f541c2bc90e8732af795de3ea60acf0ade02ed81472127cebd0eac12d16648315806c58b95
-  data.tar.gz: 6ac43f44496d94b52ca8f2d852fa4c7bb095996604ead12a81db9118fac756a9fc89a61191f46cafcd846e8617421f7bfac62304c058def1c9d8915b1af47943
+  metadata.gz: 86436a8b6d193590befeb48a29882b9bd5523f8b80fff961faf1feda91cc720b8b44c1e2705bfbebb73836b99684273d49f78b94c09d05a3077e62996473a47c
+  data.tar.gz: bb6f98a159c821e0f1cb98ab6c3f0b54a109acc3c934770fd6603f7497c047f031c7124f839963f0f5132a12bd2736e25ab2e4c648cfa56589a30b328d03de61

data/README.md

@@ -180,7 +180,7 @@ end
 Available options:
 
 * `Dotenv::Rails.files` - list of files to be loaded, in order of precedence.
-* `Dotenv::Rails.overwrite` - Overwrite exiting `ENV` variables with contents of `.env*` files
+* `Dotenv::Rails.overwrite` - Overwrite existing `ENV` variables with contents of `.env*` files
 * `Dotenv::Rails.logger` - The logger to use for dotenv's logging. Defaults to `Rails.logger`
 * `Dotenv::Rails.autorestore` - Enable or disable [autorestore](#autorestore-in-tests)
 
@@ -213,7 +213,7 @@ DATABASE_URL="postgres://$(whoami)@localhost/my_database"
 
 ### 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.
+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 unquoted or double-quoted values.
 
 ```shell
 DATABASE_URL="postgres://${USER}@localhost/my_database"
@@ -276,7 +276,7 @@ You can use the `-t` or `--template` flag on the dotenv cli to create a template
 ```console
 $ 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 `{FILENAME}.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.
 

data/lib/dotenv/parser.rb

@@ -8,25 +8,29 @@ module Dotenv
   # Parses the `.env` file format into key/value pairs.
   # It allows for variable substitutions, command substitutions, and exporting of variables.
   class Parser
-    @substitutions =
-      [Dotenv::Substitutions::Variable, Dotenv::Substitutions::Command]
+    @substitutions = [
+      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
-        \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
+      (?:^|\A)                # beginning of line
+      \s*                     # leading whitespace
+      (?<export>export\s+)?   # optional export
+      (?<key>[\w.]+)          # key
+      (?:                     # optional separator and value
+        (?:\s*=\s*?|:\s+?)    #   separator
+        (?<value>             #   optional value begin
+          \s*'(?:\\'|[^'])*'  #     single quoted value
+          |                   #     or
+          \s*"(?:\\"|[^"])*"  #     double quoted value
+          |                   #     or
+          [^\#\n]+            #     unquoted value
+        )?                    #   value end
+      )?                      # separator and value end
+      \s*                     # trailing whitespace
+      (?:\#.*)?               # optional comment
+      (?:$|\z)                # end of line
     /x
 
     class << self
@@ -38,41 +42,55 @@ module Dotenv
     end
 
     def initialize(string, overwrite: false)
-      @string = string
+      # Convert line breaks to same format
+      @string = string.gsub(/\r\n?/, "\n")
       @hash = {}
       @overwrite = overwrite
     end
 
     def call
-      # Convert line breaks to same format
-      lines = @string.gsub(/\r\n?/, "\n")
-      # Process matches
-      lines.scan(LINE).each do |key, value|
-        @hash[key] = parse_value(value || "")
-      end
-      # Process non-matches
-      lines.gsub(LINE, "").split(/[\n\r]+/).each do |line|
-        parse_line(line)
+      @string.scan(LINE) do
+        match = $LAST_MATCH_INFO
+
+        if existing?(match[:key])
+          # Use value from already defined variable
+          @hash[match[:key]] = ENV[match[:key]]
+        elsif match[:export] && !match[:value]
+          # Check for exported variable with no value
+          if !@hash.member?(match[:key])
+            raise FormatError, "Line #{match.to_s.inspect} has an unset variable"
+          end
+        else
+          @hash[match[:key]] = parse_value(match[:value] || "")
+        end
       end
+
       @hash
     end
 
     private
 
-    def parse_line(line)
-      if line.split.first == "export"
-        if variable_not_set?(line)
-          raise FormatError, "Line #{line.inspect} has an unset variable"
-        end
-      end
+    # Determine if a variable is already defined and should not be overwritten.
+    def existing?(key)
+      !@overwrite && key != "DOTENV_LINEBREAK_MODE" && ENV.key?(key)
     end
 
+    QUOTED_STRING = /\A(['"])(.*)\1\z/m
     def parse_value(value)
       # Remove surrounding quotes
-      value = value.strip.sub(/\A(['"])(.*)\1\z/m, '\2')
+      value = value.strip.sub(QUOTED_STRING, '\2')
       maybe_quote = Regexp.last_match(1)
-      value = unescape_value(value, maybe_quote)
-      perform_substitutions(value, maybe_quote)
+
+      # Expand new lines in double quoted values
+      value = expand_newlines(value) if maybe_quote == '"'
+
+      # Unescape characters and performs substitutions unless value is single quoted
+      if maybe_quote != "'"
+        value = unescape_characters(value)
+        self.class.substitutions.each { |proc| value = proc.call(value, @hash) }
+      end
+
+      value
     end
 
     def unescape_characters(value)
@@ -86,28 +104,5 @@ module Dotenv
         value.gsub('\n', "\\\\\\n").gsub('\r', "\\\\\\r")
       end
     end
-
-    def variable_not_set?(line)
-      !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, overwrite: @overwrite)
-        end
-      end
-      value
-    end
   end
 end

data/lib/dotenv/rails.rb

@@ -10,14 +10,11 @@ require "dotenv/log_subscriber"
 Dotenv.instrumenter = ActiveSupport::Notifications
 
 # Watch all loaded env files with Spring
-begin
-  require "spring/commands"
-  ActiveSupport::Notifications.subscribe("load.dotenv") do |*args|
+ActiveSupport::Notifications.subscribe("load.dotenv") do |*args|
+  if defined?(Spring) && Spring.respond_to?(:watch)
     event = ActiveSupport::Notifications::Event.new(*args)
     Spring.watch event.payload[:env].filename if Rails.application
   end
-rescue LoadError, ArgumentError
-  # Spring is not available
 end
 
 module Dotenv
@@ -26,7 +23,7 @@ module Dotenv
     delegate :files, :files=, :overwrite, :overwrite=, :autorestore, :autorestore=, :logger, to: "config.dotenv"
 
     def initialize
-      super()
+      super
       config.dotenv = ActiveSupport::OrderedOptions.new.update(
         # Rails.logger is not available yet, so we'll save log messages and replay them when it is
         logger: Dotenv::ReplayLogger.new,

data/lib/dotenv/substitutions/command.rb

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

data/lib/dotenv/substitutions/variable.rb

@@ -12,29 +12,23 @@ module Dotenv
         VARIABLE = /
           (\\)?         # is it escaped with a backslash?
           (\$)          # literal $
-          (?!\()        # shouldnt be followed by paranthesis
+          (?!\()        # shouldn't be followed by parenthesis
           \{?           # allow brace wrapping
           ([A-Z0-9_]+)? # optional alpha nums
           \}?           # closing brace
         /xi
 
-        def call(value, env, overwrite: false)
-          combined_env = overwrite ? ENV.to_h.merge(env) : env.merge(ENV)
+        def call(value, env)
           value.gsub(VARIABLE) do |variable|
             match = $LAST_MATCH_INFO
-            substitute(match, variable, combined_env)
-          end
-        end
-
-        private
 
-        def substitute(match, variable, env)
-          if match[1] == "\\"
-            variable[1..]
-          elsif match[3]
-            env.fetch(match[3], "")
-          else
-            variable
+            if match[1] == "\\"
+              variable[1..]
+            elsif match[3]
+              env[match[3]] || ENV[match[3]] || ""
+            else
+              variable
+            end
           end
         end
       end

data/lib/dotenv/template.rb

@@ -34,7 +34,7 @@ module Dotenv
 
     def var_defined?(line)
       match = Dotenv::Parser::LINE.match(line)
-      match && match[1]
+      match && match[:key]
     end
 
     def line_blank?(line)

data/lib/dotenv/version.rb

@@ -1,3 +1,3 @@
 module Dotenv
-  VERSION = "3.1.2".freeze
+  VERSION = "3.1.7".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dotenv
 version: !ruby/object:Gem::Version
-  version: 3.1.2
+  version: 3.1.7
 platform: ruby
 authors:
 - Brandon Keepers
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-06 00:00:00.000000000 Z
+date: 2024-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -83,8 +83,9 @@ files:
 homepage: https://github.com/bkeepers/dotenv
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  changelog_uri: https://github.com/bkeepers/dotenv/releases
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -99,8 +100,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key: 
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: Loads environment variables from `.env`.
 test_files: []