はじめに
みなさんお待ちかねのRails 5.0が先日リリースされました。
これまでRailsを使って開発してきた方は、おそらく既存のRailsアプリケーションではRails 4系を使っているんじゃないかと思います。(Rails 3以前の方もいるかもしれませんが・・・)
しかし、中には「Rails 5にアップグレードしたいけど、やり方がよくわからない・・・」と困っている方もいるんじゃないでしょうか?
そこでこの記事ではRails 4.1で作ったサンプルアプリケーションをRails 5.0にアップグレードする手順を説明します。
(この記事よりも詳しい)解説動画はこちら!
アップグレードの手順はYouTubeにアップした動画の中で詳しく説明しています。
この記事は動画の説明内容を簡単にピックアップするだけにとどめているので、Rails 5にアップグレードしようと考えている方は、必ず動画の方もチェックしてください!
これでもう怖くない!?Rails 4.1からRails 5.0にアップグレードする手順を動画付きで解説します - YouTube
なお、今回の動画は1時間ちょっとあるので、 1.5倍~2.0倍ぐらいの再生速度 で再生することをオススメします。
RubyMineも活用しています
動画の中ではRubyMineをメインのエディタ(IDE)として使用しています。
RSpecの実行やdiffの確認など、RubyMineの便利機能がいろいろ見られるので、RubyMineに興味がある人もぜひ動画をチェックしてみてください。
今回使用するサンプルアプリケーション
この記事では電子書籍「Everyday Rails - RSpecによるRailsテスト入門」で使われているサンプルアプリケーションをRails 5にアップグレードします。
このアプリケーションのオリジナルの動作環境は Ruby 2.1.1 + Rails 4.1.1 です。
なお、Everyday Railsのサンプルアプリケーションは使用するものの、この記事自体は書籍「Everyday Rails - RSpecによるRailsテスト入門」の内容そのものとは関係ありません。(あくまで個人の趣味で書いています)
サンプルアプリケーションのソースコード
サンプルアプリケーションのオリジナルのソースコードはGitHubに公開されています。
ですので、誰でも参照することが可能です。
実際にアップグレードをやってみたい方は自分のアカウントにフォークして試してみてください。
作業のおおまかな流れ
アップグレード作業をざっくり説明するとこんな感じです。
なお、カッコ内の数字は動画の開始ポイントを示しています。
- 公式のアップグレードガイドを確認する(1:20)
- アップグレード用の作業ブランチを作る(3:25)
- 現状のテストが全部パスすることを確認する(3:50)
- Rubyのバージョンを最新版にアップグレードする(6:30)
- テスト関連のgemを最新版にアップグレードする(10:15)
- Rails 4.2.6にアップグレードする(13:50)
- Rails 5.0.0にアップグレードする(30:15)
- Rails 5 らしく書き直す(1:02:40)
それでは以下で詳しい手順を説明していきます。
1. 公式のアップグレードガイドを確認する(1:20)
アップグレードの手順はRailsガイドでも説明されています。
まずは公式の情報に目を通して、何がどう変わるのか、どういった点に気をつければいいのかを確認しておきましょう。
なお、執筆時点(2016年7月9日)では、日本語訳が読めるのはRails 4.2までです。
Rails 5.0へのアップグレード手順は英語版を読む必要があります。
日本語訳もRails 5に対応しました。(2016/7/14)
また、リリースノートの日本語訳もあります。
こちらも一通りチェックしておくといいでしょう。
Ruby on Rails 4.2 リリースノート | Rails ガイド
Ruby on Rails 5.0 リリースノート | Rails ガイド
2. アップグレード用の作業ブランチを作る(3:25)
いきなりmasterブランチで作業せず、専用の作業ブランチを作ってから、最後にmasterにマージするようにしましょう。
今回は rails-5-0 という作業ブランチを作りました。
3. 現状のテストが全部パスすることを確認する(3:50)
もし、最初からテストが壊れていると、テストが失敗してもアップグレードが原因かどうか区別が付きません。
なので、現状のテストが全部パスすることを確認します。
今回は selenium-webdriver のバージョンが古くてテストが途中で止まってしまったため、selenium-webdriver をアップデートする必要がありました。
4. Rubyのバージョンを最新版にアップグレードする(6:30)
Rails 5はRuby 2.2.2以上でないと動きません。
なので、このタイミングで最新版のRubyにアップグレードしておきましょう。
執筆時点(2016年7月9日)ではRuby 2.3.1が最新なので、このバージョンにアップデートします。
Rubyのバージョンを上げたら、テストが全部パスすることを確認します。
なお、今回は bundle install 実行時に、json gemのインストールでエラーが発生しました。
そこで、bundle update json
を実行して json gemのバージョンを上げてこのエラーを解決しました。
5. テスト関連のgemを最新版にアップグレードする(10:15)
rspec-railsはバージョンが古いと最新のRailsでうまく動作しないことがあります。
そこで、Railsのバージョンを上げる前に、rspec-railsを最新版(執筆時点の最新版は3.5.0)にアップグレードします。
bundle update rspec-rails
を実行した際に依存関係でエラーが出る場合は、エラーの原因になっているgemも一緒にアップデートします。
今回は guard-rspec も一緒にアップデートする必要がありました。
rspec-railsのバージョンを上げたら、テストが全部パスすることも確認しておきましょう。
6. Rails 4.2.6にアップグレードする(13:50)
いきなり4.1から5.0に上げるよりも、先にRails 4系の最終版であるRails 4.2にアップグレードしてから5.0にアップグレードする方が安全です。
というわけで、まずGemfileで gem 'rails', '4.2.6'
を指定し、bundle update rails
を実行します。
gemのインストールが終わったら、bin/rake rails:update
を実行して設定ファイル等をアップデートします。
このときdiffを確認(d)しながら、上書き(Y)、またはスキップ(n)を選択します。
bin/rake rails:update
の実行が終わったら、gitのdiffを確認しながら必要に応じて上書きされたコードを元に戻していきます。
ここまで終わったらテストを実行して結果を確認します。
今回はテスト実行時に turbolinks のバージョンが古いことに起因するエラーが発生していたので、bundle update turbolinks
で turbolinks のバージョンも上げました。
テストが全部パスしたら、念のためブラウザ上でも動作確認しておきます。
特に問題が無さそうであれば、これでRails 4.2.6へのアップグレードは完了です。
7. Rails 5.0.0にアップグレードする(30:15)
さて、いよいよここからがRails 5.0へのアップグレード作業です。
基本的な流れはRails 4.2.6へのアップグレードと同じです。
まずGemfileで gem 'rails', '5.0.0'
を指定し、bundle update rails
を実行します。
しかし依存関係でエラーが出るので、関連するgemも一緒に最新版にアップグレードします。
今回は以下のgemも一緒にアップデートする必要がありました。
- factory-girl
- jquery-rails
- sass-rails
- coffee-rails
- jbuilder
- shoulda-matchers
続いて、rails app:update
を実行して設定ファイル等をアップデートします。
(Rails 4系とは微妙にコマンドが変わっているので注意!)
「diffを確認(d)しながら、上書き(Y)、またはスキップ(n)を選択」、「一通り終わったらgitのdiffを確認しながら必要に応じて上書きされたコードを元に戻す」という流れはRails 4.2.6のときと同じです。
ここまで終わったらテストを実行して結果を確認します。
今回はテスト実行中に発生したエラーや警告に対して、以下のような対応をしました。
- shoulda-matchers用の設定をrails_helper.rbに追加
- コントローラのテストの仕様が変わったので、rails-controller-testing gemを追加
- CapybaraとDatabaseCleanerを最新版にアップグレード
- コントローラスペックのパラメータを
params:
で囲む- 例:
get :index, letter: 'S'
=>get :index, params: { letter: 'S' }
- 例:
テストを実行してすべてのエラーと警告が出なくなったら、ブラウザ上でも動作確認しておきます。
特に問題が無さそうであれば、これでRails 5.0.0へのアップグレードは完了です。
8. Rails 5 らしく書き直す(1:02:40)
アプリケーションの動きだけ見るとここで終わっても問題無さそうなのですが、せっかくなのでRails 5 らしいお作法に従ってコードを直しておきましょう。
今回は config/application.rb に書いてあった generators の設定値を config/initializers/generators.rb に移動させました。
それから、app/models/application_record.rb を作成し、モデルの継承元をActiveRecord::Base
からApplicationRecord
に変更しました。
ここでも修正後にテストを実行してテストが全部パスすることを確認します。
今回のサンプルアプリケーションではこの2点だけを修正しましたが、みなさんのアプリケーションでは他にも修正すべきポイントがあるかもしれません。
詳しくはRailsガイドをチェックしてみてください。
A Guide for Upgrading Ruby on Rails — Ruby on Rails Guides
本記事で説明するアップグレード手順はこれでおしまいです。
お疲れ様でした!
Rails 5.0版のコードはこちら
動画の中で説明したコードは僕のGitHubリポジトリにpushしてあります。
よかったらこちらも参考にしてみてください。
参考になりそうな他のブログ
以下のブログにもRails 5へのアップグレード手順が詳しく解説されています。
自分でトライしてみて解決できない問題が出てきた場合は、こちらのブログを読むと解決するかもしれません。
最速で Forkwell を Rails 5 にアップグレードしてみました - Grooves開発ブログ
まとめ
というわけで、この記事ではRails 4.1からRails 5.0にアップグレードする手順を説明しました。
冒頭にも書いたように動画の方がより詳しく説明しているので、アップグレードにチャレンジする方はぜひ動画もチェックしてみてください。
これでもう怖くない!?Rails 4.1からRails 5.0にアップグレードする手順を動画付きで解説します - YouTube
また、動画を見てもらうとよくわかると思いますが、テストを自動化しているかどうかでアップグレードの作業効率に雲泥の差が出てきます。
「Railsのテストの書き方がわからない」「テストを書くのはどうしても苦手」という方は電子書籍「Everyday Rails - RSpecによるRailsテスト入門」を読んで、テストの書き方をマスターしましょう!(宣伝)
Everyday Rails - RSpecによるRailsテスト入門
あわせて読みたい
過去に書いたRails 5関連のQiita記事です。
よかったらこちらもどうぞ。
Rails 5.0で追加される主な新機能(Ruby on Rails公式ブログより) - Qiita
Rails 5 + ActionCableで作る!シンプルなチャットアプリ(DHH氏のデモ動画より) - Qiita
テストコード関連のgemを最新にしたタイミングで、こちらの対応もあわせて実施すると良いかもしれません。
JavaScriptを実行するフィーチャスペックでActiveRecordへのモンキーパッチを無くす方法 - Qiita