test: add interface and adapter for Scraper to enable mocking in unit tests

Author: shimomo

scraper.php

@@ -6,6 +6,7 @@
 
 use BOA\Programs\ProgramScraper;
 use BOA\Programs\ProgramStorage;
+use BOA\Programs\ScraperAdapter;
 use BVP\Scraper\Scraper;
 use Carbon\CarbonImmutable as Carbon;
 
@@ -17,9 +18,9 @@
 
 // v2 の場合のみ ProgramScraper を利用して出走表データを取得
 if ($version === 'v2') {
-    $scraper = new ProgramScraper(
-        Scraper::getInstance()
-    );
+    $scraperInstance = Scraper::getInstance();
+    $scraperAdapter = new ScraperAdapter($scraperInstance);
+    $scraper = new ProgramScraper($scraperAdapter);
 
     // 指定日付の出走表データをスクレイピング
     $programs = $scraper->scrape($date);

src/ProgramScraper.php

@@ -4,7 +4,6 @@
 
 namespace BOA\Programs;
 
-use BVP\Scraper\Scraper;
 use Carbon\CarbonImmutable as Carbon;
 use Carbon\CarbonInterface;
 
@@ -14,9 +13,9 @@
 final class ProgramScraper
 {
     /**
-     * @param \BVP\Scraper\Scraper  $scraper
+     * @param \BOA\Programs\ScraperInterface  $scraper
      */
-    public function __construct(private readonly Scraper $scraper)
+    public function __construct(private readonly ScraperInterface $scraper)
     {
         //
     }

src/ScraperAdapter.php

@@ -0,0 +1,72 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BOA\Programs;
+
+use BVP\Scraper\Scraper;
+use Carbon\CarbonInterface;
+
+/**
+ * @author shimomo
+ */
+final class ScraperAdapter implements ScraperInterface
+{
+    /**
+     * @param \BVP\Scraper\Scraper  $scraper
+     */
+    public function __construct(private readonly Scraper $scraper)
+    {
+        //
+    }
+
+    /**
+     * @psalm-type ScrapedBoat = array{
+     *     racer_boat_number: int,
+     *     racer_name: string,
+     *     racer_number: int,
+     *     racer_class_number: int,
+     *     racer_branch_number: int,
+     *     racer_birthplace_number: int,
+     *     racer_age: int,
+     *     racer_weight: float,
+     *     racer_flying_count: int,
+     *     racer_late_count: int,
+     *     racer_average_start_timing: float,
+     *     racer_national_top_1_percent: float,
+     *     racer_national_top_2_percent: float,
+     *     racer_national_top_3_percent: float,
+     *     racer_local_top_1_percent: float,
+     *     racer_local_top_2_percent: float,
+     *     racer_local_top_3_percent: float,
+     *     racer_assigned_motor_number: int,
+     *     racer_assigned_motor_top_2_percent: float,
+     *     racer_assigned_motor_top_3_percent: float,
+     *     racer_assigned_boat_number: int,
+     *     racer_assigned_boat_top_2_percent: float,
+     *     racer_assigned_boat_top_3_percent: float
+     * }
+     * @psalm-type ScrapedRace = array{
+     *     race_date: string,
+     *     race_stadium_number: int,
+     *     race_number: int,
+     *     race_closed_at: string,
+     *     race_grade_number: int,
+     *     race_title: string,
+     *     race_subtitle: string,
+     *     race_distance: int,
+     *     boats: array<int, ScrapedBoat>
+     * }
+     * @psalm-type ScrapedRaces = array<int, ScrapedRace>
+     * @psalm-type ScrapedStadiumRaces = array<int, ScrapedRaces>
+     *
+     * @param  \Carbon\CarbonInterface  $date
+     * @return ScrapedStadiumRaces
+     */
+    #[\Override]
+    public function scrapePrograms(CarbonInterface $date): array
+    {
+        /** @psalm-var ScrapedStadiumRaces */
+        return $this->scraper->scrapePrograms($date);
+    }
+}

src/ScraperInterface.php

@@ -0,0 +1,58 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BOA\Programs;
+
+use Carbon\CarbonInterface;
+
+/**
+ * @author shimomo
+ */
+interface ScraperInterface
+{
+    /**
+     * @psalm-type ScrapedBoat = array{
+     *     racer_boat_number: int,
+     *     racer_name: string,
+     *     racer_number: int,
+     *     racer_class_number: int,
+     *     racer_branch_number: int,
+     *     racer_birthplace_number: int,
+     *     racer_age: int,
+     *     racer_weight: float,
+     *     racer_flying_count: int,
+     *     racer_late_count: int,
+     *     racer_average_start_timing: float,
+     *     racer_national_top_1_percent: float,
+     *     racer_national_top_2_percent: float,
+     *     racer_national_top_3_percent: float,
+     *     racer_local_top_1_percent: float,
+     *     racer_local_top_2_percent: float,
+     *     racer_local_top_3_percent: float,
+     *     racer_assigned_motor_number: int,
+     *     racer_assigned_motor_top_2_percent: float,
+     *     racer_assigned_motor_top_3_percent: float,
+     *     racer_assigned_boat_number: int,
+     *     racer_assigned_boat_top_2_percent: float,
+     *     racer_assigned_boat_top_3_percent: float
+     * }
+     * @psalm-type ScrapedRace = array{
+     *     race_date: string,
+     *     race_stadium_number: int,
+     *     race_number: int,
+     *     race_closed_at: string,
+     *     race_grade_number: int,
+     *     race_title: string,
+     *     race_subtitle: string,
+     *     race_distance: int,
+     *     boats: array<int, ScrapedBoat>
+     * }
+     * @psalm-type ScrapedRaces = array<int, ScrapedRace>
+     * @psalm-type ScrapedStadiumRaces = array<int, ScrapedRaces>
+     *
+     * @param  \Carbon\CarbonInterface  $date
+     * @return ScrapedStadiumRaces
+     */
+    public function scrapePrograms(CarbonInterface $date): array;
+}