dotenv-rails 2.8.1 → 3.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d0c13519d33404b622266fbf7ff71079a199716ac564e4a2729384b15b970d7
-  data.tar.gz: f2da97acce1fb1e953e000114f9f01edb596adb0676b20a1e11cc8d77e6c405b
+  metadata.gz: c0e302fb028f65e97a5a1c22d97534a0fbc42fc6e84b6ba11fde5d5406dd2334
+  data.tar.gz: cc3d75dc764b994ce40ac42dabbcb89f88a611236f0122f1ae91517a752f71d9
 SHA512:
-  metadata.gz: 8d2102375cd88ce4b90c44629d0976062f9d9ebe05f95e480f38f6dcd509c28d23d8dff295339e2f4870263e595fcff6f45d6f972fee2e00a67a8b946979032a
-  data.tar.gz: 420d8614065db0398d72e13548c53ee25aa1da6d1676a96a7a0f93dbe33aca24e5ea4c48073b37ee29645a0bbcc56e6082289bd9473e37ade4f395eec2176099
+  metadata.gz: dd0c122d22515d49b9c245c9ba2f4f62ebe21d60fec5e599ea521c6ddb536b3d222e09d1dd356144252c96e4d4ffd9b9a526a7d0f828807d7f588f4cb62b33d8
+  data.tar.gz: c5979568723021877ab6706d2a16a6c3ab5f274d307a25de670f5a34a486a60483a13d14ad851fa94dbce6a9505ebb36d934cb93f55e734318da08cad09a7fa8

data/README.md

@@ -1,59 +1,48 @@
-# 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)
 
 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.
 
 ## Installation
 
-### Rails
-
-Add this line to the top of your application's Gemfile:
+Add this line to the top of your application's Gemfile and run `bundle install`:
 
 ```ruby
-gem 'dotenv-rails', groups: [:development, :test]
+gem 'dotenv', groups: [:development, :test]
 ```
 
-And then execute:
+## Usage
+
+Add your application configuration to your `.env` file in the root of your project:
 
 ```shell
-$ bundle
+S3_BUCKET=YOURS3BUCKET
+SECRET_KEY=YOURSECRETKEYGOESHERE
 ```
 
-#### Note on load order
-
-dotenv is initialized in your Rails app during the `before_configuration` callback, which is fired when the `Application` constant is defined in `config/application.rb` with `class Application < Rails::Application`. If you need it to be initialized sooner, you can manually call `Dotenv::Railtie.load`.
+Whenever your application loads, these variables will be available in `ENV`:
 
 ```ruby
-# config/application.rb
-Bundler.require(*Rails.groups)
-
-# Load dotenv only in development or test environment
-if ['development', 'test'].include? ENV['RAILS_ENV']
-  Dotenv::Railtie.load
-end
-
-HOSTNAME = ENV['HOSTNAME']
+config.fog_directory = ENV['S3_BUCKET']
 ```
 
-If you use gems that require environment variables to be set before they are loaded, then list `dotenv-rails` in the `Gemfile` before those other gems and require `dotenv/rails-now`.
+See the [API Docs](https://rubydoc.info/github/bkeepers/dotenv/main) for more.
 
-```ruby
-gem 'dotenv-rails', require: 'dotenv/rails-now'
-gem 'gem-that-requires-env-variables'
-```
+### Rails
 
-### Sinatra or Plain ol' Ruby
+Dotenv will automatically load when your Rails app boots. See [Customizing Rails](#customizing-rails) to change which files are loaded and when.
 
-Install the gem:
+### Sinatra / Ruby
 
-```shell
-$ gem install dotenv
-```
-
-As early as possible in your application bootstrap process, load `.env`:
+Load Dotenv as early as possible in your application bootstrap process:
 
 ```ruby
 require 'dotenv/load'
@@ -70,17 +59,17 @@ require 'dotenv'
 Dotenv.load('file1.env', 'file2.env')
 ```
 
-Alternatively, you can use the `dotenv` executable to launch your application:
+### Autorestore in tests
 
-```shell
-$ dotenv ./script.rb
-```
+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`.
 
-The `dotenv` executable also accepts a single 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.
+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).
 
-```
-$ dotenv -f ".env.local,.env" ./script.rb
-```
+To use this behavior outside of a Rails app, just `require "dotenv/autorestore"` in your test suite.
+
+See [`Dotenv.save`](https://rubydoc.info/github/bkeepers/dotenv/main/Dotenv:save), [Dotenv.restore](https://rubydoc.info/github/bkeepers/dotenv/main/Dotenv:restore), and [`Dotenv.modify(hash) { ... }`](https://rubydoc.info/github/bkeepers/dotenv/main/Dotenv:modify) for manual usage.
+
+### Rake
 
 To ensure `.env` is loaded in rake, load the tasks:
 
@@ -88,41 +77,121 @@ To ensure `.env` is loaded in rake, load the tasks:
 require 'dotenv/tasks'
 
 task mytask: :dotenv do
-    # things that require .env
+  # things that require .env
 end
 ```
 
-## Usage
+### CLI
 
-Add your application configuration to your `.env` file in the root of your project:
+You can use the `dotenv` executable load `.env` before launching your application:
 
-```shell
-S3_BUCKET=YOURS3BUCKET
-SECRET_KEY=YOURSECRETKEYGOESHERE
+```console
+$ dotenv ./script.rb
 ```
 
-Whenever your application loads, these variables will be available in `ENV`:
+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.
 
-```ruby
-config.fog_directory  = ENV['S3_BUCKET']
+```console
+$ dotenv -f ".env.local,.env" ./script.rb
 ```
 
-You may also add `export` in front of each line so you can `source` the file in bash:
+The `dotenv` executable can optionally ignore missing files with the `-i` or `--ignore` flag. For example, if the `.env.local` file does not exist, the following will ignore the missing file and only load the `.env` file.
 
-```shell
-export S3_BUCKET=YOURS3BUCKET
-export SECRET_KEY=YOURSECRETKEYGOESHERE
+```console
+$ dotenv -i -f ".env.local,.env" ./script.rb
 ```
 
-### Multi-line values
+### Load Order
 
-If you need multiline variables, for example private keys, you can double quote strings and use the `\n` character for newlines:
+If you use gems that require environment variables to be set before they are loaded, then list `dotenv` in the `Gemfile` before those other gems and require `dotenv/load`.
 
-```shell
-PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----\nHkVN9...\n-----END DSA PRIVATE KEY-----\n"
+```ruby
+gem 'dotenv', require: 'dotenv/load'
+gem 'gem-that-requires-env-variables'
 ```
 
-Alternatively, multi-line values with line breaks are now supported for quoted values.
+### Customizing Rails
+
+Dotenv will load the following files depending on `RAILS_ENV`, with the first file having the highest precedence, and `.env` having the lowest precedence:
+
+<table>
+  <thead>
+    <tr>
+      <th>Priority</th>
+      <th colspan="3">Environment</th>
+      <th><code>.gitignore</code>it?</th>
+      <th>Notes</th>
+    </tr>
+    <tr>
+      <th></th>
+      <th>development</th>
+      <th>test</th>
+      <th>production</th>
+      <th></th>
+      <th></th>
+    </tr>
+  </thead>
+  <tr>
+    <td>highest</td>
+    <td><code>.env.development.local</code></td>
+    <td><code>.env.test.local</code></td>
+    <td><code>.env.production.local</code></td>
+    <td>Yes</td>
+    <td>Environment-specific local overrides</td>
+  </tr>
+  <tr>
+    <td>2nd</td>
+    <td><code>.env.local</code></td>
+    <td><strong>N/A</strong></td>
+    <td><code>.env.local</code></td>
+    <td>Yes</td>
+    <td>Local overrides</td>
+  </tr>
+  <tr>
+    <td>3rd</td>
+    <td><code>.env.development</code></td>
+    <td><code>.env.test</code></td>
+    <td><code>.env.production</code></td>
+    <td>No</td>
+    <td>Shared environment-specific variables</td>
+  </tr>
+  <tr>
+    <td>last</td>
+    <td><code>.env</code></td>
+    <td><code>.env</code></td>
+    <td><code>.env</code></td>
+    <td><a href="#should-i-commit-my-env-file">Maybe</a></td>
+    <td>Shared for all environments</td>
+  </tr>
+</table>
+
+
+These files are loaded during the `before_configuration` callback, which is fired when the `Application` constant is defined in `config/application.rb` with `class Application < Rails::Application`. If you need it to be initialized sooner, or need to customize the loading process, you can do so at the top of `application.rb`
+
+```ruby
+# config/application.rb
+Bundler.require(*Rails.groups)
+
+# Load .env.local in test
+Dotenv::Rails.files.unshift(".env.local") if ENV["RAILS_ENV"] == "test"
+
+module YourApp
+  class Application < Rails::Application
+    # ...
+  end
+end
+```
+
+Available options:
+
+* `Dotenv::Rails.files` - list of files to be loaded, in order of precedence.
+* `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)
+
+### Multi-line values
+
+Multi-line values with line breaks must be surrounded with double quotes.
 
 ```shell
 PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----
@@ -132,7 +201,12 @@ HkVN9...
 -----END DSA PRIVATE KEY-----"
 ```
 
-This is particularly helpful when using the Heroku command line plugin [`heroku-config`](https://github.com/xavdid/heroku-config) to pull configuration variables down that may have line breaks.
+Prior to 3.0, dotenv would replace `\n` in quoted strings with a newline, but that behavior is deprecated. To use the old behavior, set `DOTENV_LINEBREAK_MODE=legacy` before any variables that include `\n`:
+
+```shell
+DOTENV_LINEBREAK_MODE=legacy
+PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----\nHkVN9...\n-----END DSA PRIVATE KEY-----\n"
+```
 
 ### Command Substitution
 
@@ -144,7 +218,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"
@@ -166,6 +240,15 @@ SECRET_KEY=YOURSECRETKEYGOESHERE # comment
 SECRET_HASH="something-with-a-#-hash"
 ```
 
+### Exports
+
+For compatability, you may also add `export` in front of each line so you can `source` the file in bash:
+
+```shell
+export S3_BUCKET=YOURS3BUCKET
+export SECRET_KEY=YOURSECRETKEYGOESHERE
+```
+
 ### Required Keys
 
 If a particular configuration value is required but not set, it's appropriate to raise an error.
@@ -191,42 +274,14 @@ Dotenv.parse(".env.local", ".env")
 
 This method returns a hash of the ENV var name/value pairs.
 
-## Frequently Answered Questions
-
-### Can I use dotenv in production?
-
-dotenv was originally created to load configuration variables into `ENV` in *development*. There are typically better ways to manage configuration in production environments - such as `/etc/environment` managed by [Puppet](https://github.com/puppetlabs/puppet) or [Chef](https://github.com/chef/chef), `heroku config`, etc.
-
-However, some find dotenv to be a convenient way to configure Rails applications in staging and production environments, and you can do that by defining environment-specific files like `.env.production` or `.env.test`.
-
-If you use this gem to handle env vars for multiple Rails environments (development, test, production, etc.), please note that env vars that are general to all environments should be stored in `.env`. Then, environment specific env vars should be stored in `.env.<that environment's name>`.
-
-### What other .env* files can I use?
-
-`dotenv-rails` will override in the following order (highest defined variable overrides lower):
-
-| Hierarchy Priority | Filename                 | Environment          | Should I `.gitignore`it?                            | Notes                                                        |
-| ------------------ | ------------------------ | -------------------- | --------------------------------------------------- | ------------------------------------------------------------ |
-| 1st (highest)      | `.env.development.local` | Development          | Yes!                                                | Local overrides of environment-specific settings.            |
-| 1st                | `.env.test.local`        | Test                 | Yes!                                                | Local overrides of environment-specific settings.            |
-| 1st                | `.env.production.local`  | Production           | Yes!                                                | Local overrides of environment-specific settings.            |
-| 2nd                | `.env.local`             | Wherever the file is | Definitely.                                         | Local overrides. This file is loaded for all environments _except_ `test`. |
-| 3rd                | `.env.development`       | Development          | No.                                                 | Shared environment-specific settings                         |
-| 3rd                | `.env.test`              | Test                 | No.                                                 | Shared environment-specific settings                         |
-| 3rd                | `.env.production`        | Production           | No.                                                 | Shared environment-specific settings                         |
-| Last               | `.env`                   | All Environments     | Depends (See [below](#should-i-commit-my-env-file)) | The Original®                                                |
-
-
-### Should I commit my .env file?
-
-Credentials should only be accessible on the machines that need access to them. Never commit sensitive information to a repository that is not needed by every development machine and server.
-
+### Templates
 
 You can use the `-t` or `--template` flag on the dotenv cli to create a template of your `.env` file.
-```shell
+
+```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.
 
@@ -244,14 +299,29 @@ S3_BUCKET=S3_BUCKET
 SECRET_KEY=SECRET_KEY
 ```
 
+## Frequently Answered Questions
+
+### Can I use dotenv in production?
+
+dotenv was originally created to load configuration variables into `ENV` in *development*. There are typically better ways to manage configuration in production environments - such as `/etc/environment` managed by [Puppet](https://github.com/puppetlabs/puppet) or [Chef](https://github.com/chef/chef), `heroku config`, etc.
+
+However, some find dotenv to be a convenient way to configure Rails applications in staging and production environments, and you can do that by defining environment-specific files like `.env.production` or `.env.test`.
+
+If you use this gem to handle env vars for multiple Rails environments (development, test, production, etc.), please note that env vars that are general to all environments should be stored in `.env`. Then, environment specific env vars should be stored in `.env.<that environment's name>`.
+
+### Should I commit my .env file?
+
+Credentials should only be accessible on the machines that need access to them. Never commit sensitive information to a repository that is not needed by every development machine and server.
+
 Personally, I prefer to commit the `.env` file with development-only settings. This makes it easy for other developers to get started on the project without compromising credentials for other environments. If you follow this advice, make sure that all the credentials for your development environment are different from your other deployments and that the development credentials do not have access to any confidential data.
 
-### Why is it not overriding existing `ENV` variables?
+### Why is it not overwriting existing `ENV` variables?
 
-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`.
+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`.
 
-You can also use the `-o` or `--overload` flag on the dotenv cli to override existing `ENV` variables.
-```shell
+You can also use the `-o` or `--overwrite` flag on the dotenv cli to overwrite existing `ENV` variables.
+
+```console
 $ dotenv -o -f ".env.local,.env"
 ```
 

data/lib/dotenv-rails.rb

@@ -1 +1 @@
-require "dotenv/rails"
+require "dotenv"

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: dotenv-rails
 version: !ruby/object:Gem::Version
-  version: 2.8.1
+  version: 3.1.8
 platform: ruby
 authors:
 - Brandon Keepers
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-27 00:00:00.000000000 Z
+date: 2025-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -16,28 +15,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.8.1
+        version: 3.1.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.8.1
+        version: 3.1.8
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: spring
   requirement: !ruby/object:Gem::Requirement
@@ -62,13 +61,12 @@ files:
 - LICENSE
 - README.md
 - lib/dotenv-rails.rb
-- lib/dotenv/rails-now.rb
-- lib/dotenv/rails.rb
 homepage: https://github.com/bkeepers/dotenv
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  changelog_uri: https://github.com/bkeepers/dotenv/releases
+  funding_uri: https://github.com/sponsors/bkeepers
 rdoc_options: []
 require_paths:
 - lib
@@ -83,8 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Autoload dotenv in Rails.
 test_files: []

data/lib/dotenv/rails-now.rb

@@ -1,10 +0,0 @@
-# If you use gems that require environment variables to be set before they are
-# loaded, then list `dotenv-rails` in the `Gemfile` before those other gems and
-# require `dotenv/rails-now`.
-#
-#     gem "dotenv-rails", require: "dotenv/rails-now"
-#     gem "gem-that-requires-env-variables"
-#
-
-require "dotenv/rails"
-Dotenv::Railtie.load

data/lib/dotenv/rails.rb

@@ -1,77 +0,0 @@
-require "dotenv"
-
-# Fix for rake tasks loading in development
-#
-# Dotenv loads environment variables when the Rails application is initialized.
-# When running `rake`, the Rails application is initialized in development.
-# Rails includes some hacks to set `RAILS_ENV=test` when running `rake test`,
-# but rspec does not include the same hacks.
-#
-# See https://github.com/bkeepers/dotenv/issues/219
-if defined?(Rake.application)
-  task_regular_expression = /^(default$|parallel:spec|spec(:|$))/
-  if Rake.application.top_level_tasks.grep(task_regular_expression).any?
-    environment = Rake.application.options.show_tasks ? "development" : "test"
-    Rails.env = ENV["RAILS_ENV"] ||= environment
-  end
-end
-
-Dotenv.instrumenter = ActiveSupport::Notifications
-
-# Watch all loaded env files with Spring
-begin
-  require "spring/commands"
-  ActiveSupport::Notifications.subscribe(/^dotenv/) do |*args|
-    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
-  # Dotenv Railtie for using Dotenv to load environment from a file into
-  # Rails applications
-  class Railtie < Rails::Railtie
-    # Public: Load dotenv
-    #
-    # This will get called during the `before_configuration` callback, but you
-    # can manually call `Dotenv::Railtie.load` if you needed it sooner.
-    def load
-      Dotenv.load(*dotenv_files)
-    end
-
-    # Public: Reload dotenv
-    #
-    # Same as `load`, but will override existing values in `ENV`
-    def overload
-      Dotenv.overload(*dotenv_files)
-    end
-
-    # Internal: `Rails.root` is nil in Rails 4.1 before the application is
-    # initialized, so this falls back to the `RAILS_ROOT` environment variable,
-    # or the current working directory.
-    def root
-      Rails.root || Pathname.new(ENV["RAILS_ROOT"] || Dir.pwd)
-    end
-
-    # Rails uses `#method_missing` to delegate all class methods to the
-    # instance, which means `Kernel#load` gets called here. We don't want that.
-    def self.load
-      instance.load
-    end
-
-    private
-
-    def dotenv_files
-      [
-        root.join(".env.#{Rails.env}.local"),
-        (root.join(".env.local") unless Rails.env.test?),
-        root.join(".env.#{Rails.env}"),
-        root.join(".env")
-      ].compact
-    end
-
-    config.before_configuration { load }
-  end
-end