Railsエンジニアとして入社前に知りたかったコマンドたち(シチュエーション付き)

この記事は DeNA 21 新卒 Advent Calendar 2020 の3日目の記事です。

はじめに

この記事はふと、コマンドだけのまとめではなくもっと具体的なシチュエーションが想像できる記事を書いてみたら面白いんじゃないかと思い書くことにしたものです

また自分がRails開発を経験した中で役に立ったと感じた知識にも触れ、メモ欄にはその解説を加えてみました。

ザックリ評価基準( 個人的 )

• 超重要☆☆☆☆☆
• 重要　☆☆☆☆
• 普通　☆☆☆

目次

index	タイトル( ※リンクになってます )
1	$ tail -F devlopment.logs
2	$ git checkout -b <ブランチ名>
3	$ git push --set-upstream origin <ブランチ名>
4	$ rails db:migrate
5	$ bundle install

1.　$ tail -F devlopment.logs　☆☆☆☆☆

わい「すいません、、ここで何で落ちてしまっているのか分からず..orz」
上司「ログの方は確認しましたか？」
わい「(...ん？ログってどうやって見るんだ?)」

使い方

tailコマンドを実行したことでログが監視される様子↓

メモ・注意点

development.log の役割

Ruby on Railsでは開発環境で動作させている場合ログが log 配下の development.log に溜まっていきます(最初これ知った時驚いた)
また詳しいロガーに仕様や設定に関してはRailsガイドを参考にするともっと詳しく知れたりします。
参考: Rails アプリケーションのデバッグ 2.1 ロガーについて

tail コマンド

tail コマンドはLinuxコマンドのうちの1つでオプションに -F もしくは -f を付けることで 指定ファイルの追記を監視する ことができます。
オプションのfの大文字小文字の違いに関してだと以下の記事だとこちらがおすすめだったりします
参考: tailコマンドのオプション「f」と「F」
また注意点として　tail コマンドを用いる際にちゃんとディレクトリが log 配下に位置していることを忘れずに！
ルートディレクトリから誤ってコマンドを実行すると存在しないと怒られてしまいますゆえ
アプリのルートディレクトリから叩くことにして tail -f log/devlopment.logs としても良いかも知れません

2.　$ git checkout -b <ブランチ名> ☆☆☆

上司「現在の状態を知りたいのでWIPでいいので適当なタイミングでPR作ってもらえますか?」
わい「はい！(あれPRってどうやって作るんだっけ?)」

使い方

まずPRを作る前に新しくブランチを作り、切り替えた様子

メモ・注意点

WIP とか PR とかの用語

ここで上司役が言っていた WIP とは Work In Progress の略称で 作業途中である状態 を指す用語として良く聞く単語だったりします。
またGithub の Pull Request をPR(ぴーあーる)と呼ばれたりするのも複数社で観測したのでシチュエーションに載せてみました。
またそのまま 「プルリクエストを作ってください」 とも良く聞きます。

時代はもう git switch -c <ブランチ名> ？

実はGitのブランチの切り替え方法に関しては Git 2.23 から実験的に git checkout -b <ブランチ名> から git switch -c <ブランチ名> にしたらどうか言う提案がされました。
参考： 【Git】あなたが知らない新コマンドswitch/restoreの世界にご招待
確かにブランチを切り替える際に switch するのと checkout するのとでは switch の方が直感的で分かりやすいですよね。( 後そもそも checkout 役割多すぎ問題..
またおまけでswitch ver. も載せておきます

3.　$ git push --set-upstream origin <ブランチ名> ☆☆☆

わい「(おし、とりあえずブランチは切れたっと。あれ、でもaddしてcommitしたのになんでpushできないんだ)」
幻聴「エラーログをちゃんと読みなさい」
わい「( ﾟДﾟ)ﾊｯ!?(今、何か聞こえた!?)」

使い方

メモ・注意点

ブランチを切り替えた後の最初のPush

個人開発ではもしかしたら全て1つのブランチ( masterブランチとか )で作業していることがありますよね？( 特にGit初めたてとかしてました← )
その場合はとりあえず
1. git add <file_name>
2. git commit -m <commit_name>
3. git push
をすることでGitを使いこなしているつもりなっていたりしました。
しかし、ブランチを切り替えた際の挙動はちょっと違ったりします。
実際には $ git push --set-upstream origin <ブランチ名> のコマンドでさっきまではmasterに向けて届けてたかも知れないけど、今度は切り替えた先のブランチに届けますよっと宣言しています。

また、おまけでpushが成功した後ブラウザ上でPRを作成する様子を載せておこうと思います(ほんとに初めここ分からなかったなぁ..)

4. $ rails db:migrate　☆☆☆☆☆

わい「すいません、追加された差分をgit pullして更新したあとエラーが..」
上司「もしかしてmigrateしてないんじゃないんですか?」
わい「あ。。(それだ！)」

使い方

メモ・注意点

差分を追加した際にマイグレーションファイルが追加されているとき

差分を拾ってきてそれでマイグレーションのエラーを引き起こすことは複数人で開発をしていると良く起きたりします。
初め自分はgit pullしてきて平気なときもあれば、なぜかこうやって ActiveRecord::PendingMigrationError になってしまうときがあるなと、同じことをしているのになぜこう言ったことが起こるのか分かっていませんでした。
しかしよく観察してみるとマイグレーションを要求されることはそう言った変更を行ったときのみ要求されるものだと気付き、それから更新した際にマイグレーションファイルが追加や削除、変更されている場合には自分の開発環境も揃えてあげる必要があるんだと知っていきました。

5. $ bundle install　☆☆☆☆☆

わい「すいません、たしかにマイグレーションエラーは消えたのですが、、」
上司「もしかして次はbundile installしてないとか言わないですよね?」
わい「( ﾟДﾟ)ﾊｯ!?。。(やばいそれだ!!)」

使い方

メモ・注意点

ブランチ切り替えにおけるgemのアップデートが必要な場合

複数人でのチーム開発を行っている際には他のエンジニアの方が新しい gem を導入するケースは当然あります。
その場合、手元の自分の環境でも同じ最新状態に揃えるためにGemfileならびにGemfile.lockを更新する必要があります。

おわりに

Railsでの開発と言うのは一言で言うのはあまりにも広く、開発組織によって様々な使われ方がされると思います。モノリシックに作って一旦VueやReactは入れずに作るんだ！ってところもあれば、RailsにはAPIサーバーとしての役割を持ってもらって、フロントはフロントで頑張りますってところも当然あるかと。
また、Webサービスを作る手段として良く知られている気がしますがRailsをゲーム開発に用いることもあります。
そして最近はDockerの利用も主流になってきて、初学者からするとdockerのコマンドとRailsのコマンドを合わせて利用する場面もありすぐに理解が追いつかず詰まりどころが多くなった印象もありました。

今回はそう言ったところで何かRails開発に慣れていく手助けができればと思い書いてみました

宣伝

この記事を読んで「面白かった」「学びがあった」と思っていただけた方、よろしければ Twitter や facebook、はてなブックマークにてコメントをお願いします！
また DeNA 公式 Twitter アカウント @DeNAxTech では、 Blog記事だけでなく色々な勉強会での登壇資料も発信してます。ぜひフォローして下さい！
Follow @DeNAxTech