Tubee\Resource\Factory

Complexity

Total Complexity

35

Size/Duplication

Total Lines	259
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

42.37%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	addTo()	0	27	2
A	updateIn()	0	39	4
A	deleteFrom()	0	14	2
A	getAllFrom()	0	28	4
C	watchFrom()	0	54	11
A	initResource()	0	8	1
A	prepareQuery()	0	20	4
A	calcOffset()	0	12	6

<?php

declare(strict_types=1);

/**
 * tubee.io
 *
 * @copyright   Copryright (c) 2017-2019 gyselroth GmbH (https://gyselroth.com)
 * @license     GPL-3.0 https://opensource.org/licenses/GPL-3.0
 */

namespace Tubee\Resource;

use Closure;
use Generator;
use MongoDB\BSON\ObjectId;
use MongoDB\BSON\ObjectIdInterface;
use MongoDB\BSON\UTCDateTime;
use MongoDB\Collection;
use MongoDB\Database;
use Psr\Log\LoggerInterface;

class Factory
{
    /**
     * Logger.
     *
     * @var LoggerInterface
     */
    protected $logger;

    /**
     * Database.
     *
     * @var Database
     */
    protected $db;

    /**
     * Initialize.
     */
    public function __construct(Database $db, LoggerInterface $logger)
    {
        $this->db = $db;
        $this->logger = $logger;
    }

    /**
     * Add resource.
     */
    public function addTo(Collection $collection, array $resource, bool $simulate = false): ObjectIdInterface
    {
        $ts = new UTCDateTime();
        $resource += [
            'created' => $ts,
            'changed' => $ts,
            'version' => 1,
        ];

        $this->logger->debug('add new resource to ['.$collection->getCollectionName().']', [
            'category' => get_class($this),
            'resource' => $resource,
        ]);

        if ($simulate === true) {
            return new ObjectId();
        }

        $result = $collection->insertOne($resource);
        $id = $result->getInsertedId();

        $this->logger->info('created new resource ['.$id.'] in ['.$collection->getCollectionName().']', [
            'category' => get_class($this),
        ]);

        return $id;
    }

    /**
     * Update resource.
     */
    public function updateIn(Collection $collection, ResourceInterface $resource, array $update, bool $simulate = false): bool
    {
        $this->logger->debug('update resource ['.$resource->getId().'] in ['.$collection->getCollectionName().']', [
            'category' => get_class($this),
            'update' => $update,
        ]);

        $op = [
            '$set' => $update,
        ];

        if (!isset($update['data']) || $resource->getData() === $update['data']) {
            $this->logger->info('resource ['.$resource->getId().'] version ['.$resource->getVersion().'] in ['.$collection->getCollectionName().'] is already up2date', [
                'category' => get_class($this),
            ]);
        } else {
            $this->logger->info('add new history record for resource ['.$resource->getId().'] in ['.$collection->getCollectionName().']', [
                'category' => get_class($this),
            ]);

            $op['$set']['changed'] = new UTCDateTime();
            $op += [
                '$addToSet' => ['history' => array_intersect_key($resource->toArray(), array_flip(['data', 'version', 'changed', 'description']))],
                '$inc' => ['version' => 1],
            ];
        }

        if ($simulate === true) {
            return true;
        }

        $result = $collection->updateOne(['_id' => $resource->getId()], $op);

$result is not used, you could remove the assignment.

        $this->logger->info('updated resource ['.$resource->getId().'] in ['.$collection->getCollectionName().']', [
            'category' => get_class($this),
        ]);

        return true;
    }

    /**
     * Delete resource.
     */
    public function deleteFrom(Collection $collection, ObjectIdInterface $id, bool $simulate = false): bool
    {
        $this->logger->info('delete resource ['.$id.'] from ['.$collection->getCollectionName().']', [
            'category' => get_class($this),
        ]);

        if ($simulate === true) {
            return true;
        }

        $result = $collection->deleteOne(['_id' => $id]);

$result is not used, you could remove the assignment.

        return true;
    }

    /**
     * Get all.
     */
    public function getAllFrom(Collection $collection, ?array $query = null, ?int $offset = null, ?int $limit = null, ?array $sort = null, ?Closure $build = null): Generator
    {
        if ($build === null) {
            $build = function ($resource) {
                return $this->build($resource);

It seems like you code against a specific sub-type and not the parent class Tubee\Resource\Factory as the method build() does only exist in the following sub-classes of Tubee\Resource\Factory: Tubee\AccessRole\Factory, Tubee\AccessRule\Factory, Tubee\Collection\Factory, Tubee\DataObjectRelation\Factory, Tubee\DataObject\Factory, Tubee\Endpoint\Factory, Tubee\Job\Factory, Tubee\Log\Factory, Tubee\Process\Factory, Tubee\ResourceNamespace\Factory, Tubee\Secret\Factory, Tubee\User\Factory, Tubee\Workflow\Factory. Maybe you want to instanceof check for one of these explicitly?

            };
        }

        $total = $collection->count($query);
        $offset = $this->calcOffset($total, $offset);

        if (empty($sort)) {
            $sort = ['$natural' => -1];
        }

        $result = $collection->find($query, [
            'projection' => ['history' => 0],
            'skip' => $offset,
            'limit' => $limit,
            'sort' => $sort,
        ]);

        foreach ($result as $resource) {
            yield (string) $resource['_id'] => $build->call($this, $resource);
        }

        return $total;
    }

    /**
     * Change stream.
     */
    public function watchFrom(Collection $collection, ?ObjectIdInterface $after = null, bool $existing = true, ?array $query = [], ?Closure $build = null, ?int $offset = null, ?int $limit = null, ?array $sort = null): Generator
    {
        if ($build === null) {
            $build = function ($resource) {
                return $this->build($resource);

It seems like you code against a specific sub-type and not the parent class Tubee\Resource\Factory as the method build() does only exist in the following sub-classes of Tubee\Resource\Factory: Tubee\AccessRole\Factory, Tubee\AccessRule\Factory, Tubee\Collection\Factory, Tubee\DataObjectRelation\Factory, Tubee\DataObject\Factory, Tubee\Endpoint\Factory, Tubee\Job\Factory, Tubee\Log\Factory, Tubee\Process\Factory, Tubee\ResourceNamespace\Factory, Tubee\Secret\Factory, Tubee\User\Factory, Tubee\Workflow\Factory. Maybe you want to instanceof check for one of these explicitly?

            };
        }

        $pipeline = $query;
        if (!empty($pipeline)) {
            $pipeline = [['$match' => $query]];
        }

        $stream = $collection->watch($pipeline, [
            'resumeAfter' => $after,
        ]);

        if ($existing === true) {
            $query = $this->prepareQuery($query);
            $total = $collection->count($query);

            if ($offset !== null && $total === 0) {
                $offset = null;
            } elseif ($offset < 0 && $total >= $offset * -1) {
                $offset = $total + $offset;
            }

            $result = $collection->find($query, [
                'projection' => ['history' => 0],
                'skip' => $offset,
                'limit' => $limit,
                'sort' => $sort,
            ]);

            foreach ($result as $resource) {
                yield (string) $resource['_id'] => [
                    'insert',
                    $build->call($this, $resource),
                ];
            }
        }

        for ($stream->rewind(); true; $stream->next()) {
            if (!$stream->valid()) {
                continue;
            }

            $event = $stream->current();
            yield (string) $event['fullDocument']['_id'] => [
                $event['operationType'],
                $build->call($this, $event['fullDocument']),
            ];
        }
    }

    /**
     * Build.
     */
    public function initResource(ResourceInterface $resource)
    {
        $this->logger->debug('initialized resource ['.$resource->getId().'] as ['.get_class($resource).']', [
            'category' => get_class($this),
        ]);

        return $resource;
    }

    /**
     * Remove fullDocument prefix from keys.
     */
    protected function prepareQuery(array $query): array
    {
        $filter = $query;
        if (isset($query['$and'])) {
            $query = $query['$and'][0];
        }

        $new = [];
        foreach ($query as $key => $value) {
            $new[substr($key, 13)] = $value;
        }

        if (isset($filter['$and'])) {
            $filter['$and'][0] = $new;

            return $filter;
        }

        return $new;
    }

    /**
     * Calculate offset.
     */
    protected function calcOffset(int $total, ?int $offset = null): ?int
    {
        if ($offset !== null && $total === 0) {
            $offset = 0;
        } elseif ($offset < 0 && $total >= $offset * -1) {
            $offset = $total + $offset;
        } elseif ($offset < 0) {
            $offset = 0;
        }

        return $offset;
    }
}