Skip to content

Commit 0c20cd7

Browse files
spawniaspawnia
authored
Introduce PHPStan (#12)
1 parent 7ab997c commit 0c20cd7

10 files changed

+194
-36
lines changed

‎.gitattributes

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
* text=auto
2+
3+
/.github export-ignore
4+
/.gitattributes export-ignore
5+
/.gitignore export-ignore
6+
/.php-cs-fixer.php export-ignore
7+
/CHANGELOG.md export-ignore
8+
/Makefile export-ignore
9+
/phpstan.neon export-ignore

‎.github/workflows/format.yml

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
name: "Format"
2+
on:
3+
push:
4+
branches:
5+
- '*'
6+
7+
jobs:
8+
composer-normalize:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v3
12+
with:
13+
ref: ${{ github.head_ref }}
14+
15+
- uses: shivammathur/setup-php@v2
16+
with:
17+
coverage: none
18+
extensions: mbstring
19+
php-version: 8.1
20+
21+
- run: composer install --no-interaction --no-progress --no-suggest
22+
23+
- run: composer normalize
24+
25+
- uses: stefanzweifel/git-auto-commit-action@v4
26+
with:
27+
commit_message: Normalize composer.json
28+
29+
prettier:
30+
runs-on: ubuntu-latest
31+
steps:
32+
- uses: actions/checkout@v3
33+
with:
34+
ref: ${{ github.head_ref }}
35+
36+
- uses: creyD/[email protected]
37+
with:
38+
prettier_options: --write --tab-width=2 *.md
39+
branch: ${{ github.head_ref }}
40+
commit_message: Prettify
41+
env:
42+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
43+
44+
php-cs-fixer:
45+
runs-on: ubuntu-latest
46+
steps:
47+
- uses: actions/checkout@v3
48+
with:
49+
ref: ${{ github.head_ref }}
50+
51+
- uses: shivammathur/setup-php@v2
52+
with:
53+
coverage: none
54+
extensions: mbstring
55+
php-version: 8.1
56+
57+
- run: composer install --no-interaction --no-progress --no-suggest
58+
59+
- run: vendor/bin/php-cs-fixer fix
60+
61+
- run: git pull
62+
63+
- uses: stefanzweifel/git-auto-commit-action@v4
64+
with:
65+
commit_message: Apply php-cs-fixer changes

‎.github/workflows/validate.yml

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: "Validate"
2+
on:
3+
pull_request:
4+
push:
5+
branches:
6+
- master
7+
8+
jobs:
9+
static-analysis:
10+
name: PHPStan on PHP ${{ matrix.php-version }} with Laravel ${{ matrix.laravel-version }} and ${{ matrix.composer.name }} dependencies
11+
runs-on: ubuntu-latest
12+
13+
strategy:
14+
fail-fast: false
15+
matrix:
16+
php-version:
17+
- "8.0"
18+
- "8.1"
19+
- "8.2"
20+
laravel-version:
21+
- "^9"
22+
- "^10"
23+
composer:
24+
- name: lowest
25+
arg: "--prefer-lowest --prefer-stable"
26+
- name: highest
27+
arg: "" # No args added as highest is default
28+
exclude:
29+
- php-version: "8.0"
30+
laravel-version: "^10"
31+
32+
steps:
33+
- uses: actions/checkout@v3
34+
35+
- uses: shivammathur/setup-php@v2
36+
with:
37+
coverage: none
38+
extensions: ${{ env.REQUIRED_PHP_EXTENSIONS }}
39+
php-version: ${{ matrix.php-version }}
40+
41+
- name: "Cache composer dependencies"
42+
uses: actions/cache@v3
43+
with:
44+
path: ~/.composer/cache
45+
key: php-${{ matrix.php-version }}-composer-${{ matrix.laravel-version }}-os-${{ matrix.os }}-composer-${{ matrix.composer.name }}
46+
47+
- run: >
48+
composer require
49+
illuminate/contracts:${{ matrix.laravel-version }}
50+
--no-interaction
51+
--prefer-dist
52+
--no-progress
53+
--update-with-all-dependencies
54+
${{ matrix.composer.arg }}
55+
56+
- run: vendor/bin/phpstan

‎CHANGELOG.md

+6
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,12 @@ See [GitHub releases](https://github.com/mll-lab/laravel-graphiql/releases).
99

1010
## Unreleased
1111

12+
## v1.2.2
13+
14+
### Fixed
15+
16+
- Properly handle errors of `file_get_contents()` in `graphiql:download-assets`
17+
1218
## v1.2.1
1319

1420
### Fixed

‎Makefile

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
.PHONY: it
2-
it: fix ## Perform all quality checks
2+
it: fix stan ## Perform all quality checks
33

44
.PHONY: help
55
help: ## Displays this list of targets with descriptions
@@ -13,5 +13,9 @@ fix: ## Fix the codestyle
1313
composer normalize
1414
vendor/bin/php-cs-fixer fix --allow-risky=yes
1515

16+
.PHONY: stan
17+
stan: ## Run static analysis
18+
vendor/bin/phpstan
19+
1620
vendor: composer.json composer.lock ## Install dependencies through composer
1721
composer update

‎composer.json

+9-2
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,13 @@
2222
"require-dev": {
2323
"ergebnis/composer-normalize": "^2.29",
2424
"laravel/lumen-framework": "5.5.* || 5.6.* || 5.7.* || 5.8.* || ^6 || ^7 || ^8 || ^9 || ^10",
25-
"mll-lab/php-cs-fixer-config": "^4.4"
25+
"mll-lab/php-cs-fixer-config": "^4.4",
26+
"nunomaduro/larastan": "^2.4.1",
27+
"orchestra/testbench": "^4 || ^5 || ^6 || ^7.7 || ^8.8",
28+
"phpstan/extension-installer": "^1",
29+
"phpstan/phpstan": "^1.10.3",
30+
"phpstan/phpstan-mockery": "^1.1",
31+
"phpstan/phpstan-phpunit": "^1.1.1"
2632
},
2733
"minimum-stability": "dev",
2834
"prefer-stable": true,
@@ -34,7 +40,8 @@
3440
"config": {
3541
"allow-plugins": {
3642
"kylekatarnls/update-helper": true,
37-
"ergebnis/composer-normalize": true
43+
"ergebnis/composer-normalize": true,
44+
"phpstan/extension-installer": true
3845
},
3946
"sort-packages": true
4047
},

‎phpstan.neon

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
parameters:
2+
level: max
3+
paths:
4+
- src
5+
- views
6+
checkOctaneCompatibility: true

‎src/DownloadAssetsCommand.php

+28-29
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
namespace MLL\GraphiQL;
44

55
use Illuminate\Console\Command;
6+
use Illuminate\Container\Container;
7+
use Illuminate\Contracts\Routing\UrlGenerator;
8+
use Illuminate\Foundation\Application as LaravelApplication;
9+
use Laravel\Lumen\Application as LumenApplication;
610

711
class DownloadAssetsCommand extends Command
812
{
@@ -30,41 +34,31 @@ class DownloadAssetsCommand extends Command
3034

3135
public function handle(): void
3236
{
33-
$this->fileForceContents(
34-
self::publicPath(self::REACT_PATH_LOCAL),
35-
file_get_contents('https:' . self::REACT_PATH_CDN)
36-
);
37-
$this->fileForceContents(
38-
self::publicPath(self::REACT_DOM_PATH_LOCAL),
39-
file_get_contents('https:' . self::REACT_DOM_PATH_CDN)
40-
);
41-
$this->fileForceContents(
42-
self::publicPath(self::CSS_PATH_LOCAL),
43-
file_get_contents('https:' . self::CSS_PATH_CDN)
44-
);
45-
$this->fileForceContents(
46-
self::publicPath(self::JS_PATH_LOCAL),
47-
file_get_contents('https:' . self::JS_PATH_CDN)
48-
);
49-
$this->fileForceContents(
50-
self::publicPath(self::EXPLORER_PLUGIN_PATH_LOCAL),
51-
file_get_contents('https:' . self::EXPLORER_PLUGIN_PATH_CDN)
52-
);
53-
$this->fileForceContents(
54-
self::publicPath(self::FAVICON_PATH_LOCAL),
55-
file_get_contents('https:' . self::FAVICON_PATH_CDN)
56-
);
37+
$this->downloadFileFromCDN(self::REACT_PATH_LOCAL, self::REACT_PATH_CDN);
38+
$this->downloadFileFromCDN(self::REACT_DOM_PATH_LOCAL, self::REACT_DOM_PATH_CDN);
39+
$this->downloadFileFromCDN(self::CSS_PATH_LOCAL, self::CSS_PATH_CDN);
40+
$this->downloadFileFromCDN(self::JS_PATH_LOCAL, self::JS_PATH_CDN);
41+
$this->downloadFileFromCDN(self::EXPLORER_PLUGIN_PATH_LOCAL, self::EXPLORER_PLUGIN_PATH_CDN);
42+
$this->downloadFileFromCDN(self::FAVICON_PATH_LOCAL, self::FAVICON_PATH_CDN);
5743
}
5844

59-
protected function fileForceContents(string $filePath, string $contents): void
45+
protected function downloadFileFromCDN(string $localPath, string $cdnPath): void
6046
{
47+
$publicPath = self::publicPath($localPath);
48+
6149
// Ensure the directory exists
62-
$directory = dirname($filePath);
50+
$directory = dirname($publicPath);
6351
if (! is_dir($directory)) {
6452
mkdir($directory, 0777, true);
6553
}
6654

67-
file_put_contents($filePath, $contents);
55+
$contents = file_get_contents("https:{$cdnPath}");
56+
if (false === $contents) {
57+
$error = error_get_last();
58+
throw new \ErrorException($error['message'] ?? 'An error occurred', 0, $error['type'] ?? 1);
59+
}
60+
61+
file_put_contents($publicPath, $cdnPath);
6862
}
6963

7064
public static function reactPath(): string
@@ -106,11 +100,16 @@ protected static function assetPath(string $local, string $cdn): string
106100

107101
protected static function asset(string $path): string
108102
{
109-
return app('url')->asset($path);
103+
$url = Container::getInstance()->make(UrlGenerator::class);
104+
105+
return $url->asset($path);
110106
}
111107

112108
protected static function publicPath(string $path): string
113109
{
114-
return app()->basePath("public/{$path}");
110+
$container = Container::getInstance();
111+
assert($container instanceof LaravelApplication || $container instanceof LumenApplication);
112+
113+
return $container->basePath("public/{$path}");
115114
}
116115
}

‎src/GraphiQLController.php

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,11 @@
22

33
namespace MLL\GraphiQL;
44

5+
use Illuminate\Contracts\View\View;
6+
57
class GraphiQLController
68
{
7-
public function __invoke()
9+
public function __invoke(): View
810
{
911
return view('graphiql::index');
1012
}

‎src/routes.php

+7-3
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
11
<?php declare(strict_types=1);
22

3+
use Illuminate\Container\Container;
34
use Illuminate\Contracts\Config\Repository as ConfigRepository;
45
use MLL\GraphiQL\GraphiQLController;
56

6-
$config = app(ConfigRepository::class);
7+
$app = Container::getInstance();
8+
9+
$config = $app->make(ConfigRepository::class);
710
assert($config instanceof ConfigRepository);
811

9-
if ($routeConfig = $config->get('graphiql.route')) {
12+
$routeConfig = $config->get('graphiql.route');
13+
if (is_array($routeConfig)) {
1014
/** @var \Illuminate\Contracts\Routing\Registrar|\Laravel\Lumen\Routing\Router $router */
11-
$router = app('router');
15+
$router = $app->make('router');
1216

1317
$actions = [
1418
'as' => $routeConfig['name'] ?? 'graphiql',

0 commit comments

Comments
 (0)