NodeDecorator::parseAttributes() - Code Metrics - Inspection of "v2 fixes regarding delta attribute decorator" - gyselroth/balloon - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — dev (d5d70c)

by Raffael

created 2018-02-16 14:20 UTC

NodeDecorator::parseAttributes() A

↳ Parent: NodeDecorator

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	9
rs	9.6666
c	0
b	0
f	0
cc	2
eloc	5
nc	2
nop	1

<?php

declare(strict_types=1);

/**
 * balloon
 *
 * @copyright   Copryright (c) 2012-2018 gyselroth GmbH (https://gyselroth.com)
 * @license     GPL-3.0 https://opensource.org/licenses/GPL-3.0
 */

namespace Balloon\App\Api\v1\AttributeDecorator;

use Balloon\Filesystem;
use Balloon\Filesystem\Acl;
use Balloon\Filesystem\Node\Collection;
use Balloon\Filesystem\Node\File;
use Balloon\Filesystem\Node\NodeInterface;
use Balloon\Server;
use Closure;
use MongoDB\BSON\UTCDateTime;
use stdClass;

class NodeDecorator
{
    /**
     * Server.
     *
     * @var Server
     */
    protected $server;

    /**
     * Filesystem.
     *
     * @var Filesystem
     */
    protected $fs;

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

    /**
     * Custom attributes.
     *
     * @var array
     */
    protected $custom = [];

    /**
     * Init.
     *
     * @param Server $server
     * @param Acl    $acl
     */
    public function __construct(Server $server, Acl $acl)
    {
        $this->server = $server;
        $this->acl = $acl;
    }

    /**
     * Decorate attributes.
     *
     * @param NodeInterface $node
     * @param array         $attributes
     *
     * @return array
     */
    public function decorate(NodeInterface $node, array $attributes = []): array
    {
        $requested = $this->parseAttributes($attributes);
        $attributes = $node->getAttributes();

        $attrs = array_merge(
            $this->getAttributes($node, $attributes),
            $this->getTimeAttributes($node, $attributes),
            $this->getTypeAttributes($node, $attributes),
            $this->custom
        );

        if (0 === count($requested)) {
            return $this->translateAttributes($node, $attrs);
        }

        return $this->translateAttributes($node, array_intersect_key($attrs, array_flip($requested)));
    }

    /**
     * Add decorator.
     *
     * @param string  $attribute
     * @param Closure $decorator
     *
     * @return AttributeDecorator
     */
    public function addDecorator(string $attribute, Closure $decorator): self
    {
        $this->custom[$attribute] = $decorator;

        return $this;
    }

    /**
     * Parse v1 attribute filter requests.
     *
     * @param array
     *
     * @return array
     */
    protected function parseAttributes(array $attributes): array
    {
        foreach ($attributes as &$attribute) {
            $parts = explode('.', $attribute);
            $attribute = $parts[0];
        }

        return $attributes;
    }

    /**
     * Get Attributes.
     *
     * @param NodeInterface
     *
     * @return array
     */
    protected function getAttributes(NodeInterface $node, array $attributes): array
    {
        $acl = $this->acl;
        $server = $this->server;
        $fs = $this->server->getFilesystem();

        return [
            'id' => (string) $attributes['_id'],
            'name' => (string) $attributes['name'],
            'mime' => (string) $attributes['mime'],
            'readonly' => (bool) $attributes['readonly'],
            'directory' => $node instanceof Collection,
            'meta' => function ($node) {
                return (object) $node->getMetaAttributes();
            },
            'size' => function ($node) {
                return $node->getSize();
            },
            'path' => function ($node) {
                try {
                    return $node->getPath();
                } catch (\Exception $e) {
                    return null;
                }
            },
            'parent' => function ($node) {
                $id = $node->getAttributes()['parent'];

                if (null === $id) {
                    return null;
                }

                return (string) $id;
            },
            'access' => function ($node) use ($acl) {
                return $acl->getAclPrivilege($node);
            },
            'share' => function ($node) {
                if ($node->isShared() || !$node->isSpecial()) {
                    return null;
                }

                try {
                    return $this->decorate($node->getShareNode(), ['id', 'name', '_links']);
                } catch (\Exception $e) {
                    return null;
                }
            },
            'shareowner' => function ($node) use ($server, $fs) {
                if (!$node->isSpecial()) {
                    return null;
                }

                try {
                    return $server->getUserById($fs->findRawNode($node->getShareId())['owner'])->getUsername();
                } catch (\Exception $e) {
                    return null;
                }
            },
        ];
    }

    /**
     * Convert UTCDateTime to unix ts.
     *
     * @param UTCDateTime $date
     *
     * @return stdClass
     */
    protected function dateTimeToUnix(?UTCDateTime $date): ?stdClass
    {
        if (null === $date) {
            return null;
        }

        $date = $date->toDateTime();
        $ts = new stdClass();
        $ts->sec = $date->format('U');
        $ts->usec = $date->format('u');

        return $ts;
    }

    /**
     * Get Attributes.
     *
     * @param NodeInterface
     * @param array $attributes
     *
     * @return array
     */
    protected function getTimeAttributes(NodeInterface $node, array $attributes): array

    {
        return [
            'created' => function ($node) use ($attributes) {

                return $this->dateTimeToUnix($attributes['created']);
            },
            'changed' => function ($node) use ($attributes) {

                return $this->dateTimeToUnix($attributes['changed']);
            },
            'deleted' => function ($node) use ($attributes) {

                if (false === $attributes['deleted']) {
                    return false;
                }

                return $this->dateTimeToUnix($attributes['destroy']);
            },
            'destroy' => function ($node) use ($attributes) {

                if (null === $attributes['destroy']) {
                    return false;
                }

                return $this->dateTimeToUnix($attributes['destroy']);
            },
        ];
    }

    /**
     * Get Attributes.
     *
     * @param NodeInterface
     * @param array $attributes
     *
     * @return array
     */
    protected function getTypeAttributes(NodeInterface $node, array $attributes): array
    {
        $server = $this->server;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        $fs = $this->server->getFilesystem();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        if ($node instanceof File) {
            return [
                'version' => $attributes['version'],
                'hash' => $attributes['hash'],
            ];
        }

        return [
            'reference' => $node->isReference(),
        ];
    }

    /**
     * Execute closures.
     *
     * @param NodeInterface
     * @param array $attributes
     *
     * @return array
     */
    protected function translateAttributes(NodeInterface $node, array $attributes): array
    {
        foreach ($attributes as $key => &$value) {
            if ($value instanceof Closure) {
                $result = $value->call($this, $node);

                if (null === $result) {
                    unset($attributes[$key]);
                } else {
                    $value = $result;
                }
            } elseif ($value === null) {
                unset($attributes[$key]);
            }
        }

        return $attributes;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/**
6			* balloon
7			*
8			* @copyright Copryright (c) 2012-2018 gyselroth GmbH (https://gyselroth.com)
9			* @license GPL-3.0 https://opensource.org/licenses/GPL-3.0
10			*/
11
12			namespace Balloon\App\Api\v1\AttributeDecorator;
13
14			use Balloon\Filesystem;
15			use Balloon\Filesystem\Acl;
16			use Balloon\Filesystem\Node\Collection;
17			use Balloon\Filesystem\Node\File;
18			use Balloon\Filesystem\Node\NodeInterface;
19			use Balloon\Server;
20			use Closure;
21			use MongoDB\BSON\UTCDateTime;
22			use stdClass;
23
24			class NodeDecorator
25			{
26			/**
27			* Server.
28			*
29			* @var Server
30			*/
31			protected $server;
32
33			/**
34			* Filesystem.
35			*
36			* @var Filesystem
37			*/
38			protected $fs;
39
40			/**
41			* Acl.
42			*
43			* @var Acl
44			*/
45			protected $acl;
46
47			/**
48			* Custom attributes.
49			*
50			* @var array
51			*/
52			protected $custom = [];
53
54			/**
55			* Init.
56			*
57			* @param Server $server
58			* @param Acl $acl
59			*/
60			public function __construct(Server $server, Acl $acl)
61			{
62			$this->server = $server;
63			$this->acl = $acl;
64			}
65
66			/**
67			* Decorate attributes.
68			*
69			* @param NodeInterface $node
70			* @param array $attributes
71			*
72			* @return array
73			*/
74			public function decorate(NodeInterface $node, array $attributes = []): array
75			{
76			$requested = $this->parseAttributes($attributes);
77			$attributes = $node->getAttributes();
78
79			$attrs = array_merge(
80			$this->getAttributes($node, $attributes),
81			$this->getTimeAttributes($node, $attributes),
82			$this->getTypeAttributes($node, $attributes),
83			$this->custom
84			);
85
86			if (0 === count($requested)) {
87			return $this->translateAttributes($node, $attrs);
88			}
89
90			return $this->translateAttributes($node, array_intersect_key($attrs, array_flip($requested)));
91			}
92
93			/**
94			* Add decorator.
95			*
96			* @param string $attribute
97			* @param Closure $decorator
98			*
99			* @return AttributeDecorator
100			*/
101			public function addDecorator(string $attribute, Closure $decorator): self
102			{
103			$this->custom[$attribute] = $decorator;
104
105			return $this;
106			}
107
108			/**
109			* Parse v1 attribute filter requests.
110			*
111			* @param array
112			*
113			* @return array
114			*/
115			protected function parseAttributes(array $attributes): array
116			{
117			foreach ($attributes as &$attribute) {
118			$parts = explode('.', $attribute);
119			$attribute = $parts[0];
120			}
121
122			return $attributes;
123			}
124
125			/**
126			* Get Attributes.
127			*
128			* @param NodeInterface
129			*
130			* @return array
131			*/
132			protected function getAttributes(NodeInterface $node, array $attributes): array
133			{
134			$acl = $this->acl;
135			$server = $this->server;
136			$fs = $this->server->getFilesystem();
137
138			return [
139			'id' => (string) $attributes['_id'],
140			'name' => (string) $attributes['name'],
141			'mime' => (string) $attributes['mime'],
142			'readonly' => (bool) $attributes['readonly'],
143			'directory' => $node instanceof Collection,
144			'meta' => function ($node) {
145			return (object) $node->getMetaAttributes();
146			},
147			'size' => function ($node) {
148			return $node->getSize();
149			},
150			'path' => function ($node) {
151			try {
152			return $node->getPath();
153			} catch (\Exception $e) {
154			return null;
155			}
156			},
157			'parent' => function ($node) {
158			$id = $node->getAttributes()['parent'];
159
160			if (null === $id) {
161			return null;
162			}
163
164			return (string) $id;
165			},
166			'access' => function ($node) use ($acl) {
167			return $acl->getAclPrivilege($node);
168			},
169			'share' => function ($node) {
170			if ($node->isShared() \|\| !$node->isSpecial()) {
171			return null;
172			}
173
174			try {
175			return $this->decorate($node->getShareNode(), ['id', 'name', '_links']);
176			} catch (\Exception $e) {
177			return null;
178			}
179			},
180			'shareowner' => function ($node) use ($server, $fs) {
181			if (!$node->isSpecial()) {
182			return null;
183			}
184
185			try {
186			return $server->getUserById($fs->findRawNode($node->getShareId())['owner'])->getUsername();
187			} catch (\Exception $e) {
188			return null;
189			}
190			},
191			];
192			}
193
194			/**
195			* Convert UTCDateTime to unix ts.
196			*
197			* @param UTCDateTime $date
198			*
199			* @return stdClass
200			*/
201			protected function dateTimeToUnix(?UTCDateTime $date): ?stdClass
202			{
203			if (null === $date) {
204			return null;
205			}
206
207			$date = $date->toDateTime();
208			$ts = new stdClass();
209			$ts->sec = $date->format('U');
210			$ts->usec = $date->format('u');
211
212			return $ts;
213			}
214
215			/**
216			* Get Attributes.
217			*
218			* @param NodeInterface
219			* @param array $attributes
220			*
221			* @return array
222			*/
223			protected function getTimeAttributes(NodeInterface $node, array $attributes): array
			0 ignored issues – show Unused Code introduced 2018-02-16 14:31 UTC by Report Bug Copy Issue Report The parameter `$node` 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...
224			{
225			return [
226			'created' => function ($node) use ($attributes) {
			0 ignored issues – show Unused Code introduced 2018-02-16 14:31 UTC by Report Bug Copy Issue Report The parameter `$node` 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...
227			return $this->dateTimeToUnix($attributes['created']);
228			},
229			'changed' => function ($node) use ($attributes) {
			0 ignored issues – show Unused Code introduced 2018-02-16 14:31 UTC by Report Bug Copy Issue Report The parameter `$node` 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...
230			return $this->dateTimeToUnix($attributes['changed']);
231			},
232			'deleted' => function ($node) use ($attributes) {
			0 ignored issues – show Unused Code introduced 2018-02-16 14:31 UTC by Report Bug Copy Issue Report The parameter `$node` 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...
233			if (false === $attributes['deleted']) {
234			return false;
235			}
236
237			return $this->dateTimeToUnix($attributes['destroy']);
238			},
239			'destroy' => function ($node) use ($attributes) {
			0 ignored issues – show Unused Code introduced 2018-02-16 14:31 UTC by Report Bug Copy Issue Report The parameter `$node` 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...
240			if (null === $attributes['destroy']) {
241			return false;
242			}
243
244			return $this->dateTimeToUnix($attributes['destroy']);
245			},
246			];
247			}
248
249			/**
250			* Get Attributes.
251			*
252			* @param NodeInterface
253			* @param array $attributes
254			*
255			* @return array
256			*/
257			protected function getTypeAttributes(NodeInterface $node, array $attributes): array
258			{
259			$server = $this->server;
			0 ignored issues – show Unused Code introduced 2018-02-16 14:31 UTC by Report Bug Copy Issue Report `$server` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
260			$fs = $this->server->getFilesystem();
			0 ignored issues – show Unused Code introduced 2018-02-16 14:31 UTC by Report Bug Copy Issue Report `$fs` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
261
262			if ($node instanceof File) {
263			return [
264			'version' => $attributes['version'],
265			'hash' => $attributes['hash'],
266			];
267			}
268
269			return [
270			'reference' => $node->isReference(),
271			];
272			}
273
274			/**
275			* Execute closures.
276			*
277			* @param NodeInterface
278			* @param array $attributes
279			*
280			* @return array
281			*/
282			protected function translateAttributes(NodeInterface $node, array $attributes): array
283			{
284			foreach ($attributes as $key => &$value) {
285			if ($value instanceof Closure) {
286			$result = $value->call($this, $node);
287
288			if (null === $result) {
289			unset($attributes[$key]);
290			} else {
291			$value = $result;
292			}
293			} elseif ($value === null) {
294			unset($attributes[$key]);
295			}
296			}
297
298			return $attributes;
299			}
300			}
301

gyselroth / balloon

Branch — dev (d5d70c)

NodeDecorator::parseAttributes() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like