【Rails】Gemfileの書き方を学ぼう!バージョン指定・Gemfile.lockとの違いは?

当サイトでは一部リンクに広告が含まれています
アイキャッチ
目次

Ruby on Rails の Gemfile とは何か

プログラミングにおいて、特定の機能やツールを簡単に使えるようにするための小さなプログラムを「Gem」といいます。
このGemという言葉は、プログラムの一部分であるライブラリやツールのことを指します。
Ruby on Rails(通称Rails)は、ウェブアプリケーションを作るためのフレームワークで、これらのGemを管理するための特別なファイルがあります。
その名も「Gemfile」です。

Gemfileとは何か?

Gemfileは、Railsプロジェクトで使用するGemのリストを書いたファイルです。
簡単に言うと、プロジェクトで必要な道具をリストアップしているようなものです。
これにより、必要な機能を一覧でき、追加や削除が容易になります。

なぜGemfileが重要なのか?

Gemfileがあることで、プロジェクトに必要なGemを一括でインストールしたり、バージョンを揃えたりできます。
これによって、他の人と一緒に作業する際に、同じツールを同じバージョンで使うことが保証されます。
結果、開発作業がスムーズに進むようになります。

Gemfileの位置(どこにあるか)

RailsプロジェクトのルートフォルダにGemfileがあります。
このルートフォルダとは、プロジェクトの最上位のフォルダのことで、以下は一般的なRailsプロジェクトのフォルダ構造です。

  • Railsプロジェクトルート
    • app
    • bin
    • config
    • db
    • Gemfile
    • Gemfile.lock

Gemfileのバージョン指定

Gemfileで特定のバージョンのGemを使用する理由と方法について見ていきます。

バージョン指定の必要性

バージョンが異なると、Gemの動作が変わることがあります。
プロジェクトで一定のバージョンを保持するため、バージョンを指定することが重要です。
バージョンを固定することで、予期せぬエラーやバグの発生を防ぐことができます。

バージョンの書き方

以下のようにGemfile内でバージョンを指定することができます。

gem 'nokogiri', '1.10.10'

この例では、’nokogiri’というGemのバージョンを1.10.10に固定しています。
‘nokogiri’は、HTMLやXMLファイルを扱うためのライブラリです。

version syntaxの理解と使用例

バージョンを指定するには、いくつかの方法があります。
以下のテーブルで、それぞれの方法を紹介します。

方法 Gemfileの書き方 説明
固定バージョン gem 'gem_name', '1.0.0' 特定のバージョンのみを使用します。
最低限のバージョン gem 'gem_name', '>= 1.0.0' 1.0.0以上のバージョンを使用します。
範囲指定 gem 'gem_name', '>= 1.0.0', '< 2.0.0' 1.0.0以上、2.0.0未満のバージョンを使用します。

以下のセクションでは、Gemfileの更新や管理、グループとシンタックスの管理など、さらに詳しい内容を学んでいきます。

Gemfileの更新と管理

プロジェクトが進むにつれて、新しいGem(Rubyプログラミングのパッケージのこと)を追加したり、バージョンを変更したりすることがあります。
このセクションでは、そのような更新と管理の方法について詳しく見ていきます。

Gemfileの更新方法

Gemfileとは、プロジェクトで使用するGemのリストが書かれたファイルです。
Gemfileに新しいGemを追加したり、バージョンを変更したいときには、次の手順を行います。

  1. Gemfileを開き、変更を行う
  2. ターミナルでbundle installコマンドを実行

この手順により、Gemfileに記述されたGemがインストールされます。

Gemfile.lockの役割と操作

Gemfileの隣にはGemfile.lockというファイルがあります。
このファイルは、プロジェクトで実際に使用されているGemの正確なバージョンを記録するものです。

bundle installを実行すると、このGemfile.lockファイルも自動的に更新されます。
これによって、プロジェクトのメンバー全員が同じバージョンのGemを使用することが保証されるのです。

更新時の注意点

Gemのバージョンを更新する際には注意が必要です。
特に、大きなバージョンの変更は、プログラムの動作に影響を与えることがあるため慎重に行う必要があります。

groupの管理

ここでは、Gemを特定の「group(グループ)」に分類する方法について学びます。
グループは、特定の環境でのみ使用するGemを指定するためのものです。

Railsプロジェクトでは、特定の環境(例:開発環境、テスト環境)でのみ使用するGemを指定することがよくあります。
これを行うために、groupという概念を使います。

group :development do
  gem 'pry'
end

この例では、開発環境でのみpryというGemを使用するように指定しています。

groupの使い分け

development

開発環境でのみ使用するGemを指定します。

例えば、開発環境でのみ使用するGemとして、prypry-railsがあります。
pryは、開発環境でのみ使用するデバッグツールです。
また、pry-railsは、Railsアプリケーションでpryを使用するためのGemです。

test

テスト環境でのみ使用するGemを指定します。

例えば、テスト環境でのみ使用するGemとして、rspec-railsfactory_bot_railsがあります。
rspec-railsは、テストを実行するためのGemです。
また、factory_bot_railsは、テストデータを作成するためのGemです。

production

本番環境でのみ使用するGemを指定します。
例えば、本番環境でのみ使用するGemとして、unicorncapistranoがあります。

unicornは、本番環境でのみ使用するWebサーバーです。
また、capistranoは、本番環境へのデプロイを自動化するためのツールです。

このように、環境ごとに使用するGemを分けることで、プロジェクトの管理がしやすくなります。

よかったらシェアしてね!
  • URLをコピーしました!
  • URLをコピーしました!

この記事を書いた人

フルスタックWebエンジニアであり、プログラミングスクール講師でもあります。
プログラミングスクールのカリキュラム執筆にも携わっており、プログラミング教材に精通しています。
Rails / React / Next.js / Vue.js / AWS が得意技術。

目次