Jobs::getAllLogs() - Code Metrics - Inspection of "Merge pull request #21 from gyselroth/dev" - gyselroth/tubee - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 316baf...2178d1 )

by Raffael

created 2019-01-25 14:58 UTC

Jobs::getAllLogs() A

↳ Parent: Jobs

Complexity

Conditions	4
Paths	4

Size

Total Lines

Duplication

Lines	35
Ratio	100 %

Code Coverage

Tests	0
CRAP Score	20

Importance

Changes

Metric	Value
dl	35
loc	35
ccs	0
cts	27
cp	0
rs	9.36
c	0
b	0
f	0
cc	4
nc	4
nop	4
crap	20

<?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\Rest\v1;

use Fig\Http\Message\StatusCodeInterface;
use Lcobucci\ContentNegotiation\UnformattedResponse;
use Micro\Auth\Identity;
use MongoDB\BSON\ObjectIdInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Rs\Json\Patch;
use Tubee\Acl;
use Tubee\Job;
use Tubee\Job\Factory as JobFactory;
use Tubee\Log\Factory as LogFactory;
use Tubee\ResourceNamespace\Factory as ResourceNamespaceFactory;
use Tubee\Rest\Helper;
use Zend\Diactoros\Response;

class Jobs
{
    /**
     * namespace factory.
     *
     * @var ResourceNamespaceFactory
     */
    protected $namespace_factory;

    /**
     * Job factory.
     *
     * @var JobFactory
     */
    protected $job_factory;

    /**
     * Acl.
     *
     * @var Acl
     */
    protected $acl;

    /**
     * Log factory.
     *
     * @var LogFactory
     */
    protected $log_factory;

    /**
     * Init.
     */
    public function __construct(JobFactory $job_factory, Acl $acl, ResourceNamespaceFactory $namespace_factory, LogFactory $log_factory)
    {
        $this->job_factory = $job_factory;
        $this->acl = $acl;
        $this->namespace_factory = $namespace_factory;
        $this->log_factory = $log_factory;
    }

    /**
     * Entrypoint.
     */
    public function getAll(ServerRequestInterface $request, Identity $identity, string $namespace): ResponseInterface

    {
        $query = array_merge([
            'offset' => 0,
            'limit' => 20,
        ], $request->getQueryParams());

        $namespace = $this->namespace_factory->getOne($namespace);

        if (isset($query['watch'])) {
            $cursor = $this->job_factory->watch($namespace, null, true, $query['query'], (int) $query['offset'], (int) $query['limit'], $query['sort']);

            return Helper::watchAll($request, $identity, $this->acl, $cursor);
        }

        $jobs = $this->job_factory->getAll($namespace, $query['query'], $query['offset'], $query['limit'], $query['sort']);

        return Helper::getAll($request, $identity, $this->acl, $jobs);
    }

    /**
     * Entrypoint.
     */
    public function getOne(ServerRequestInterface $request, Identity $identity, string $namespace, string $job): ResponseInterface

    {
        $namespace = $this->namespace_factory->getOne($namespace);
        $resource = $this->job_factory->getOne($namespace, $job);

        return Helper::getOne($request, $identity, $resource);
    }

    /**
     * Delete job.
     */
    public function delete(ServerRequestInterface $request, Identity $identity, string $namespace, string $job): ResponseInterface

    {
        $namespace = $this->namespace_factory->getOne($namespace);
        $this->job_factory->deleteOne($namespace, $job);

        return (new Response())->withStatus(StatusCodeInterface::STATUS_NO_CONTENT);
    }

    /**
     * Add new job.
     */
    public function post(ServerRequestInterface $request, Identity $identity, string $namespace): ResponseInterface

    {
        $body = $request->getParsedBody();
        $query = $request->getQueryParams();
        $job = array_merge(['namespaces' => []], $body);

        $namespace = $this->namespace_factory->getOne($namespace);
        $this->job_factory->create($namespace, $job);

        return new UnformattedResponse(
            (new Response())->withStatus(StatusCodeInterface::STATUS_ACCEPTED),
            $this->job_factory->getOne($namespace, $job['name'])->decorate($request),
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            ['pretty' => isset($query['pretty'])]
        );
    }

    /**
     * Patch.
     */
    public function patch(ServerRequestInterface $request, Identity $identity, string $namespace, string $job): ResponseInterface

    {
        $body = $request->getParsedBody();
        $query = $request->getQueryParams();

        $namespace = $this->namespace_factory->getOne($namespace);
        $job = $this->job_factory->getOne($namespace, $job);
        $doc = ['data' => $job->getData()];

        $patch = new Patch(json_encode($doc), json_encode($body));
        $patched = $patch->apply();
        $update = json_decode($patched, true);
        $this->job_factory->update($job, $update);

        return new UnformattedResponse(
            (new Response())->withStatus(StatusCodeInterface::STATUS_OK),
            $this->job_factory->getOne($namespace, $job->getName())->decorate($request),
            ['pretty' => isset($query['pretty'])]
        );
    }

    /**
     * Entrypoint.
     */
    public function getAllLogs(ServerRequestInterface $request, Identity $identity, string $namespace, string $job): ResponseInterface

    {
        $query = array_merge([
            'offset' => 0,
            'limit' => 20,
        ], $request->getQueryParams());

        if (isset($query['watch'])) {
            $filter = [
                'fullDocument.context.namespace' => $namespace,
                'fullDocument.context.job' => $job,
            ];

            if (!empty($query['query'])) {
                $filter = ['$and' => [$filter, $query['query']]];
            }

            $logs = $this->log_factory->watch(null, true, $filter, (int) $query['offset'], (int) $query['limit'], $query['sort']);

            return Helper::watchAll($request, $identity, $this->acl, $logs);
        }

        $filter = [
            'context.namespace' => $namespace,
            'context.job' => $job,
        ];

        if (!empty($query['query'])) {
            $filter = ['$and' => [$filter, $query['query']]];
        }

        $logs = $this->log_factory->getAll($filter, (int) $query['offset'], (int) $query['limit'], $query['sort']);

        return Helper::getAll($request, $identity, $this->acl, $logs);
    }

    /**
     * Entrypoint.
     */
    public function getOneLog(ServerRequestInterface $request, Identity $identity, string $namespace, string $job, ObjectIdInterface $log): ResponseInterface

    {
        $resource = $this->log_factory->getOne($log);


        return Helper::getOne($request, $identity, $resource);
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		/**
6		* tubee.io
7		*
8		* @copyright Copryright (c) 2017-2019 gyselroth GmbH (https://gyselroth.com)
9		* @license GPL-3.0 https://opensource.org/licenses/GPL-3.0
10		*/
11
12		namespace Tubee\Rest\v1;
13
14		use Fig\Http\Message\StatusCodeInterface;
15		use Lcobucci\ContentNegotiation\UnformattedResponse;
16		use Micro\Auth\Identity;
17		use MongoDB\BSON\ObjectIdInterface;
18		use Psr\Http\Message\ResponseInterface;
19		use Psr\Http\Message\ServerRequestInterface;
20		use Rs\Json\Patch;
21		use Tubee\Acl;
22		use Tubee\Job;
23		use Tubee\Job\Factory as JobFactory;
24		use Tubee\Log\Factory as LogFactory;
25		use Tubee\ResourceNamespace\Factory as ResourceNamespaceFactory;
26		use Tubee\Rest\Helper;
27		use Zend\Diactoros\Response;
28
29		class Jobs
30		{
31		/**
32		* namespace factory.
33		*
34		* @var ResourceNamespaceFactory
35		*/
36		protected $namespace_factory;
37
38		/**
39		* Job factory.
40		*
41		* @var JobFactory
42		*/
43		protected $job_factory;
44
45		/**
46		* Acl.
47		*
48		* @var Acl
49		*/
50		protected $acl;
51
52		/**
53		* Log factory.
54		*
55		* @var LogFactory
56		*/
57		protected $log_factory;
58
59		/**
60		* Init.
61		*/
62		public function __construct(JobFactory $job_factory, Acl $acl, ResourceNamespaceFactory $namespace_factory, LogFactory $log_factory)
63		{
64		$this->job_factory = $job_factory;
65		$this->acl = $acl;
66		$this->namespace_factory = $namespace_factory;
67		$this->log_factory = $log_factory;
68		}
69
70		/**
71		* Entrypoint.
72		*/
73	View Code Duplication	public function getAll(ServerRequestInterface $request, Identity $identity, string $namespace): ResponseInterface
		0 ignored issues – show Duplication introduced 2018-10-11 15:02 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
74		{
75		$query = array_merge([
76		'offset' => 0,
77		'limit' => 20,
78		], $request->getQueryParams());
79
80		$namespace = $this->namespace_factory->getOne($namespace);
81
82		if (isset($query['watch'])) {
83		$cursor = $this->job_factory->watch($namespace, null, true, $query['query'], (int) $query['offset'], (int) $query['limit'], $query['sort']);
84
85		return Helper::watchAll($request, $identity, $this->acl, $cursor);
86		}
87
88		$jobs = $this->job_factory->getAll($namespace, $query['query'], $query['offset'], $query['limit'], $query['sort']);
89
90		return Helper::getAll($request, $identity, $this->acl, $jobs);
91		}
92
93		/**
94		* Entrypoint.
95		*/
96	View Code Duplication	public function getOne(ServerRequestInterface $request, Identity $identity, string $namespace, string $job): ResponseInterface
		0 ignored issues – show Duplication introduced 2019-01-14 11:29 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
97		{
98		$namespace = $this->namespace_factory->getOne($namespace);
99		$resource = $this->job_factory->getOne($namespace, $job);
100
101		return Helper::getOne($request, $identity, $resource);
102		}
103
104		/**
105		* Delete job.
106		*/
107	View Code Duplication	public function delete(ServerRequestInterface $request, Identity $identity, string $namespace, string $job): ResponseInterface
		0 ignored issues – show Unused Code introduced 2019-01-14 11:29 UTC by Report Bug Copy Issue Report The parameter `$request` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2018-11-26 15:35 UTC by Report Bug Copy Issue Report The parameter `$identity` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Duplication introduced 2019-01-14 11:29 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
108		{
109		$namespace = $this->namespace_factory->getOne($namespace);
110		$this->job_factory->deleteOne($namespace, $job);
111
112		return (new Response())->withStatus(StatusCodeInterface::STATUS_NO_CONTENT);
113		}
114
115		/**
116		* Add new job.
117		*/
118	View Code Duplication	public function post(ServerRequestInterface $request, Identity $identity, string $namespace): ResponseInterface
		0 ignored issues – show Unused Code introduced 2018-10-11 15:02 UTC by Report Bug Copy Issue Report The parameter `$identity` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Duplication introduced 2019-01-14 11:29 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
119		{
120		$body = $request->getParsedBody();
121		$query = $request->getQueryParams();
122		$job = array_merge(['namespaces' => []], $body);
123
124		$namespace = $this->namespace_factory->getOne($namespace);
125		$this->job_factory->create($namespace, $job);
126
127		return new UnformattedResponse(
128		(new Response())->withStatus(StatusCodeInterface::STATUS_ACCEPTED),
129		$this->job_factory->getOne($namespace, $job['name'])->decorate($request),
		0 ignored issues – show Documentation introduced 2019-01-14 11:29 UTC by Report Bug Copy Issue Report `$job['name']` is of type `array`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
130		['pretty' => isset($query['pretty'])]
131		);
132		}
133
134		/**
135		* Patch.
136		*/
137	View Code Duplication	public function patch(ServerRequestInterface $request, Identity $identity, string $namespace, string $job): ResponseInterface
		0 ignored issues – show Unused Code introduced 2019-01-14 11:29 UTC by Report Bug Copy Issue Report The parameter `$identity` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Duplication introduced 2018-11-26 15:35 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
138		{
139		$body = $request->getParsedBody();
140		$query = $request->getQueryParams();
141
142		$namespace = $this->namespace_factory->getOne($namespace);
143		$job = $this->job_factory->getOne($namespace, $job);
144		$doc = ['data' => $job->getData()];
145
146		$patch = new Patch(json_encode($doc), json_encode($body));
147		$patched = $patch->apply();
148		$update = json_decode($patched, true);
149		$this->job_factory->update($job, $update);
150
151		return new UnformattedResponse(
152		(new Response())->withStatus(StatusCodeInterface::STATUS_OK),
153		$this->job_factory->getOne($namespace, $job->getName())->decorate($request),
154		['pretty' => isset($query['pretty'])]
155		);
156		}
157
158		/**
159		* Entrypoint.
160		*/
161	View Code Duplication	public function getAllLogs(ServerRequestInterface $request, Identity $identity, string $namespace, string $job): ResponseInterface
		0 ignored issues – show Duplication introduced 2019-01-14 11:29 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
162		{
163		$query = array_merge([
164		'offset' => 0,
165		'limit' => 20,
166		], $request->getQueryParams());
167
168		if (isset($query['watch'])) {
169		$filter = [
170		'fullDocument.context.namespace' => $namespace,
171		'fullDocument.context.job' => $job,
172		];
173
174		if (!empty($query['query'])) {
175		$filter = ['$and' => [$filter, $query['query']]];
176		}
177
178		$logs = $this->log_factory->watch(null, true, $filter, (int) $query['offset'], (int) $query['limit'], $query['sort']);
179
180		return Helper::watchAll($request, $identity, $this->acl, $logs);
181		}
182
183		$filter = [
184		'context.namespace' => $namespace,
185		'context.job' => $job,
186		];
187
188		if (!empty($query['query'])) {
189		$filter = ['$and' => [$filter, $query['query']]];
190		}
191
192		$logs = $this->log_factory->getAll($filter, (int) $query['offset'], (int) $query['limit'], $query['sort']);
193
194		return Helper::getAll($request, $identity, $this->acl, $logs);
195		}
196
197		/**
198		* Entrypoint.
199		*/
200		public function getOneLog(ServerRequestInterface $request, Identity $identity, string $namespace, string $job, ObjectIdInterface $log): ResponseInterface
		0 ignored issues – show Unused Code introduced 2019-01-25 16:05 UTC by Report Bug Copy Issue Report The parameter `$namespace` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2019-01-25 16:05 UTC by Report Bug Copy Issue Report The parameter `$job` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
201		{
202		$resource = $this->log_factory->getOne($log);
		0 ignored issues – show Bug introduced 2019-01-25 16:05 UTC by Report Bug Copy Issue Report The call to `getOne()` misses a required argument `$log`. This check looks for function calls that miss required arguments. Loading history...
203
204		return Helper::getOne($request, $identity, $resource);
205		}
206		}
207

gyselroth / tubee

Push — master ( 316baf...2178d1 )

Jobs::getAllLogs() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like