ヘルプ − 困ったときのヒント集

本ページではRailsチュートリアルでよく見かけるエラーや対処法、迷ったときの学習ロードマップなどをまとめています。Railsチュートリアルを進めていて困ったときにご活用ください。

目次

• はじめに
• 学習ロードマップ
• GitHubでSSH鍵を使って認証する
• Visual Studio Code と Docker コンテナを使ってローカル環境で開発する
• AWS Cloud9 の容量不足を解決する
• 本番環境でメールが送れない
• 公式情報まとめ
• 公式動画：Railsチュートリアルの歩き方
• 公式リポジトリ：yasslab/sample_apps
• 公式アカウント
• 完走者向け読み物ガイド

はじめに

Web技術は日々進化しているため、エラーに遭遇せずに開発を進められることは稀です。すべてのエラーを網羅するのは難しいですが、エラー発生時に役立つ（かもしれない）ヒントを以下にまとめておきました。困ったときはぜひお試しください。

• Sample App 実装例のコードと自分のコードを比較しましたか？
• チュートリアルで使用した gem のバージョン（Rails を含む）を正確に使用していますか？
• エラーメッセージで検索してみましたか？
• RailsのWebサーバを（Ctrl-Cで）停止して再起動しましたか？
• bin/spring stopを使ってSpringを停止してみましたか？
• bundle installを再実行しましたか？
• bundle updateを実行してみましたか？
• heroku logsやheroku logs --tailを使って Heroku のログを調べましたか？
• sqlite3gem がGemfileの開発環境とテスト環境にのみリストされていることを確認しましたか？
• エラーメッセージで検索してみましたか？（大事なことなので２回書きました）

上記ヒントが皆さんのお役に立てば解決すれば嬉しいです。『デバッグ時間をもっと短くしたい』『より早く学びたい』といった場合は、次の学習ロードマップをご参照していただけると幸いです。

学習ロードマップ

よくある学習の流れをまとめたロードマップもあります。『この流れが正解』といったものはありませんが、自分に合った学習計画を立てる場面などでご活用ください。

☝️ 図中に記載されている各種サービスの概要は、次の通りです。

• Progate

  対話的に学べるオンラインのプログラミング学習サービスです。初心者向けのコンテンツが特に充実しており、初めてプログラミングをする方にオススメです。『Progate Journey』でプログラミング学習の全体像を把握することもできます。

• Railsチュートリアル実践入門シリーズ

  Railsチュートリアルを進めて『難しい!』と感じた方を対象とした補足コンテンツです。『基礎力を高めたい』『まずは基本を押さえたい』という方にオススメです。

• RailsチュートリアルWebテキスト

  WebpackやGitHubにも対応した最新のコンテンツです。『理解がうまく進まない』『もっと早く学びたい』といった場合は、スライドと実演動画で学べるRailsチュートリアル解説動画がオススメです。

• Railsチュートリアル解説動画 + トレーニング

  イラストと実演で効率的に学べる解説動画で、すばやく復習したい人にオススメです。2022年から回答付き問題集「トレーニング」も同梱され、７０問以上の問題を通して各章の理解度もチェックできます。「コードは動いたけど理解できたか不安」という人に特にオススメです。

• 質問対応サポート付き解説動画【提供: ShareWis】

  現役Rubyエンジニアのサポート付きで学べる、解説動画の質問対応付きサービスです。後半の章ほど難しくなっていきますが、サポートを受けながらしっかり学ぶことができます。

• コミュニティサポート付き解説動画【提供: TechCommit】

  コミュニティ型の学習支援サービスです。独学での学習が不安な方にオススメです。（【Railsチュートリアルコラボ】Rails学習支援追加パックでお申し込みください。）

• Ruby on Railsガイド

  トピック毎に体系化された、1,600ページを超えるRailsの大型リファレンスです。Railsチュートリアルを完走し、プロダクト開発の実践に入った方々を対象として、各機能の詳しい使い方を解説する辞書型サービスです。『もっと生産的に開発したい』という方向けにProプランやTeamプラン、電子書籍版も提供しています。

• 読み物ガイド

  Railsチュートリアル完走者を対象とした『読み物ガイド』も用意しています。『完走後ってどうしたらいいの？』とお悩みの場面でお役に立てば嬉しいです 😌💖

上記の他、YouTubeチャンネルやnoteマガジンもあります。『Ruby/Rails学習者の統計データ』や『３ヶ月でWebサービスを開発した話』、『医者からエンジニアになった話』などを公開しているので、ぜひご購読ください！📺✅

GitHubにSSH鍵を使って接続する

GitHubにSSH鍵を使って接続する方法です。GitHubアカウントがない場合は、初めにアカウントを作成します。

1. SSH鍵の登録方法

1. 公開鍵をクリップボードにコピーします。既に公開鍵を作成している場合は、catコマンドを使って公開鍵を表示できます。

             $ cat ~/.ssh/id_rsa.pub
           

   まだ作成していない場合はコマンドを実行しても No such file or directory と表示されます。その場合は「Git - SSH 公開鍵の作成」を参考に公開鍵・暗号鍵を作成してください。
2. 公開鍵を追加するには、GitHubで右上にあるプロフィール画像をクリックしドロップダウンメニューから「Settings」をクリック、次に左サイドバーから「SSH and GPG keys」をクリックします。
3. 右上の「New SSH key」をクリックして、表示されたページで任意の鍵の名前を入力し、catコマンドで出力した公開鍵をコピー＆ペーストします。
   
4. 最後に「Add SSH key」をクリックするとページが移動し、追加した公開鍵を確認できます。
   

2. GitHubをリモートoriginに追加する方法

GitHubでリポジトリを作成した後に表示される画面では、「SSHオプション」を選択してコマンドを表示させてください。

ターミナルで下記のコマンドを実行し、GitHubをリモートoriginに追加します

        $ git remote add origin git@github.com:<あなたのGitHubアカウント名>/hello_app.git
      

参考記事

• Pro Git（日本語版）
• GitHub アカウントへの新しい SSH キーの追加 - GitHub Docs

Visual Studio Code と Docker コンテナを使って開発する

Visual Studio Code と Docker コンテナを使って、ローカル環境に開発環境を用意する方法です。開発環境完了後は1.2 さっそく動かすのセクションを読み飛ばすことができます。今回の環境構築にあたりsaboyutakaさんが作成したdevcontainer for Rails Tutorial 6を利用します。ご提供いただき、ありがとうございます。

必要なものをインストールする

• Docker Desktop for Windows/Mac.からDockerをインストールします。詳しくはこちらから。
• Visual Studio Codeをインストールします。
• Remote Development extension packというVScodeの拡張をインストールすることで、VScode内でDockerを起動することができます。

devcontainerの起動する

• devcontainer for Rails Tutorial 6をgit cloneを使い、ローカル環境にダウンロードします。以下のコードをターミナルで実行すると、rails-tutorial6-devcontainerというディレクトリがダウンロードされます。

            $ git clone https://github.com/saboyutaka/rails-tutorial6-devcontainer.git
          

  上記の方法で失敗する方は、devcontainer for Rails Tutorial 6のページからZIPでダウンロードすることもできます。

  
• VSCodeを起動し、rails-tutorial6-devcontainer を開きます。
• 左下のボタンをクリックし、メニュを開きます。
• Reopen in Container を実行します。繋がらない場合はDockerが起動しているか確認してみましょう。
• 右上のボタンからTerminalを開きます。
• コマンドを実行し完了になります。リスト 1.5まで完了している状態です。お疲れ様でした。

AWS Cloud9 の容量不足を解決する

Cloud9 で開発していると、デフォルトで設定されている Amazon EBS ボリューム容量では足りなくなってしまうことがあります。本セクションでは、使わなくなったファイルの削除方法や EBS ボリュームを増やす方法を紹介します。（Amazon EBS の無料利用枠については公式ページからご確認ください。）

0. 第3章に入ったら hello_app, toy_app は削除しよう

第3章『ほぼ静的なページの作成』からは sample_app だけを使います。第1章で作った hello_app と、第2章で作った toy_app は削除しても大丈夫です。容量不足が不安になってきたら、まずは hello_app と toy_app を削除してみましょう。（ソースコードを残しておきたい方は、事前に GitHub に push しておきましょう）

1. EBS ボリュームの確認方法

        $ df -h
        Filesystem      Size  Used Avail Use% Mounted on
        .
        .
        /dev/xvda1      9.8G  8.2G  1.5G  85% /
      

        There was an error while trying to write to `/home/ubuntu/environment/sample_app/.bundle/config`. There was insufficient space remaining on the device.
      

2. EBS ボリュームを増やす方法

• Amazon EC2 コンソールを開きます。
• 「ボリューム」を選択し、変更するボリュームを選択します。（複数あって分からない場合は、「インスタンス」の「実行中のインスタンス」の中からaws-cloud9から始まる Name のインスタンス ID をコピーし、ボリューム内で検索するとよいでしょう。）
• 上部にある「アクション」ボタンから「ボリュームの変更」を選択し、サイズを AWS が定める最大無料枠に設定し、変更します。（執筆時点では 30 でしたが、念のため確認しておくことをオススメします）
• 「インスタンス」にいき、該当のインスタンスを選択後、画面上部にある「アクション」ボタンから「インスタンスの状態」→「再起動（停止中なら開始）」をします。
• 「Cloud9」に戻り、ターミナルからボリュームの拡張をします。現在のインスタンスに割り当てられているブロックデバイスの情報を確認するには、lsblkコマンドで表示します。ルートボリュームである/dev/xvdaは拡張されていますが、/dev/xvda1はまだ元のままです。

            $ lsblk
            .
            .
            xvda    202:0    0  30G  0 disk
            └─xvda1 202:1    0   8G  0 part
          

  ボリュームを拡張させるには以下のコマンドを使います。

            $ sudo growpart /dev/xvda 1
          

            $ lsblk
            .
            .
            xvda    202:0    0  30G  0 disk
            └─xvda1 202:1    0  30G  0 part /
          

• 最後にファイルシステムを拡張します。ファイルシステムを拡張するには、以下のコマンドを使います。

            $ sudo resize2fs /dev/xvda1
          

            $ df -h
            Filesystem      Size  Used Avail Use% Mounted on
            .
            .
            /dev/xvda1       30G  8.2G  21G  27% /
          

参考記事

• 料金 - Amazon EBS ｜AWS
• Elastic Volumes を使用して EBS ボリュームを変更する (コンソール)
• 例: EBS ボリュームのファイルシステムの拡張

本番環境でメールが送れない

Heroku のメール系アドオンにはいくつかあります。メールが送れない場合は、設定を見直すか、もしくは別のメール系アドオンを試してみましょう。本セクションでは『Mailgun』と『SendGrid』の２つをご紹介します。

Mailgun の設定方法

Mailgun でメールを送る場合は、次の手順でセットアップを行います。

• $ heroku addons:create mailgun:starterで無料枠 (1日400通まで) の Starter プランを追加します。
• Mailgun の公式ドキュメントに従って、ActionMailer を設定します。(config/environments/production.rb)
  

  Rails.application.configure do
    ...
    config.action_mailer.raise_delivery_errors = true
    config.action_mailer.delivery_method = :smtp
    host = '【Herokuのサブドメイン】.herokuapp.com'
    config.action_mailer.default_url_options = { host: host }
    ActionMailer::Base.smtp_settings = {
          :port           => ENV['MAILGUN_SMTP_PORT'],
          :address        => ENV['MAILGUN_SMTP_SERVER'],
          :user_name      => ENV['MAILGUN_SMTP_LOGIN'],
          :password       => ENV['MAILGUN_SMTP_PASSWORD'],
          :domain         => host,
          :authentication => :plain,
    }
    ...
  end
  	

• 変更したコードをcommitし、Heroku にpushします。

            $ git push heroku
          

• $ heroku addons:open mailgunで Mailgun ダッシュボードのURLが表示されるので、ブラウザで開きます。
• MailGun公式ドキュメントに従い、受信したいメールアドレスを認証します。画面左側の「Sending」→「Domains」のリストにある「sandbox」で始まるサンドボックスドメインを選択します。画面右側の「Authorized Recipients」で、受信したいメールアドレスを認証できます。

SendGrid の設定方法

SendGrid でメールを送る場合は、次の手順でセットアップを行います。Mailgun でメールが送れず、設定を見直してもうまくいかなかった場合は、SendGrid を試してみてください。

• 公式ページを参考に、ActionMailer を設定します。(config/environments/production.rb)

    Rails.application.configure do
      ...
      config.action_mailer.delivery_method = :smtp
      config.action_mailer.perform_deliveries = true
      host = '【Herokuのサブドメイン】.herokuapp.com'
      config.action_mailer.default_url_options = { host: host }
      ActionMailer::Base.smtp_settings = {
            :port                 => 587,
            :address              => 'smtp.sendgrid.net',
            :user_name            => ENV['SENDGRID_USERNAME'],
            :password             => ENV['SENDGRID_PASSWORD'],
            :domain               => host,
            :authentication       => :plain,
            :enable_starttls_auto => true
      }
      ...
    end
      

• 変更したコードをcommitし、Heroku にpushします。
• $ heroku addons:create sendgrid:starterで無料枠 (1日400通まで) の Starter プランを追加します。

SendGrid アカウントの状態を確認

      # エラー例『認証に失敗 (535)』
      Net::SMTPAuthenticationError (535 Authentication failed: account disabled
    

      # エラー例『未確認のドメイン (550)』
      Net::SMTPFatalError (550 The from address does not match a verified Sender Identity. Mail cannot be sent until this error is resolved.
    

メールアドレスの認証

• 上記のようなエラーメッセージの場合、noreply@example.com を認証されたメールアドレスに置き換えてみましょう。
• Heroku ダッシュボードから該当するアプリのページにいき、「Resources」をクリックします。
• 「Add-ons」という項目の中にある「SendGrid」をクリックし、SendGrid のダッシュボードに行きます。
• SendGrid ダッシュボード下部の「Admin User Details」に認証されたメールアドレスが表示されているので、ソースコード内の「noreply@example.com」を表示されているメールアドレスに置き換えます。
• 最後に、変更したコードをcommitし、Heroku にpushします。

            $ git push heroku
          

参考記事

• Mailgun | Heroku Dev Center
• Mailgun | Authorized Recipients
• SendGrid - アカウント凍結のフローとその解除方法について教えてください。
• SendGrid - アカウントの凍結を防ぐためには、どうすればいいですか？
• SendGrid - Removing the add-on | Heroku Dev Center

公式情報まとめ

Railsチュートリアルに関する公式動画・公式アカウントなどをまとめてみました。最新情報を知りたい場面などでお役立てください。

公式動画：Railsチュートリアルの歩き方

Railsチュートリアルの全体像を俯瞰したいときや、完走後のイメージを掴みたい場面でご活用ください。

公式リポジトリ：yasslab/sample_apps

GitHub 上で公開しているRailsチュートリアルの実装例です。Railsのバージョン毎にそれぞれディレクトリが分けられているので、学習中のバージョンに合わせて適宜ご参照ください。

• 第6版（Rails6.0対応）
• 第4版（Rails5.1対応）
• 第4版（Rails5.0対応）
• 第3版（Rails4.2対応）
• 第2版（Rails4.0対応）

公式アカウント

• Railsチュートリアル マガジン (note)
• @RailsTutorialJP (Twitter)
• #Railsチュートリアル (ハッシュタグ)

完走者向け読み物ガイド

Railsチュートリアル完走者を対象とした『読み物ガイド』も用意しています。『完走後ってどうしたらいいの？』とお悩みの場面でご活用ください 🗺✨