[2.x] Supports Laravel 11 & PHP 8.2+ (#20)

Author: sethsandaru

.github/workflows/build_laravel.yaml

@@ -14,10 +14,10 @@ jobs:
     strategy:
         fail-fast: false
         matrix:
-            php: [8.1, 8.2]
-            laravel: [ '^9', '^10' ]
+            php: [8.2, 8.3]
+            laravel: [ '^11' ]
     steps:
-      -   uses: actions/checkout@v2
+      -   uses: actions/checkout@v3
           if: success()
 
       -   name: Setup PHP with coverage driver
@@ -26,44 +26,6 @@ jobs:
             php-version: ${{ matrix.php }}
             coverage: pcov
 
-      -   name: Set Minimum PHP 8.1 Versions
-          uses: nick-fields/retry@v2
-          with:
-            timeout_minutes: 5
-            max_attempts: 5
-            command: composer require symfony/css-selector:^6.0 --no-interaction --no-update
-
-      -   name: Set Minimum PHP 8.2 Versions
-          uses: nick-fields/retry@v2
-          with:
-              timeout_minutes: 5
-              max_attempts: 5
-              command: composer require guzzlehttp/guzzle:^7.5 guzzlehttp/psr7:^2.4 predis/predis:^2.0.2 --no-interaction --no-update
-          if: matrix.php >= 8.2
-
-      - name: Set Laravel Version
-        uses: nick-fields/retry@v2
-        with:
-          timeout_minutes: 5
-          max_attempts: 5
-          command: composer require laravel/framework:${{ matrix.laravel }} --no-interaction --no-update
-
-      - name: Set Testbench Version for Laravel ^9
-        uses: nick-fields/retry@v2
-        with:
-          timeout_minutes: 5
-          max_attempts: 5
-          command: composer require orchestra/testbench:^7 --dev --no-interaction --no-update
-        if: matrix.laravel == '^9'
-
-      - name: Set Testbench Version for Laravel ^10
-        uses: nick-fields/retry@v2
-        with:
-          timeout_minutes: 5
-          max_attempts: 5
-          command: composer require orchestra/testbench:^8 --dev --no-interaction --no-update
-        if: matrix.laravel == '^10'
-
       - name: Install dependencies
         uses: nick-fields/retry@v2
         with:

.github/workflows/build_mysql.yaml

@@ -1,4 +1,4 @@
-name: Build and test [MYSQL]
+name: Build and test [MYSQL 8.0]
 on:
   pull_request:
     branches:
@@ -13,13 +13,13 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      -   uses: actions/checkout@v2
+      -   uses: actions/checkout@v3
           if: success()
 
       -   name: Setup PHP with coverage driver
           uses: shivammathur/setup-php@v2
           with:
-            php-version: '8.1'
+            php-version: '8.2'
             coverage: pcov
 
       -   name: Setup
@@ -38,7 +38,7 @@ jobs:
             composer test-coverage
 
       -   name: upload coverage to codecov.io
-          uses: codecov/codecov-action@v1
+          uses: codecov/codecov-action@v3
           with:
             token: ${{ secrets.CODECOV_TOKEN }}
             file: ./coverage.xml

.github/workflows/build_postgresql.yaml

@@ -1,4 +1,4 @@
-name: Build and test [PostgreSQL]
+name: Build and test [PostgreSQL 15.x]
 on:
   pull_request:
     branches:
@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     services:
       postgresql:
-        image: postgres:14
+        image: postgres:15
         env:
           POSTGRES_DB: eloquentdocs
           POSTGRES_USER: root
@@ -23,13 +23,13 @@ jobs:
         options: --health-cmd=pg_isready --health-interval=10s --health-timeout=5s --health-retries=3
 
     steps:
-      -   uses: actions/checkout@v2
+      -   uses: actions/checkout@v3
           if: success()
 
       -   name: Setup PHP with coverage driver
           uses: shivammathur/setup-php@v2
           with:
-            php-version: '8.1'
+            php-version: '8.3'
             extensions: pdo, pdo_pgsql
             coverage: none
 

.github/workflows/build_sqlite.yaml

@@ -13,13 +13,13 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      -   uses: actions/checkout@v2
+      -   uses: actions/checkout@v3
           if: success()
 
       -   name: Setup PHP with coverage driver
           uses: shivammathur/setup-php@v2
           with:
-            php-version: '8.1'
+            php-version: '8.3'
             coverage: pcov
 
       -   name: Setup

README.md

@@ -20,13 +20,14 @@ And, welcome to Eloquent phpDoc Generator, which going to help you to achieve th
 
 ## What will Eloquent phpDoc Generator will generate?
 - Table name
-- Table columns (with types)
+- Table columns (with correct types - including Casting types 😎)
 - Model relationships
 - Model attributes/accessors
 
 ## Available For / Requirements
-- PHP 8.1 / 8.2
-- Laravel 9 / 10
+
+- **v2.x**: Laravel 11, PHP 8.2+.
+- **v1.x**: Laravel 9/10, PHP 8.0, 8.1.
 
 ## Install
 Install as dev-dependencies is enough, since you are only going to use this command on `local/development` env.
@@ -87,15 +88,12 @@ Thank you for using EloquentDocs!
 
 </details>
 
-Note: if you haven't installed `doctrine/dbal` as your dev-dependency, 
-then once you trigger the command for the first time, it will help you to install the needful dependency
-
 ## Best practices
-- Use `$casts` in your model, in order to help EloquentPhpDoc generate better types for you (array, Carbon,...)
+- Use `$casts` in your model, in order to help EloquentPhpDoc generate better types for you (array, date, datetime,...)
 - For `get*Attribute` accessor, always declare the return type
 
-Note: Eloquent new `Attribute` class utilize the data via Closure, thus we can't declare any return type for any attributes.
-For this case, EloquentPhpDoc will always return `mixed`
+Note: for Eloquent new `Attribute` class utilize the data via Closure, making it impossible to acquire the return types. 
+For this case, EloquentDocs will always return `mixed`
 
 ## Release logs
 - v1.0.0
@@ -117,6 +115,11 @@ For this case, EloquentPhpDoc will always return `mixed`
   - New command to bulk generate from a given model path.
     - `php artisan eloquent:bulk-phpdoc "app/Models/*.php"`
   - Fixed an issue where accessors/attributes being generated as snake_case. Should be camelCase.
+- v2.0.0
+  - Supports Laravel 11 + PHP 8.2/8.3
+  - DBAL as required dependencies
+  - Better date/datetime parsing (Carbon & Carbon immutable)
+  - Better boolean parsing
 
 ## Contribute to the library
 
@@ -132,3 +135,15 @@ MIT License
 
 - [Seth Phat](https://github.com/sethsandaru)
 - And contributors
+
+## (Sponsered Content) Introducing RenderPDF.io - Render your PDF in seconds
+
+![RenderPDF.io](./.github/render-pdf-io.png)
+
+[RenderPDF.io](https://renderpdf.io) is a Render-PDF-as-a-Service that provides developer-friendly APIs
+to render your HTML content to modern PDFs file sin seconds 😎.
+
+All you have to do is get your API Key and send RenderPDF.io an API call 🚀, no infrastructure setup, no overhead and
+hassle-free integration 🔋.
+
+Get your free API Key today: [Sign Up to RenderPDF.io](https://renderpdf.io)

composer.json

@@ -1,19 +1,19 @@
 {
     "name": "sethphat/eloquent-docs",
-    "version": "1.2.3",
+    "version": "2.0.0",
     "description": "Generate PHPDoc scope for your Eloquent models",
     "type": "library",
     "require": {
-        "php": "^8",
-        "laravel/framework": "^10|^9"
+        "php": "^8.2|^8.3",
+        "laravel/framework": "^11",
+        "doctrine/dbal": "^3.8"
     },
     "require-dev": {
         "fakerphp/faker": "^1.20",
         "mockery/mockery": "^1.5",
-        "phpunit/phpunit": "^9.5",
-        "orchestra/testbench": "^7.6",
-        "phpunit/php-code-coverage": "^9.2",
-        "doctrine/dbal": "^3.4"
+        "orchestra/testbench": "^9",
+        "phpunit/phpunit": "^10",
+        "phpunit/php-code-coverage": "^10"
     },
     "license": "MIT",
     "authors": [