Migrate to PHP 8.3+ and add docs

coisa · coisa · commit 687c008a7408 · 2026-03-29T10:58:50.000-03:00
Signed-off-by: Felipe Sayão Lobato Abreu &lt;github@mentordosnerds.com&gt;
diff --git a/.docheader b/.docheader
@@ -4,7 +4,10 @@
  * This source file is subject to the license bundled
  * with this source code in the file LICENSE.
  *
- * @link      https://github.com/php-fast-forward/framework
  * @copyright Copyright (c) 2025-%year% Felipe Sayão Lobato Abreu <github@mentordosnerds.com>
  * @license   https://opensource.org/licenses/MIT MIT License
+ *
+ * @see       https://github.com/php-fast-forward/framework
+ * @see       https://github.com/php-fast-forward
+ * @see       https://datatracker.ietf.org/doc/html/rfc2119
  */
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,23 @@
+version: 2
+updates:
+  - package-ecosystem: "composer"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    commit-message:
+      prefix: "Composer"
+      include: "scope"
+    labels:
+      - "composer"
+      - "dependencies"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    commit-message:
+      prefix: "GitHub Actions"
+      include: "scope"
+    labels:
+      - "github-actions"
+      - "continuous-integration"
diff --git a/.github/wiki b/.github/wiki
@@ -0,0 +1 @@
+Subproject commit 9538a3c2f999bdeba216cd082e7007b3c4e0f7e3
diff --git a/.github/workflows/reports.yml b/.github/workflows/reports.yml
@@ -0,0 +1,17 @@
+name: "Fast Forward Reports"
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+
+jobs:
+  reports:
+    uses: php-fast-forward/dev-tools/.github/workflows/reports.yml@main
+    secrets: inherit
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -0,0 +1,15 @@
+name: "Fast Forward Test Suite"
+
+on:
+  push:
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+
+jobs:
+  tests:
+    uses: php-fast-forward/dev-tools/.github/workflows/tests.yml@main
+    secrets: inherit
diff --git a/.github/workflows/wiki.yml b/.github/workflows/wiki.yml
@@ -0,0 +1,17 @@
+name: "Fast Forward Wiki Update"
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+
+jobs:
+  wiki:
+    uses: php-fast-forward/dev-tools/.github/workflows/wiki.yml@main
+    secrets: inherit
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,7 @@
 .idea/
+.vscode/
 public/
+tmp/
 vendor/
 composer.lock
 *.cache
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule ".github/wiki"]
+	path = .github/wiki
+	url = git@github.com:php-fast-forward/framework.wiki.git
diff --git a/.php-cs-fixer.php b/.php-cs-fixer.php
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # Fast Forward Framework
 
 [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
-[![PHP Version](https://img.shields.io/badge/php-^8.2-blue.svg)](https://www.php.net/releases/)
+[![PHP Version](https://img.shields.io/badge/php-^8.3-blue.svg)](https://www.php.net/releases/)
 
 **Fast Forward Framework** is a lightweight and fast PHP framework designed for building modern web applications.  
 This package serves as an **aggregate metapackage**, bundling all core components of the Fast Forward ecosystem for easier installation and management.
@@ -10,7 +10,7 @@ This package serves as an **aggregate metapackage**, bundling all core component
 
 ## Features
 
-- 🚀 **Modern PHP 8.2+ syntax**
+- 🚀 **Modern PHP 8.3+ syntax**
 - 📦 Simplifies installation of all core packages in one step
 - 🧱 Provides a solid foundation for building scalable PHP applications
 
diff --git a/composer.json b/composer.json
@@ -15,21 +15,17 @@
         "source": "https://github.com/php-fast-forward/framework"
     },
     "require": {
-        "php": "^8.2",
+        "php": "^8.3",
         "fast-forward/config": "^1.4",
         "fast-forward/container": "^1.5",
+        "fast-forward/defer": "^1.0",
         "fast-forward/http": "^1.0",
         "fast-forward/iterators": "^1.0"
     },
-    "minimum-stability": "stable",
-    "config": {
-        "sort-packages": true
-    },
-    "extra": {
-        "branch-alias": {
-            "dev-main": "1.x-dev"
-        }
+    "require-dev": {
+        "fast-forward/dev-tools": "dev-main"
     },
+    "minimum-stability": "stable",
     "autoload": {
         "psr-4": {
             "FastForward\\Framework\\": "src/"
@@ -40,21 +36,28 @@
             "FastForward\\Framework\\Tests\\": "tests/"
         }
     },
-    "scripts": {
-        "cs-check": "PHP_CS_FIXER_IGNORE_ENV=1 php-cs-fixer fix --dry-run --diff",
-        "cs-fix": "PHP_CS_FIXER_IGNORE_ENV=1 php-cs-fixer fix",
-        "mutation-testing": "infection --threads=4",
-        "pre-commit": [
-            "@cs-check",
-            "@static-analysis",
-            "@tests"
-        ],
-        "static-analysis": "phpstan analyse --level 5 src",
-        "tests": "phpunit --testdox"
+    "config": {
+        "allow-plugins": {
+            "ergebnis/composer-normalize": true,
+            "fast-forward/dev-tools": true,
+            "phpdocumentor/shim": true,
+            "phpro/grumphp": true
+        },
+        "platform": {
+            "php": "8.3.0"
+        },
+        "sort-packages": true
     },
-    "require-dev": {
-        "coisa/php-cs-fixer": "^2.1",
-        "phpspec/prophecy-phpunit": "^2.4",
-        "phpunit/phpunit": "^12.3"
+    "extra": {
+        "branch-alias": {
+            "dev-main": "1.x-dev"
+        },
+        "grumphp": {
+            "config-default-path": "vendor/fast-forward/dev-tools/grumphp.yml"
+        }
+    },
+    "scripts": {
+        "dev-tools": "dev-tools",
+        "dev-tools:fix": "@dev-tools --fix"
     }
 }
diff --git a/docs/advanced/index.rst b/docs/advanced/index.rst
@@ -0,0 +1,9 @@
+Advanced
+========
+
+Advanced topics for extending and integrating the Fast Forward Framework.
+
+.. toctree::
+   :maxdepth: 1
+
+   integration
diff --git a/docs/advanced/integration.rst b/docs/advanced/integration.rst
@@ -0,0 +1,4 @@
+Integration
+===========
+
+The Fast Forward Framework is designed to integrate seamlessly with other PSR-compliant packages and libraries. You can add or override service providers as needed to customize your application's infrastructure.
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -0,0 +1,9 @@
+API Reference
+============
+
+This section documents the main classes and interfaces provided by the Fast Forward Framework.
+
+.. toctree::
+   :maxdepth: 1
+
+   service-provider
diff --git a/docs/api/service-provider.rst b/docs/api/service-provider.rst
@@ -0,0 +1,27 @@
+FrameworkServiceProvider
+========================
+
+.. php:class:: FastForward\Framework\ServiceProvider\FrameworkServiceProvider
+
+   Aggregates all core service providers required to initialize the application container.
+
+   **Usage:**
+
+   .. code-block:: php
+
+      use FastForward\Framework\ServiceProvider\FrameworkServiceProvider;
+      use FastForward\Container\Container;
+
+      $container = new Container([
+          new FrameworkServiceProvider(),
+      ]);
+
+   **Constructor:**
+
+   .. php:method:: __construct()
+
+      Initializes the aggregate service provider with all essential framework service providers (e.g., HTTP, logging, caching, etc.).
+
+   **Extends:**
+
+   - :php:class:`FastForward\Container\ServiceProvider\AggregateServiceProvider`
diff --git a/docs/faq.rst b/docs/faq.rst
@@ -0,0 +1,17 @@
+FAQ
+===
+
+Frequently Asked Questions
+-------------------------
+
+**Q: What is the Fast Forward Framework?**
+A: It is a lightweight, modern PHP framework that aggregates all core components of the Fast Forward ecosystem for easy installation and management.
+
+**Q: What PHP version is required?**
+A: PHP 8.3 or higher.
+
+**Q: How do I install it?**
+A: Run ``composer require fast-forward/framework``.
+
+**Q: Can I use my own service providers?**
+A: Yes, you can add or override service providers as needed.
diff --git a/docs/getting-started/index.rst b/docs/getting-started/index.rst
@@ -0,0 +1,12 @@
+Getting Started
+==============
+
+Welcome to the Fast Forward Framework!
+
+This section will guide you through the installation and initial setup of the framework.
+
+.. toctree::
+   :maxdepth: 1
+
+   installation
+   quickstart
diff --git a/docs/getting-started/installation.rst b/docs/getting-started/installation.rst
@@ -0,0 +1,16 @@
+Installation
+============
+
+To install the Fast Forward Framework, use Composer:
+
+.. code-block:: bash
+
+   composer require fast-forward/framework
+
+This command will automatically pull in all required dependencies.
+
+Requirements
+------------
+
+- PHP 8.3 or higher
+- Composer
diff --git a/docs/getting-started/quickstart.rst b/docs/getting-started/quickstart.rst
@@ -0,0 +1,15 @@
+Quickstart
+==========
+
+After installing the framework, you can start building your application by registering the `FrameworkServiceProvider` in your container:
+
+.. code-block:: php
+
+   use FastForward\Framework\ServiceProvider\FrameworkServiceProvider;
+   use FastForward\Container\Container;
+
+   $container = new Container([
+       new FrameworkServiceProvider(),
+   ]);
+
+This will aggregate all core service providers and initialize your application infrastructure.
diff --git a/docs/index.rst b/docs/index.rst
@@ -0,0 +1,25 @@
+.. FastForward Framework documentation master file
+   See https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-toctree
+
+Documentation
+=============
+
+**Fast Forward Framework** is an aggregate metapackage that bundles all core components of the Fast Forward ecosystem, providing a solid foundation for building scalable PHP applications. It simplifies the installation and management of all essential packages in one step.
+
+Useful Links:
+-------------
+
+- `GitHub Repository <https://github.com/php-fast-forward/framework>`_
+- `Coverage Report <../public/coverage/index.html>`_
+- `API Reference (README) <https://github.com/php-fast-forward/framework#readme>`_
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   getting-started/index
+   usage/index
+   advanced/index
+   api/index
+   links/index
+   faq
diff --git a/docs/links/dependencies.rst b/docs/links/dependencies.rst
@@ -0,0 +1,21 @@
+Dependencies Documentation
+=========================
+
+Below are the main dependencies aggregated by the Fast Forward Framework, with links to their documentation:
+
+- `fast-forward/http <https://github.com/php-fast-forward/http>`_
+  - `Documentation <https://php-fast-forward.github.io/http/>`_
+- `fast-forward/http-factory <https://github.com/php-fast-forward/http-factory>`_
+  - `Documentation <https://php-fast-forward.github.io/http-factory/>`_
+- `fast-forward/http-message <https://github.com/php-fast-forward/http-message>`_
+  - `Documentation <https://php-fast-forward.github.io/http-message/>`_
+- `fast-forward/http-client <https://github.com/php-fast-forward/http-client>`_
+  - `Documentation <https://php-fast-forward.github.io/http-client/>`_
+- `fast-forward/config <https://github.com/php-fast-forward/config>`_
+  - `Documentation <https://php-fast-forward.github.io/config/>`_
+- `fast-forward/container <https://github.com/php-fast-forward/container>`_
+  - `Documentation <https://php-fast-forward.github.io/container/>`_
+- `fast-forward/defer <https://github.com/php-fast-forward/defer>`_
+  - `Documentation <https://php-fast-forward.github.io/defer/>`_
+- `fast-forward/iterators <https://github.com/php-fast-forward/iterators>`_
+  - `Documentation <https://php-fast-forward.github.io/iterators/>`_
diff --git a/docs/links/index.rst b/docs/links/index.rst
@@ -0,0 +1,13 @@
+Links
+=====
+
+- `GitHub Repository <https://github.com/php-fast-forward/framework>`_
+- `Coverage Report <https://php-fast-forward.github.io/framework/coverage/index.html>`_
+- `Testdox Report <https://php-fast-forward.github.io/framework/coverage/testdox.html>`_
+- `API Reference (README) <https://github.com/php-fast-forward/framework#readme>`_
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Dependencies
+
+   dependencies
diff --git a/docs/usage/getting-services.rst b/docs/usage/getting-services.rst
diff --git a/docs/usage/index.rst b/docs/usage/index.rst
diff --git a/docs/usage/use-cases.rst b/docs/usage/use-cases.rst
diff --git a/grumphp.yml b/grumphp.yml
diff --git a/phpunit.xml b/phpunit.xml
diff --git a/src/ServiceProvider/FrameworkServiceProvider.php b/src/ServiceProvider/FrameworkServiceProvider.php
diff --git a/tests/ServiceProvider/FrameworkServiceProviderTest.php b/tests/ServiceProvider/FrameworkServiceProviderTest.php

-Original file line number
+Diff line change
@@ @@ -1,5 +1,7 @@ @@
 .idea/
 +.vscode/
 public/
 +tmp/
 vendor/
 composer.lock
 *.cache
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+[submodule ".github/wiki"]`
	`2`	`+ path = .github/wiki`
	`3`	`+ url = git@github.com:php-fast-forward/framework.wiki.git`