S3ClientStub::getIterator() - Code Metrics - Inspection of "More test cases and coverage ignores" - thephpleague/flysystem-aws-s3-v3 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 2.x ( 3ea09a...0ff08f )

by Frank

created 2020-10-21 21:19 UTC

S3ClientStub::getIterator() A

↳ Parent: S3ClientStub

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

declare(strict_types=1);

namespace League\Flysystem\AwsS3V3;

use Aws\Command;
use Aws\CommandInterface;
use Aws\ResultInterface;
use Aws\S3\Exception\S3Exception;
use Aws\S3\S3ClientInterface;
use Aws\S3\S3ClientTrait;
use GuzzleHttp\Psr7\Response;

use function GuzzleHttp\Promise\promise_for;

/**
 * @codeCoverageIgnore
 */
class S3ClientStub implements S3ClientInterface
{
    use S3ClientTrait;

    /**
     * @var S3ClientInterface
     */
    private $actualClient;

    /**
     * @var S3Exception[]
     */
    private $stagedExceptions = [];

    /**
     * @var ResultInterface[]
     */
    private $stagedResult = [];

    public function __construct(S3ClientInterface $client)
    {
        return $this->actualClient = $client;

    }

    public function failOnNextCopy(): void
    {
        $this->throwExceptionWhenExecutingCommand('CopyObject');
    }

    public function throwExceptionWhenExecutingCommand(string $commandName, S3Exception $exception = null): void
    {
        $this->stagedExceptions[$commandName] = $exception ?: new S3Exception($commandName, new Command($commandName));
    }

    public function throw500ExceptionWhenExecutingCommand(string $commandName): void
    {
        $response = new Response(500);
        $exception = new S3Exception($commandName, new Command($commandName), compact('response'));

        $this->throwExceptionWhenExecutingCommand($commandName, $exception);
    }

    public function stageResultForCommand(string $commandName, ResultInterface $result): void
    {
        $this->stagedResult[$commandName] = $result;
    }

    public function execute(CommandInterface $command)
    {
        return $this->executeAsync($command)->wait();
    }

    public function getCommand($name, array $args = [])
    {
        return $this->actualClient->getCommand($name, $args);
    }

    public function getHandlerList()
    {
        return $this->actualClient->getHandlerList();
    }

    public function getIterator($name, array $args = [])
    {
        return $this->actualClient->getIterator($name, $args);
    }

    public function __call($name, array $arguments)
    {
        return $this->actualClient->__call($name, $arguments);
    }

    public function executeAsync(CommandInterface $command)
    {
        $name = $command->getName();

        if (array_key_exists($name, $this->stagedExceptions)) {
            $exception = $this->stagedExceptions[$name];
            unset($this->stagedExceptions[$name]);
            throw $exception;
        }

        if (array_key_exists($name, $this->stagedResult)) {
            $result = $this->stagedResult[$name];
            unset($this->stagedResult[$name]);

            return promise_for($result);

        }

        return $this->actualClient->executeAsync($command);
    }

    public function getCredentials()
    {
        return $this->actualClient->getCredentials();
    }

    public function getRegion()
    {
        return $this->actualClient->getRegion();
    }

    public function getEndpoint()
    {
        return $this->actualClient->getEndpoint();
    }

    public function getApi()
    {
        return $this->actualClient->getApi();
    }

    public function getConfig($option = null)
    {
        return $this->actualClient->getConfig($option);
    }

    public function getPaginator($name, array $args = [])
    {
        return $this->actualClient->getPaginator($name, $args);
    }

    public function waitUntil($name, array $args = [])
    {
        $this->actualClient->waitUntil($name, $args);
    }

    public function getWaiter($name, array $args = [])
    {
        return $this->actualClient->getWaiter($name, $args);
    }

    public function createPresignedRequest(CommandInterface $command, $expires, array $options = [])
    {
        return $this->actualClient->createPresignedRequest($command, $expires, $options);
    }

    public function getObjectUrl($bucket, $key)
    {
        return $this->actualClient->getObjectUrl($bucket, $key);
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace League\Flysystem\AwsS3V3;
6
7			use Aws\Command;
8			use Aws\CommandInterface;
9			use Aws\ResultInterface;
10			use Aws\S3\Exception\S3Exception;
11			use Aws\S3\S3ClientInterface;
12			use Aws\S3\S3ClientTrait;
13			use GuzzleHttp\Psr7\Response;
14
15			use function GuzzleHttp\Promise\promise_for;
16
17			/**
18			* @codeCoverageIgnore
19			*/
20			class S3ClientStub implements S3ClientInterface
21			{
22			use S3ClientTrait;
23
24			/**
25			* @var S3ClientInterface
26			*/
27			private $actualClient;
28
29			/**
30			* @var S3Exception[]
31			*/
32			private $stagedExceptions = [];
33
34			/**
35			* @var ResultInterface[]
36			*/
37			private $stagedResult = [];
38
39			public function __construct(S3ClientInterface $client)
40			{
41			return $this->actualClient = $client;
			0 ignored issues – show Bug introduced 2020-10-13 12:48 UTC by Report Bug Copy Issue Report Constructors do not have meaningful return values, anything that is returned from here is discarded. Are you sure this is correct? Loading history...
42			}
43
44			public function failOnNextCopy(): void
45			{
46			$this->throwExceptionWhenExecutingCommand('CopyObject');
47			}
48
49			public function throwExceptionWhenExecutingCommand(string $commandName, S3Exception $exception = null): void
50			{
51			$this->stagedExceptions[$commandName] = $exception ?: new S3Exception($commandName, new Command($commandName));
52			}
53
54			public function throw500ExceptionWhenExecutingCommand(string $commandName): void
55			{
56			$response = new Response(500);
57			$exception = new S3Exception($commandName, new Command($commandName), compact('response'));
58
59			$this->throwExceptionWhenExecutingCommand($commandName, $exception);
60			}
61
62			public function stageResultForCommand(string $commandName, ResultInterface $result): void
63			{
64			$this->stagedResult[$commandName] = $result;
65			}
66
67			public function execute(CommandInterface $command)
68			{
69			return $this->executeAsync($command)->wait();
70			}
71
72			public function getCommand($name, array $args = [])
73			{
74			return $this->actualClient->getCommand($name, $args);
75			}
76
77			public function getHandlerList()
78			{
79			return $this->actualClient->getHandlerList();
80			}
81
82			public function getIterator($name, array $args = [])
83			{
84			return $this->actualClient->getIterator($name, $args);
85			}
86
87			public function __call($name, array $arguments)
88			{
89			return $this->actualClient->__call($name, $arguments);
90			}
91
92			public function executeAsync(CommandInterface $command)
93			{
94			$name = $command->getName();
95
96			if (array_key_exists($name, $this->stagedExceptions)) {
97			$exception = $this->stagedExceptions[$name];
98			unset($this->stagedExceptions[$name]);
99			throw $exception;
100			}
101
102			if (array_key_exists($name, $this->stagedResult)) {
103			$result = $this->stagedResult[$name];
104			unset($this->stagedResult[$name]);
105
106			return promise_for($result);
			0 ignored issues – show Deprecated Code introduced 2020-10-21 19:36 UTC by Report Bug Copy Issue Report The function `GuzzleHttp\Promise\promise_for()` has been deprecated with message: promise_for will be removed in guzzlehttp/promises:2.0. Use Create::promiseFor instead. This function has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the function will be removed from the class and what other function to use instead. Loading history...
107			}
108
109			return $this->actualClient->executeAsync($command);
110			}
111
112			public function getCredentials()
113			{
114			return $this->actualClient->getCredentials();
115			}
116
117			public function getRegion()
118			{
119			return $this->actualClient->getRegion();
120			}
121
122			public function getEndpoint()
123			{
124			return $this->actualClient->getEndpoint();
125			}
126
127			public function getApi()
128			{
129			return $this->actualClient->getApi();
130			}
131
132			public function getConfig($option = null)
133			{
134			return $this->actualClient->getConfig($option);
135			}
136
137			public function getPaginator($name, array $args = [])
138			{
139			return $this->actualClient->getPaginator($name, $args);
140			}
141
142			public function waitUntil($name, array $args = [])
143			{
144			$this->actualClient->waitUntil($name, $args);
145			}
146
147			public function getWaiter($name, array $args = [])
148			{
149			return $this->actualClient->getWaiter($name, $args);
150			}
151
152			public function createPresignedRequest(CommandInterface $command, $expires, array $options = [])
153			{
154			return $this->actualClient->createPresignedRequest($command, $expires, $options);
155			}
156
157			public function getObjectUrl($bucket, $key)
158			{
159			return $this->actualClient->getObjectUrl($bucket, $key);
160			}
161			}
162

thephpleague / flysystem-aws-s3-v3

Push — 2.x ( 3ea09a...0ff08f )

S3ClientStub::getIterator() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like