dotenv 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3963c1ba53e439322c807f8312b8a8f9ebd0766e4d03757b41e5ce6b4bb43bc5
-  data.tar.gz: a7f026d236de3dbac4a1bd08a28cee474159abedb750ff5a6b3e545f1aa5cf15
+  metadata.gz: 1dc708aad5fcaf487b064451b8f47d5b0e402a7c250385f234306ab3c77fcf20
+  data.tar.gz: e939eca5e64f2aef9aeb784bd9765e20a3201057d4ed69c1ea46b1405625920e
 SHA512:
-  metadata.gz: 9bd6a081fb16b6115340a1d0751e5886a8333137061121c7adbe6c2757d8199cf3c23ae374bc9fa2dcac7faeb6c4533a30ce28f5e5eb34eac9fce1b9308cf10c
-  data.tar.gz: deeb7d87a65e8e7f1af595a822abd1b81ade441a46fbe1b7188e1d511ad621ceb3c45b1509580e5ceab7c957b7b49ea2d3686eef0c91fb43d914c4a58f9d975c
+  metadata.gz: 3c7a9b929e7b419a1df9c07bd2dfa7959deea186bc6de9e0e8bdfdc671b7d4c183104715206ac956e81d4689b76d14907dd0a644eb995f4cd48437047e307ad1
+  data.tar.gz: de3d64ad2bf4fbec40e7c253c71de40cf1cab82875293f168c73a5098e7419554362014e6eb0c6339d485c41c12cccad82e0f854fee30f7fef18e7cc4afc26ef

data/README.md

@@ -54,11 +54,11 @@ require 'dotenv'
 Dotenv.load('file1.env', 'file2.env')
 ```
 
-## Autorestore in tests
+### Autorestore in tests
 
 Since 3.0, dotenv in a Rails app will automatically restore `ENV` after each test. This means you can modify `ENV` in your tests without fear of leaking state to other tests. It works with both `ActiveSupport::TestCase` and `Rspec`.
 
-To disable this behavior, set `config.dotenv.autorestore = false` in `config/application.rb` or `config/environments/test.rb`.
+To disable this behavior, set `config.dotenv.autorestore = false` in `config/application.rb` or `config/environments/test.rb`. It is disabled by default if your app uses [climate_control](https://github.com/thoughtbot/climate_control) or [ice_age](https://github.com/dpep/ice_age_rb).
 
 To use this behavior outside of a Rails app, just `require "dotenv/autorestore"` in your test suite.
 
@@ -181,6 +181,8 @@ 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.logger` - The logger to use for dotenv's logging. Defaults to `Rails.logger`
+* `Dotenv::Rails.autorestore` - Enable or disable [autorestore](#autorestore-in-tests)
 
 ### Multi-line values
 

data/lib/dotenv/rails.rb

@@ -1,4 +1,9 @@
-require "dotenv"
+# Since rubygems doesn't support optional dependencies, we have to manually check
+unless Gem::Requirement.new(">= 6.1").satisfied_by?(Gem::Version.new(Rails.version))
+  warn "dotenv 3.0 only supports Rails 6.1 or later. Use dotenv ~> 2.0."
+  return
+end
+
 require "dotenv/replay_logger"
 require "dotenv/log_subscriber"
 
@@ -18,7 +23,7 @@ end
 module Dotenv
   # Rails integration for using Dotenv to load ENV variables from a file
   class Rails < ::Rails::Railtie
-    delegate :files, :files=, :overwrite, :overwrite=, :autorestore, :autorestore=, :logger, :logger=, to: "config.dotenv"
+    delegate :files, :files=, :overwrite, :overwrite=, :autorestore, :autorestore=, :logger, to: "config.dotenv"
 
     def initialize
       super()
@@ -27,12 +32,12 @@ module Dotenv
         logger: Dotenv::ReplayLogger.new,
         overwrite: false,
         files: [
-          root.join(".env.#{env}.local"),
-          (root.join(".env.local") unless env.test?),
-          root.join(".env.#{env}"),
-          root.join(".env")
+          ".env.#{env}.local",
+          (".env.local" unless env.test?),
+          ".env.#{env}",
+          ".env"
         ].compact,
-        autorestore: env.test?
+        autorestore: env.test? && !defined?(ClimateControl) && !defined?(IceAge)
       )
     end
 
@@ -41,12 +46,12 @@ module Dotenv
     # This will get called during the `before_configuration` callback, but you
     # can manually call `Dotenv::Rails.load` if you needed it sooner.
     def load
-      Dotenv.load(*files, overwrite: overwrite)
+      Dotenv.load(*files.map { |file| root.join(file).to_s }, overwrite: overwrite)
     end
 
     def overload
       deprecator.warn("Dotenv::Rails.overload is deprecated. Set `Dotenv::Rails.overwrite = true` and call Dotenv::Rails.load instead.")
-      Dotenv.load(*files, overwrite: true)
+      Dotenv.load(*files.map { |file| root.join(file).to_s }, overwrite: true)
     end
 
     # Internal: `Rails.root` is nil in Rails 4.1 before the application is
@@ -56,6 +61,12 @@ module Dotenv
       ::Rails.root || Pathname.new(ENV["RAILS_ROOT"] || Dir.pwd)
     end
 
+    # Set a new logger and replay logs
+    def logger=(new_logger)
+      logger.replay new_logger if logger.is_a?(ReplayLogger)
+      config.dotenv.logger = new_logger
+    end
+
     # The current environment that the app is running in.
     #
     # When running `rake`, the Rails application is initialized in development, so we have to
@@ -83,10 +94,9 @@ module Dotenv
     end
 
     initializer "dotenv", after: :initialize_logger do |app|
-      # Set up a new logger once Rails has initialized the logger and replay logs
-      new_logger = ActiveSupport::TaggedLogging.new(::Rails.logger).tagged("dotenv")
-      logger.replay new_logger if logger.respond_to?(:replay)
-      self.logger = new_logger
+      if logger.is_a?(ReplayLogger)
+        self.logger = ActiveSupport::TaggedLogging.new(::Rails.logger).tagged("dotenv")
+      end
     end
 
     initializer "dotenv.deprecator" do |app|

data/lib/dotenv/replay_logger.rb

@@ -1,20 +1,20 @@
 module Dotenv
   # A logger that can be used before the apps real logger is initialized.
-  class ReplayLogger
+  class ReplayLogger < Logger
     def initialize
+      super(nil) # Doesn't matter what this is, it won't be used.
       @logs = []
     end
 
-    def method_missing(name, *args, &block)
-      @logs.push([name, args, block])
-    end
-
-    def respond_to_missing?(name, include_private = false)
-      (include_private ? Logger.instance_methods : Logger.public_instance_methods).include?(name) || super
+    # Override the add method to store logs so we can replay them to a real logger later.
+    def add(*args, &block)
+      @logs.push([args, block])
     end
 
+    # Replay the store logs to a real logger.
     def replay(logger)
-      @logs.each { |name, args, block| logger.send(name, *args, &block) }
+      @logs.each { |args, block| logger.add(*args, &block) }
+      @logs.clear
     end
   end
 end

data/lib/dotenv/version.rb

@@ -1,3 +1,3 @@
 module Dotenv
-  VERSION = "3.0.0".freeze
+  VERSION = "3.1.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dotenv
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Brandon Keepers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-12 00:00:00.000000000 Z
+date: 2024-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake