FilesystemQueue::remove() - Code Metrics - Inspection of "- queue method offer() return bool" - initx/querabilis - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e9000a...3a63a2 )

by Damian

created 2019-05-30 21:01 UTC

FilesystemQueue::remove() A

↳ Parent: FilesystemQueue

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2

Importance

Changes

Metric	Value
eloc	3
dl	0
loc	7
ccs	4
cts	4
cp	1
rs	10
c	0
b	0
f	0
cc	2
nc	2
nop	0
crap	2

<?php declare(strict_types=1);

namespace Initx\Driver;

use Initx\Envelope;
use Initx\Exception\IllegalStateException;
use Initx\Exception\NoSuchElementException;
use Initx\Queue;
use JMS\Serializer\SerializerBuilder;
use JMS\Serializer\SerializerInterface;
use Throwable;

final class FilesystemQueue implements Queue
{
    use HasFallbackSerializer;

    /**
     * @var string
     */
    private $path;

    /**
     * @var SerializerInterface
     */
    private $serializer;

    public function __construct(string $path, SerializerInterface $serializer = null)
    {
        $this->serializer = $serializer;
        $this->path = $path;
        $this->fallbackSerializer();
    }

    /**
     * Inserts an element if possible, otherwise throwing exception.
     *
     * @param Envelope $envelope
     * @return void
     * @throws IllegalStateException
     */
    public function add(Envelope $envelope): void
    {
        if (!$this->offer($envelope)) {
            throw IllegalStateException::create("Could not write to {$this->path}");
        }
    }

    /**
     * Inserts an element if possible.
     *
     * @param Envelope $envelope
     * @return void
     */
    public function offer(Envelope $envelope): bool
    {
        $content = $this->serializer->serialize($envelope, 'json').PHP_EOL;
        try {
            $result = (bool)file_put_contents(
                $this->path,
                $content,
                FILE_APPEND
            );
        } catch (Throwable $exception) {
            $result = false;
        }

        return $result;

    }

    /**
     * Remove and return head of queue, otherwise throwing exception.
     *
     * @return Envelope
     * @throws NoSuchElementException | IllegalStateException
     */
    public function remove(): Envelope
    {
        if (!$envelope = $this->poll()) {
            throw new NoSuchElementException('Queue empty');
        }

        return $envelope;
    }

    private function removeFirstLine(): ?string
    {
        if (!file_exists($this->path)) {
            throw new IllegalStateException("File $this->path not exists");
        }
        $firstLine = null;
        if ($handle = fopen($this->path, 'cb+')) {
            if (!flock($handle, LOCK_EX)) {
                fclose($handle);
            }
            $offset = 0;
            $len = filesize($this->path);
            while (($line = fgets($handle, 4096)) !== false) {
                if (!$firstLine) {
                    $firstLine = $line;
                    $offset = strlen($firstLine);
                    continue;
                }
                $pos = ftell($handle);
                fseek($handle, $pos - strlen($line) - $offset);
                fwrite($handle, $line);
                fseek($handle, $pos);
            }
            fflush($handle);
            ftruncate($handle, $len - $offset);
            flock($handle, LOCK_UN);
            fclose($handle);
        }

        return $firstLine;
    }

    private function readFirstLine(): ?string
    {
        if (!file_exists($this->path)) {
            throw new IllegalStateException("File $this->path not exists");
        }

        $firstLine = fgets(fopen($this->path, 'rb'));
        $firstLine = fgets(/** @scrutinizer ignore-type */ fopen($this->path, 'rb'));

        return $firstLine ?: null;
    }

    /**
     * Remove and return head of queue, otherwise returning null.
     *
     * @return Envelope | null
     * @throws IllegalStateException
     */
    public function poll(): ?Envelope
    {
        $firstLine = $this->removeFirstLine();

        if (!$firstLine) {
            return null;
        }

        return $this->serializer->deserialize($firstLine, Envelope::class, 'json');
    }

    /**
     * Return but do not remove head of queue, otherwise throwing exception.
     *
     * @return Envelope
     * @throws NoSuchElementException | IllegalStateException
     */
    public function element(): Envelope
    {
        if (!$envelope = $this->peek()) {
            throw new NoSuchElementException('Queue empty');
        }

        return $envelope;
    }

    /**
     * Return but do not remove head of queue, otherwise returning null.
     *
     * @return Envelope | null
     * @throws IllegalStateException
     */
    public function peek(): ?Envelope
    {
        $firstLine = $this->readFirstLine();

        if (!$firstLine) {
            return null;
        }

        return $this->serializer->deserialize($firstLine, Envelope::class, 'json');
    }
}


initx / querabilis

Push — master ( e9000a...3a63a2 )

FilesystemQueue::remove() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like