php-path/src/AbstractPath.php

<?php

declare(strict_types=1);

namespace Arokettu\Path;

use Arokettu\Path\Helpers\DataTypeHelper;

/**
 * @internal
 */
abstract class AbstractPath implements PathInterface
{
    protected string $prefix;
    protected \SplDoublyLinkedList $components;

    abstract protected function parsePath(string $path, bool $strict): void;

    public function __construct(string $path, bool $strict = false)
    {
        $this->parsePath($path, $strict);
    }

    /**
     * @param RelativePathInterface|string $path
     * @return static
     */
    public function resolveRelative($path, bool $strict = false): self
    {
        if (\is_string($path)) {
            $path = $this->buildRelative($path);
        }

        return $this->doResolveRelative($path, $strict);
    }

    protected function buildRelative(string $path): RelativePath
    {
        return new RelativePath($path);
    }

    /**
     * @return static
     */
    protected function doResolveRelative(RelativePathInterface $path, bool $strict): self
    {
        if ($path instanceof RelativePath) {
            // optimize
            $relativeComponents = $path->components;
        } else {
            // allow external implementations
            $relativeComponents = $path->getComponents();
            if (!array_is_list($relativeComponents)) {
                throw new \InvalidArgumentException(
                    'Poor RelativePathInterface implementation: getComponents() must return a list'
                );
            }
        }

        if ($path->isRoot()) {
            $newPath = clone $this;
            $newPath->components = DataTypeHelper::iterableToNewListInstance($relativeComponents);

            return $newPath;
        }

        $components = clone $this->components;

        $numComponents = \count($relativeComponents);
        for ($i = 0; $i < $numComponents; $i++) {
            if ($relativeComponents[$i] === '.') {
                continue;
            }

            if (
                $relativeComponents[$i] === '..' &&
                !$components->isEmpty() &&
                $components->top() !== '..' &&
                $components->top() !== '.'
            ) {
                $components->pop();
                continue;
            }

            $components->push($relativeComponents[$i]);
        }

        $newPath = clone $this;
        $newPath->components = $this->normalizeHead($components, $strict);

        return $newPath;
    }

    protected function normalize(array $components): \SplDoublyLinkedList
    {
        $componentsList = new \SplDoublyLinkedList();

        $prevComponent = null;
        foreach ($components as $component) {
            if ($component === '.' || $component === '') {
                continue;
            }

            if (
                $component === '..' &&
                $prevComponent !== '..' && $prevComponent !== null && // leading ..'s
                $componentsList->count() > 0 // beginning of the list
            ) {
                $componentsList->pop();
                continue;
            }

            $componentsList->push($component);
            $prevComponent = $component;
        }

        return $componentsList;
    }

    protected function normalizeHead(\SplDoublyLinkedList $components, bool $strict): \SplDoublyLinkedList
    {
        while (!$components->isEmpty()) {
            if ($components[0] === '.') {
                $components->shift();
                continue;
            }

            if ($components[0] === '..') {
                if ($strict) {
                    throw new \InvalidArgumentException('Relative path went beyond root');
                }

                $components->shift();
                continue;
            }

            break;
        }

        return $components;
    }

    public function toString(): string
    {
        return $this->prefix . \iter\join('/', $this->components);
    }

    public function __toString(): string
    {
        return $this->toString();
    }

    public function getPrefix(): string
    {
        return $this->prefix;
    }

    public function getComponents(): array
    {
        return iterator_to_array($this->components, false);
    }
}