GpsLab\Component\Sitemap\Stream\RenderIndexFileStream

Complexity

Total Complexity

12

Size/Duplication

Total Lines	124
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

95.12%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	getFilename()	0	4	1
A	open()	0	6	1
A	close()	0	8	1
A	push()	0	13	3
A	addSubStreamFileToIndex()	0	20	4
A	getIndexPartFilename()	0	10	1

<?php
declare(strict_types=1);

/**
 * GpsLab component.
 *
 * @author    Peter Gribanov <info@peter-gribanov.ru>
 * @copyright Copyright (c) 2011, Peter Gribanov
 * @license   http://opensource.org/licenses/MIT
 */

namespace GpsLab\Component\Sitemap\Stream;

use GpsLab\Component\Sitemap\Render\SitemapIndexRender;
use GpsLab\Component\Sitemap\Stream\Exception\IndexStreamException;
use GpsLab\Component\Sitemap\Stream\Exception\OverflowException;
use GpsLab\Component\Sitemap\Stream\Exception\StreamStateException;
use GpsLab\Component\Sitemap\Stream\State\StreamState;
use GpsLab\Component\Sitemap\Url\Url;

class RenderIndexFileStream implements FileStream
{
    /**
     * @var SitemapIndexRender
     */
    private $render;

    /**
     * @var FileStream
     */
    private $substream;

    /**
     * @var StreamState
     */
    private $state;

    /**
     * @var string
     */
    private $filename = '';

    /**
     * @var int
     */
    private $index = 0;

    /**
     * @var string
     */
    private $buffer = '';

    /**
     * @param SitemapIndexRender $render
     * @param FileStream         $substream
     * @param string             $filename
     */
    public function __construct(SitemapIndexRender $render, FileStream $substream, string $filename)
    {
        $this->render = $render;
        $this->substream = $substream;
        $this->filename = $filename;
        $this->state = new StreamState();
    }

    /**
     * @return string
     */
    public function getFilename(): string
    {
        return $this->filename;
    }

    public function open(): void
    {
        $this->state->open();
        $this->substream->open();
        $this->buffer = $this->render->start();
    }

    public function close(): void
    {
        $this->state->close();
        $this->addSubStreamFileToIndex();

        file_put_contents($this->filename, $this->buffer.$this->render->end());
        $this->buffer = '';
    }

    /**
     * @param Url $url
     */
    public function push(Url $url): void
    {
        if (!$this->state->isReady()) {
            throw StreamStateException::notReady();
        }

        try {
            $this->substream->push($url);
        } catch (OverflowException $e) {
            $this->addSubStreamFileToIndex();
            $this->substream->open();
        }
    }

    private function addSubStreamFileToIndex(): void
    {
        $this->substream->close();

        $filename = $this->substream->getFilename();
        $indexed_filename = $this->getIndexPartFilename($filename, ++$this->index);

        if (!is_file($filename) || !($time = filemtime($filename))) {
            throw IndexStreamException::undefinedSubstreamFile($filename);
        }

        $last_mod = (new \DateTimeImmutable())->setTimestamp($time);

        // rename sitemap file to the index part file
        if (!rename($filename, dirname($filename).'/'.$indexed_filename)) {
            throw IndexStreamException::failedRename($filename, dirname($filename).'/'.$indexed_filename);
        }

        $this->buffer .= $this->render->sitemap($indexed_filename, $last_mod);

It seems like $last_mod defined by (new \DateTimeImmutable())->setTimestamp($time) on line 118 can also be of type false; however, GpsLab\Component\Sitemap\Render\SitemapIndexRender::sitemap() does only seem to accept null|object<DateTimeInterface>, did you maybe forget to handle an error condition?

    }

    /**
     * @param string $filename
     * @param int    $index
     *
     * @return string
     */
    private function getIndexPartFilename(string $filename, int $index): string
    {
        // use explode() for correct add index
        // sitemap.xml -> sitemap1.xml
        // sitemap.xml.gz -> sitemap1.xml.gz

        list($filename, $extension) = explode('.', basename($filename), 2);

        return sprintf('%s%s.%s', $filename, $index, $extension);
    }
}