IntelliJ IDEA で Ruby / Rails プロジェクトを開始する

プロジェクトビュー

IDE の左側にあるプロジェクトビュー（Alt+1）には、プロジェクトの構造が表示されます。これを使用して、プロジェクト内の任意のファイルを開いたり、新しいファイルを作成したりできます。

また、ファイルやディレクトリではなく Rails 要素としてコントローラー、モデル、ビュー、DB 移行を表示する論理プロジェクト構造を示す特別な Rails ビューに切り替えることもできます。

宣言に移動

宣言に移動を使用すると、任意のシンボル使用箇所からシンボルの宣言にナビゲートできます。この機能を実際に使用するには、Ctrl+Shift+N を押して「users_controller」と入力し、users_controller.rb ファイルを選択して Enter をクリックします。

開いた app/controllers/users_controller.rb ファイルで、ユーザークラスの横にキャレットを置き、Ctrl+B を押します。

user.rb ファイルのクラス宣言にジャンプします。

プロジェクトエンティティだけでなく、外部ライブラリ内の定義（この例では gems）にジャンプできることに注意してください。たとえば、Ctrl を押したまま、has_many メソッドにマウスポインターを合わせます。メソッドがハイパーリンクになったら、キーを放さずにクリックします。

IntelliJ IDEA は ActiveRecord Rails モジュール内のメソッド定義を開きます。

使用箇所の検索

使用箇所の検索機能を実演しましょう。 app/controllers/users_controller.rb ファイルで、編集アクションまでスクロールし、キャレットをその横に置き、Alt+F7 を押します。検索ウィンドウでは、このアクションが使用されている場所を探索することができます。

Rails エンティティ間を移動する

コントローラーなどの特定の Rails エンティティで作業する場合、関連するビュー、モデル、テスト、またはヘルパーに移動できます。編集メソッドの横にキャレットを置き、Ctrl+Alt+Home を押し、表示を選択して Enter を押します。IntelliJ IDEA は、対応するビューを含む edit.html.erb ファイルを開きます。

ビュー内で同じショートカットを使用するか、エディターのガターの アイコンを使用して、対応するアクションにすばやく移動できます。

どこでも検索

次の IntelliJ IDEA 機能を使用すると、ファイル、クラス、シンボル、またはオプションを検索し、必要なエンティティにジャンプすることができます。

UsersController 内で destroy アクションを見つけようとしましょう。 Shift を 2 回押して、destroy と入力し始めます。ドロップダウンリストには、シンボルグループ内のすべてのコントローラーの destroy がリストされます。UsersController から destroy アクションを選択して Enter を押します。

users_controller.rb ファイルが開き、キャレットが destroy アクションの定義に配置されます。

コード補完

IntelliJ IDEA は、クラス、メソッド、キーワードなどの名前を完成させるのに役立ちます。コード補完を呼び出すと、IntelliJ IDEA はコンテキストを分析し、現在のキャレット位置に適用可能な選択肢を提案します。

たとえば、users_controller.rb ファイルを開き、UsersController クラスで宣言されているインデックスメソッドに移動します。メソッド内に次のコードを入力します。

... と入力し、ドットを入力します。ユーザークラスは ApplicationRecord モジュールから継承されるため、エディターには継承されたすべてのメンバーが表示されます。

その後、first と入力してリストをフィルタリングし、クエリモジュールから対応するメンバーを見つけて、Enter を押します。

インテンション

インテンションは、さまざまなコード変更をすばやく適用できます: より良いコードスタイルのためのステートメントの変換、ロケール辞書への文字列の追加、言語インジェクションの使用など。

インテンションの動作を確認するには、user.rb ファイルを開き、複数行の 3 項演算子（? :) を使用する User.digest メソッドまでスクロールダウンします。Ruby スタイルガイド(英語)によれば、そのような演算子を if/then/else/end ブロックに置き換えることが好ましい。これを行うには、キャレットをこの三項演算子（たとえば、ActiveModel の隣）に配置し、Alt+Enter を押します。 Enter を押して、三項演算子を if/then/else/end ブロックに変換します。

インスペクションを使用してコードを確認し、起こりうる問題を検出することができます。

コードのリファクタリング

リファクタリングは、ソースコードを変更したり維持したりするのを容易にするために、ソースコードを変更するプロセスですが、動作を変更することはありません。IntelliJ IDEA で利用できるリファクタリング機能をいくつか見てみましょう。

名前の変更リファクタリングを使用すると、クラス、メソッド、ファイル、変数、パラメーターの名前を変更でき、コード内のそれらへのすべての参照がそれに応じて修正されます。 users.rb ファイルを開き、before_save ActiveRecord コールバックで育っ downcase_email メソッドまでスクロールします。このメソッドの横にキャレットを置き、Ctrl+Shift+I を押してその定義を確認します。

Esc をクリックし、Ctrl+Alt+Shift+T を押します。呼び出されたポップアップで名前の変更を選択すると、さまざまなリファクタリングが提案されます。

名前の変更ダイアログで、新しいメソッド名（この場合 lowercase_email）を指定してリファクタリングをクリックします。

リファクタリングプレビューウィンドウには、名前を変更したメソッドへの参照がすべて表示されます。

リファクタリング実行をクリックして、すべての場所でメソッドの名前を変更します。

変数を抽出

変数の抽出リファクタリングは、選択した式の結果を変数に代入します。新しい変数を宣言し、その式を初期化子として使用します。元の式は新しい変数に置き換えられます。

user.rb ファイルを開き、フィード方法に移動します。このメソッドでは、SQL サブクエリを変数に抽出できます。これを行うには、対応する部分文字列を選択して Ctrl+Alt+V を押します。次に、変数名を指定し、Enter を押して抽出を終了します。

コードの整形

IntelliJ IDEA を使用すると、コードスタイルの要件を満たすようにソースコードを再フォーマットできます。

user.rb ファイルのコードを再フォーマットしましょう。このファイルを開いて Ctrl+Alt+L を押してください。

IntelliJ IDEA はファイル全体を再フォーマットし、いくつかの変更された行を表示します。

すべてのテストを実行

プロジェクトの test フォルダーには Minitest テストが含まれています。すべてのテストを実行するには、Alt+1 を押してプロジェクトビューを開きます。次に、test フォルダーを右クリックし、コンテキストメニューから実行 'All tests in test' を選択します。

IntelliJ IDEA が実行され、テスト結果が実行ツールウィンドウに表示されます。

特定のテストを実行する

それでは、特定のテストを実行する方法を見てみましょう。 users_controller_test.rb ファイルを開き、テストにログインしていない場合はリダイレクト先のインデックスまでスクロールし、このテストの横にある左ガターの実行ボタンをクリックします。

呼び出されたメニューで、'test_should_redirect ...' を実行しますを選択します。IntelliJ IDEA はこのテストの結果を表示します。

失敗したテストの再実行

それでは users_controller_test.rb に戻り、2 つのテストを破りましょう。ログインしていないときはインデックスをリダイレクトし、新しいテストで get users_path と get_sighup_path の行をコメントアウトする必要があります。これを行うには、これらの行を選択して Ctrl+/ ショートカットを使用します。

すべてのテストを実行の説明に従って、すべてのテストを再度実行します。これらのテストが失敗したことがわかります。

get users_path および get_sighup_path 行 Ctrl+/ のコメントを外して、現在開いている users_controller_test.rb ファイルのこれらのテストを修正しましょう。 ボタンを使用して、これらの失敗したテストのみを再実行できるようになりました。

ブレークポイントを設定してデバッグを開始する

まず、users_controller.rb ファイルを開きます。新しいユーザーが作成された行の横にある create メソッド内にブレークポイントを設定します。

デバッグを開始するには、Ctrl を二回押して、sample_rails_app と入力し始めます。リストから開発: sample_rails_app 設定を選択し、Shift キーを押しながら（ダイアログのタイトルがデバッグに変わります）、Enter を押します。

デバッグに必要な debase(英語) および ruby-debug-ide(英語) gems がまだインストールされていない場合、IntelliJ IDEA はそれらをインストールすることをお勧めします。

gems をインストールすると、デバッグツールウィンドウにアプリケーションの出力が表示されます。

ローカルマシンでブラウザーを開き、アプリケーションアドレス 0.0.0.0:3000 を指定します。

今すぐサインアップ ! ボタンをクリックします。サインアップページで、資格情報を入力し、アカウントを作るをクリックします。

プログラムはブレークポイントに達すると停止します。

変数を調べる

これで、アプリケーションの状態と変数の値を調べることができます。

フレームペインには、アプリケーションスレッドとそれに対応する呼び出しスタックが表示されます。今回の場合、create メソッドはスレッド 30 で呼び出されます。変数ペインでは、現在のコンテキストで利用可能な変数を調べることができます。

リストに user_params 変数を追加しましょう。変数ペインのボタン をクリックして、user_params の入力を 開始します。呼び出されたドロップダウンから user_params 変数を選択して Enter を押します。

次に、この変数の横にある ボタンをクリックし、同じ方法で @parameters 変数を展開します。サインアップ形式で指定されたユーザー資格情報が表示されます。

ブレークポイントに達すると、コードをステップ実行できます。

ステップオーバー

ステップオーバーは、現在のスコープ内の次の行に進みます（たとえば、次の行に移動します）。途中でメソッド呼び出しに降下することはありません。

以下の画面では、ユーザーオブジェクトがまだ作成されておらず、@user 変数が初期化されていない（ nil に等しい）ことがわかります。

F8 を押すか、デバッグウィンドウのツールバーの ボタンをクリックします。デバッガーは次の行（ if ステートメント）に進みます。エディターと変数ペインで、@user 変数が初期化されたことを確認できます。

ボタンを使用して、@user のプロパティを調べます。

ステップイン

ステップインはデバッガーを現在の行のメソッド呼び出しまたはブロックに移動させ、追跡します。複数のメソッド呼び出しまたはブロックがある場合は、目的のターゲットを選択できます。

プログラムの実行を再開するには、 ボタンをクリックします。ブラウザーに再度アクセスし、別のユーザーをサインアップ形式で作成します。スクリプトは、ユーザーが作成された行に到達すると停止します。

F7 を押すか、 ボタンをクリックしてください。エディターは user_params メソッドにフォーカスを置きます。矢印キーまたは Tab を使用してステップインする方法を選択できます（以下の例では new または user_params）。user_params を選択して Enter を押す。プログラムの実行は user_params メソッド定義にジャンプします。

F7 をもう一度押すと、デバッガーは params から選択することを提案し、StrongParameters(英語) モジュールのメソッドを要求します。

コンソールでデバッグする

デバッガーにはコンソールタブがあり、IRB のようなコンソールでデバッグされたアプリケーションと対話できます。

コンソールで user_params と入力し始め、対応する変数を選択して Enter を押します。

コンソールウィンドウに変数の値が表示されます。