Move from phpat-example

Signed-off-by: Oliver Davies <oliver@oliverdavies.uk>
This commit is contained in:
Oliver Davies 2025-09-25 12:00:00 +01:00
parent b7c3fffbaa
commit 37ad11a9b4
8 changed files with 297 additions and 0 deletions

1
php/phpat/.envrc Normal file
View file

@ -0,0 +1 @@
use flake git+https://code.oliverdavies.uk/opdavies/dev-shells#php83

1
php/phpat/.gitignore vendored Normal file
View file

@ -0,0 +1 @@
vendor/

10
php/phpat/.nvim.lua Normal file
View file

@ -0,0 +1,10 @@
local cmp_nvim_lsp = require("cmp_nvim_lsp")
local capabilities = cmp_nvim_lsp.default_capabilities(vim.lsp.protocol.make_client_capabilities())
local lspconfig = require("lspconfig")
lspconfig.phpactor.setup({ capabilities = capabilities })
require("lint").linters_by_ft = {
php = { "phpstan" },
}

21
php/phpat/composer.json Normal file
View file

@ -0,0 +1,21 @@
{
"require-dev": {
"phpat/phpat": "^0.11.5",
"phpstan/extension-installer": "^1.4"
},
"config": {
"allow-plugins": {
"phpstan/extension-installer": true
}
},
"autoload": {
"psr-4": {
"App\\": "src/"
}
},
"autoload-dev": {
"psr-4": {
"Tests\\": "tests/"
}
}
}

181
php/phpat/composer.lock generated Normal file
View file

@ -0,0 +1,181 @@
{
"_readme": [
"This file locks the dependencies of your project to a known state",
"Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
"This file is @generated automatically"
],
"content-hash": "85bfd49ff9043444a18d526d47e46a2e",
"packages": [],
"packages-dev": [
{
"name": "phpat/phpat",
"version": "0.11.5",
"source": {
"type": "git",
"url": "https://github.com/carlosas/phpat.git",
"reference": "db6aaa96023a6b1b1dfeed7ad9e498e8119a4066"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/carlosas/phpat/zipball/db6aaa96023a6b1b1dfeed7ad9e498e8119a4066",
"reference": "db6aaa96023a6b1b1dfeed7ad9e498e8119a4066",
"shasum": ""
},
"require": {
"php": "^7.4 || ^8.0",
"phpstan/phpstan": "^2.0"
},
"require-dev": {
"friendsofphp/php-cs-fixer": "^3.60",
"kubawerlos/php-cs-fixer-custom-fixers": "3.18.*",
"phpunit/phpunit": "^9.0 || 10.5.*"
},
"type": "phpstan-extension",
"extra": {
"phpstan": {
"includes": [
"extension.neon"
]
}
},
"autoload": {
"files": [
"helpers.php"
],
"psr-4": {
"PHPat\\": "src/"
}
},
"notification-url": "https://packagist.org/downloads/",
"license": [
"MIT"
],
"authors": [
{
"name": "Carlos Alandete Sastre",
"email": "carlos.alandete@gmail.com"
}
],
"description": "PHP Architecture Tester",
"support": {
"issues": "https://github.com/carlosas/phpat/issues",
"source": "https://github.com/carlosas/phpat/tree/0.11.5"
},
"time": "2025-05-28T16:39:55+00:00"
},
{
"name": "phpstan/extension-installer",
"version": "1.4.3",
"source": {
"type": "git",
"url": "https://github.com/phpstan/extension-installer.git",
"reference": "85e90b3942d06b2326fba0403ec24fe912372936"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/phpstan/extension-installer/zipball/85e90b3942d06b2326fba0403ec24fe912372936",
"reference": "85e90b3942d06b2326fba0403ec24fe912372936",
"shasum": ""
},
"require": {
"composer-plugin-api": "^2.0",
"php": "^7.2 || ^8.0",
"phpstan/phpstan": "^1.9.0 || ^2.0"
},
"require-dev": {
"composer/composer": "^2.0",
"php-parallel-lint/php-parallel-lint": "^1.2.0",
"phpstan/phpstan-strict-rules": "^0.11 || ^0.12 || ^1.0"
},
"type": "composer-plugin",
"extra": {
"class": "PHPStan\\ExtensionInstaller\\Plugin"
},
"autoload": {
"psr-4": {
"PHPStan\\ExtensionInstaller\\": "src/"
}
},
"notification-url": "https://packagist.org/downloads/",
"license": [
"MIT"
],
"description": "Composer plugin for automatic installation of PHPStan extensions",
"keywords": [
"dev",
"static analysis"
],
"support": {
"issues": "https://github.com/phpstan/extension-installer/issues",
"source": "https://github.com/phpstan/extension-installer/tree/1.4.3"
},
"time": "2024-09-04T20:21:43+00:00"
},
{
"name": "phpstan/phpstan",
"version": "2.1.17",
"source": {
"type": "git",
"url": "https://github.com/phpstan/phpstan.git",
"reference": "89b5ef665716fa2a52ecd2633f21007a6a349053"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/phpstan/phpstan/zipball/89b5ef665716fa2a52ecd2633f21007a6a349053",
"reference": "89b5ef665716fa2a52ecd2633f21007a6a349053",
"shasum": ""
},
"require": {
"php": "^7.4|^8.0"
},
"conflict": {
"phpstan/phpstan-shim": "*"
},
"bin": [
"phpstan",
"phpstan.phar"
],
"type": "library",
"autoload": {
"files": [
"bootstrap.php"
]
},
"notification-url": "https://packagist.org/downloads/",
"license": [
"MIT"
],
"description": "PHPStan - PHP Static Analysis Tool",
"keywords": [
"dev",
"static analysis"
],
"support": {
"docs": "https://phpstan.org/user-guide/getting-started",
"forum": "https://github.com/phpstan/phpstan/discussions",
"issues": "https://github.com/phpstan/phpstan/issues",
"security": "https://github.com/phpstan/phpstan/security/policy",
"source": "https://github.com/phpstan/phpstan-src"
},
"funding": [
{
"url": "https://github.com/ondrejmirtes",
"type": "github"
},
{
"url": "https://github.com/phpstan",
"type": "github"
}
],
"time": "2025-05-21T20:55:28+00:00"
}
],
"aliases": [],
"minimum-stability": "stable",
"stability-flags": {},
"prefer-stable": false,
"prefer-lowest": false,
"platform": {},
"platform-dev": {},
"plugin-api-version": "2.6.0"
}

View file

@ -0,0 +1,9 @@
parameters:
level: max
paths:
- src
- tests
services:
- class: Tests\Architecture\ArchitectureTest
tags:
- phpat.test

View file

@ -0,0 +1,13 @@
<?php
declare(strict_types=1);
namespace App\Action;
readonly final class DoesSomething
{
public function __invoke(): void
{
var_dump('Doing something...');
}
}

View file

@ -0,0 +1,61 @@
<?php
declare(strict_types=1);
namespace Tests\Architecture;
use PHPat\Selector\Selector;
use PHPat\Test\Builder\Rule;
use PHPat\Test\PHPat;
final class ArchitectureTest
{
private const ACTION_NAMESPACE = 'App\Action';
function test_action_classes_are_not_suffixed(): Rule
{
return PHPat::rule()
->classes(Selector::inNamespace(self::ACTION_NAMESPACE))
->shouldBeNamed(
fqcn: '/^(?!.*Action$).*$/',
regex: TRUE,
);
}
function test_action_classes_are_final(): Rule
{
return PHPat::rule()
->classes(Selector::inNamespace(self::ACTION_NAMESPACE))
->shouldBeFinal();
}
function test_action_classes_are_readonly(): Rule
{
return PHPat::rule()
->classes(Selector::inNamespace(self::ACTION_NAMESPACE))
->shouldBeReadonly();
}
function test_action_classes_are_invokeable(): Rule
{
return PHPat::rule()
->classes(Selector::inNamespace(self::ACTION_NAMESPACE))
->shouldHaveOnlyOnePublicMethodNamed('__invoke');
}
function test_action_classes_do_not_extend_other_classes(): Rule
{
return PHPat::rule()
->classes(Selector::inNamespace(self::ACTION_NAMESPACE))
->shouldNotExtend()
->classes(Selector::all());
}
function test_action_classes_do_not_implement_interfaces(): Rule
{
return PHPat::rule()
->classes(Selector::inNamespace(self::ACTION_NAMESPACE))
->shouldNotImplement()
->classes(Selector::all());
}
}