# PHPUnitを利用したリファクタリングの実践

## 目次

1. はじめに

2. PHPUnitとは

   1. どのように機能するのか

   2. 安装とセットアップ

3. リファクタリングの基本概念

   1. なぜリファクタリングが重要なのか

   2. コードの臭いとその解決策

4. PHPUnitを用いたリファクタリングのステップ

   1. 既存コードのテスト作成

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

   3. テストケースの更新と実行

5. 実践例：PHPUnitとリファクタリング

   1. 具体例によるステップバイステップ

   2. PHPコードサンプル

6. PHPUnitでのベストプラクティス

   1. テストの設計

   2. CI/CDへの統合

7. まとめ

## 1. はじめに

ソフトウェア開発において、テスト自動化は品質を高めるための重要な役割を担っています。特にリファクタリングは、コードをより整然とし、維持しやすくするプロセスであり、これを安全かつ効果的に進めるうえで単体テストの存在は必須です。PHPUnitはPHP環境における代表的なテストフレームワークとして知られており、開発者がリファクタリングを効率よく行えるようサポートします。

## 2. PHPUnitとは

### 2-1. どのように機能するのか

PHPUnitはPHP用の単体テストフレームワークであり、テスト駆動開発（TDD）を促進するために設計されています。テストケースの作成と実行を容易にし、開発者がコードの振る舞いを正確に検証できるようにします。

### 2-2. 安装とセットアップ

PHPUnitはComposerを使用してインストールすることができます：

```bash

composer require --dev phpunit/phpunit

```

インストールが成功すると、`vendor/bin/phpunit` から実行可能になります。

## 3. リファクタリングの基本概念

### 3-1. なぜリファクタリングが重要なのか

リファクタリングはコードの動作を変更せずに内部構造を改善するプロセスです。主な目的は、コードの読みやすさや保守性、パフォーマンスを向上させることにあります。

### 3-2. コードの臭いとその解決策

"コードの臭い"はリファクタリングが必要な部分を示します。例えば、重複したコードや長過ぎるメソッドなどは典型的なものです。これらはコードの維持を難しくし、新たなバグを誘発する要因となります。

## 4. PHPUnitを用いたリファクタリングのステップ

### 4-1. 既存コードのテスト作成

リファクタリングを始める前に、現状のコードが期待通りに動作することを証明するためのテストケースを作成します。こうすることで、リファクタリング後に機能が損なわれていないことを確認できます。

### 4-2. コードのリファクタリング

テストが成功していることを確認しながら、コードを段階的にリファクタリングしていきます。各ステップでテストを実行し、動作が変わっていないことを検証します。

### 4-3. テストケースの更新と実行

リファクタリングによって新たな機能や改善が追加された場合は、テストケースもそれに対応させて更新する必要があります。

## 5. 実践例：PHPUnitとリファクタリング

### 5-1. 具体例によるステップバイステップ

ここでは、サンプルとして簡単な電卓アプリケーションのリファクタリングを行います。以下にリファクタリングの手順を示します。

#### Step 1: 現在のコードとテストケース

```php

// Calculator.php

class Calculator {

    public function add($a, $b) {

        return $a + $b;

    }

}

// CalculatorTest.php

use PHPUnit\Framework\TestCase;

class CalculatorTest extends TestCase {

    public function testAdd() {

        $calc = new Calculator();

        $this->assertEquals(4, $calc->add(2, 2));

    }

}

```

#### Step 2: リファクタリング

コード内の重複箇所を削除するために、共通メソッドを抽出します。

```php

class Calculator {

    public function operate($a, $b, $operation) {

        switch ($operation) {

            case 'add':

                return $this->add($a, $b);

            // 他の演算もここで管理可能

        }

        return null;

    }

    private function add($a, $b) {

        return $a + $b;

    }

}

```

#### Step 3: テストケースの更新

```php

class CalculatorTest extends TestCase {

    public function testAdd() {

        $calc = new Calculator();

        $this->assertEquals(4, $calc->operate(2, 2, 'add'));

    }

}

```

### 5-2. PHPコードサンプル

この例では、`operate` メソッドを使用して、演算を一元管理しました。計算機能が追加されるたびに、新しいメソッドを追加して切り替えることができます。

## 6. PHPUnitでのベストプラクティス

### 6-1. テストの設計

- **分離:** 各テストは1つの操作や機能をテストすること

- **独立:** 各テストは他のテストに依存せずに実行できること

### 6-2. CI/CDへの統合

PHPUnitテストはCI/CDパイプラインに統合することで、自動的にコードの品質を確保することができます。GitHub ActionsやJenkinsなどを利用してテストを実行すると良いでしょう。

## 7. まとめ

PHPUnitを活用したリファクタリングは、コードベースを改善しながらバグを防ぐための強力な手法です。事前にテストケースを作成し、リファクタリング中にテストを実行することで、コードの一貫性と信頼性を維持することができます。リファクタリングによってコーディング標準の向上が期待できるため、積極的に取り組むことをお勧めします。

PHPUnitを利用したリファクタリングの実践

目次

続きを読むには単価診断を受けてください（30秒）