[FEATURE] Doctrine ORM 3.0 & DBAL 4.0 & Doctrine Coding Standard

.github/workflows/coding-standards.yml

@@ -0,0 +1,20 @@
+name: "Coding Standards"
+
+on:
+  pull_request:
+    branches:
+      - "*.x"
+      - "main"
+  push:
+    branches:
+      - "*.x"
+      - "main"
+
+jobs:
+  coding-standards:
+    name: "Coding Standards"
+    uses: "doctrine/.github/.github/workflows/[email protected]"
+    with:
+      php-version: '8.1'
+      composer-options: '--prefer-dist --ignore-platform-req=php'
+

.github/workflows/continuous-integration.yml

@@ -0,0 +1,84 @@
+name: "Continuous Integration"
+
+on:
+  pull_request:
+    branches:
+      - "*.x"
+      - "main"
+  push:
+    branches:
+      - "*.x"
+      - "main"
+
+jobs:
+  phpunit:
+    name: "PHPUnit"
+    runs-on: "ubuntu-20.04"
+
+    strategy:
+      fail-fast: false
+      matrix:
+        php-version:
+          - "8.1"
+          - "8.2"
+          - "8.3"
+        dependencies:
+          - "highest"
+          - "lowest"
+        optional-dependencies:
+          - true
+          - false
+
+    steps:
+      - name: "Checkout"
+        uses: "actions/checkout@v2"
+        with:
+          fetch-depth: 2
+
+      - name: "Install PHP"
+        uses: "shivammathur/setup-php@v2"
+        with:
+          php-version: "${{ matrix.php-version }}"
+          coverage: "pcov"
+          ini-values: "zend.assertions=1"
+          extensions: "pdo_mysql"
+
+      - name: "Install dependencies with Composer"
+        uses: "ramsey/composer-install@v1"
+        with:
+          dependency-versions: "${{ matrix.dependencies }}"
+          composer-options: "--prefer-dist"
+
+      - name: "Show Composer packages"
+        run: "composer show"
+
+      - name: "Run PHPUnit"
+        run: "vendor/bin/phpunit --coverage-clover=coverage.xml"
+
+      - name: "Upload coverage file"
+        uses: "codecov/codecov-action@v4"
+        with:
+          name: "phpunit-${{ matrix.php-version }}-${{ matrix.dependencies }}-${{ matrix.dbal-version }}.coverage"
+          files: "./coverage.xml"
+
+  upload_coverage:
+    name: "Upload coverage to Codecov"
+    runs-on: "ubuntu-20.04"
+    needs:
+      - "phpunit"
+
+    steps:
+      - name: "Checkout"
+        uses: "actions/checkout@v2"
+        with:
+          fetch-depth: 2
+
+      - name: "Download coverage files"
+        uses: "actions/download-artifact@v4"
+        with:
+          path: "reports"
+
+      - name: "Upload to Codecov"
+        uses: "codecov/codecov-action@v2"
+        with:
+          directory: "reports"

.gitignore

@@ -1,9 +1,9 @@
+/coverage
 /vendor
 composer.phar
 composer.lock
 .DS_Store
-.php_cs.cache
-.php-cs-fixer.cache
+.phpcs-cache
 .phpunit.result.cache
 
 /tests/Stubs/storage/framework/views/*

LICENSE

@@ -1,6 +1,7 @@
 The MIT License (MIT)
 
 Copyright (c) 2015 Patrick Brouwers
+Copyright (c) 2024 Tom H Anderson <[email protected]>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -28,7 +28,6 @@ EntityManager::flush();
 * Pagination
 * Pre-configured metadata, connections and caching
 * Extendable: extend or add your own drivers for metadata, connections or cache
-* Fluent, Annotations, YAML, SimplifiedYAML, XML, SimplifiedXML, Config and Static PHP metadata mappings
 * Multiple entity managers and connections
 * Laravel naming strategy
 * Simple authentication implementation

composer.json

@@ -13,38 +13,43 @@
         {
             "name": "Patrick Brouwers",
             "email": "[email protected]"
+        },
+        {
+            "name": "Tom H Anderson",
+            "email": "[email protected]"
         }
     ],
     "require": {
-        "php": "^8.0",
-        "doctrine/annotations": "^2",
-        "doctrine/dbal": "^3.2",
-        "doctrine/orm": "^2.14",
-        "doctrine/persistence": "^3",
-        "illuminate/auth": "^9.0|^10.0|^11.0",
-        "illuminate/console": "^9.0|^10.0|^11.0",
-        "illuminate/container": "^9.0|^10.0|^11.0",
-        "illuminate/contracts": "^9.0|^10.0|^11.0",
-        "illuminate/pagination": "^9.0|^10.0|^11.0",
-        "illuminate/routing": "^9.0|^10.0|^11.0",
-        "illuminate/support": "^9.0|^10.0|^11.0",
-        "illuminate/validation": "^9.0|^10.0|^11.0",
-        "illuminate/view": "^9.0|^10.0|^11.0",
+        "php": "^8.1",
+        "doctrine/dbal": "^4.1",
+        "doctrine/orm": "^3.1",
+        "doctrine/persistence": "^3.3",
+        "illuminate/auth": "^10.0|^11.0",
+        "illuminate/console": "^10.0|^11.0",
+        "illuminate/container": "^10.0|^11.0",
+        "illuminate/contracts": "^10.0|^11.0",
+        "illuminate/pagination": "^10.0|^11.0",
+        "illuminate/routing": "^10.0|^11.0",
+        "illuminate/support": "^10.0|^11.0",
+        "illuminate/validation": "^10.0|^11.0",
+        "illuminate/view": "^10.0|^11.0",
         "symfony/cache": "^6.0|^7.0",
-        "symfony/serializer": "^5.0|^6.0|^7.0",
-        "symfony/yaml": "^5.0|^6.0|^7.0"
+        "symfony/serializer": "^5.0|^6.0|^7.0"
     },
     "conflict": {
         "laravel/lumen": "*"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.3",
-        "mockery/mockery": "^1.3.1",
+        "mockery/mockery": "^1.6.12",
         "illuminate/log": "^9.0|^10.0|^11.0",
         "illuminate/notifications": "^9.0|^10.0|^11.0",
         "illuminate/queue": "^9.0|^10.0|^11.0",
         "phpstan/phpstan": "^1.9",
-        "phpstan/phpstan-deprecation-rules": "^1.1"
+        "phpstan/phpstan-deprecation-rules": "^1.1",
+        "doctrine/coding-standard": "^12.0",
+        "php-parallel-lint/php-parallel-lint": "^1.4",
+        "vimeo/psalm": "^0.3.14"
     },
     "autoload": {
         "psr-4": {
@@ -78,5 +83,18 @@
                 "EntityManager": "LaravelDoctrine\\ORM\\Facades\\EntityManager"
             }
         }
+    },
+    "config": {
+        "allow-plugins": {
+            "dealerdirect/phpcodesniffer-composer-installer": true
+        }
+    },
+    "scripts": {
+        "test": [
+            "vendor/bin/parallel-lint src tests",
+            "vendor/bin/phpcs",
+            "vendor/bin/phpunit"
+        ],
+        "coverage": "XDEBUG_MODE=coverage vendor/bin/phpunit --coverage-html=coverage"
     }
 }

config/doctrine.php

@@ -27,7 +27,7 @@
     'managers'                   => [
         'default' => [
             'dev'           => env('APP_DEBUG', false),
-            'meta'          => env('DOCTRINE_METADATA', 'annotations'),
+            'meta'          => env('DOCTRINE_METADATA', 'attributes'),
             'connection'    => env('DB_CONNECTION', 'mysql'),
             'paths'         => [
                 base_path('app/Entities')

phpcs.xml.dist

@@ -0,0 +1,17 @@
+<?xml version="1.0"?>
+<ruleset>
+    <arg name="basepath" value="."/>
+    <arg name="extensions" value="php"/>
+    <arg name="parallel" value="80"/>
+    <arg name="cache" value=".phpcs-cache"/>
+    <arg name="colors"/>
+
+    <!-- Ignore warnings, show progress of the run and show sniff names -->
+    <arg value="nps"/>
+
+    <!-- Directories to be checked -->
+    <file>src</file>
+
+    <!-- Include full Doctrine Coding Standard -->
+    <rule ref="Doctrine"/>
+</ruleset>

src/AbstractTable.php

@@ -1,73 +1,47 @@
 <?php
 
+declare(strict_types=1);
+
 namespace LaravelDoctrine\ORM;
 
 use Doctrine\DBAL\Schema\Column;
 use Doctrine\DBAL\Schema\Index;
 use Doctrine\DBAL\Schema\Table;
 use Doctrine\DBAL\Types\Type;
 
-/** @interal  */
+// phpcs:disable SlevomatCodingStandard.Classes.SuperfluousAbstractClassNaming.SuperfluousPrefix
 abstract class AbstractTable
 {
-    /**
-     * @var string
-     */
-    protected string $table;
-
-    /**
-     * @param string $table
-     */
-    public function __construct(string $table)
+    public function __construct(protected string $table)
     {
-        $this->table = $table;
     }
 
-    /**
-     * @return Table
-     */
     public function build(): Table
     {
         return new Table(
             $this->table,
             $this->columns(),
-            $this->indices()
+            $this->indices(),
         );
     }
 
-    /**
-     * @param  string $name
-     * @param  string $type
-     * @param  bool   $autoincrement
-     * @return Column
-     */
-    protected function column($name, string $type, bool $autoincrement = false): Column
+    protected function column(string $name, string $type, bool $autoincrement = false): Column
     {
         $column = new Column($name, Type::getType($type));
         $column->setAutoincrement($autoincrement);
 
         return $column;
     }
 
-    /**
-     * @param  string $name
-     * @param  string[]  $columns
-     * @param  bool   $unique
-     * @param  bool   $primary
-     * @return Index
-     */
+    /** @param  string[] $columns */
     protected function index(string $name, array $columns, bool $unique = false, bool $primary = false): Index
     {
         return new Index($name, $columns, $unique, $primary);
     }
 
-    /**
-     * @return Column[]
-     */
-    abstract protected function columns();
+    /** @return Column[] */
+    abstract protected function columns(): array;
 
-    /**
-     * @return Index[]
-     */
-    abstract protected function indices();
+    /** @return Index[] */
+    abstract protected function indices(): array;
 }