【Rails】忘れがちなGemfileの書き方を総復習

はじめに

RailsアプリにGemをインストールするときに使うGemfileですが、意外とその詳しい書き方は把握していないという方も多いと思います。例えば、インストールするバージョンを「2.1.2以上でパッチバージョンのみ上げることを許容」などと指定する方法や、ソースとしてGitHubの特定のブランチを指定する方法などは、よく使う割に曖昧になりがちです。

本記事では、Gemfileを書くときによく使うものの「そういえば、どう書くんだっけ?」ということをまとめています。

Gemfileでよく使う書き方

Gemのバージョン指定

Gemfileでは、インストールするGemに対して以下のバージョン指定方法ができます。

指定方法 意味
X.X.X X.X.X固定
>= X.X.X X.X.X以上
>= X.X.X, < Y.Y.Y X.X.X以上Y.Y.Y未満
~> X.X.X 明記したところ以下のバージョンが上がることのみ許容

最後のチルダ(~)を使ったバージョン指定方法がわかりにくいので補足します。

「明記したところ以下のバージョン」とは、指定したバージョンの右端のバージョンのことを指します。X.Y.ZだったらZX.YだったらYXだったらXが「明記したところ以下のバージョン」となります。指定したバージョンの段階別にまとめると以下の通りとなります。

指定バージョン 意味 別の書き方
~> 1.2.3 1.2.3以上1.3.0未満 >= 1.2.3, < 1.3.0
~> 1.2 1.2.x1.2以上1.3未満) >= 1.2, < 1.3
~> 1 1.x1以上2未満) >= 1, < 2

ちなみに、package.jsonなどで使えるキャレット(^)を使ったバージョン指定方法は、Gemfileではサポートしていません。

バージョニング表記について

補足として、簡単にバージョニング表記の意味について説明しておきます。

表記 意味
0.0.x パッチバージョン。APIの変更のない実装レベルの修正。バグフィックス等。
0.x.0 マイナーバージョン。後方互換性をもったAPIの変更など。新機能、新APIの実装等。
x.0.0 アップデートするとユーザーの実装が動かなくなるような後方互換性のない変更を含む場合。

Gitリポジトリの指定

Gemfileはファイルの先頭でグローバルなソースを指定します。

source "https://rubygems.org"

Gemのインストールにグローバルなソースを使うのではなく、特定のGitリポジトリを指定することができます。

gem 'impressionist', git: 'git://github.com/charlotte-ruby/impressionist.git'

オプションで特定のタグやブランチも指定できます。

オプション 意味
tag: 'tag_name' タグを指定
branch: 'branch_name' ブランチを指定
ref: '46a582ff8cd3496da64f174b30b91f9d97e86643' コミット(リファレンス)を指定

GitHubリポジトリの場合はgitの代わりにgithubが使えます。gitと比べて簡略表記が可能です。もちろんタグやブランチも指定できます。

gem 'impressionist', github: 'charlotte-ruby/impressionist', branch: 'branch_name'

インストール環境の指定

byebugなど特定の環境でのみ必要となるGemがあります。こういったGemのためにインストール環境を指定することができます。

group :development, :test do
  gem 'byebug'
end

特定のGemに対して直接指定することもできます。あまり使いませんが、参考までに。

gem 'byebug', group: [development, test]

Bundlerを実行する際、--withoutオプションをつけることで、インストールすべきでない環境を明示的に指定することができます。

$ bundle install --without development test

--withoutオプションを指定すると、Bundlerは指定された環境を記憶します。次にBundlerを実行するときは、--withoutオプションを指定しなくても記憶している環境を除いて実行されます。

指定された環境は.bundleディレクトリ配下のconfigファイルに書き込まれます。もし、指定した環境をリセットしたいという場合、このファイルを削除することでリセットすることができます(次に--withoutオプションを指定したときに再作成される)。

config

---
BUNDLE_WITHOUT: "production"

まとめ

Gemfileには今回紹介した書き方以外にももっとたくさんの書き方がありますが、その中でも特によく使うであろう書き方をピックアップしてまとめてみました。

Webページの記述されているコードをコピペする方法は楽ですが、コピペばかりしているといつまで経っても書き方を覚えることができません。よく使う書き方くらいは何も見ずとも書けるようになりたいものです。

本記事を参考にして、Gemfileの書き方を覚えていただければと思います。

関連記事

【Ruby】Bundlerを使ってRubyGemsを作成/公開する方法
# はじめに Bundlerを使ってRubyGemsを作成および公開する方法について説明します。Bundlerを使わずにRubyGemsを作成/公開する方法については以下の記事を参照してください。 <iframe class="hatena [...]
2022年7月12日 23:18
【Ruby】RubyGemsを作成/公開する方法
# はじめに RubyGemsを作成および公開する方法について説明します。Bundlerを使ってRubyGemsを作成する方法については以下の記事を参照してください。 <iframe class="hatenablogcard" style [...]
2022年7月11日 21:52
【Rails】M1チップ搭載MacでRuby on Railsの開発環境構築
# はじめに M1チップ搭載MacにRuby on Railsの開発環境を構築する手順を記載します。 - MacBook Air (M1, 2020) - macOS Monterey 12.3.1 # Homebrew ## [...]
2022年5月5日 11:56
【Rails】Rakeタスクの基本情報と作成・実行方法
# はじめに Railsには標準でRakeというGemが同梱されています。RakeはRubyで実装されたMake(UNIX系のOSで使用できるコマンド)のようなビルド作業を自動化するツールです。Ruby Make、略してRakeというわけですね。 [...]
2022年3月7日 22:12
【Rails】モデルに外部キーを設定する方法とよく起こるエラー内容について
# はじめに Railsでモデルに外部キーを設定する方法について説明します。 # モデルに外部キーを設定する ## リレーションシップ 今回は1つのブログ記事は複数のコメントを持つ1対多のリレーションシップを例に説明します。現在は` [...]
2022年2月10日 14:18
【Rails】Capybaraのfill_inメソッドを実行すると「既存レコードの内容+指定した内容」がセットされる事象の原因と対処【RSpec】
# はじめに RSpec + Capybaraを使用して、Railsアプリの統合テストを実装しています。とあるモデルの編集画面において、入力フォームの内容を書き換えた上で送信し、レコードが更新されることを確認します。 入力フォームの内容を書 [...]
2022年1月27日 21:22
【Rails】GitHubのセキュリティアラートで発見された脆弱性を解消する方法
# はじめに GitHubにはセキュリティアラートという機能があります。セキュリティアラートはリポジトリに含まれるライブラリやパッケージの脆弱性を定期的にチェックし、脆弱性のあるライブラリやパッケージが発見されたらアラートで知らせてくれるという機 [...]
2022年1月16日 10:36
【Rails】devise-two-factorを使った2段階認証の実装方法【初学者】
# はじめに Railsアプリで2段階認証を実装するには、「rotp」というGemを使う方法の他に、「devise-two-factor」というGemを使う方法があります。「devise-two-factor」はその名の通り、IDとパスワードによ [...]
2021年12月12日 17:58