perf: runtime performance optmization

Author: iroybotlinio

.githooks/pre-commit.sh

@@ -188,10 +188,14 @@ fi
 printf "${YELLOW}Pest Unit Tests${NC}\n"
 if $HAS_PEST; then
     if RUN $PEST --testdox --colors=always; then
-      # All good, also re-generate clover.xml
-        $PEST --coverage --coverage-clover clover.xml
-        git add clover.xml
-        printf "${GREEN}Pest tests passed${NC}\n"
+      # All good, also re-generate clover.xml and stage it
+        if RUN env XDEBUG_MODE=coverage $PEST --coverage --coverage-clover clover.xml; then
+            git add clover.xml
+            printf "${GREEN}Pest tests passed; clover.xml updated${NC}\n"
+        else
+            printf "${RED}Pest coverage generation failed${NC}\n"
+            PASS=false
+        fi
     else
       PASS=false
     fi

README.md

@@ -170,13 +170,45 @@ echo $twig->render('index.twig', [
 ### XSLT
 You can use the XML data to transform it into HTML using XSLT.
 ```php
-$xml = (new DOM\ORM\Storage\StorageService())->read();
+$xml = DOM\ORM\Storage\StorageService::fromConfig()->read();
 $dom = (new DOMDocument())->loadXML($xml);
 $xslt = (new XSLTProcessor())->importStylesheet(DOMDocument::load('path/to/stylesheet.xsl'));
 
 echo $xslt->transformToXML($dom);
 ```
 
+## Testing And Coverage
+
+Run the full Pest test suite:
+
+```bash
+./vendor/bin/pest
+```
+
+Run Pest with a human-friendly output format:
+
+```bash
+./vendor/bin/pest --testdox
+```
+
+Generate an HTML coverage report (output directory: `build/coverage-html`):
+
+```bash
+XDEBUG_MODE=coverage ./vendor/bin/pest --coverage-html build/coverage-html
+```
+
+Update `clover.xml` (used by CI and quality tooling):
+
+```bash
+XDEBUG_MODE=coverage ./vendor/bin/pest --coverage-clover clover.xml
+```
+
+Generate both HTML coverage and a fresh `clover.xml` in one run:
+
+```bash
+XDEBUG_MODE=coverage ./vendor/bin/pest --coverage-html build/coverage-html --coverage-clover clover.xml
+```
+
 ### Roadmap
 
 - [ ] Add support for Many-to-many relationships using hash maps.

src/Repository/AbstractEntityRepository.php

@@ -11,11 +11,13 @@ abstract class AbstractEntityRepository implements EntityRepositoryInterface
     use EntityManagerTrait;
 
     private string $entityType;
+    private string $entityTypeXPathLiteral;
     private string $entityClass;
 
     public function __construct(string $entityType)
     {
         $this->entityType = $entityType;
+        $this->entityTypeXPathLiteral = $this->toXPathValue($entityType);
         $this->entityClass = $this->getEntityByEntityType($entityType);
         $this->init();
     }
@@ -30,7 +32,11 @@ public function getEntityType(): string
      */
     public function findAll(): ?Collection
     {
-        $nodes = $this->xpath->query(\sprintf('//item[@type="%s"]', $this->entityType));
+        $nodes = $this->queryNodes(\sprintf('//item[@type=%s]', $this->entityTypeXPathLiteral));
+        if ($nodes === null) {
+            return null;
+        }
+
         if ($nodes->length < 1) {
             return null;
         }
@@ -42,16 +48,24 @@ public function findAll(): ?Collection
 
     public function find(string $id): ?EntityInterface
     {
-        $node = $this->xpath->query(\sprintf('//item[@type="%s" and @id="%s"]', $this->entityType, $id));
-        if ($node->length > 1) {
+        $nodes = $this->queryNodes(\sprintf(
+            '//item[@type=%s and @id=%s]',
+            $this->entityTypeXPathLiteral,
+            $this->toXPathValue($id)
+        ));
+        if ($nodes === null) {
+            return null;
+        }
+
+        if ($nodes->length > 1) {
             throw new \Exception('Multiple entities found with the same ID.');
         }
 
-        if ($node->length < 1) {
+        if ($nodes->length < 1) {
             return null;
         }
 
-        $array = $this->serializer->decode($node, SchemaEncoder::FORMAT);
+        $array = $this->serializer->decode($nodes, SchemaEncoder::FORMAT);
 
         return $this->serializer->denormalize($array, $this->entityClass);
     }
@@ -72,18 +86,31 @@ public function findBy(array $criteria, ?array $orderBy = null, ?int $limit = nu
      */
     public function findOneBy(array $criteria, ?array $orderBy = null): ?EntityInterface
     {
-        $additionalArgs = '';
+        if (isset($criteria['id']) && \count($criteria) === 1) {
+            return $this->find((string)$criteria['id']);
+        }
+
+        $predicates = [\sprintf('@type=%s', $this->entityTypeXPathLiteral)];
         if (isset($criteria['id'])) {
-            $additionalArgs .= \sprintf(' and @id="%s" ', $criteria['id']);
+            $predicates[] = \sprintf('@id=%s', $this->toXPathValue((string)$criteria['id']));
             unset($criteria['id']);
         }
 
         foreach ($criteria as $key => $value) {
-            $additionalArgs .= \sprintf(' and ./fragment[@name="%s"] = "%s"', \trim($key), \trim((string)$value));
+            $predicates[] = \sprintf(
+                './fragment[@name=%s]=%s',
+                $this->toXPathValue($key),
+                $this->toXPathValue((string)$value)
+            );
+        }
+
+        $query = '//item[' . \implode(' and ', $predicates) . ']';
+        $nodes = $this->queryNodes($query);
+        if ($nodes === null) {
+            return null;
         }
 
-        $query = \sprintf('//item[@type="%s" %s]', $this->entityType, $additionalArgs);
-        $node = $this->xpath->query($query)->item(0);
+        $node = $nodes->item(0);
         if ($node === null) {
             return null;
         }
@@ -97,4 +124,39 @@ public function remove(string $id): void
     {
         $this->removeById($id);
     }
+
+    /**
+     * @return \DOMNodeList<\DOMNode>|null
+     */
+    private function queryNodes(string $query): ?\DOMNodeList
+    {
+        $nodes = $this->xpath->query($query);
+
+        return ($nodes === false) ? null : $nodes;
+    }
+
+    private function xpathLiteral(string $value): string
+    {
+        if (!\str_contains($value, "'")) {
+            return "'{$value}'";
+        }
+
+        if (!\str_contains($value, '"')) {
+            return '"' . $value . '"';
+        }
+
+        $parts = \explode("'", $value);
+        $quotedParts = \array_map(static fn (string $part): string => "'{$part}'", $parts);
+
+        return 'concat(' . \implode(', "\'", ', $quotedParts) . ')';
+    }
+
+    private function toXPathValue(string $value): string
+    {
+        if (!\str_contains($value, "'") && !\str_contains($value, '"')) {
+            return '"' . $value . '"';
+        }
+
+        return $this->xpathLiteral($value);
+    }
 }