Container::createObject() - Code Metrics - Inspection of "bump test coverage" - php-opencloud/openstack - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 307cce...27531d )

by Jamie

created 2015-11-26 10:42 UTC

Container::createObject() A

↳ Parent: Container

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	2
Bugs	0	Features	2

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

<?php

namespace OpenStack\ObjectStore\v1\Models;

use Psr\Http\Message\ResponseInterface;
use OpenStack\Common\Error\BadResponseError;
use OpenStack\Common\Resource\AbstractResource;
use OpenStack\Common\Resource\Creatable;
use OpenStack\Common\Resource\Deletable;
use OpenStack\Common\Resource\HasMetadata;
use OpenStack\Common\Resource\Listable;
use OpenStack\Common\Resource\Retrievable;

/**
 * @property \OpenStack\ObjectStore\v1\Api $api
 */
class Container extends AbstractResource implements Creatable, Deletable, Retrievable, Listable, HasMetadata
{
    use MetadataTrait;

    const METADATA_PREFIX = 'X-Container-Meta-';

    /** @var int */
    public $objectCount;

    /** @var int */
    public $bytesUsed;

    /** @var string */
    public $name;

    /** @var array */
    public $metadata;

    protected $markerKey = 'name';

    /**
     * {@inheritdoc}
     */
    public function populateFromResponse(ResponseInterface $response)
    {
        parent::populateFromResponse($response);

        $this->objectCount = $response->getHeaderLine('X-Container-Object-Count');
$answer = 42;

$correct = false;

$correct = (bool) $answer;
        $this->bytesUsed = $response->getHeaderLine('X-Container-Bytes-Used');
$answer = 42;

$correct = false;

$correct = (bool) $answer;
        $this->metadata = $this->parseMetadata($response);
    }

    /**
     * Retrieves a collection of object resources in the form of a generator.
     *
     * @param array         $options {@see \OpenStack\ObjectStore\v1\Api::getContainer}
     * @param callable|null $mapFn   Allows a function to be mapped over each element.
     *
     * @return \Generator
     */
    public function listObjects(array $options = [], callable $mapFn = null)
    {
        $options = array_merge($options, ['name' => $this->name, 'format' => 'json']);
        return $this->model(Object::class)->enumerate($this->api->getContainer(), $options, $mapFn);
    }

    /**
     * {@inheritdoc}
     */
    public function retrieve()
    {
        $response = $this->executeWithState($this->api->headContainer());
        $this->populateFromResponse($response);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
    }

    /**
     * @param array $data {@see \OpenStack\ObjectStore\v1\Api::putContainer}
     *
     * @return $this
     */
    public function create(array $data)
    {
        $response = $this->execute($this->api->putContainer(), $data);

        $this->populateFromResponse($response);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        $this->name = $data['name'];

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function delete()
    {
        $this->executeWithState($this->api->deleteContainer());
    }

    /**
     * {@inheritdoc}
     */
    public function mergeMetadata(array $metadata)
    {
        $response = $this->execute($this->api->postContainer(), ['name' => $this->name, 'metadata' => $metadata]);
        return $this->parseMetadata($response);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
    }

    /**
     * {@inheritdoc}
     */
    public function resetMetadata(array $metadata)

    {
        $options = [
            'name'           => $this->name,
            'removeMetadata' => [],
            'metadata'       => $metadata,
        ];

        foreach ($this->getMetadata() as $key => $val) {
            if (!array_key_exists($key, $metadata)) {
                $options['removeMetadata'][$key] = 'True';
            }
        }

        $response = $this->execute($this->api->postContainer(), $options);
        return $this->parseMetadata($response);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
    }

    /**
     * {@inheritdoc}
     */
    public function getMetadata()
    {
        $response = $this->executeWithState($this->api->headContainer());
        return $this->parseMetadata($response);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
    }

    /**
     * Retrieves an Object and populates its `name` and `containerName` properties according to the name provided and
     * the name of this container. A HTTP call will not be executed by default - you need to call
     * {@see Object::retrieve} or {@see Object::download} on the returned Object object to do that.
     *
     * @param string $name The name of the object
     *
     * @return Object
     */
    public function getObject($name)
    {
        return $this->model(Object::class, ['containerName' => $this->name, 'name' => $name]);
    }

    /**
     * Identifies whether an object exists in this container.
     *
     * @param string $name The name of the object.
     *
     * @return bool TRUE if the object exists, FALSE if it does not.
     *
     * @throws BadResponseError For any other HTTP error which does not have a 404 Not Found status.
     * @throws \Exception       For any other type of fatal error.
     */
    public function objectExists($name)
    {
        try {
            $this->getObject($name)->retrieve();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            return true;
        } catch (BadResponseError $e) {
            if ($e->getResponse()->getStatusCode() === 404) {
                return false;
            }
            throw $e;
        }
    }

    /**
     * Creates a single object according to the values provided.
     *
     * @param array $data {@see \OpenStack\ObjectStore\v1\Api::putObject}
     *
     * @return Object
     */
    public function createObject(array $data)
    {
        return $this->model(Object::class)->create($data + ['containerName' => $this->name]);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }
}


1			<?php
2
3			namespace OpenStack\ObjectStore\v1\Models;
4
5			use Psr\Http\Message\ResponseInterface;
6			use OpenStack\Common\Error\BadResponseError;
7			use OpenStack\Common\Resource\AbstractResource;
8			use OpenStack\Common\Resource\Creatable;
9			use OpenStack\Common\Resource\Deletable;
10			use OpenStack\Common\Resource\HasMetadata;
11			use OpenStack\Common\Resource\Listable;
12			use OpenStack\Common\Resource\Retrievable;
13
14			/**
15			* @property \OpenStack\ObjectStore\v1\Api $api
16			*/
17			class Container extends AbstractResource implements Creatable, Deletable, Retrievable, Listable, HasMetadata
18			{
19			use MetadataTrait;
20
21			const METADATA_PREFIX = 'X-Container-Meta-';
22
23			/** @var int */
24			public $objectCount;
25
26			/** @var int */
27			public $bytesUsed;
28
29			/** @var string */
30			public $name;
31
32			/** @var array */
33			public $metadata;
34
35			protected $markerKey = 'name';
36
37			/**
38			* {@inheritdoc}
39			*/
40	4		public function populateFromResponse(ResponseInterface $response)
41			{
42	4		parent::populateFromResponse($response);
43
44	4		$this->objectCount = $response->getHeaderLine('X-Container-Object-Count');
			0 ignored issues – show Documentation Bug introduced 2015-11-23 10:33 UTC by Report Bug Copy Issue Report The property `$objectCount` was declared of type `integer`, but `$response->getHeaderLine...ontainer-Object-Count')` is of type `string`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
45	4		$this->bytesUsed = $response->getHeaderLine('X-Container-Bytes-Used');
			0 ignored issues – show Documentation Bug introduced 2015-11-23 10:33 UTC by Report Bug Copy Issue Report The property `$bytesUsed` was declared of type `integer`, but `$response->getHeaderLine...-Container-Bytes-Used')` is of type `string`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
46	4		$this->metadata = $this->parseMetadata($response);
47	4		}
48
49			/**
50			* Retrieves a collection of object resources in the form of a generator.
51			*
52			* @param array $options {@see \OpenStack\ObjectStore\v1\Api::getContainer}
53			* @param callable\|null $mapFn Allows a function to be mapped over each element.
54			*
55			* @return \Generator
56			*/
57	1		public function listObjects(array $options = [], callable $mapFn = null)
58			{
59	1		$options = array_merge($options, ['name' => $this->name, 'format' => 'json']);
60	1		return $this->model(Object::class)->enumerate($this->api->getContainer(), $options, $mapFn);
61			}
62
63			/**
64			* {@inheritdoc}
65			*/
66	1		public function retrieve()
67			{
68	1		$response = $this->executeWithState($this->api->headContainer());
69	1		$this->populateFromResponse($response);
			0 ignored issues – show Bug introduced 2015-11-26 10:46 UTC by Report Bug Copy Issue Report It seems like `$response` defined by `$this->executeWithState(...->api->headContainer())` on line `68` can also be of type `object<GuzzleHttp\Promise\PromiseInterface>`; however, `OpenStack\ObjectStore\v1...:populateFromResponse()` does only seem to accept `object<Psr\Http\Message\ResponseInterface>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
70	1		}
71
72			/**
73			* @param array $data {@see \OpenStack\ObjectStore\v1\Api::putContainer}
74			*
75			* @return $this
76			*/
77	2		public function create(array $data)
78			{
79	2		$response = $this->execute($this->api->putContainer(), $data);
80
81	2		$this->populateFromResponse($response);
			0 ignored issues – show Bug introduced 2015-11-26 10:46 UTC by Report Bug Copy Issue Report It seems like `$response` defined by `$this->execute($this->api->putContainer(), $data)` on line `79` can also be of type `object<GuzzleHttp\Promise\PromiseInterface>`; however, `OpenStack\ObjectStore\v1...:populateFromResponse()` does only seem to accept `object<Psr\Http\Message\ResponseInterface>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
82	2		$this->name = $data['name'];
83
84	2		return $this;
85			}
86
87			/**
88			* {@inheritdoc}
89			*/
90	1		public function delete()
91			{
92	1		$this->executeWithState($this->api->deleteContainer());
93	1		}
94
95			/**
96			* {@inheritdoc}
97			*/
98	1		public function mergeMetadata(array $metadata)
99			{
100	1		$response = $this->execute($this->api->postContainer(), ['name' => $this->name, 'metadata' => $metadata]);
101	1		return $this->parseMetadata($response);
			0 ignored issues – show Bug introduced 2015-11-26 10:46 UTC by Report Bug Copy Issue Report It seems like `$response` defined by `$this->execute($this->ap...etadata' => $metadata))` on line `100` can also be of type `object<GuzzleHttp\Promise\PromiseInterface>`; however, `OpenStack\ObjectStore\v1...aTrait::parseMetadata()` does only seem to accept `object<Psr\Http\Message\ResponseInterface>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
102			}
103
104			/**
105			* {@inheritdoc}
106			*/
107	1	View Code Duplication	public function resetMetadata(array $metadata)
			0 ignored issues – show Duplication introduced 2015-11-23 10:33 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			$options = [
110	1		'name' => $this->name,
111	1		'removeMetadata' => [],
112	1		'metadata' => $metadata,
113	1		];
114
115	1		foreach ($this->getMetadata() as $key => $val) {
116	1		if (!array_key_exists($key, $metadata)) {
117	1		$options['removeMetadata'][$key] = 'True';
118	1		}
119	1		}
120
121	1		$response = $this->execute($this->api->postContainer(), $options);
122	1		return $this->parseMetadata($response);
			0 ignored issues – show Bug introduced 2015-11-26 10:46 UTC by Report Bug Copy Issue Report It seems like `$response` defined by `$this->execute($this->ap...tContainer(), $options)` on line `121` can also be of type `object<GuzzleHttp\Promise\PromiseInterface>`; however, `OpenStack\ObjectStore\v1...aTrait::parseMetadata()` does only seem to accept `object<Psr\Http\Message\ResponseInterface>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
123			}
124
125			/**
126			* {@inheritdoc}
127			*/
128	2		public function getMetadata()
129			{
130	2		$response = $this->executeWithState($this->api->headContainer());
131	2		return $this->parseMetadata($response);
			0 ignored issues – show Bug introduced 2015-11-26 10:46 UTC by Report Bug Copy Issue Report It seems like `$response` defined by `$this->executeWithState(...->api->headContainer())` on line `130` can also be of type `object<GuzzleHttp\Promise\PromiseInterface>`; however, `OpenStack\ObjectStore\v1...aTrait::parseMetadata()` does only seem to accept `object<Psr\Http\Message\ResponseInterface>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
132			}
133
134			/**
135			* Retrieves an Object and populates its `name` and `containerName` properties according to the name provided and
136			* the name of this container. A HTTP call will not be executed by default - you need to call
137			* {@see Object::retrieve} or {@see Object::download} on the returned Object object to do that.
138			*
139			* @param string $name The name of the object
140			*
141			* @return Object
142			*/
143	4		public function getObject($name)
144			{
145	4		return $this->model(Object::class, ['containerName' => $this->name, 'name' => $name]);
146			}
147
148			/**
149			* Identifies whether an object exists in this container.
150			*
151			* @param string $name The name of the object.
152			*
153			* @return bool TRUE if the object exists, FALSE if it does not.
154			*
155			* @throws BadResponseError For any other HTTP error which does not have a 404 Not Found status.
156			* @throws \Exception For any other type of fatal error.
157			*/
158	3		public function objectExists($name)
159			{
160			try {
161	3		$this->getObject($name)->retrieve();
			0 ignored issues – show Bug introduced 2015-11-23 10:33 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `OpenStack\Common\Resource\ResourceInterface` as the method `retrieve()` does only exist in the following implementations of said interface: `OpenStack\BlockStorage\v2\Models\Snapshot`, `OpenStack\BlockStorage\v2\Models\Volume`, `OpenStack\Compute\v2\Models\Flavor`, `OpenStack\Compute\v2\Models\Image`, `OpenStack\Compute\v2\Models\Server`, `OpenStack\Identity\v3\Models\Credential`, `OpenStack\Identity\v3\Models\Domain`, `OpenStack\Identity\v3\Models\Group`, `OpenStack\Identity\v3\Models\Policy`, `OpenStack\Identity\v3\Models\Project`, `OpenStack\Identity\v3\Models\Service`, `OpenStack\Identity\v3\Models\Token`, `OpenStack\Identity\v3\Models\User`, `OpenStack\Networking\v2\Models\Network`, `OpenStack\Networking\v2\Models\Subnet`, `OpenStack\ObjectStore\v1\Models\Account`, `OpenStack\ObjectStore\v1\Models\Container`, `OpenStack\ObjectStore\v1\Models\Object`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
162	1		return true;
163	2		} catch (BadResponseError $e) {
164	2		if ($e->getResponse()->getStatusCode() === 404) {
165	1		return false;
166			}
167	1		throw $e;
168			}
169			}
170
171			/**
172			* Creates a single object according to the values provided.
173			*
174			* @param array $data {@see \OpenStack\ObjectStore\v1\Api::putObject}
175			*
176			* @return Object
177			*/
178	1		public function createObject(array $data)
179			{
180	1		return $this->model(Object::class)->create($data + ['containerName' => $this->name]);
			0 ignored issues – show Bug introduced 2015-11-23 10:33 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `OpenStack\Common\Resource\ResourceInterface` as the method `create()` does only exist in the following implementations of said interface: `OpenStack\BlockStorage\v2\Models\Snapshot`, `OpenStack\BlockStorage\v2\Models\Volume`, `OpenStack\BlockStorage\v2\Models\VolumeType`, `OpenStack\Compute\v2\Models\Server`, `OpenStack\Identity\v3\Models\Credential`, `OpenStack\Identity\v3\Models\Domain`, `OpenStack\Identity\v3\Models\Endpoint`, `OpenStack\Identity\v3\Models\Group`, `OpenStack\Identity\v3\Models\Policy`, `OpenStack\Identity\v3\Models\Project`, `OpenStack\Identity\v3\Models\Role`, `OpenStack\Identity\v3\Models\Service`, `OpenStack\Identity\v3\Models\Token`, `OpenStack\Identity\v3\Models\User`, `OpenStack\Networking\v2\Models\Network`, `OpenStack\Networking\v2\Models\Subnet`, `OpenStack\ObjectStore\v1\Models\Container`, `OpenStack\ObjectStore\v1\Models\Object`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
181			}
182			}
183

php-opencloud / openstack

GitHub Access Token became invalid

Push — master ( 307cce...27531d )

Container::createObject() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like