GoogleCloudClientStorage - Code Metrics - Inspection of "Adds adapter for Google Cloud Client Library" - KnpLabs/Gaufrette - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#427)

unknown

created 2016-09-09 12:04 UTC

GoogleCloudClientStorage A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	253
Duplicated Lines	6.32 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
wmc	35
c	2
b	0
f	0
lcom	1
cbo	3
dl	16
loc	253
rs	9

20 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	12	1
A	getOptions()	0	4	1
A	setOptions()	0	4	1
A	computePath()	0	12	3
A	isBucket()	0	11	3
A	setBucket()	0	6	1
A	getBucket()	0	4	1
A	read()	8	8	1
B	write()	0	26	2
A	exists()	0	10	2
A	isDirectory()	0	8	2
A	listKeys()	0	17	3
A	keys()	0	4	1
A	mtime()	8	8	1
A	delete()	0	6	1
A	rename()	0	5	1
A	setMetadata()	0	4	1
A	getMetadata()	0	4	2
A	setResource()	0	4	1
B	getResource()	0	13	6

How to fix Duplicated Code

<?php

namespace Gaufrette\Adapter;

use Gaufrette\Adapter;
use Gaufrette\Adapter\MetadataSupporter;
use Gaufrette\Adapter\ListKeysAware;

/**
 * Google Cloud Storage adapter using the Google Cloud Client Library for PHP
 * http://googlecloudplatform.github.io/google-cloud-php/
 *
 * @package Gaufrette
 * @author  Lech Buszczynski <[email protected]>
 */
class GoogleCloudClientStorage implements Adapter, MetadataSupporter, ResourceSupporter, ListKeysAware {

    protected $storageClient;
    protected $bucket;
    protected $bucketValidated;
    protected $options  = array();
    protected $metadata = array();
    protected $resource = array();

    /**
     * @param Google\Cloud\Storage\StorageClient    $service    Authenticated storage client class
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param string                                $bucketName Name of the bucket
     * @param array                                 $options    Options are: "directory" and "acl" (see https://cloud.google.com/storage/docs/access-control/lists)
     */
    public function __construct(\Google\Cloud\Storage\StorageClient $storageClient, $bucketName, $options = array())
    {
        $this->storageClient = $storageClient;
        $this->setBucket($bucketName);
        $this->options = array_replace_recursive(
            array(
                'directory' => '',
                'acl'       => array()
            ),
            $options
        );
    }
    
    /**
     * Get adapter options
     * 
     * @return  array
     */
    public function getOptions()
    {
        return $this->options;
    }

    /**
     * Set adapter options
     * 
     * @param   array   $options
     */
    public function setOptions($options)
    {
        $this->options = array_replace($this->options, $options);
    }
    
    protected function computePath($key)
    {
        if (strlen($this->options['directory']))
        {
            if (strcmp(substr($this->options['directory'], -1), '/') == 0)
            {
                return $this->options['directory'].$key;
            }
            return $this->options['directory'].'/'.$key;
        }
        return $key;
    }
    
    protected function isBucket()
    {
        if ($this->bucketValidated === true)
        {
            return true;
        } elseif (!$this->bucket->exists()) {
            throw new \RuntimeException(sprintf('Bucket %s does not exist.', $this->bucket->name()));
        }
        $this->bucketValidated = true;
        return true;
    }
    
    public function setBucket($name)
    {
        $this->bucketValidated = null;
        $this->bucket = $this->storageClient->bucket($name);       
        $this->isBucket();
    }
    
    public function getBucket()
    {
        return $this->bucket;
    }
    
    /**
     * {@inheritdoc}
     */
    public function read($key)

    {   
        $this->isBucket();     
        $object = $this->bucket->object($this->computePath($key));
        $info = $object->info();
        $this->setResource($key, $info);
        return $object->downloadAsString();
    }
    
    /**
     * {@inheritdoc}
     */
    public function write($key, $content)
    {
        $this->isBucket();
        
        $options = array(
            'resumable'     => true,
            'name'          => $this->computePath($key),
            'metadata'      => $this->getMetadata($key),
        );

        $object = $this->bucket->upload(
            $content,
            $options
        );

        $acl = $object->acl();
        foreach ($this->options['acl'] as $k => $v)
        {
            $acl->add($k, $v);
        }
        $object->update(array('metadata' => $this->getMetadata($key)));
        
        $info = $object->info();
        $this->setResource($key, $info);        
        return $info['size'];
    }
    
    /**
     * {@inheritdoc}
     */
    public function exists($key)
    {
        $this->isBucket();
        $object = $this->bucket->object($this->computePath($key));
        if ($object->exists())
        {
            return true;
        }
        return false;
    }
    
    /**
     * {@inheritdoc}
     */
    public function isDirectory($key)
    {
        if ($this->exists($key . '/'))
        {
            return true;
        }
        return false;
    }
    
    /**
     * {@inheritdoc}
     */
    public function listKeys($prefix = null)
    {
        $this->isBucket();        
        $keys = array();        
        if ($prefix === null)
        {
            $prefix = $this->options['directory'];
        } else {
            $prefix = $this->computePath($prefix);
        }
        foreach ($this->bucket->objects(array('prefix' => $prefix)) as $e)
        {
            $keys[] = $e->name();
        }
        sort($keys);
        return $keys;
    }
    
    /**
     * {@inheritdoc}
     */
    public function keys()
    {
        return $this->listKeys();
    }

    /**
     * {@inheritdoc}
     */
    public function mtime($key)

    {
        $this->isBucket();
        $object = $object = $this->bucket->object($this->computePath($key));
        $info = $object->info();
        $this->setResource($key, $info);
        return strtotime($info['updated']);
    }
    
    /**
     * {@inheritdoc}
     */
    public function delete($key)
    {
        $object = $this->bucket->object($this->computePath($key));
        $object->delete();
        return true;
    }
    
    /**
     * {@inheritdoc}
     */
    public function rename($sourceKey, $targetKey)
    {
        # there is no support for rename currently in Google Cloud Client Library 0.7.1 - it will be added in v0.8 any time now
        return false;
    }
    
    /**
     * {@inheritdoc}
     */
    public function setMetadata($key, $metadata)
    {
        $this->metadata[$key] = $metadata;
    }

    /**
     * {@inheritdoc}
     */
    public function getMetadata($key)
    {    
        return isset($this->metadata[$key]) ? $this->metadata[$key] : array();
    }
    
    /**
     * {@inheritdoc}
     */
    public function setResource($key, $data)
    {
        $this->resource[$key] = $data;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getResource($key, $name = null)
    {
        if (isset($this->resource[$key]))
        {
            if ($name)
            {
                return isset($this->resource[$key][$name]) ? $this->resource[$key][$name] : null;
            } elseif (isset($this->resource[$key])) {
                return isset($this->resource[$key]) ? $this->resource[$key] : array();
            }
        }            
        return array();
    }    
}

1		<?php
2
3		namespace Gaufrette\Adapter;
4
5		use Gaufrette\Adapter;
6		use Gaufrette\Adapter\MetadataSupporter;
7		use Gaufrette\Adapter\ListKeysAware;
8
9		/**
10		* Google Cloud Storage adapter using the Google Cloud Client Library for PHP
11		* http://googlecloudplatform.github.io/google-cloud-php/
12		*
13		* @package Gaufrette
14		* @author Lech Buszczynski <[email protected]>
15		*/
16		class GoogleCloudClientStorage implements Adapter, MetadataSupporter, ResourceSupporter, ListKeysAware {
17
18		protected $storageClient;
19		protected $bucket;
20		protected $bucketValidated;
21		protected $options = array();
22		protected $metadata = array();
23		protected $resource = array();
24
25		/**
26		* @param Google\Cloud\Storage\StorageClient $service Authenticated storage client class
		0 ignored issues – show Bug introduced 2016-09-09 12:17 UTC by Report Bug Copy Issue Report There is no parameter named `$service`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
27		* @param string $bucketName Name of the bucket
28		* @param array $options Options are: "directory" and "acl" (see https://cloud.google.com/storage/docs/access-control/lists)
29		*/
30		public function __construct(\Google\Cloud\Storage\StorageClient $storageClient, $bucketName, $options = array())
31		{
32		$this->storageClient = $storageClient;
33		$this->setBucket($bucketName);
34		$this->options = array_replace_recursive(
35		array(
36		'directory' => '',
37		'acl' => array()
38		),
39		$options
40		);
41		}
42
43		/**
44		* Get adapter options
45		*
46		* @return array
47		*/
48		public function getOptions()
49		{
50		return $this->options;
51		}
52
53		/**
54		* Set adapter options
55		*
56		* @param array $options
57		*/
58		public function setOptions($options)
59		{
60		$this->options = array_replace($this->options, $options);
61		}
62
63		protected function computePath($key)
64		{
65		if (strlen($this->options['directory']))
66		{
67		if (strcmp(substr($this->options['directory'], -1), '/') == 0)
68		{
69		return $this->options['directory'].$key;
70		}
71		return $this->options['directory'].'/'.$key;
72		}
73		return $key;
74		}
75
76		protected function isBucket()
77		{
78		if ($this->bucketValidated === true)
79		{
80		return true;
81		} elseif (!$this->bucket->exists()) {
82		throw new \RuntimeException(sprintf('Bucket %s does not exist.', $this->bucket->name()));
83		}
84		$this->bucketValidated = true;
85		return true;
86		}
87
88		public function setBucket($name)
89		{
90		$this->bucketValidated = null;
91		$this->bucket = $this->storageClient->bucket($name);
92		$this->isBucket();
93		}
94
95		public function getBucket()
96		{
97		return $this->bucket;
98		}
99
100		/**
101		* {@inheritdoc}
102		*/
103	View Code Duplication	public function read($key)
		0 ignored issues – show Duplication introduced 2016-09-09 12:17 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...
104		{
105		$this->isBucket();
106		$object = $this->bucket->object($this->computePath($key));
107		$info = $object->info();
108		$this->setResource($key, $info);
109		return $object->downloadAsString();
110		}
111
112		/**
113		* {@inheritdoc}
114		*/
115		public function write($key, $content)
116		{
117		$this->isBucket();
118
119		$options = array(
120		'resumable' => true,
121		'name' => $this->computePath($key),
122		'metadata' => $this->getMetadata($key),
123		);
124
125		$object = $this->bucket->upload(
126		$content,
127		$options
128		);
129
130		$acl = $object->acl();
131		foreach ($this->options['acl'] as $k => $v)
132		{
133		$acl->add($k, $v);
134		}
135		$object->update(array('metadata' => $this->getMetadata($key)));
136
137		$info = $object->info();
138		$this->setResource($key, $info);
139		return $info['size'];
140		}
141
142		/**
143		* {@inheritdoc}
144		*/
145		public function exists($key)
146		{
147		$this->isBucket();
148		$object = $this->bucket->object($this->computePath($key));
149		if ($object->exists())
150		{
151		return true;
152		}
153		return false;
154		}
155
156		/**
157		* {@inheritdoc}
158		*/
159		public function isDirectory($key)
160		{
161		if ($this->exists($key . '/'))
162		{
163		return true;
164		}
165		return false;
166		}
167
168		/**
169		* {@inheritdoc}
170		*/
171		public function listKeys($prefix = null)
172		{
173		$this->isBucket();
174		$keys = array();
175		if ($prefix === null)
176		{
177		$prefix = $this->options['directory'];
178		} else {
179		$prefix = $this->computePath($prefix);
180		}
181		foreach ($this->bucket->objects(array('prefix' => $prefix)) as $e)
182		{
183		$keys[] = $e->name();
184		}
185		sort($keys);
186		return $keys;
187		}
188
189		/**
190		* {@inheritdoc}
191		*/
192		public function keys()
193		{
194		return $this->listKeys();
195		}
196
197		/**
198		* {@inheritdoc}
199		*/
200	View Code Duplication	public function mtime($key)
		0 ignored issues – show Duplication introduced 2016-09-09 12:17 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...
201		{
202		$this->isBucket();
203		$object = $object = $this->bucket->object($this->computePath($key));
204		$info = $object->info();
205		$this->setResource($key, $info);
206		return strtotime($info['updated']);
207		}
208
209		/**
210		* {@inheritdoc}
211		*/
212		public function delete($key)
213		{
214		$object = $this->bucket->object($this->computePath($key));
215		$object->delete();
216		return true;
217		}
218
219		/**
220		* {@inheritdoc}
221		*/
222		public function rename($sourceKey, $targetKey)
223		{
224		# there is no support for rename currently in Google Cloud Client Library 0.7.1 - it will be added in v0.8 any time now
225		return false;
226		}
227
228		/**
229		* {@inheritdoc}
230		*/
231		public function setMetadata($key, $metadata)
232		{
233		$this->metadata[$key] = $metadata;
234		}
235
236		/**
237		* {@inheritdoc}
238		*/
239		public function getMetadata($key)
240		{
241		return isset($this->metadata[$key]) ? $this->metadata[$key] : array();
242		}
243
244		/**
245		* {@inheritdoc}
246		*/
247		public function setResource($key, $data)
248		{
249		$this->resource[$key] = $data;
250		}
251
252		/**
253		* {@inheritdoc}
254		*/
255		public function getResource($key, $name = null)
256		{
257		if (isset($this->resource[$key]))
258		{
259		if ($name)
260		{
261		return isset($this->resource[$key][$name]) ? $this->resource[$key][$name] : null;
262		} elseif (isset($this->resource[$key])) {
263		return isset($this->resource[$key]) ? $this->resource[$key] : array();
264		}
265		}
266		return array();
267		}
268		}

KnpLabs / Gaufrette

Pull Request — master (#427)

GoogleCloudClientStorage A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

20 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like