Updated the way we calculate selector logic

Author: paquettg

CHANGELOG.md

@@ -5,9 +5,6 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-### Changed
-- Added tag attribute DTO.
-
 ## [Unreleased]
 
 ### Added
@@ -17,7 +14,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 - Fixed issue with \ causing an infite loop.
 - CDATA should not be altered when cleanupInput is false.
-
+- Added tag attribute DTO.
+- Cleaned up the selector logic.
 
 ### Removed
 - Removed curl interface and curl implementation.

src/PHPHtmlParser/Contracts/Selector/ParserInterface.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PHPHtmlParser\Contracts\Selector;
+
+use PHPHtmlParser\DTO\Selector\ParsedSelectorCollectionDTO;
+
+interface ParserInterface
+{
+    public function parseSelectorString(string $selector): ParsedSelectorCollectionDTO;
+}

src/PHPHtmlParser/Contracts/Selector/SeekerInterface.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace PHPHtmlParser\Contracts\Selector;
+
+use PHPHtmlParser\DTO\Selector\RuleDTO;
+use PHPHtmlParser\Exceptions\ChildNotFoundException;
+
+interface SeekerInterface
+{
+    /**
+     * Attempts to find all children that match the rule
+     * given.
+     *
+     * @throws ChildNotFoundException
+     */
+    public function seek(array $nodes, RuleDTO $rule, array $options, bool $depthFirst): array;
+}

src/PHPHtmlParser/Contracts/Selector/SelectorInterface.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PHPHtmlParser\Contracts\Selector;
+
+use PHPHtmlParser\Dom\AbstractNode;
+use PHPHtmlParser\Dom\Collection;
+use PHPHtmlParser\DTO\Selector\ParsedSelectorCollectionDTO;
+use PHPHtmlParser\Exceptions\ChildNotFoundException;
+
+interface SelectorInterface
+{
+    /**
+     * Constructs with the selector string.
+     */
+    public function __construct(string $selector, ?ParserInterface $parser = null, ?SeekerInterface $seeker = null);
+
+    /**
+     * Returns the selectors that where found.
+     */
+    public function getParsedSelectorCollectionDTO(): ParsedSelectorCollectionDTO;
+
+    public function setDepthFirstFind(bool $status): void;
+
+    /**
+     * Attempts to find the selectors starting from the given
+     * node object.
+     *
+     * @throws ChildNotFoundException
+     */
+    public function find(AbstractNode $node): Collection;
+}

src/PHPHtmlParser/DTO/Selector/ParsedSelectorCollectionDTO.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PHPHtmlParser\DTO\Selector;
+
+final class ParsedSelectorCollectionDTO
+{
+    /**
+     * @var ParsedSelectorDTO[]
+     */
+    private $parsedSelectorDTO = [];
+
+    public function __construct(array $values)
+    {
+        foreach ($values as $value) {
+            if ($value instanceof ParsedSelectorDTO) {
+                $this->parsedSelectorDTO[] = $value;
+            }
+        }
+    }
+
+    /**
+     * @return ParsedSelectorDTO[]
+     */
+    public function getParsedSelectorDTO(): array
+    {
+        return $this->parsedSelectorDTO;
+    }
+}

src/PHPHtmlParser/DTO/Selector/ParsedSelectorDTO.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PHPHtmlParser\DTO\Selector;
+
+final class ParsedSelectorDTO
+{
+    /**
+     * @var RuleDTO[]
+     */
+    private $rules = [];
+
+    public function __construct(array $values)
+    {
+        foreach ($values as $value) {
+            if ($value instanceof RuleDTO) {
+                $this->rules[] = $value;
+            }
+        }
+    }
+
+    /**
+     * @return RuleDTO[]
+     */
+    public function getRules(): array
+    {
+        return $this->rules;
+    }
+}

src/PHPHtmlParser/DTO/Selector/RuleDTO.php

@@ -0,0 +1,96 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PHPHtmlParser\DTO\Selector;
+
+final class RuleDTO
+{
+    /**
+     * @var string
+     */
+    private $tag;
+
+    /**
+     * @var string
+     */
+    private $operator;
+
+    /**
+     * @var string|array|null
+     */
+    private $key;
+
+    /**
+     * @var string|array|null
+     */
+    private $value;
+
+    /**
+     * @var bool
+     */
+    private $noKey;
+
+    /**
+     * @var bool
+     */
+    private $alterNext;
+
+    public function __construct(array $values)
+    {
+        $this->tag = $values['tag'];
+        $this->operator = $values['operator'];
+        $this->key = $values['key'];
+        $this->value = $values['value'];
+        $this->noKey = $values['noKey'];
+        $this->alterNext = $values['alterNext'];
+    }
+
+    /**
+     * @return string
+     */
+    public function getTag(): string
+    {
+        return $this->tag;
+    }
+
+    /**
+     * @return string
+     */
+    public function getOperator(): string
+    {
+        return $this->operator;
+    }
+
+    /**
+     * @return string|array|null
+     */
+    public function getKey()
+    {
+        return $this->key;
+    }
+
+    /**
+     * @return string|array|null
+     */
+    public function getValue()
+    {
+        return $this->value;
+    }
+
+    /**
+     * @return bool
+     */
+    public function isNoKey(): bool
+    {
+        return $this->noKey;
+    }
+
+    /**
+     * @return bool
+     */
+    public function isAlterNext(): bool
+    {
+        return $this->alterNext;
+    }
+}

src/PHPHtmlParser/DTO/Tag/AttributeDTO.php

@@ -7,17 +7,17 @@
 use stringEncode\Encode;
 use stringEncode\Exception;
 
-class AttributeDTO
+final class AttributeDTO
 {
     /**
      * @var ?string
      */
-    protected $value;
+    private $value;
 
     /**
      * @var bool
      */
-    protected $doubleQuote = true;
+    private $doubleQuote = true;
 
     public function __construct(array $values)
     {

src/PHPHtmlParser/Discovery/ParserDiscovery.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PHPHtmlParser\Discovery;
+
+use PHPHtmlParser\Contracts\Selector\ParserInterface;
+use PHPHtmlParser\Selector\Parser;
+
+class ParserDiscovery
+{
+    /**
+     * @var ParserInterface|null
+     */
+    private static $parser = null;
+
+    public static function find(): ParserInterface
+    {
+        if (self::$parser == null) {
+            self::$parser = new Parser();
+        }
+
+        return self::$parser;
+    }
+}

src/PHPHtmlParser/Discovery/SeekerDiscovery.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PHPHtmlParser\Discovery;
+
+use PHPHtmlParser\Contracts\Selector\SeekerInterface;
+use PHPHtmlParser\Selector\Seeker;
+
+class SeekerDiscovery
+{
+    /**
+     * @var SeekerInterface|null
+     */
+    private static $seeker = null;
+
+    public static function find(): SeekerInterface
+    {
+        if (self::$seeker == null) {
+            self::$seeker = new Seeker();
+        }
+
+        return self::$seeker;
+    }
+}