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

Completed

Push — master ( abe227...316baf )

by Raffael

created 2019-01-14 11:22 UTC

AbstractEndpoint::getKind() A

↳ Parent: AbstractEndpoint

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?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\Endpoint;

use Generator;
use InvalidArgumentException;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Log\LoggerInterface;
use Tubee\Collection\CollectionInterface;
use Tubee\EndpointObject;
use Tubee\EndpointObject\EndpointObjectInterface;
use Tubee\Helper;
use Tubee\Resource\AbstractResource;
use Tubee\Resource\AttributeResolver;
use Tubee\Workflow\Factory as WorkflowFactory;
use Tubee\Workflow\WorkflowInterface;

abstract class AbstractEndpoint extends AbstractResource implements EndpointInterface
{
    /**
     * Kind.
     */
    public const KIND = 'Endpoint';

    /**
     * Endpoint name.
     *
     * @var string
     */
    protected $name;

    /**
     * CollectionInterface.
     *
     * @var CollectionInterface
     */
    protected $collection;

    /**
     * Logger.
     *
     * @var LoggerInterface
     */
    protected $logger;

    /**
     * Filter All.
     *
     * @var string
     */
    protected $filter_all;

    /**
     * Filter One.
     *
     * @var string
     */
    protected $filter_one;

    /**
     * Import.
     *
     * @var array
     */
    protected $import = [];

    /**
     * Type.
     *
     * @var string
     */
    protected $type;

    /**
     * Flush.
     *
     * @var bool
     */
    protected $flush = false;

    /**
     * Workflow factory.
     *
     * @var WorkflowFactory
     */
    protected $workflow_factory;

    /**
     * Endpoint object identifiers.
     *
     * @var string
     */
    protected $identifier;

    /**
     * Init endpoint.
     */
    public function __construct(string $name, string $type, CollectionInterface $collection, WorkflowFactory $workflow_factory, LoggerInterface $logger, array $resource = [])
    {
        $this->name = $name;
        $this->type = $type;
        $this->resource = $resource;
        $this->collection = $collection;
        $this->logger = $logger;
        $this->workflow_factory = $workflow_factory;

        if (isset($resource['data']['options'])) {
            $this->setOptions($resource['data']['options']);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function setup(bool $simulate = false): EndpointInterface
    {
        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function getKind(): string
    {
        return $this->resource['kind'];
    }

    /**
     * Set options.
     */
    public function setOptions(?array $config = null): EndpointInterface
    {
        if ($config === null) {
            return $this;
        }

        foreach ($config as $option => $value) {
            switch ($option) {
                case 'flush':
                case 'import':
                case 'identifier':
                case 'filter_one':
                case 'filter_all':
                    $this->{$option} = $value;

                break;
                default:
                    throw new InvalidArgumentException('unknown option '.$option.' given');
            }
        }

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function decorate(ServerRequestInterface $request): array
    {
        $collection = $this->collection->getName();
        $namespace = $this->collection->getResourceNamespace()->getName();

        $resource = [
            '_links' => [
                'namespace' => ['href' => (string) $request->getUri()->withPath('/api/v1/namespaces/'.$namespace)],
                'collection' => ['href' => (string) $request->getUri()->withPath('/api/v1/namespaces/'.$namespace.'/collections/'.$collection)],
           ],
            'kind' => static::KIND,
            'namespace' => $namespace,
            'collection' => $collection,
            'data' => $this->getData(),
            'status' => function ($endpoint) {
                try {
                    $endpoint->setup();

                    return [
                        'available' => true,
                    ];
                } catch (\Exception $e) {
                    return [
                        'available' => false,
                        'exception' => get_class($e),
                        'error' => $e->getMessage(),
                        'code' => $e->getCode(),
                    ];
                }
            },
        ];

        return AttributeResolver::resolve($request, $this, $resource);
    }

    /**
     * {@inheritdoc}
     */
    public function shutdown(bool $simulate = false): EndpointInterface
    {
        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function flushRequired(): bool
    {
        return $this->flush;
    }

    /**
     * {@inheritdoc}
     */
    public function flush(bool $simulate = false): bool
    {
        return true;
    }

    /**
     * {@inheritdoc}
     */
    public function getCollection(): CollectionInterface
    {
        return $this->collection;
    }

    /**
     * {@inheritdoc}
     */
    public function getResourceIdentifier(): array
    {
        return $this->identifier;
    }

    /**
     * {@inheritdoc}
     */
    public function getImport(): array
    {
        return $this->import;
    }

    /**
     * {@inheritdoc}
     */
    public function exists(array $object): bool
    {
        try {
            $this->getOne($object, []);

            return true;
        } catch (Exception\ObjectMultipleFound $e) {
            return true;
        } catch (\Exception $e) {
            return false;
        }
    }

    /**
     * {@inheritdoc}
     */
    public function hasWorkflow(string $name): bool
    {
        return $this->workflow_factory->has($this, $name);
    }

    /**
     * {@inheritdoc}
     */
    public function getWorkflow(string $name): WorkflowInterface
    {
        return $this->workflow_factory->getOne($this, $name);
    }

    /**
     * {@inheritdoc}
     */
    public function getWorkflows(array $workflows = [], ?int $offset = null, ?int $limit = null): Generator
    {
        return $this->workflow_factory->getAll($this, $workflows, $offset, $limit, [
            'priority' => 1,
        ]);
    }

    /**
     * {@inheritdoc}
     */
    public function getType(): string
    {
        return $this->type;
    }

    /**
     * {@inheritdoc}
     */
    public function getIdentifier(): string
    {
        return $this->collection->getIdentifier().'::'.$this->name;
    }

    /**
     * {@inheritdoc}
     */
    public function getFilterOne(array $object)
    {
        return $this->parseAttribute($this->filter_one, $object);
    }

    /**
     * {@inheritdoc}
     */
    public function getFilterAll()
    {
        return $this->filter_all;
    }

    /**
     * Build endpoint object.
     */
    protected function build(array $object): EndpointObjectInterface
    {
        return new EndpointObject(['data' => $object], $this);
    }

    /**
     * Parse and replace string with attribute values.
     */
    private function parseAttribute(string $string, array $data): string
    {
        return preg_replace_callback('/(\{(([^\}\"]*)+)\})(\}?)/', function ($match) use ($string, $data) {
            if (substr($match[0], 0, 2) === '{{' && $match[4][0] === '}') {
                return $match[2].$match[4];
            }

            $attribute = $match[2];

            try {
                return Helper::getArrayValue($data, $attribute);
            } catch (\Exception $e) {
                throw new Exception\AttributeNotResolvable('could not resolve attribute '.$attribute.' in value '.$string);
            }
        }, $string);
    }
}


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\Endpoint;
13
14		use Generator;
15		use InvalidArgumentException;
16		use Psr\Http\Message\ServerRequestInterface;
17		use Psr\Log\LoggerInterface;
18		use Tubee\Collection\CollectionInterface;
19		use Tubee\EndpointObject;
20		use Tubee\EndpointObject\EndpointObjectInterface;
21		use Tubee\Helper;
22		use Tubee\Resource\AbstractResource;
23		use Tubee\Resource\AttributeResolver;
24		use Tubee\Workflow\Factory as WorkflowFactory;
25		use Tubee\Workflow\WorkflowInterface;
26
27		abstract class AbstractEndpoint extends AbstractResource implements EndpointInterface
28		{
29		/**
30		* Kind.
31		*/
32		public const KIND = 'Endpoint';
33
34		/**
35		* Endpoint name.
36		*
37		* @var string
38		*/
39		protected $name;
40
41		/**
42		* CollectionInterface.
43		*
44		* @var CollectionInterface
45		*/
46		protected $collection;
47
48		/**
49		* Logger.
50		*
51		* @var LoggerInterface
52		*/
53		protected $logger;
54
55		/**
56		* Filter All.
57		*
58		* @var string
59		*/
60		protected $filter_all;
61
62		/**
63		* Filter One.
64		*
65		* @var string
66		*/
67		protected $filter_one;
68
69		/**
70		* Import.
71		*
72		* @var array
73		*/
74		protected $import = [];
75
76		/**
77		* Type.
78		*
79		* @var string
80		*/
81		protected $type;
82
83		/**
84		* Flush.
85		*
86		* @var bool
87		*/
88		protected $flush = false;
89
90		/**
91		* Workflow factory.
92		*
93		* @var WorkflowFactory
94		*/
95		protected $workflow_factory;
96
97		/**
98		* Endpoint object identifiers.
99		*
100		* @var string
101		*/
102		protected $identifier;
103
104		/**
105		* Init endpoint.
106		*/
107	58	public function __construct(string $name, string $type, CollectionInterface $collection, WorkflowFactory $workflow_factory, LoggerInterface $logger, array $resource = [])
108		{
109	58	$this->name = $name;
110	58	$this->type = $type;
111	58	$this->resource = $resource;
112	58	$this->collection = $collection;
113	58	$this->logger = $logger;
114	58	$this->workflow_factory = $workflow_factory;
115
116	58	if (isset($resource['data']['options'])) {
117	9	$this->setOptions($resource['data']['options']);
118		}
119	58	}
120
121		/**
122		* {@inheritdoc}
123		*/
124		public function setup(bool $simulate = false): EndpointInterface
125		{
126		return $this;
127		}
128
129		/**
130		* {@inheritdoc}
131		*/
132		public function getKind(): string
133		{
134		return $this->resource['kind'];
135		}
136
137		/**
138		* Set options.
139		*/
140	9	public function setOptions(?array $config = null): EndpointInterface
141		{
142	9	if ($config === null) {
143		return $this;
144		}
145
146	9	foreach ($config as $option => $value) {
147	9	switch ($option) {
148	9	case 'flush':
149	9	case 'import':
150	9	case 'identifier':
151	9	case 'filter_one':
152	2	case 'filter_all':
153	9	$this->{$option} = $value;
154
155	9	break;
156		default:
157	9	throw new InvalidArgumentException('unknown option '.$option.' given');
158		}
159		}
160
161	9	return $this;
162		}
163
164		/**
165		* {@inheritdoc}
166		*/
167		public function decorate(ServerRequestInterface $request): array
168		{
169		$collection = $this->collection->getName();
170		$namespace = $this->collection->getResourceNamespace()->getName();
171
172		$resource = [
173		'_links' => [
174		'namespace' => ['href' => (string) $request->getUri()->withPath('/api/v1/namespaces/'.$namespace)],
175		'collection' => ['href' => (string) $request->getUri()->withPath('/api/v1/namespaces/'.$namespace.'/collections/'.$collection)],
176		],
177		'kind' => static::KIND,
178		'namespace' => $namespace,
179		'collection' => $collection,
180		'data' => $this->getData(),
181		'status' => function ($endpoint) {
182		try {
183		$endpoint->setup();
184
185		return [
186		'available' => true,
187		];
188		} catch (\Exception $e) {
189		return [
190		'available' => false,
191		'exception' => get_class($e),
192		'error' => $e->getMessage(),
193		'code' => $e->getCode(),
194		];
195		}
196		},
197		];
198
199		return AttributeResolver::resolve($request, $this, $resource);
200		}
201
202		/**
203		* {@inheritdoc}
204		*/
205		public function shutdown(bool $simulate = false): EndpointInterface
206		{
207		return $this;
208		}
209
210		/**
211		* {@inheritdoc}
212		*/
213		public function flushRequired(): bool
214		{
215		return $this->flush;
216		}
217
218		/**
219		* {@inheritdoc}
220		*/
221		public function flush(bool $simulate = false): bool
222		{
223		return true;
224		}
225
226		/**
227		* {@inheritdoc}
228		*/
229		public function getCollection(): CollectionInterface
230		{
231		return $this->collection;
232		}
233
234		/**
235		* {@inheritdoc}
236		*/
237		public function getResourceIdentifier(): array
238		{
239		return $this->identifier;
240		}
241
242		/**
243		* {@inheritdoc}
244		*/
245		public function getImport(): array
246		{
247		return $this->import;
248		}
249
250		/**
251		* {@inheritdoc}
252		*/
253	3	public function exists(array $object): bool
254		{
255		try {
256	3	$this->getOne($object, []);
257
258	1	return true;
259	2	} catch (Exception\ObjectMultipleFound $e) {
260	1	return true;
261	1	} catch (\Exception $e) {
262	1	return false;
263		}
264		}
265
266		/**
267		* {@inheritdoc}
268		*/
269		public function hasWorkflow(string $name): bool
270		{
271		return $this->workflow_factory->has($this, $name);
272		}
273
274		/**
275		* {@inheritdoc}
276		*/
277		public function getWorkflow(string $name): WorkflowInterface
278		{
279		return $this->workflow_factory->getOne($this, $name);
280		}
281
282		/**
283		* {@inheritdoc}
284		*/
285		public function getWorkflows(array $workflows = [], ?int $offset = null, ?int $limit = null): Generator
286		{
287		return $this->workflow_factory->getAll($this, $workflows, $offset, $limit, [
288		'priority' => 1,
289		]);
290		}
291
292		/**
293		* {@inheritdoc}
294		*/
295		public function getType(): string
296		{
297		return $this->type;
298		}
299
300		/**
301		* {@inheritdoc}
302		*/
303	22	public function getIdentifier(): string
304		{
305	22	return $this->collection->getIdentifier().'::'.$this->name;
306		}
307
308		/**
309		* {@inheritdoc}
310		*/
311	7	public function getFilterOne(array $object)
312		{
313	7	return $this->parseAttribute($this->filter_one, $object);
314		}
315
316		/**
317		* {@inheritdoc}
318		*/
319	2	public function getFilterAll()
320		{
321	2	return $this->filter_all;
322		}
323
324		/**
325		* Build endpoint object.
326		*/
327	2	protected function build(array $object): EndpointObjectInterface
328		{
329	2	return new EndpointObject(['data' => $object], $this);
330		}
331
332		/**
333		* Parse and replace string with attribute values.
334		*/
335		private function parseAttribute(string $string, array $data): string
336		{
337	7	return preg_replace_callback('/(\{(([^\}\"]*)+)\})(\}?)/', function ($match) use ($string, $data) {
338		if (substr($match[0], 0, 2) === '{{' && $match[4][0] === '}') {
339		return $match[2].$match[4];
340		}
341
342		$attribute = $match[2];
343
344		try {
345		return Helper::getArrayValue($data, $attribute);
346		} catch (\Exception $e) {
347		throw new Exception\AttributeNotResolvable('could not resolve attribute '.$attribute.' in value '.$string);
348		}
349	7	}, $string);
350		}
351		}
352

gyselroth / tubee

Push — master ( abe227...316baf )

AbstractEndpoint::getKind() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like