Railsアプリの名称を変更したい!できるだけ楽に安心して行える方法を解説【+リモートリポジトリー名変更】

Railsアプリを作成してしばらくしてからアプリ名を変更したいと思ったことはないでしょうか。Railsのアプリ名とは、最初にrails newしたときに指定した文字列のことです。
$ rails new <アプリ名>
ここで指定したアプリ名はRailsアプリのソースコードのそこかしこに書かれています。少しPCに詳しい人だったらディレクトリ配下の一括置換なんかでさくっと変更してしまえますが、初心者にはなかなかハードルの高い作業かもしれません。
今回は初心者の方でも楽に、そして安心してRailsアプリの名称を変更する方法を解説します。
また、GitHubのリポジトリー名の変更についても合わせて解説します。

バックアップ

せっかく作ったアプリが消えてしまったり起動しなくなるのは嫌ですよね。
そんな万が一のことを考えて二重三重にバックアップをとっておくことにしましょう。

GitHub
Railsでアプリ開発を行っている方ならGitHubを利用していることかと思います。
万が一ローカルのアプリが消えてしまっても、GitHubにソースをあげていればすぐに復活させることができます。

GitHubからローカルにアプリを復活させる手順を予習しておきましょう。
1.png 40.1KB

自分のGitHubのページにアクセスし、リポジトリー名をクリックします。
2.png 72.7KB

Clone or downloadボタンをクリックします。
3.png 29.8KB

URLの横のボタンをクリックするとURLがクリップボードにコピーされます。

次に、ターミナルで以下のコマンドを実行します。
既存のアプリがあるディレクトリでは実行しないでください。
$ git clone <コピーしたリポジトリーのURL>
万が一ローカルのアプリが消えてしまったらGitHubから復活させましょう。

データベース
ソースコードのバックアップはGitHubにあるので安心ですが、データベースのバックアップはGitHubにはありません。
なので、原始的な方法でバックアップを取っておきましょう。
なお、データベースはSQLiteを使っていることとします。

SQLiteのデータベースはdb/development.sqlite3です。これを別のディレクトリにコピーしておきます。
$ cd ~/Product/sample/db/
$ cp -p development.sqlite3 ~/.
「~/」はユーザーのホームディレクトリ、「.」はコピー元のファイル名と同じという意味です。

Railsアプリ名称変更

Railsアプリ名称変更を行うためだけのGemが存在します。
Gemfileに以下を追記してbundle installを行います。
...
gem 'rename'
直球の名前ですね。シンプルで好みです。
インストールできたら、変更したいアプリのルートディレクトリで以下を実行します。
$ rails g rename:into <変更後の名前>
これでRailsアプリの名称が変更されました。
ディレクトリ名も変更されているので、VSCodeを使っている人は開き直しましょう。

GitHubのリポジトリー名変更

続いてGitHubのリポジトリー名を変更していきます。
4.png 72.6KB

GitHubにアクセスし、Settingsをクリックします。
5.png 23.2KB

Repository nameに変更後の名前を入力し、Renameボタンをクリックします。

ローカルのリモートリポジトリー設定を変更していきます。
まず、現在のリモートリポジトリー設定を確認します。
$ git remote -v
origin  <リモートリポジトリーのURL> (fetch)
origin  <リモートリポジトリーのURL> (push)
次に、リモートリポジトリー設定を変更します。
$ git remote set-url origin <変更後のURL>
最後に、リモートリポジトリー設定が変更されているか確認します。
$ git remote -v
origin  <変更後のURL> (fetch)
origin  <変更後のURL> (push)

まとめ

Railsアプリの名称変更はあまり行いたくないものです。そうは言っても、どうしても変更したいということもあると思います。
そんなときはできるだけ安全に行えるよう、事前にバックアップを取っておくと安心です。
また、バックアップから復活させる方法も事前にシミュレーションしておくことをおすすめします。