Merge pull request #420 from wayofdev/fix/infection

Author: lotyp

.github/assets/deptrac.svg

@@ -225,6 +225,28 @@ Check full instructions in [docker-shared-services](https://github.com/wayofdev/
 
 <br>
 
+## 🧰 Project Architecture
+
+The project architecture of `wayofdev/laravel-starter-tpl` follows a structured approach with distinct layers:
+
+* **Domain:** Contains core business logic and entities.
+* **Bridge:** Connects the domain layer with external systems or services.
+* **Infrastructure:** Handles interactions with external systems, such as databases, APIs, or file systems.
+* **Support:** Provides general-purpose helper classes that assist various parts of the application.
+* **DatabaseSeeders:** Handles database seeding logic.
+* **DatabaseFactories:** Manages database factory definitions.
+* **Tests:** Contains test cases for various layers of the application.
+
+Each layer has defined dependencies, ensuring a clear separation of concerns and facilitating maintainability and scalability.
+
+For more information check [deptrac.yaml](https://github.com/wayofdev/laravel-starter-tpl/blob/develop/app/deptrac.yaml) located in repository `app` folder.
+
+### → Architecture Diagram
+
+![Architecture Diagram](.github/assets/deptrac.svg)
+
+<br>
+
 ## 🤖 Deployment to Staging and Production
 
 This repository utilizes GitHub Actions for continuous deployment to both staging and production servers. Below is a description.

README.md

@@ -75,6 +75,7 @@
             "Database\\Factories\\": "database/factories/",
             "Database\\Seeders\\": "database/seeders/",
             "Domain\\": "src/Domain/",
+            "Infrastructure\\": "src/Infrastructure/",
             "Support\\": "src/Support/"
         }
     },

app/composer.json

@@ -21,6 +21,11 @@ deptrac:
         - type: directory
           value: src/Bridge/.*
 
+    - name: Infrastructure
+      collectors:
+        - type: directory
+          value: src/Infrastructure/.*
+
     - name: Support
       collectors:
         - type: directory
@@ -45,9 +50,12 @@ deptrac:
     Domain: ~
     Bridge:
       - Domain
+      - Infrastructure
       - Support
-    Support:
+    Infrastructure:
       - Domain
+      - Support
+    Support:
     DatabaseSeeders:
       - DatabaseFactories
       - Domain
@@ -56,6 +64,7 @@ deptrac:
     Tests:
       - Domain
       - Bridge
+      - Infrastructure
       - Support
       - DatabaseSeeders
       - DatabaseFactories

app/deptrac.yaml

@@ -196,7 +196,7 @@
       <code><![CDATA[$hidden]]></code>
     </NonInvariantDocblockPropertyType>
   </file>
-  <file src="src/Support/Filters/FuzzyFilter.php">
+  <file src="src/Infrastructure/Filters/FuzzyFilter.php">
     <MixedAssignment>
       <code><![CDATA[$item]]></code>
     </MixedAssignment>
@@ -250,4 +250,9 @@
       <code><![CDATA[make]]></code>
     </MixedMethodCall>
   </file>
+  <file src="tests/src/Functional/Support/StringUtilsTest.php">
+    <PossiblyUnusedMethod>
+      <code><![CDATA[it_converts_string]]></code>
+    </PossiblyUnusedMethod>
+  </file>
 </files>

app/psalm-baseline.xml

@@ -6,9 +6,9 @@
 
 use Domain\Category\Models\Category;
 use Illuminate\Http\Request;
+use Infrastructure\Filters\FuzzyFilter;
 use Spatie\QueryBuilder\AllowedFilter;
 use Spatie\QueryBuilder\QueryBuilder;
-use Support\Filters\FuzzyFilter;
 
 final class IndexQuery extends QueryBuilder
 {

app/src/Bridge/Laravel/Public/Category/Queries/IndexQuery.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Support\Filters;
+namespace Infrastructure\Filters;
 
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Model;

app/src/Support/Filters/FuzzyFilter.php renamed to app/src/Infrastructure/Filters/FuzzyFilter.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Support;
+
+/**
+ * This is a stub class, just to show purpose of Support layer.
+ */
+final class StringUtils
+{
+    public static function toTitleCase(string $str): string
+    {
+        return ucwords(strtolower($str));
+    }
+}

app/src/Support/StringUtils.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Functional\Support;
+
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+use Support\StringUtils;
+
+class StringUtilsTest extends TestCase
+{
+    #[Test]
+    public function it_converts_string(): void
+    {
+        $input = 'hello world';
+        $expectedOutput = 'Hello World';
+
+        $actualOutput = StringUtils::toTitleCase($input);
+
+        self::assertSame($expectedOutput, $actualOutput);
+    }
+}