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

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

バックアップ

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

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

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

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

Clone or downloadボタンをクリックします。
3.png29.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.png72.6KB

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

関連記事

【Rails】Railsアップグレードまとめ
# はじめに Ruby on Railsに限らず、何らかのフレームワークを使ってWebシステムを構築している場合、フレームワークのアップグレード作業は避けて通れません。 一般的にフレームワークはバージョン毎にEOL (End of Life [...]
2022年10月1日 14:32
【Rails】ユーザー登録時に行うメールアドレス認証機能の実装方法
# はじめに ユーザー登録/解除やログイン/ログアウトといった認証機能の導入に「devise」というGemを使っている人は多いと思います。「devise」では以下のように記述するだけで、ユーザー登録時に確認メールを送付しメールアドレス認証を行う機 [...]
2022年9月24日 14:24
【Rails】モデルに列挙型(enum)を定義し、使いこなす方法
# はじめに Railsはモデルでカラム名と同名の列挙型(enum)を定義することで、カラムと列挙型の変数を紐付けることができます。カラムと列挙型の変数を紐付けると、カラムに対して様々な便利な使い方ができるようになります。 本記事では、モデ [...]
2022年9月3日 10:29
【Rails】RailsでCORSとPreflight requestの設定を行う方法
# はじめに RailsアプリをAPIサーバーとして構築するには、CORS (Cross-Origin Resource Sharing)と Preflight requestの設定を行う必要があります。APIサーバーは外部からの要求に対して処理 [...]
2022年8月27日 10:44
【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】Capybaraのfill_inメソッドを実行すると「既存レコードの内容+指定した内容」がセットされる事象の原因と対処【RSpec】
# はじめに RSpec + Capybaraを使用して、Railsアプリの統合テストを実装しています。とあるモデルの編集画面において、入力フォームの内容を書き換えた上で送信し、レコードが更新されることを確認します。 入力フォームの内容を書 [...]
2022年1月27日 21:22
【Rails】GitHubのセキュリティアラートで発見された脆弱性を解消する方法
# はじめに GitHubにはセキュリティアラートという機能があります。セキュリティアラートはリポジトリに含まれるライブラリやパッケージの脆弱性を定期的にチェックし、脆弱性のあるライブラリやパッケージが発見されたらアラートで知らせてくれるという機 [...]
2022年1月16日 10:36