Merge pull request #21 from nspalo/development

BWA-Dev-7-Weather-App-Code-Quality

src/.env.example

@@ -1,4 +1,4 @@
-APP_NAME=Laravel
+APP_NAME='Weather App'
 APP_ENV=local
 APP_KEY=
 APP_DEBUG=true
@@ -56,3 +56,18 @@ VITE_PUSHER_HOST="${PUSHER_HOST}"
 VITE_PUSHER_PORT="${PUSHER_PORT}"
 VITE_PUSHER_SCHEME="${PUSHER_SCHEME}"
 VITE_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"
+
+# OPEN WEATHER API
+OPEN_WEATHER_API_URI=api.openweathermap.org/data/2.5
+OPEN_WEATHER_API_KEY=
+OPEN_WEATHER_UNIT=metric
+OPEN_WEATHER_MAX_OUTPUT=5
+
+# GEOAPIFY API
+GEOAPIFY_API_URI=api.geoapify.com/v1/geocode/search
+GEOAPIFY_API_KEY=
+GEOAPIFY_FILTER=countrycode:jp
+GEOAPIFY_FORMAT=json
+GEOAPIFY_LANG=en
+GEOAPIFY_MAX_OUTPUT=1
+GEOAPIFY_TYPE=city

src/app/Console/Kernel.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Console;
 
 use Illuminate\Console\Scheduling\Schedule;
@@ -25,7 +27,7 @@ protected function schedule(Schedule $schedule)
      */
     protected function commands()
     {
-        $this->load(__DIR__.'/Commands');
+        $this->load(__DIR__ . '/Commands');
 
         require base_path('routes/console.php');
     }

src/app/Enums/Direction.php

@@ -1,31 +1,34 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Enums;
 
 enum Direction: string
 {
-    case North = "N";
-    case NorthEast = "NE";
-    case East = "E";
-    case SouthEast = "SE";
-    case South = "S";
-    case SouthWest = "SW";
-    case West = "W";
-    case NorthSouth = "NW";
+    case North = 'N';
+    case NorthEast = 'NE';
+    case East = 'E';
+    case SouthEast = 'SE';
+    case South = 'S';
+    case SouthWest = 'SW';
+    case West = 'W';
+    case NorthSouth = 'NW';
 
     /**
-     * Convert Degrees to Direction using 8 Wind Compass Implementation
+     * Convert Degrees to Direction using 8 Point Compass Implementation
      * - Cardinal Directions: N, E, S, W
      * - Ordinal Directions: NE, SE, SW, NW
      */
     public static function convertFromDegrees(int $degrees = 0): string
     {
-        if($degrees < 0) {
-            $degrees *= -1; // Handle negative input value
+        if ($degrees < 0) {
+            // Handle negative input value
+            $degrees *= -1;
         }
 
-        $direction = floor(($degrees/45)) % 8;
+        $index = \floor(($degrees / 45)) % 8;
 
-        return self::cases()[$direction]->value;
+        return self::cases()[$index]->value;
     }
 }

src/app/Exceptions/BaseException.php

@@ -9,15 +9,27 @@
 
 class BaseException extends Exception
 {
+    /**
+     * @var array|null
+     */
     private ?array $errors;
 
+    /**
+     * @param $message
+     * @param $code
+     * @param Throwable|null $previous
+     * @param array|null $errors
+     */
     public function __construct($message = '', $code = 0, ?Throwable $previous = null, ?array $errors = null)
     {
         parent::__construct($message, $code, $previous);
 
         $this->errors = $errors;
     }
 
+    /**
+     * @return array|null
+     */
     public function getErrors(): ?array
     {
         return $this->errors;

src/app/Exceptions/Handler.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Exceptions;
 
 use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;

src/app/Http/Controllers/API/WeatherApp/WeatherUpdateApiController.php

@@ -14,6 +14,7 @@
 class WeatherUpdateApiController extends Controller
 {
     protected GeoapifyApiServiceInterface $geoapifyGeocodingService;
+
     protected OpenWeatherApiServiceFactoryInterface $weatherApiServiceFactory;
 
     public function __construct(
@@ -30,10 +31,10 @@ public function __invoke(Request $request): JsonResource
 
         $responseGeolocation = $this->geoapifyGeocodingService->getGeolocation($location);
 
-        $responseCurrentWeather =  $this->weatherApiServiceFactory->make(WeatherTypeEnum::Current)
+        $responseCurrentWeather = $this->weatherApiServiceFactory->make(WeatherTypeEnum::Current)
             ->getWeatherData($responseGeolocation);
 
-        $responseForecastWeather =  $this->weatherApiServiceFactory->make(WeatherTypeEnum::Forecast)
+        $responseForecastWeather = $this->weatherApiServiceFactory->make(WeatherTypeEnum::Forecast)
             ->getWeatherData($responseGeolocation);
 
         $data = [

src/app/Http/Controllers/Controller.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Http\Controllers;
 
 use Illuminate\Foundation\Auth\Access\AuthorizesRequests;

src/app/Http/Controllers/WeatherApp/WeatherUpdateController.php

@@ -9,11 +9,11 @@
 use App\Services\GeoapifyApi\Interfaces\GeoapifyApiServiceInterface;
 use App\Services\OpenWeatherApi\Interfaces\OpenWeatherApiServiceFactoryInterface;
 use Illuminate\Http\Request;
-use Illuminate\View\View;
 
 class WeatherUpdateController extends Controller
 {
     protected GeoapifyApiServiceInterface $geoapifyGeocodingService;
+
     protected OpenWeatherApiServiceFactoryInterface $weatherApiServiceFactory;
 
     public function __construct(
@@ -24,16 +24,20 @@ public function __construct(
         $this->weatherApiServiceFactory = $weatherApiServiceFactory;
     }
 
-    public function index(Request $request): View
+    /**
+     * @param Request $request
+     * @return \Illuminate\Contracts\Foundation\Application|\Illuminate\Contracts\View\Factory|\Illuminate\Contracts\View\View
+     */
+    public function index(Request $request)
     {
         $location = $request->get('location') ?? \config('services.api.geoapify.default_search');
 
         $responseGeolocation = $this->geoapifyGeocodingService->getGeolocation($location);
 
-        $responseCurrentWeather =  $this->weatherApiServiceFactory->make(WeatherTypeEnum::Current)
+        $responseCurrentWeather = $this->weatherApiServiceFactory->make(WeatherTypeEnum::Current)
             ->getWeatherData($responseGeolocation);
 
-        $responseForecastWeather =  $this->weatherApiServiceFactory->make(WeatherTypeEnum::Forecast)
+        $responseForecastWeather = $this->weatherApiServiceFactory->make(WeatherTypeEnum::Forecast)
             ->getWeatherData($responseGeolocation);
 
         $data = [

src/app/Http/Kernel.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Http;
 
 use Illuminate\Foundation\Http\Kernel as HttpKernel;

src/app/Http/Middleware/Authenticate.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Http\Middleware;
 
 use Illuminate\Auth\Middleware\Authenticate as Middleware;

src/app/Http/Middleware/EncryptCookies.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Http\Middleware;
 
 use Illuminate\Cookie\Middleware\EncryptCookies as Middleware;

src/app/Http/Middleware/PreventRequestsDuringMaintenance.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Http\Middleware;
 
 use Illuminate\Foundation\Http\Middleware\PreventRequestsDuringMaintenance as Middleware;

src/app/Http/Middleware/RedirectIfAuthenticated.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Http\Middleware;
 
 use App\Providers\RouteServiceProvider;

src/app/Http/Middleware/TrimStrings.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Http\Middleware;
 
 use Illuminate\Foundation\Http\Middleware\TrimStrings as Middleware;

src/app/Http/Middleware/TrustHosts.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Http\Middleware;
 
 use Illuminate\Http\Middleware\TrustHosts as Middleware;

src/app/Http/Middleware/TrustProxies.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Http\Middleware;
 
 use Illuminate\Http\Middleware\TrustProxies as Middleware;

src/app/Http/Middleware/ValidateSignature.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Http\Middleware;
 
 use Illuminate\Routing\Middleware\ValidateSignature as Middleware;

src/app/Http/Middleware/VerifyCsrfToken.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Http\Middleware;
 
 use Illuminate\Foundation\Http\Middleware\VerifyCsrfToken as Middleware;

src/app/Models/User.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Models;
 
 // use Illuminate\Contracts\Auth\MustVerifyEmail;

src/app/Providers/AppServiceProvider.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Providers;
 
 use Illuminate\Support\ServiceProvider;

src/app/Providers/AuthServiceProvider.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Providers;
 
 // use Illuminate\Support\Facades\Gate;

src/app/Providers/BroadcastServiceProvider.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Providers;
 
 use Illuminate\Support\Facades\Broadcast;

src/app/Providers/EventServiceProvider.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Providers;
 
 use Illuminate\Auth\Events\Registered;

src/app/Providers/RouteServiceProvider.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Providers;
 
 use Illuminate\Cache\RateLimiting\Limit;

src/app/Providers/WeatherAppServiceProvider.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Providers;
 
 use App\Services\ConfigurationMapper\Interfaces\ServiceConfigurationMapperInterface;

src/app/Services/Collector/ServiceCollector.php

@@ -6,6 +6,11 @@
 
 class ServiceCollector
 {
+    /**
+     * @param iterable $objects
+     * @param string $class
+     * @return array
+     */
     public static function filterByClass(iterable $objects, string $class): array
     {
         $objects = $objects instanceof \Traversable ? \iterator_to_array($objects) : (array) $objects;

src/app/Services/ConfigurationMapper/Interfaces/ServiceConfigurationMapperInterface.php

@@ -6,7 +6,21 @@
 
 interface ServiceConfigurationMapperInterface
 {
+    /**
+     * @param string|null $config
+     * @return void
+     */
     public function loadConfig(?string $config = null): void;
+
+    /**
+     * @param array $keyMapping
+     * @return array
+     */
     public function map(array $keyMapping): array;
+
+    /**
+     * @param string $key
+     * @return string|null
+     */
     public function getByKey(string $key): ?string;
 }