dotenv 3.1.7 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4ad122f937755147ff0cc52552f17b1e1cf8f9a290ff791ac5ba2f8ef8b43c7
-  data.tar.gz: 3116d767ea5dc67adca867395ea7effbc1b4ee30769223961f8d041d5c34482d
+  metadata.gz: d94f968de5def640d49274915a92e82c9dcf9e5783e58fee39fa2b72a9b7ac0d
+  data.tar.gz: e892cb84dfbcc7c38bd484f4c747849c52f3050fc170719180c3f79eef63a2ef
 SHA512:
-  metadata.gz: 86436a8b6d193590befeb48a29882b9bd5523f8b80fff961faf1feda91cc720b8b44c1e2705bfbebb73836b99684273d49f78b94c09d05a3077e62996473a47c
-  data.tar.gz: bb6f98a159c821e0f1cb98ab6c3f0b54a109acc3c934770fd6603f7497c047f031c7124f839963f0f5132a12bd2736e25ab2e4c648cfa56589a30b328d03de61
+  metadata.gz: 5ce6017a1069f68382d9a0a241130243bc807a388788bd17129ce2a135d10cdb1dd607b8fbb69ce469540114d77014a833dbe2ebc416ae77560c5bf40db09e0c
+  data.tar.gz: 301e709c9e0d322668a145ee6cf723a532b2805a6112a6479624b6cd61be0e4b60a42234be611bc1901195f99c799598402b846c257f813744ef286bd0326987

data/README.md

@@ -47,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'
@@ -84,7 +87,7 @@ You can use the `dotenv` executable load `.env` before launching your applicatio
 $ dotenv ./script.rb
 ```
 
-The `dotenv` executable also accepts the 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.
+The `dotenv` executable also accepts the flag `-f`. Its value should be a comma-separated list of configuration files, in the order of the most important to the least important. All of the files must exist. There _must_ be a space between the flag and its value.
 
 ```console
 $ dotenv -f ".env.local,.env" ./script.rb
@@ -314,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 = /
@@ -33,6 +33,8 @@ module Dotenv
       (?:$|\z)                # end of line
     /x
 
+    QUOTED_STRING = /\A(['"])(.*)\1\z/m
+
     class << self
       attr_reader :substitutions
 
@@ -75,7 +77,6 @@ module Dotenv
       !@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(QUOTED_STRING, '\2')

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.7".freeze
+  VERSION = "3.2.0".freeze
 end

data/lib/dotenv.rb

@@ -55,7 +55,7 @@ module Dotenv
       begin
         env = Environment.new(File.expand_path(filename), overwrite: overwrite)
         env = block.call(env) if block
-      rescue Errno::ENOENT
+      rescue Errno::ENOENT, Errno::EISDIR
         raise unless ignore
       end
 
@@ -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,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: dotenv
 version: !ruby/object:Gem::Version
-  version: 3.1.7
+  version: 3.2.0
 platform: ruby
 authors:
 - Brandon Keepers
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-18 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -85,7 +84,7 @@ licenses:
 - MIT
 metadata:
   changelog_uri: https://github.com/bkeepers/dotenv/releases
-post_install_message:
+  funding_uri: https://github.com/sponsors/bkeepers
 rdoc_options: []
 require_paths:
 - lib
@@ -100,8 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Loads environment variables from `.env`.
 test_files: []