DropboxAdapter::listContents() - Code Metrics - Inspection of "Merge pull request #28 from TheNodi/list_folder_ex..." - spatie/flysystem-dropbox - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 55c5a6...8e7aa7 )

by Freek

created 2017-10-21 17:23 UTC

DropboxAdapter::listContents() B

↳ Parent: DropboxAdapter

Complexity

Conditions	4
Paths	5

Size

Total Lines	27
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	27
rs	8.5806
c	0
b	0
f	0
cc	4
eloc	16
nc	5
nop	2

<?php

namespace Spatie\FlysystemDropbox;

use LogicException;
use Spatie\Dropbox\Client;
use League\Flysystem\Config;
use Spatie\Dropbox\Exceptions\BadRequest;
use League\Flysystem\Adapter\AbstractAdapter;
use League\Flysystem\Adapter\Polyfill\NotSupportingVisibilityTrait;

class DropboxAdapter extends AbstractAdapter
{
    use NotSupportingVisibilityTrait;

    /** @var \Spatie\Dropbox\Client */
    protected $client;

    public function __construct(Client $client, string $prefix = '')
    {
        $this->client = $client;

        $this->setPathPrefix($prefix);
    }

    /**
     * {@inheritdoc}
     */
    public function write($path, $contents, Config $config)
    {
        return $this->upload($path, $contents, 'add');
    }

    /**
     * {@inheritdoc}
     */
    public function writeStream($path, $resource, Config $config)
    {
        return $this->upload($path, $resource, 'add');
    }

    /**
     * {@inheritdoc}
     */
    public function update($path, $contents, Config $config)
    {
        return $this->upload($path, $contents, 'overwrite');
    }

    /**
     * {@inheritdoc}
     */
    public function updateStream($path, $resource, Config $config)
    {
        return $this->upload($path, $resource, 'overwrite');
    }

    /**
     * {@inheritdoc}
     */
    public function rename($path, $newPath): bool
    {
        $path = $this->applyPathPrefix($path);
        $newPath = $this->applyPathPrefix($newPath);

        try {
            $this->client->move($path, $newPath);
        } catch (BadRequest $e) {
            return false;
        }

        return true;
    }

    /**
     * {@inheritdoc}
     */
    public function copy($path, $newpath): bool

    {
        $path = $this->applyPathPrefix($path);
        $newpath = $this->applyPathPrefix($newpath);

        try {
            $this->client->copy($path, $newpath);
        } catch (BadRequest $e) {
            return false;
        }

        return true;
    }

    /**
     * {@inheritdoc}
     */
    public function delete($path): bool
    {
        $location = $this->applyPathPrefix($path);

        try {
            $this->client->delete($location);
        } catch (BadRequest $e) {
            return false;
        }

        return true;
    }

    /**
     * {@inheritdoc}
     */
    public function deleteDir($dirname): bool
    {
        return $this->delete($dirname);
    }

    /**
     * {@inheritdoc}
     */
    public function createDir($dirname, Config $config)

    {
        $path = $this->applyPathPrefix($dirname);

        try {
            $object = $this->client->createFolder($path);
        } catch (BadRequest $e) {
            return false;
        }

        return $this->normalizeResponse($object);
    }

    /**
     * {@inheritdoc}
     */
    public function has($path)
    {
        return $this->getMetadata($path);
    }

    /**
     * {@inheritdoc}
     */
    public function read($path)
    {
        if (! $object = $this->readStream($path)) {
            return false;
        }

        $object['contents'] = stream_get_contents($object['stream']);
        fclose($object['stream']);
        unset($object['stream']);

        return $object;
    }

    /**
     * {@inheritdoc}
     */
    public function readStream($path)

    {
        $path = $this->applyPathPrefix($path);

        try {
            $stream = $this->client->download($path);
        } catch (BadRequest $e) {
            return false;
        }

        return compact('stream');
    }

    /**
     * {@inheritdoc}
     */
    public function listContents($directory = '', $recursive = false): array
    {
        $location = $this->applyPathPrefix($directory);

        try {
            $result = $this->client->listFolder($location, $recursive);
        } catch (BadRequest $e) {
            return [];
        }

        $entries = $result['entries'];

        while ($result['has_more']) {
            $result = $this->client->listFolderContinue($result['cursor']);
            $entries = array_merge($entries, $result['entries']);
        }

        if (! count($entries)) {
            return [];
        }

        return array_map(function ($entry) {
            $path = $this->removePathPrefix($entry['path_display']);

            return $this->normalizeResponse($entry, $path);

        }, $entries);
    }

    /**
     * {@inheritdoc}
     */
    public function getMetadata($path)

    {
        $path = $this->applyPathPrefix($path);

        try {
            $object = $this->client->getMetadata($path);
        } catch (BadRequest $e) {
            return false;
        }

        return $this->normalizeResponse($object);
    }

    /**
     * {@inheritdoc}
     */
    public function getSize($path)
    {
        return $this->getMetadata($path);
    }

    /**
     * {@inheritdoc}
     */
    public function getMimetype($path)
    {
        throw new LogicException("The Dropbox API v2 does not support mimetypes. Given path: `{$path}`.");
    }

    /**
     * {@inheritdoc}
     */
    public function getTimestamp($path)
    {
        return $this->getMetadata($path);
    }

    public function getTemporaryLink(string $path): string
    {
        return $this->client->getTemporaryLink($path);
    }

    public function getThumbnail(string $path, string $format = 'jpeg', string $size = 'w64h64')
    {
        return $this->client->getThumbnail($path, $format, $size);
    }

    /**
     * {@inheritdoc}
     */
    public function applyPathPrefix($path): string
    {
        $path = parent::applyPathPrefix($path);

        return '/'.trim($path, '/');
    }

    public function getClient(): Client
    {
        return $this->client;
    }

    /**
     * @param string $path
     * @param resource|string $contents
     * @param string $mode
     *
     * @return array|false file metadata
     */
    protected function upload(string $path, $contents, string $mode)

    {
        $path = $this->applyPathPrefix($path);

        try {
            $object = $this->client->upload($path, $contents, $mode);
        } catch (BadRequest $e) {
            return false;
        }

        return $this->normalizeResponse($object);
    }

    protected function normalizeResponse(array $response): array
    {
        $normalizedPath = ltrim($this->removePathPrefix($response['path_display']), '/');

        $normalizedResponse = ['path' => $normalizedPath];

        if (isset($response['server_modified'])) {
            $normalizedResponse['timestamp'] = strtotime($response['server_modified']);
        }

        if (isset($response['size'])) {
            $normalizedResponse['size'] = $response['size'];
            $normalizedResponse['bytes'] = $response['size'];
        }

        $type = ($response['.tag'] === 'folder' ? 'dir' : 'file');
        $normalizedResponse['type'] = $type;

        return $normalizedResponse;
    }
}


1		<?php
2
3		namespace Spatie\FlysystemDropbox;
4
5		use LogicException;
6		use Spatie\Dropbox\Client;
7		use League\Flysystem\Config;
8		use Spatie\Dropbox\Exceptions\BadRequest;
9		use League\Flysystem\Adapter\AbstractAdapter;
10		use League\Flysystem\Adapter\Polyfill\NotSupportingVisibilityTrait;
11
12		class DropboxAdapter extends AbstractAdapter
13		{
14		use NotSupportingVisibilityTrait;
15
16		/** @var \Spatie\Dropbox\Client */
17		protected $client;
18
19		public function __construct(Client $client, string $prefix = '')
20		{
21		$this->client = $client;
22
23		$this->setPathPrefix($prefix);
24		}
25
26		/**
27		* {@inheritdoc}
28		*/
29		public function write($path, $contents, Config $config)
30		{
31		return $this->upload($path, $contents, 'add');
32		}
33
34		/**
35		* {@inheritdoc}
36		*/
37		public function writeStream($path, $resource, Config $config)
38		{
39		return $this->upload($path, $resource, 'add');
40		}
41
42		/**
43		* {@inheritdoc}
44		*/
45		public function update($path, $contents, Config $config)
46		{
47		return $this->upload($path, $contents, 'overwrite');
48		}
49
50		/**
51		* {@inheritdoc}
52		*/
53		public function updateStream($path, $resource, Config $config)
54		{
55		return $this->upload($path, $resource, 'overwrite');
56		}
57
58		/**
59		* {@inheritdoc}
60		*/
61		public function rename($path, $newPath): bool
62		{
63		$path = $this->applyPathPrefix($path);
64		$newPath = $this->applyPathPrefix($newPath);
65
66		try {
67		$this->client->move($path, $newPath);
68		} catch (BadRequest $e) {
69		return false;
70		}
71
72		return true;
73		}
74
75		/**
76		* {@inheritdoc}
77		*/
78	View Code Duplication	public function copy($path, $newpath): bool
		0 ignored issues – show Duplication introduced 2017-09-06 13:13 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...
79		{
80		$path = $this->applyPathPrefix($path);
81		$newpath = $this->applyPathPrefix($newpath);
82
83		try {
84		$this->client->copy($path, $newpath);
85		} catch (BadRequest $e) {
86		return false;
87		}
88
89		return true;
90		}
91
92		/**
93		* {@inheritdoc}
94		*/
95		public function delete($path): bool
96		{
97		$location = $this->applyPathPrefix($path);
98
99		try {
100		$this->client->delete($location);
101		} catch (BadRequest $e) {
102		return false;
103		}
104
105		return true;
106		}
107
108		/**
109		* {@inheritdoc}
110		*/
111		public function deleteDir($dirname): bool
112		{
113		return $this->delete($dirname);
114		}
115
116		/**
117		* {@inheritdoc}
118		*/
119	View Code Duplication	public function createDir($dirname, Config $config)
		0 ignored issues – show Duplication introduced 2017-09-06 13:13 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...
120		{
121		$path = $this->applyPathPrefix($dirname);
122
123		try {
124		$object = $this->client->createFolder($path);
125		} catch (BadRequest $e) {
126		return false;
127		}
128
129		return $this->normalizeResponse($object);
130		}
131
132		/**
133		* {@inheritdoc}
134		*/
135		public function has($path)
136		{
137		return $this->getMetadata($path);
138		}
139
140		/**
141		* {@inheritdoc}
142		*/
143		public function read($path)
144		{
145		if (! $object = $this->readStream($path)) {
146		return false;
147		}
148
149		$object['contents'] = stream_get_contents($object['stream']);
150		fclose($object['stream']);
151		unset($object['stream']);
152
153		return $object;
154		}
155
156		/**
157		* {@inheritdoc}
158		*/
159	View Code Duplication	public function readStream($path)
		0 ignored issues – show Duplication introduced 2017-09-06 13:13 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...
160		{
161		$path = $this->applyPathPrefix($path);
162
163		try {
164		$stream = $this->client->download($path);
165		} catch (BadRequest $e) {
166		return false;
167		}
168
169		return compact('stream');
170		}
171
172		/**
173		* {@inheritdoc}
174		*/
175		public function listContents($directory = '', $recursive = false): array
176		{
177		$location = $this->applyPathPrefix($directory);
178
179		try {
180		$result = $this->client->listFolder($location, $recursive);
181		} catch (BadRequest $e) {
182		return [];
183		}
184
185		$entries = $result['entries'];
186
187		while ($result['has_more']) {
188		$result = $this->client->listFolderContinue($result['cursor']);
189		$entries = array_merge($entries, $result['entries']);
190		}
191
192		if (! count($entries)) {
193		return [];
194		}
195
196		return array_map(function ($entry) {
197		$path = $this->removePathPrefix($entry['path_display']);
198
199		return $this->normalizeResponse($entry, $path);
		0 ignored issues – show Unused Code introduced 2017-04-18 17:00 UTC by Report Bug Copy Issue Report The call to `DropboxAdapter::normalizeResponse()` has too many arguments starting with `$path`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
200		}, $entries);
201		}
202
203		/**
204		* {@inheritdoc}
205		*/
206	View Code Duplication	public function getMetadata($path)
		0 ignored issues – show Duplication introduced 2017-09-06 13:13 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...
207		{
208		$path = $this->applyPathPrefix($path);
209
210		try {
211		$object = $this->client->getMetadata($path);
212		} catch (BadRequest $e) {
213		return false;
214		}
215
216		return $this->normalizeResponse($object);
217		}
218
219		/**
220		* {@inheritdoc}
221		*/
222		public function getSize($path)
223		{
224		return $this->getMetadata($path);
225		}
226
227		/**
228		* {@inheritdoc}
229		*/
230		public function getMimetype($path)
231		{
232		throw new LogicException("The Dropbox API v2 does not support mimetypes. Given path: `{$path}`.");
233		}
234
235		/**
236		* {@inheritdoc}
237		*/
238		public function getTimestamp($path)
239		{
240		return $this->getMetadata($path);
241		}
242
243		public function getTemporaryLink(string $path): string
244		{
245		return $this->client->getTemporaryLink($path);
246		}
247
248		public function getThumbnail(string $path, string $format = 'jpeg', string $size = 'w64h64')
249		{
250		return $this->client->getThumbnail($path, $format, $size);
251		}
252
253		/**
254		* {@inheritdoc}
255		*/
256		public function applyPathPrefix($path): string
257		{
258		$path = parent::applyPathPrefix($path);
259
260		return '/'.trim($path, '/');
261		}
262
263		public function getClient(): Client
264		{
265		return $this->client;
266		}
267
268		/**
269		* @param string $path
270		* @param resource\|string $contents
271		* @param string $mode
272		*
273		* @return array\|false file metadata
274		*/
275	View Code Duplication	protected function upload(string $path, $contents, string $mode)
		0 ignored issues – show Duplication introduced 2017-09-06 13:13 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...
276		{
277		$path = $this->applyPathPrefix($path);
278
279		try {
280		$object = $this->client->upload($path, $contents, $mode);
281		} catch (BadRequest $e) {
282		return false;
283		}
284
285		return $this->normalizeResponse($object);
286		}
287
288		protected function normalizeResponse(array $response): array
289		{
290		$normalizedPath = ltrim($this->removePathPrefix($response['path_display']), '/');
291
292		$normalizedResponse = ['path' => $normalizedPath];
293
294		if (isset($response['server_modified'])) {
295		$normalizedResponse['timestamp'] = strtotime($response['server_modified']);
296		}
297
298		if (isset($response['size'])) {
299		$normalizedResponse['size'] = $response['size'];
300		$normalizedResponse['bytes'] = $response['size'];
301		}
302
303		$type = ($response['.tag'] === 'folder' ? 'dir' : 'file');
304		$normalizedResponse['type'] = $type;
305
306		return $normalizedResponse;
307		}
308		}
309

spatie / flysystem-dropbox

GitHub Access Token became invalid

Push — master ( 55c5a6...8e7aa7 )

DropboxAdapter::listContents() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like