Skip to content

Commit

Permalink
style: Upgrade to use latest PHP CS Fixer config and fix code style i…
Browse files Browse the repository at this point in the history
…ssues

Signed-off-by: Sacha Telgenhof <[email protected]>
  • Loading branch information
stelgenhof committed Jan 31, 2024
1 parent e4a4a83 commit f309783
Show file tree
Hide file tree
Showing 8 changed files with 144 additions and 11 deletions.
126 changes: 126 additions & 0 deletions phpinsights.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
<?php

declare(strict_types = 1);

/**
* This file is part of the 'azuyalabs/waqi' package.
*
* Simple PHP Wrapper for the World Air Quality Index API.
*
* Copyright (c) 2017 - 2024 AzuyaLabs
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*
* @author Sacha Telgenhof <me at sachatelgenhof dot com>
*/

return [
/*
|--------------------------------------------------------------------------
| Default Preset
|--------------------------------------------------------------------------
|
| This option controls the default preset that will be used by PHP Insights
| to make your code reliable, simple, and clean. However, you can always
| adjust the `Metrics` and `Insights` below in this configuration file.
|
| Supported: "default", "laravel", "symfony", "magento2", "drupal"
|
*/

'preset' => 'symfony',

/*
|--------------------------------------------------------------------------
| IDE
|--------------------------------------------------------------------------
|
| This options allow to add hyperlinks in your terminal to quickly open
| files in your favorite IDE while browsing your PhpInsights report.
|
| Supported: "textmate", "macvim", "emacs", "sublime", "phpstorm",
| "atom", "vscode".
|
| If you have another IDE that is not in this list but which provide an
| url-handler, you could fill this config with a pattern like this:
|
| myide://open?url=file://%f&line=%l
|
*/

'ide' => null,

/*
|--------------------------------------------------------------------------
| Configuration
|--------------------------------------------------------------------------
|
| Here you may adjust all the various `Insights` that will be used by PHP
| Insights. You can either add, remove or configure `Insights`. Keep in
| mind, that all added `Insights` must belong to a specific `Metric`.
|
*/

'exclude' => [
// 'path/to/directory-or-file'
],

'add' => [
/* \SlevomatCodingStandard\Sniffs\Namespaces\FullyQualifiedClassNameInAnnotationSniff::class, */
/* \SlevomatCodingStandard\Sniffs\ControlStructures\RequireYodaComparisonSniff::class, */
// ExampleMetric::class => [
// ExampleInsight::class,
// ]
],

'remove' => [
SlevomatCodingStandard\Sniffs\ControlStructures\DisallowShortTernaryOperatorSniff::class,
SlevomatCodingStandard\Sniffs\ControlStructures\DisallowYodaComparisonSniff::class,
NunoMaduro\PhpInsights\Domain\Sniffs\ForbiddenSetterSniff::class,
// ExampleInsight::class,
],

'config' => [
PHP_CodeSniffer\Standards\Generic\Sniffs\Files\LineLengthSniff::class => [
'lineLimit' => 120,
'absoluteLineLimit' => 140,
'ignoreComments' => false,
],
// ExampleInsight::class => [
// 'key' => 'value',
// ],
],

/*
|--------------------------------------------------------------------------
| Requirements
|--------------------------------------------------------------------------
|
| Here you may define a level you want to reach per `Insights` category.
| When a score is lower than the minimum level defined, then an error
| code will be returned. This is optional and individually defined.
|
*/

'requirements' => [
'min-quality' => 90,
'min-complexity' => 90,
'min-architecture' => 90,
'min-style' => 90,
'disable-security-check' => false,
],

/*
|--------------------------------------------------------------------------
| Threads
|--------------------------------------------------------------------------
|
| Here you may adjust how many threads (core) PHPInsights can use to perform
| the analyse. This is optional, don't provide it and the tool will guess
| the max core number available. It accepts null value or integer > 0.
|
*/

'threads' => null,
];
3 changes: 2 additions & 1 deletion rector.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@

/**
* This file is part of the 'azuyalabs/waqi' package.
* A Simple PHP Wrapper for the World Air Quality Index API.
*
* Simple PHP Wrapper for the World Air Quality Index API.
*
* Copyright (c) 2017 - 2024 AzuyaLabs
*
Expand Down
5 changes: 3 additions & 2 deletions src/AirQuality.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@

/**
* This file is part of the 'azuyalabs/waqi' package.
* A Simple PHP Wrapper for the World Air Quality Index API.
*
* Simple PHP Wrapper for the World Air Quality Index API.
*
* Copyright (c) 2017 - 2024 AzuyaLabs
*
Expand Down Expand Up @@ -70,7 +71,7 @@ public function getAQI(): array;
*
* @throws \Exception
*/
public function getMeasurementTime(): \DateTime;
public function getMeasurementTime(): \DateTimeImmutable;

Check failure on line 74 in src/AirQuality.php

View workflow job for this annotation

GitHub Actions / CI (ubuntu-latest, 8.2)

PHPDoc tag @return with type DateTime is incompatible with native type DateTimeImmutable.

Check failure on line 74 in src/AirQuality.php

View workflow job for this annotation

GitHub Actions / CI (ubuntu-latest, 8.3)

PHPDoc tag @return with type DateTime is incompatible with native type DateTimeImmutable.

Check failure on line 74 in src/AirQuality.php

View workflow job for this annotation

GitHub Actions / CI (windows-latest, 8.2)

PHPDoc tag @return with type DateTime is incompatible with native type DateTimeImmutable.

Check failure on line 74 in src/AirQuality.php

View workflow job for this annotation

GitHub Actions / CI (windows-latest, 8.3)

PHPDoc tag @return with type DateTime is incompatible with native type DateTimeImmutable.

Check failure on line 74 in src/AirQuality.php

View workflow job for this annotation

GitHub Actions / CI (macOS-latest, 8.2)

PHPDoc tag @return with type DateTime is incompatible with native type DateTimeImmutable.

Check failure on line 74 in src/AirQuality.php

View workflow job for this annotation

GitHub Actions / CI (macOS-latest, 8.3)

PHPDoc tag @return with type DateTime is incompatible with native type DateTimeImmutable.

/**
* Returns information about this monitoring station.
Expand Down
3 changes: 2 additions & 1 deletion src/Exceptions/InvalidAccessToken.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@

/**
* This file is part of the 'azuyalabs/waqi' package.
* A Simple PHP Wrapper for the World Air Quality Index API.
*
* Simple PHP Wrapper for the World Air Quality Index API.
*
* Copyright (c) 2017 - 2024 AzuyaLabs
*
Expand Down
3 changes: 2 additions & 1 deletion src/Exceptions/QuotaExceeded.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@

/**
* This file is part of the 'azuyalabs/waqi' package.
* A Simple PHP Wrapper for the World Air Quality Index API.
*
* Simple PHP Wrapper for the World Air Quality Index API.
*
* Copyright (c) 2017 - 2024 AzuyaLabs
*
Expand Down
3 changes: 2 additions & 1 deletion src/Exceptions/UnknownStation.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@

/**
* This file is part of the 'azuyalabs/waqi' package.
* A Simple PHP Wrapper for the World Air Quality Index API.
*
* Simple PHP Wrapper for the World Air Quality Index API.
*
* Copyright (c) 2017 - 2024 AzuyaLabs
*
Expand Down
7 changes: 4 additions & 3 deletions src/WAQI.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@

/**
* This file is part of the 'azuyalabs/waqi' package.
* A Simple PHP Wrapper for the World Air Quality Index API.
*
* Simple PHP Wrapper for the World Air Quality Index API.
*
* Copyright (c) 2017 - 2024 AzuyaLabs
*
Expand Down Expand Up @@ -164,9 +165,9 @@ public function getAQI(): array
*
* @throws \Exception
*/
public function getMeasurementTime(): \DateTime
public function getMeasurementTime(): \DateTimeImmutable

Check failure on line 168 in src/WAQI.php

View workflow job for this annotation

GitHub Actions / CI (ubuntu-latest, 8.2)

PHPDoc tag @return with type DateTime is incompatible with native type DateTimeImmutable.

Check failure on line 168 in src/WAQI.php

View workflow job for this annotation

GitHub Actions / CI (ubuntu-latest, 8.3)

PHPDoc tag @return with type DateTime is incompatible with native type DateTimeImmutable.

Check failure on line 168 in src/WAQI.php

View workflow job for this annotation

GitHub Actions / CI (windows-latest, 8.2)

PHPDoc tag @return with type DateTime is incompatible with native type DateTimeImmutable.

Check failure on line 168 in src/WAQI.php

View workflow job for this annotation

GitHub Actions / CI (windows-latest, 8.3)

PHPDoc tag @return with type DateTime is incompatible with native type DateTimeImmutable.

Check failure on line 168 in src/WAQI.php

View workflow job for this annotation

GitHub Actions / CI (macOS-latest, 8.2)

PHPDoc tag @return with type DateTime is incompatible with native type DateTimeImmutable.

Check failure on line 168 in src/WAQI.php

View workflow job for this annotation

GitHub Actions / CI (macOS-latest, 8.3)

PHPDoc tag @return with type DateTime is incompatible with native type DateTimeImmutable.
{
return new \DateTime($this->raw_data->time->s, new \DateTimeZone($this->raw_data->time->tz));
return new \DateTimeImmutable($this->raw_data->time->s, new \DateTimeZone($this->raw_data->time->tz));
}

/**
Expand Down
5 changes: 3 additions & 2 deletions tests/WAQITest.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@

/**
* This file is part of the 'azuyalabs/waqi' package.
* A Simple PHP Wrapper for the World Air Quality Index API.
*
* Simple PHP Wrapper for the World Air Quality Index API.
*
* Copyright (c) 2017 - 2024 AzuyaLabs
*
Expand Down Expand Up @@ -245,7 +246,7 @@ public function should_get_null_if_no_s_o2(): void
*/
public function should_get_measurement_time(): void
{
$expectedValue = $this->faker->dateTime();
$expectedValue = \DateTimeImmutable::createFromMutable($this->faker->dateTime());

$this->waqi->shouldReceive('getMeasurementTime')
->once()
Expand Down

0 comments on commit f309783

Please sign in to comment.