dotenv 3.1.8 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 586dd937a4a5a27f37fb6c71d64498ba9c84854d36d761cd1e1759f6cf130710
-  data.tar.gz: c3c8aad2fa4666f59833edc8baa77a2e127350a5987208c6c96b6a0f4ac55e98
+  metadata.gz: d94f968de5def640d49274915a92e82c9dcf9e5783e58fee39fa2b72a9b7ac0d
+  data.tar.gz: e892cb84dfbcc7c38bd484f4c747849c52f3050fc170719180c3f79eef63a2ef
 SHA512:
-  metadata.gz: d77998e7079602e9e2114cea2fcc9a119be0f9fcbc5d962d687c72df0239bf6ae93a66502fb856abaaa0b12dd14960ef08bc990d75fc3bca87ec8b08f8f17ea6
-  data.tar.gz: a669c1d1bc64af5cb3e3eafafdab2877adf5bfcf7d8b72b90d47bfcdad441afd77c8a55742660a46ab75b34ac8bc447c82a6b86b52f2714366382737eb72efa3
+  metadata.gz: 5ce6017a1069f68382d9a0a241130243bc807a388788bd17129ce2a135d10cdb1dd607b8fbb69ce469540114d77014a833dbe2ebc416ae77560c5bf40db09e0c
+  data.tar.gz: 301e709c9e0d322668a145ee6cf723a532b2805a6112a6479624b6cd61be0e4b60a42234be611bc1901195f99c799598402b846c257f813744ef286bd0326987

data/README.md

@@ -2,11 +2,6 @@
 
 Shim to load environment variables from `.env` into `ENV` in *development*.
 
-<img align="left" src="https://github.com/user-attachments/assets/0052ed0b-00d2-416a-bdaa-0466c0226933" width="80" />
-<div><sup>Dotenv is proud to be <a href="https://github.com/sponsors/bkeepers">sponsored by</a>:</sup></div>
-<strong><a href="https://bit.ly/dotenv-stoked-seagull">Stoked Seagull Software</a></strong>
-<div>Need help with a software project but don't know where to begin? <a href="https://bit.ly/dotenv-stoked-seagull">Stoked Seagull can help.</a></div><br><br>
-
 Storing [configuration in the environment](http://12factor.net/config) is one of the tenets of a [twelve-factor app](http://12factor.net). Anything that is likely to change between deployment environments–such as resource handles for databases or credentials for external services–should be extracted from the code into environment variables.
 
 But it is not always practical to set environment variables on development machines or continuous integration servers where multiple projects are run. dotenv loads variables from a `.env` file into `ENV` when the environment is bootstrapped.
@@ -52,7 +47,10 @@ 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.
+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.
+Existing environment variables will not be overwritten unless you set `overwrite: true`.
 
 ```ruby
 require 'dotenv'
@@ -319,6 +317,9 @@ 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.load files, overwrite: true`.
 
+To warn when a value was not overwritten (e.g. to make users aware of this gotcha),
+use `Dotenv.load files, overwrite: :warn`.
+
 You can also use the `-o` or `--overwrite` flag on the dotenv cli to overwrite existing `ENV` variables.
 
 ```console

data/lib/dotenv/log_subscriber.rb

@@ -24,7 +24,7 @@ module Dotenv
     def update(event)
       diff = event.payload[:diff]
       changed = diff.env.keys.map { |key| color_var(key) }
-      debug "Set #{changed.to_sentence}" if diff.any?
+      debug "Set #{changed.join(", ")}" if diff.any?
     end
 
     def save(event)
@@ -39,8 +39,8 @@ module Dotenv
 
       if removed.any? || restored.any?
         info "Restored snapshot of #{color_env_constant}"
-        debug "Unset #{removed.to_sentence}" if removed.any?
-        debug "Restored #{restored.to_sentence}" if restored.any?
+        debug "Unset #{removed.join(", ")}" if removed.any?
+        debug "Restored #{restored.join(", ")}" if restored.any?
       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#{"s" if keys.size > 1}"
       super("Missing required configuration #{key_word}: #{keys.inspect}")
     end
   end

data/lib/dotenv/parser.rb

@@ -9,8 +9,8 @@ module Dotenv
   # It allows for variable substitutions, command substitutions, and exporting of variables.
   class Parser
     @substitutions = [
-      Dotenv::Substitutions::Variable,
-      Dotenv::Substitutions::Command
+      Dotenv::Substitutions::Command,
+      Dotenv::Substitutions::Variable
     ]
 
     LINE = /

data/lib/dotenv/substitutions/command.rb

@@ -20,7 +20,7 @@ module Dotenv
           )
         /x
 
-        def call(value, _env)
+        def call(value, env)
           # Process interpolated shell commands
           value.gsub(INTERPOLATED_SHELL_COMMAND) do |*|
             # Eliminate opening and closing parentheses
@@ -31,7 +31,7 @@ module Dotenv
               $LAST_MATCH_INFO[0][1..]
             else
               # Execute the command and return the value
-              `#{command}`.chomp
+              `#{Variable.call(command, env)}`.chomp
             end
           end
         end

data/lib/dotenv/version.rb

@@ -1,3 +1,3 @@
 module Dotenv
-  VERSION = "3.1.8".freeze
+  VERSION = "3.2.0".freeze
 end

data/lib/dotenv.rb

@@ -94,13 +94,21 @@ module Dotenv
   # Update `ENV` with the given hash of keys and values
   #
   # @param env [Hash] Hash of keys and values to set in `ENV`
-  # @param overwrite [Boolean] Overwrite existing `ENV` values
+  # @param overwrite [Boolean|:warn] Overwrite existing `ENV` values
   def update(env = {}, overwrite: false)
     instrument(:update) do |payload|
       diff = payload[:diff] = Dotenv::Diff.new do
         ENV.update(env.transform_keys(&:to_s)) do |key, old_value, new_value|
           # This block is called when a key exists. Return the new value if overwrite is true.
-          overwrite ? new_value : old_value
+          case overwrite
+          when :warn
+            # not printing the value since that could be a secret
+            warn "Warning: dotenv not overwriting ENV[#{key.inspect}]"
+            old_value
+          when true then new_value
+          when false then old_value
+          else raise ArgumentError, "Invalid value for overwrite: #{overwrite.inspect}"
+          end
         end
       end
       diff.env

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: dotenv
 version: !ruby/object:Gem::Version
-  version: 3.1.8
+  version: 3.2.0
 platform: ruby
 authors:
 - Brandon Keepers
 bindir: bin
 cert_chain: []
-date: 2025-04-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -99,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Loads environment variables from `.env`.
 test_files: []