Support Laravel 9

CHANGELOG.md

@@ -1,14 +1,16 @@
 # CHANGELOG
 
-## [v0.9.2 (Unreleased)](https://github.com/onlime/laravel-sql-reporter/compare/v0.9.1...main)
+## [1.0.x (Unreleased)](https://github.com/onlime/laravel-sql-reporter/compare/v1.0.0...main)
 
-## [v0.9.1 (2021-06-03)](https://github.com/onlime/laravel-sql-reporter/releases/tag/v0.9.1)
+## [v1.0.0 (2022-02-10)](https://github.com/onlime/laravel-sql-reporter/releases/tag/compare/v0.9.1...v1.0.0)
+
+- Support Laravel 9
+- Added some function return types and cleaned up phpdoc comments.
+
+## [v0.9.1 (2021-06-03)](https://github.com/onlime/laravel-sql-reporter/releases/tag/compare/v0.9...v0.9.1)
 
-### Added
 - Added new config param `queries.exclude_pattern` (env var `SQL_REPORTER_QUERIES_EXCLUDE_PATTERN`) to narrow down queries to be logged without bloating include pattern regex.
 - Added unit tests for `Writer`, testing query include/exclude patterns and min exec time.
-
-### Changed
 - Renamed `SQL_REPORTER_QUERIES_PATTERN` env var to `SQL_REPORTER_QUERIES_INCLUDE_PATTERN`
 - Renamed methods in `Writer` for clarity.
 - Improved testability of `Writer::writeQuery()` by returning true if query was written to log.

composer.json

@@ -15,15 +15,15 @@
     ],
     "require": {
         "php": "^8.0",
-        "illuminate/support": "8.*",
-        "nesbot/carbon": "^2.0",
-        "illuminate/filesystem": "8.*",
-        "illuminate/container": "8.*"
+        "illuminate/support": "^8.0|^9.0",
+        "illuminate/filesystem": "^8.0|^9.0",
+        "illuminate/container": "^8.0|^9.0",
+        "nesbot/carbon": "^2.0"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.5",
         "mockery/mockery": "^1.0",
-        "laravel/framework": "8.*"
+        "laravel/framework": "^8.0|^9.0"
     },
     "autoload": {
         "psr-4": {

src/Concerns/ReplacesBindings.php

@@ -14,7 +14,7 @@ trait ReplacesBindings
      *
      * @return string
      */
-    protected function replaceBindings($sql, array $bindings)
+    protected function replaceBindings(string $sql, array $bindings): string
     {
         $generalRegex = $this->getRegex();
 
@@ -53,7 +53,7 @@ protected function value($value)
      *
      * @return string
      */
-    protected function getNamedParameterRegex($name)
+    protected function getNamedParameterRegex($name): string
     {
         if (mb_substr($name, 0, 1) == ':') {
             $name = mb_substr($name, 1);

src/Config.php

@@ -8,15 +8,13 @@ class Config
 {
     /**
      * Config constructor.
-     *
-     * @param ConfigRepository $repository
      */
-    public function __construct(protected ConfigRepository $repository) {}
+    public function __construct(
+        protected ConfigRepository $repository
+    ) {}
 
     /**
      * Get directory where log files should be saved.
-     *
-     * @return string
      */
     public function logDirectory(): string
     {
@@ -25,28 +23,22 @@ public function logDirectory(): string
 
     /**
      * Whether query execution time should be converted to seconds.
-     *
-     * @return bool
      */
     public function useSeconds(): bool
     {
-        return (bool) $this->repository->get('sql-reporter.general.use_seconds');
+        return (bool)$this->repository->get('sql-reporter.general.use_seconds');
     }
 
     /**
      * Get suffix for console logs.
-     *
-     * @return string
      */
     public function consoleSuffix(): string
     {
-        return (string) $this->repository->get('sql-reporter.general.console_log_suffix');
+        return (string)$this->repository->get('sql-reporter.general.console_log_suffix');
     }
 
     /**
      * Get file extension for logs.
-     *
-     * @return string
      */
     public function fileExtension(): string
     {
@@ -55,18 +47,14 @@ public function fileExtension(): string
 
     /**
      * Whether all queries should be logged.
-     *
-     * @return bool
      */
     public function queriesEnabled(): bool
     {
-        return (bool) $this->repository->get('sql-reporter.queries.enabled');
+        return (bool)$this->repository->get('sql-reporter.queries.enabled');
     }
 
     /**
      * Minimum execution time (in milliseconds) for queries to be logged.
-     *
-     * @return float
      */
     public function queriesMinExecTime(): float
     {
@@ -75,18 +63,14 @@ public function queriesMinExecTime(): float
 
     /**
      * Whether SQL log should be overridden for each request.
-     *
-     * @return bool
      */
     public function queriesOverrideLog(): bool
     {
-        return (bool) $this->repository->get('sql-reporter.queries.override_log');
+        return (bool)$this->repository->get('sql-reporter.queries.override_log');
     }
 
     /**
      * Get include pattern for queries.
-     *
-     * @return string
      */
     public function queriesIncludePattern(): string
     {
@@ -95,8 +79,6 @@ public function queriesIncludePattern(): string
 
     /**
      * Get exclude pattern for queries.
-     *
-     * @return string
      */
     public function queriesExcludePattern(): string
     {
@@ -105,8 +87,6 @@ public function queriesExcludePattern(): string
 
     /**
      * Get file name (without extension) for all queries.
-     *
-     * @return string
      */
     public function queriesFileName(): string
     {
@@ -115,8 +95,6 @@ public function queriesFileName(): string
 
     /**
      * Get header fields that should be printed in header before query loglines.
-     *
-     * @return array
      */
     public function headerFields(): array
     {
@@ -125,8 +103,6 @@ public function headerFields(): array
 
     /**
      * Get query format that should be used to save query.
-     *
-     * @return string
      */
     public function entryFormat(): string
     {

src/FileName.php

@@ -21,7 +21,7 @@ public function __construct(
     /**
      * Create file name for query log.
      */
-    public function getLogfile()
+    public function getLogfile(): string
     {
         return
             $this->parseFileName($this->config->queriesFileName()) .
@@ -31,22 +31,16 @@ public function getLogfile()
 
     /**
      * Get file suffix.
-     *
-     * @return string
      */
-    protected function suffix()
+    protected function suffix(): string
     {
         return $this->app->runningInConsole() ? $this->config->consoleSuffix() : '';
     }
 
     /**
      * Parse file name to include date in it.
-     *
-     * @param string $fileName
-     *
-     * @return string
      */
-    protected function parseFileName($fileName)
+    protected function parseFileName(string $fileName): string
     {
         return preg_replace_callback('#(\[.*\])#U', function ($matches) {
             $format = str_replace(['[',']'], [], $matches[1]);

src/Formatter.php

@@ -5,7 +5,6 @@
 use Carbon\Carbon;
 use Illuminate\Container\Container;
 use Illuminate\Support\Arr;
-use Illuminate\Support\Facades\App;
 use Illuminate\Support\Facades\Auth;
 use Illuminate\Support\Facades\DB;
 use Illuminate\Support\Facades\Request;
@@ -29,11 +28,8 @@ public function __construct(
 
     /**
      * Get formatted single query line(s).
-     *
-     * @param SqlQuery $query
-     * @return string
      */
-    public function getLine(SqlQuery $query)
+    public function getLine(SqlQuery $query): string
     {
         $replace = [
             '[query_nr]'   => $query->number(),
@@ -48,10 +44,8 @@ public function getLine(SqlQuery $query)
 
     /**
      * Get formatted header lines.
-     *
-     * @return string
      */
-    public function getHeader()
+    public function getHeader(): string
     {
         $headerFields = $this->config->headerFields();
         if (empty($headerFields)) {
@@ -97,21 +91,16 @@ public function getHeader()
 
     /**
      * Format time.
-     *
-     * @param float $time
-     * @return string
      */
-    protected function time($time)
+    protected function time(float $time): string
     {
         return $this->config->useSeconds() ? ($time / 1000.0) . 's' : $time . 'ms';
     }
 
     /**
      * Get origin line.
-     *
-     * @return string
      */
-    protected function originLine()
+    protected function originLine(): string
     {
         return $this->app->runningInConsole()
                 ? '(console) ' . $this->getArtisanLine()
@@ -120,21 +109,16 @@ protected function originLine()
 
     /**
      * Get query line.
-     *
-     * @param SqlQuery $query
-     * @return string
      */
-    protected function getQueryLine(SqlQuery $query)
+    protected function getQueryLine(SqlQuery $query): string
     {
         return $query->get() . ';';
     }
 
     /**
      * Get Artisan line.
-     *
-     * @return string
      */
-    protected function getArtisanLine()
+    protected function getArtisanLine(): string
     {
         $command = $this->app['request']->server('argv', []);
 
@@ -147,20 +131,16 @@ protected function getArtisanLine()
 
     /**
      * Get request line.
-     *
-     * @return string
      */
-    protected function getRequestLine()
+    protected function getRequestLine(): string
     {
         return $this->app['request']->method() . ' ' . $this->app['request']->fullUrl();
     }
 
     /**
      * Get separator line.
-     *
-     * @return string
      */
-    protected function separatorLine()
+    protected function separatorLine(): string
     {
         return '-- ' . str_repeat('-', 50);
     }

src/Listeners/SqlQueryLogSubscriber.php

@@ -3,6 +3,7 @@
 namespace Onlime\LaravelSqlReporter\Listeners;
 
 use Illuminate\Console\Events\CommandFinished;
+use Illuminate\Events\Dispatcher;
 use Illuminate\Foundation\Http\Events\RequestHandled;
 use Onlime\LaravelSqlReporter\SqlLogger;
 
@@ -20,10 +21,10 @@ public function __construct(
     /**
      * Register the listeners for the subscriber.
      *
-     * @param \Illuminate\Events\Dispatcher $events
+     * @param Dispatcher $events
      * @return void
      */
-    public function subscribe($events)
+    public function subscribe(Dispatcher $events)
     {
         $events->listen(
             [
@@ -36,9 +37,6 @@ public function subscribe($events)
 
     /**
      * Handle the event.
-     *
-     * @param  object  $event
-     * @return void
      */
     public function handle($event)
     {

src/Providers/EventServiceProvider.php

@@ -54,10 +54,8 @@ public function boot()
 
     /**
      * Get package config file location.
-     *
-     * @return bool|string
      */
-    protected function configFileLocation()
+    protected function configFileLocation(): string
     {
         return realpath(__DIR__ . '/../../config/sql-reporter.php');
     }

src/SqlLogger.php

@@ -8,8 +8,6 @@ class SqlLogger
 {
     /**
      * Number of executed queries.
-     *
-     * @var int
      */
     private int $queryNumber = 0;