feature: added rank field and updated query action

Added a new rank field to the airport entity Updated Query action to order by rank
amvid · May 14, 2024 · 4a9d41c · 4a9d41c
1 parent 73ba7ab
commit 4a9d41c
Show file tree

Hide file tree

Showing 22 changed files with 145 additions and 47 deletions.
diff --git a/.docker/php/entrypoint.sh b/.docker/php/entrypoint.sh
@@ -1,9 +1,20 @@
 #!/usr/bin/env sh
 
-composer install
+if [ ! -d "vendor" ]; then
+	echo "Vendor directory not found. Installing dependencies..."
+	composer install
+else
+	echo "Vendor directory found. Skipping dependency installation."
+fi
+
 bin/console assets:install
 
-vendor/bin/rr get-binary -f v2024.1.1 --location bin
-chmod +x bin/rr
+if [ ! -f "bin/rr" ]; then
+	echo "RoadRunner binary not found. Downloading..."
+	vendor/bin/rr get-binary -f v2024.1.1 --location bin
+	chmod +x bin/rr
+else
+	echo "RoadRunner binary found. Skipping download."
+fi
 
 bin/rr serve -c .rr.dev.yaml
diff --git a/Makefile b/Makefile
@@ -6,6 +6,12 @@ up:
 dev:
 	@docker compose up
 
+.PHONY: coldstart
+coldstart:
+	-rm -rf vendor
+	-rm -rf bin/rr
+	@docker compose up
+
 .PHONY: install
 install:
 	@docker compose up -d

diff --git a/migrations/Version20240514101332.php b/migrations/Version20240514101332.php
@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DoctrineMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+/**
+ * Auto-generated Migration: Please modify to your needs!
+ */
+final class Version20240514101332 extends AbstractMigration
+{
+    public function getDescription(): string
+    {
+        return '';
+    }
+
+    public function up(Schema $schema): void
+    {
+        // this up() migration is auto-generated, please modify it to your needs
+        $this->addSql('ALTER TABLE airport ADD rank DOUBLE PRECISION NOT NULL');
+    }
+
+    public function down(Schema $schema): void
+    {
+        // this down() migration is auto-generated, please modify it to your needs
+        $this->addSql('ALTER TABLE airport DROP rank');
+    }
+}
diff --git a/src/Airport/Action/Create/CreateAirportAction.php b/src/Airport/Action/Create/CreateAirportAction.php
@@ -59,6 +59,7 @@ public function run(CreateAirportActionRequest $request): CreateAirportActionRes
         $airport = $this->airportFactory
             ->setIata($request->iata)
             ->setIcao($request->icao)
+            ->setRank($request->rank)
             ->setTitle($request->title)
             ->setLatitude($request->latitude)
             ->setLongitude($request->longitude)

diff --git a/src/Airport/Action/Create/CreateAirportActionRequest.php b/src/Airport/Action/Create/CreateAirportActionRequest.php
@@ -35,4 +35,6 @@ class CreateAirportActionRequest
     #[NotBlank]
     #[Length(max: 150)]
     public string $timezone;
+
+    public float $rank = 0.0;
 }
diff --git a/src/Airport/Action/Query/QueryAirportsAction.php b/src/Airport/Action/Query/QueryAirportsAction.php
@@ -16,10 +16,6 @@ public function __construct(
     ) {
     }
 
-    /**
-     * @throws TimezoneNotFoundException
-     * @throws CityNotFoundException
-     */
     public function run(QueryAirportsActionRequest $request): QueryAirportsActionResponse
     {
         /** @var array<Airport> $airports */
@@ -36,48 +32,45 @@ public function run(QueryAirportsActionRequest $request): QueryAirportsActionRes
         foreach ($airports as $airport) {
             $city = $airport->getCity();
             $country = $city->getCountry();
-            $map[$country->getTitle()][$city->getTitle()][] = $airport;
+            $cityIata = $city->getIata() ?? $airport->getIata();
+
+            if (!isset($map[$country->getTitle()])) {
+                $map[$country->getTitle()] = [];
+            }
+            if (!isset($map[$country->getTitle()][$cityIata])) {
+                $map[$country->getTitle()][$cityIata] = [];
+            }
+
+            $map[$country->getTitle()][$cityIata][] = $airport;
         }
 
-        foreach ($map as $country => $cities) {
-            foreach ($cities as $city => $airports) {
+        foreach ($map as $countryTitle => $cities) {
+            foreach ($cities as $cityIata => $airports) {
                 $isGroup = count($airports) > 1;
-                $airport = $airports[0];
 
                 if ($isGroup) {
-                    $ap = $airports[0];
-
-                    foreach ($airports as $a) {
-                        $cityEntity = $a->getCity();
-                        $countryEntity = $cityEntity->getCountry();
-
-                        if ($cityEntity === $countryEntity->getCapital()) {
-                            $ap = $a;
-                            break;
-                        }
-                    }
-
+                    $cityTitle = $airports[0]->getCity()->getTitle();
                     $res[] = new QueryChildrenAirportResponse(
-                        $city . ' (Any)',
-                        $ap->getCity()->getIata() ?? $ap->getIata(),
-                        $country,
+                        $cityTitle . ' (Any)',
+                        $cityIata,
+                        $countryTitle
                     );
-                }
 
-                foreach ($airports as $airport) {
-                    if (!$isGroup) {
-                        $res[] = new QueryAirportResponse(
+                    $parentIndex = count($res) - 1;
+
+                    foreach ($airports as $airport) {
+                        $res[$parentIndex]->children[] = new QueryAirportResponse(
                             $airport->getTitle(),
                             $airport->getIata(),
-                            $country,
+                            $countryTitle
                         );
-                        continue;
                     }
-
-                    $res[count($res) - 1]->children[] = new QueryAirportResponse(
+                } else {
+                    $airport = $airports[0];
+                    $res[] = new QueryAirportResponse(
                         $airport->getTitle(),
                         $airport->getIata(),
-                        $country,
+                        $countryTitle
                     );
                 }
             }

diff --git a/src/Airport/Action/Update/UpdateAirportAction.php b/src/Airport/Action/Update/UpdateAirportAction.php
@@ -72,6 +72,10 @@ public function run(UpdateAirportActionRequest $request, UuidInterface $id): Upd
             $this->airportFactory->setTimezone($timezone);
         }
 
+        if ($request->rank) {
+            $this->airportFactory->setRank($request->rank);
+        }
+
         if ($request->icao) {
             $this->airportFactory->setIcao($request->icao);
         }

diff --git a/src/Airport/Action/Update/UpdateAirportActionRequest.php b/src/Airport/Action/Update/UpdateAirportActionRequest.php
@@ -30,4 +30,6 @@ class UpdateAirportActionRequest
     public ?string $timezone = null;
 
     public ?bool $isActive = null;
+
+    public ?float $rank = null;
 }
diff --git a/src/Airport/Command/Import/ImportAirports2FromJsonCommand.php b/src/Airport/Command/Import/ImportAirports2FromJsonCommand.php
@@ -72,6 +72,9 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                     $exists = $this->airportRepository->findByIata($airport->Iata);
 
                     if ($exists) {
+                        $exists->setRank($airport->Rank ?? 0.0);
+                        $this->airportRepository->save($exists, true);
+
                         continue;
                     }
 
@@ -149,17 +152,14 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                         ->setTitle($airport->Name)
                         ->setIcao($airport->Icao ?? null)
                         ->setIata($airport->Iata)
+                        ->setRank($airport->Rank ?? 0.0)
                         ->setLongitude((float)$airport->Longitude)
                         ->setLatitude((float)$airport->Latitude)
                         ->setAltitude((int)$airport->Elevation)
                         ->create();
 
-                    try {
-                        $this->airportRepository->save($newAirport, true);
-                        $imported++;
-                    } catch (Throwable $e) {
-                        dd($e->getMessage(), $airport);
-                    }
+                    $this->airportRepository->save($newAirport, true);
+                    $imported++;
 
                     if ($imported % 2000 === 0) {
                         $this->em->clear();

diff --git a/src/Airport/Controller/Admin/AirportCrudController.php b/src/Airport/Controller/Admin/AirportCrudController.php
@@ -53,9 +53,10 @@ public function configureFields(string $pageName): iterable
 
             FormField::addFieldset('Basic'),
             TextField::new('title')->setColumns(4),
-            TextField::new('iata')->setColumns(4),
-            TextField::new('icao')->setColumns(4),
-            BooleanField::new('isActive')->setColumns(4),
+            TextField::new('iata')->setColumns(2),
+            TextField::new('icao')->setColumns(2),
+            NumberField::new('rank')->setColumns(1),
+            BooleanField::new('isActive'),
 
             FormField::addFieldset('Position'),
             NumberField::new('longitude')->hideOnIndex()->setColumns(2),

diff --git a/src/Airport/Controller/Response/AirportResponse.php b/src/Airport/Controller/Response/AirportResponse.php
@@ -17,6 +17,7 @@ class AirportResponse
     public string $title;
     public string $iata;
     public string $icao;
+    public float $rank;
     public bool $isActive;
     public float $longitude;
     public float $latitude;
@@ -30,6 +31,7 @@ public function __construct(Airport $airport, bool $withRelations = true)
         $this->title = $airport->getTitle();
         $this->iata = $airport->getIata();
         $this->icao = $airport->getIcao();
+        $this->rank = $airport->getRank();
         $this->isActive = $airport->isActive();
         $this->longitude = $airport->getLongitude();
         $this->altitude = $airport->getAltitude();

diff --git a/src/Airport/Entity/Airport.php b/src/Airport/Entity/Airport.php
@@ -46,6 +46,9 @@ class Airport
     #[ORM\Column(length: 150, unique: false, nullable: false)]
     private string $title;
 
+    #[ORM\Column(nullable: false)]
+    private float $rank = 0;
+
     #[ORM\Column(options: ['default' => true])]
     private bool $isActive = true;
 
@@ -61,6 +64,18 @@ public function __toString(): string
         return $this->title;
     }
 
+    public function setRank(float $rank = 0.0): self
+    {
+        $this->rank = $rank;
+
+        return $this;
+    }
+
+    public function getRank(): float
+    {
+        return $this->rank;
+    }
+
     public function isActive(): bool
     {
         return $this->isActive;

diff --git a/src/Airport/Factory/AirportFactory.php b/src/Airport/Factory/AirportFactory.php
@@ -40,6 +40,12 @@ public function setIcao(?string $icao = null): AirportFactoryInterface
         return $this;
     }
 
+    public function setRank(float $rank = 0.0): AirportFactoryInterface
+    {
+        $this->airport->setRank($rank);
+        return $this;
+    }
+
     public function setIata(string $iata): AirportFactoryInterface
     {
         $this->airport->setIata($iata);

diff --git a/src/Airport/Factory/AirportFactoryInterface.php b/src/Airport/Factory/AirportFactoryInterface.php
@@ -16,6 +16,8 @@ public function setAirport(Airport $airport): self;
 
     public function setTitle(string $title): self;
 
+    public function setRank(float $rank = 0.0): self;
+
     public function setIcao(?string $icao = null): self;
 
     public function setIata(string $iata): self;

diff --git a/src/Airport/Repository/AirportRepository.php b/src/Airport/Repository/AirportRepository.php
@@ -110,19 +110,22 @@ public function query(int $offset, int $limit, string $query): iterable
     {
         $params = new ArrayCollection();
         $params->add(new Parameter('query', "$query%"));
+        $params->add(new Parameter('exactQuery', $query));
         $params->add(new Parameter('isActive', true));
 
         return $this->createQueryBuilder('a')
             ->setFirstResult($offset)
             ->setMaxResults($limit)
             ->join('a.city', 'c')
             ->join('c.country', 'co')
-            ->where('a.title LIKE :query')
-            ->orWhere('a.iata LIKE :query')
-            ->orWhere('a.icao LIKE :query')
+            ->where('a.iata LIKE :query')
+            ->orWhere('a.title LIKE :query')
             ->orWhere('c.title LIKE :query')
             ->orWhere('co.title LIKE :query')
             ->andWhere('a.isActive = :isActive')
+            ->orderBy('CASE WHEN a.iata = :exactQuery THEN 0 ELSE 1 END', 'ASC')
+            ->addOrderBy('a.rank', 'DESC')
+            ->addOrderBy('a.title', 'ASC')
             ->setParameters($params)
             ->getQuery()
             ->getResult();

diff --git a/tests/Application/Airport/Api/V1/AirportControllerE2ETest.php b/tests/Application/Airport/Api/V1/AirportControllerE2ETest.php
@@ -43,6 +43,7 @@ public function testCreateActionSuccess(): void
             'longitude' => 11,
             'latitude' => 22,
             'altitude' => 10,
+            'rank' => 0.11,
         ];
 
         $this->client->request(
@@ -56,6 +57,7 @@ public function testCreateActionSuccess(): void
         self::assertResponseIsSuccessful();
         self::assertResponseStatusCodeSame(Response::HTTP_OK);
         self::assertEquals($content['title'], $response['title']);
+        self::assertEquals($content['rank'], $response['rank']);
     }
 
     public function testQueryActionSuccess(): void

diff --git a/tests/Unit/Airport/Action/Create/CreateAirportActionTest.php b/tests/Unit/Airport/Action/Create/CreateAirportActionTest.php
@@ -38,6 +38,7 @@ class CreateAirportActionTest extends TestCase
     private string $icao = 'TEST';
     private string $title = 'Test Airport';
     private string $cityTitle = CityDummy::TITLE;
+    private float $rank = 0.25;
     private float $longitude = 11.11;
     private float $latitude = 22.22;
     private int $altitude = 33;
@@ -54,6 +55,7 @@ protected function setUp(): void
         $this->request = new CreateAirportActionRequest();
         $this->request->countryIso2 = $this->countryIso2;;
         $this->request->timezone = $this->timezone;
+        $this->request->rank = $this->rank;
         $this->request->iata = $this->iata;
         $this->request->icao = $this->icao;
         $this->request->title = $this->title;
@@ -245,6 +247,7 @@ public function testShouldReturnAValidResponse(): void
         $this->factory->expects($this->once())->method('setTimezone')->with($timezone)->willReturn($this->factory);
         $this->factory->expects($this->once())->method('setIata')->with($this->iata)->willReturn($this->factory);
         $this->factory->expects($this->once())->method('setIcao')->with($this->icao)->willReturn($this->factory);
+        $this->factory->expects($this->once())->method('setRank')->with($this->rank)->willReturn($this->factory);
         $this->factory->expects($this->once())->method('create')->with()->willReturn($airport);
 
         $this->airportRepository
@@ -265,6 +268,7 @@ public function testShouldReturnAValidResponse(): void
         $this->assertEquals($airport->getTitle(), $actual->airport->title);
         $this->assertEquals($airport->getIata(), $actual->airport->iata);
         $this->assertEquals($airport->getIcao(), $actual->airport->icao);
+        $this->assertEquals($airport->getRank(), $actual->airport->rank);
         $this->assertEquals($airport->getLatitude(), $actual->airport->latitude);
         $this->assertEquals($airport->getAltitude(), $actual->airport->altitude);
         $this->assertEquals($airport->getLongitude(), $actual->airport->longitude);