環境変数を簡単に管理することができるgem dotenv-rails まとめ

はじめに

環境変数を使うタイミングがあり、途中で便利なgemがあることを知り、使おうと思ったのがきっかけ。
まだ知識が浅いため細かくは解説できないけど、自分なりにまとめてみました🏄‍♂️

dotenv-rails　　gem

環境変数を簡単に管理することができるgemのこと

環境変数は主に漏洩すると危険なアクセスキーなどを隠して使いたいときや、テスト環境、開発環境などの環境によって異なる値を使いたいときに使う。後者の使い道で使ったことはまだない、、、
私は今回はメールアドレスを隠すために使った。

使い方

1.gemインストール
ここはgemをインストールする時と一緒、bundle installも忘れずにやって

2.環境を指定する場合

gemファイル.

gem 'dotenv-rails', groups: [:development, :test]

---gemが複数ある場合は下記の記述で---

group :development, :test do # 上記と同等
    gem 'dotenv-rails', groups: [:development, :test]
end

3.「.env」ファイルの作成
.envファイルは環境変数を記述するためのファイル
アプリケーションの直下に作成する。ターミナルにてアプリケーションのディレクトリでtouch .envと記述して作成する。

ターミナル.

xxxxxMacBook-Pro アプリケーション名 % touch .env

4.定義する

env.

SECRET_KEY = YOURSECRETKEY

のように定義する

呼び出すときは、ENV['環境変数名']で呼び出せる

5.gitで公開しないために
ここもかなり大事なポイントで、環境変数として使えるようになっているが、このままgitに公開するとモロにみられてしまうので、gitignoreファイルに.envファイルを追記して、gitで公開しないようにする。

gitignore.

/.env

# 環境毎のファイルがある場合
/.env.production
/.env.local,,,

ここまでがセット

参考文献

他にも、環境ごとに環境変数の値を変える方法や、実際の使用例などが乗っている🙇‍♂️
url: https://pikawaka.com/rails/dotenv-rails#Git%E7%AE%A1%E7%90%86%E4%B8%8B%E3%81%8B%E3%82%89%E5%BF%85%E3%81%9A%E9%99%A4%E5%A4%96%E3%81%99%E3%82%8B