PHPerがRubyistになろうとしてつまづいたところ②コンソール

こんにちは！WEBアプリケーションエンジニアの小松です！

この記事は[Enigmo Advent Calendar 2024]の16日目の記事です。

コンソールを使ったデバッグは開発において非常に重要です。フレームワークや言語ごとに特性が異なるため、それぞれの仕組みに慣れる必要があります。以下にPHPやRailsを例に、デバッグ手法や注意点を詳しく解説します。

PHPにはRuby on Railsのような標準的なコンソール機能（例：rails console）が存在しません。そのため、デバッグの際には以下の手法を使うことが一般的です。

var_dump()の利用
PHPでは主にvar_dump()が使われます。これはCLIからの実行でもWEBブラウザ経由のアクセスでも有効です。
例:
```
$data = ['name' => 'John', 'age' => 30];
var_dump($data);
```
CLIでのPHP スクリプト実行
テストスクリプトを作成してCLIから直接実行する方法もあります。これにより、サーバーを介さずにデバッグが可能です。

Railsには標準でrails consoleが用意されており、デバッグやテストに非常に便利です。ただし、注意すべき点もいくつかあります。

関数のテストが容易
Railsのコンソールでは、関数やクラスを直接呼び出してテストできます。
例:
```
def greet(name)
  "Hello, #{name}!"
end

puts greet("Alice") #=> Hello, Alice!
```
デバッグにおける注意点
Railsコンソールでのデバッグにはpを使用しますが、PHPのvar_dump()と異なるため、切り替えを忘れることがあります。
例:
```
data = { name: "John", age: 30 }
p data #=> {:name=>"John", :age=>30}
```
コード変更時の再起動
コードを変更した場合、Railsコンソールに入り直す必要があります。これを忘れると、古いコードのままデバッグを続けることになり、時間を無駄にする原因になります。

RSpecのデバッグでもコンソールと似ています。以下に注意点と手法を挙げます。

pを利用したデバッグ
RSpecでは、ログを確認するよりもpを使う方が効率的な場合があります。しかし、つい忘れてしまうことも多いです。
例:
```
it "tests addition" do
  result = 2 + 2
  p result #=> 4
  expect(result).to eq(4)
end
```
コード変更時の挙動
RSpecコードそのものを変更する場合、通常は何もせずにテストを実行できます。しかし、テスト対象のロジックを変更した場合、特定の環境では注意が必要です。
コード変更と反映
テスト用のコード変更は即時反映されますが、今の開発環境では実際のアプリケーションコードを変更した場合はDockerコンテナを再起動する必要がある場合があります。この手順を忘れると、古いコードでデバッグを進めてしまう可能性があります。

手順:
1. コードを変更する。
2. 以下のコマンドでコンテナを再起動する。

PHPやRails、RSpec環境それぞれに特有のデバッグ手法と注意点があります。特にRailsやDocker環境ではコード変更時の再起動を忘れがちになります。また、各環境でのデバッグ手法に慣れることで、無駄な時間を減らし、生産性を向上させることができます。