ProcessQueueScript::defaultArguments() - Code Metrics - Inspection of "Merge pull request #5 from locomotivemtl/mcaskill-..." - locomotivemtl/charcoal-email - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 8924b8...a73d41 )

by Mathieu

created 2020-08-07 15:39 UTC

ProcessQueueScript::defaultArguments() A

↳ Parent: ProcessQueueScript

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	32
rs	9.408
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

declare(strict_types=1);

namespace Charcoal\Email\Script;

// From PSR-7
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;

// From Pimple
use Pimple\Container;

// From 'charcoal-app'
use Charcoal\App\Script\AbstractScript;
use Charcoal\App\Script\CronScriptInterface;
use Charcoal\App\Script\CronScriptTrait;

// From 'charcoal-factory'
use Charcoal\Factory\FactoryInterface;

// From 'charcoal-email'
use Charcoal\Email\EmailQueueManager;

/**
 * Script: Process Email Queue
 *
 * Can also be used as a cron script.
 */
class ProcessQueueScript extends AbstractScript implements CronScriptInterface
{
    use CronScriptTrait;

    /**
     * @var FactoryInterface
     */
    private $queueItemFactory;

    /**
     * Process all messages currently in queue.
     *
     * @param  RequestInterface  $request  A PSR-7 compatible Request instance.
     * @param  ResponseInterface $response A PSR-7 compatible Response instance.
     * @return ResponseInterface
     */
    public function run(RequestInterface $request, ResponseInterface $response): ResponseInterface
    {
        // Unused parameter
        unset($request);

        // Lock script; Ensure it can not be run twice at the same time.
        $this->startLock();

        $cli = $this->climate();

        if ($this->dryRun()) {
            $cli->shout('This command does not support --dry-run');
            $cli->br();
            $cli->whisper('Doing nothing');
            return $response;
        }

        $queueManager = $this->makeQueueManager();
        $queueManager->processQueue();

        // Unlock script
        $this->stopLock();

        return $response;
    }

    /**
     * Default script arguments.
     *
     * @return array
     */
    public function defaultArguments()
    {
        $arguments = [
            'queue-id' => [
                'longPrefix'   => 'queue-id',
                'description'  => 'The queue to process. If blank, all queues will be processed.',
                'defaultValue' => null,
                'castTo'       => 'string',
            ],
            'rate' => [
                'longPrefix'   => 'rate',
                'description'  => 'Number of items to process per second.',
                'defaultValue' => 50,
                'castTo'       => 'int',
            ],
            'limit' => [
                'longPrefix'   => 'limit',
                'description'  => 'Maximum number of items to process.',
                'defaultValue' => null,
                'castTo'       => 'int',
            ],
            'chunk-size' => [
                'longPrefix'   => 'chunk-size',
                'description'  => 'Number of items to keep in memory at a given time.',
                'defaultValue' => 100,
                'castTo'       => 'int',
            ],
        ];

        $arguments = array_merge(parent::defaultArguments(), $arguments);
        return $arguments;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * Create and prepare the queue manager.
     *
     * @return EmailQueueManager
     */
    protected function makeQueueManager()
    {
        $cli = $this->climate();

        $data = [
            'logger'             => $this->logger,
            'queue_item_factory' => $this->queueItemFactory,
            'chunkSize'          => 100,
        ];

        $rate = $cli->arguments->get('rate');
        if ($rate !== null) {
            $data['rate'] = $rate;
        }

        $limit = $cli->arguments->get('limit');
        if ($limit !== null) {
            $data['limit'] = $limit;
        }

        $chunkSize = $cli->arguments->get('chunk-size');
        if ($chunkSize !== null) {
            $data['chunkSize'] = $chunkSize;
        }

        $class = $this->getQueueManagerClass();
        $queueManager = new $class($data);
        $queueManager->setProcessedCallback($this->getProcessedQueueCallback());

        $queueId = $cli->arguments->get('queue-id');
        if ($queueId !== null) {
            $data['queue_id'] = $queueId;
        }

        return $queueManager;
    }

    /**
     * Retrieve the class name of the queue manager model.
     *
     * @return string
     */
    protected function getQueueManagerClass(): string
    {
        return EmailQueueManager::class;
    }

    /**
     * @return Closure
     */
    protected function getProcessedQueueCallback(): callable
    {
        $climate = $this->climate();

        $callback = function ($success, $failures, $skipped) use ($climate): void {
            if (!empty($success)) {
                $climate->green()->out(sprintf('%s emails were successfully sent.', count($success)));
            }

            if (!empty($failures)) {
                $climate->red()->out(sprintf('%s emails failed to be sent', count($failures)));
            }

            if (!empty($skipped)) {
                $climate->dim()->out(sprintf('%s emails were skipped.', count($skipped)));
            }
        };

        return $callback;
    }

    /**
     * @param  Container $container Pimple DI container.
     * @return void
     */
    protected function setDependencies(Container $container): void
    {
        parent::setDependencies($container);
        $this->setQueueItemFactory($container['model/factory']);
    }

    /**
     * @param  FactoryInterface $factory The factory to create queue items.
     * @return void
     */
    private function setQueueItemFactory(FactoryInterface $factory): void
    {
        $this->queueItemFactory = $factory;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Charcoal\Email\Script;
6
7			// From PSR-7
8			use Psr\Http\Message\RequestInterface;
9			use Psr\Http\Message\ResponseInterface;
10
11			// From Pimple
12			use Pimple\Container;
13
14			// From 'charcoal-app'
15			use Charcoal\App\Script\AbstractScript;
16			use Charcoal\App\Script\CronScriptInterface;
17			use Charcoal\App\Script\CronScriptTrait;
18
19			// From 'charcoal-factory'
20			use Charcoal\Factory\FactoryInterface;
21
22			// From 'charcoal-email'
23			use Charcoal\Email\EmailQueueManager;
24
25			/**
26			* Script: Process Email Queue
27			*
28			* Can also be used as a cron script.
29			*/
30			class ProcessQueueScript extends AbstractScript implements CronScriptInterface
31			{
32			use CronScriptTrait;
33
34			/**
35			* @var FactoryInterface
36			*/
37			private $queueItemFactory;
38
39			/**
40			* Process all messages currently in queue.
41			*
42			* @param RequestInterface $request A PSR-7 compatible Request instance.
43			* @param ResponseInterface $response A PSR-7 compatible Response instance.
44			* @return ResponseInterface
45			*/
46			public function run(RequestInterface $request, ResponseInterface $response): ResponseInterface
47			{
48			// Unused parameter
49			unset($request);
50
51			// Lock script; Ensure it can not be run twice at the same time.
52			$this->startLock();
53
54			$cli = $this->climate();
55
56			if ($this->dryRun()) {
57			$cli->shout('This command does not support --dry-run');
58			$cli->br();
59			$cli->whisper('Doing nothing');
60			return $response;
61			}
62
63			$queueManager = $this->makeQueueManager();
64			$queueManager->processQueue();
65
66			// Unlock script
67			$this->stopLock();
68
69			return $response;
70			}
71
72			/**
73			* Default script arguments.
74			*
75			* @return array
76			*/
77			public function defaultArguments()
78			{
79			$arguments = [
80			'queue-id' => [
81			'longPrefix' => 'queue-id',
82			'description' => 'The queue to process. If blank, all queues will be processed.',
83			'defaultValue' => null,
84			'castTo' => 'string',
85			],
86			'rate' => [
87			'longPrefix' => 'rate',
88			'description' => 'Number of items to process per second.',
89			'defaultValue' => 50,
90			'castTo' => 'int',
91			],
92			'limit' => [
93			'longPrefix' => 'limit',
94			'description' => 'Maximum number of items to process.',
95			'defaultValue' => null,
96			'castTo' => 'int',
97			],
98			'chunk-size' => [
99			'longPrefix' => 'chunk-size',
100			'description' => 'Number of items to keep in memory at a given time.',
101			'defaultValue' => 100,
102			'castTo' => 'int',
103			],
104			];
105
106			$arguments = array_merge(parent::defaultArguments(), $arguments);
107			return $arguments;
			0 ignored issues – show Bug Best Practice introduced 2020-08-07 15:53 UTC by Report Bug Copy Issue Report The return type of `return $arguments;` (`array<string,array>`) is incompatible with the return type of the parent method `Charcoal\App\Script\Abst...cript::defaultArguments` of type `array<string,array<string,string\|boolean>>`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
108			}
109
110			/**
111			* Create and prepare the queue manager.
112			*
113			* @return EmailQueueManager
114			*/
115			protected function makeQueueManager()
116			{
117			$cli = $this->climate();
118
119			$data = [
120			'logger' => $this->logger,
121			'queue_item_factory' => $this->queueItemFactory,
122			'chunkSize' => 100,
123			];
124
125			$rate = $cli->arguments->get('rate');
126			if ($rate !== null) {
127			$data['rate'] = $rate;
128			}
129
130			$limit = $cli->arguments->get('limit');
131			if ($limit !== null) {
132			$data['limit'] = $limit;
133			}
134
135			$chunkSize = $cli->arguments->get('chunk-size');
136			if ($chunkSize !== null) {
137			$data['chunkSize'] = $chunkSize;
138			}
139
140			$class = $this->getQueueManagerClass();
141			$queueManager = new $class($data);
142			$queueManager->setProcessedCallback($this->getProcessedQueueCallback());
143
144			$queueId = $cli->arguments->get('queue-id');
145			if ($queueId !== null) {
146			$data['queue_id'] = $queueId;
147			}
148
149			return $queueManager;
150			}
151
152			/**
153			* Retrieve the class name of the queue manager model.
154			*
155			* @return string
156			*/
157			protected function getQueueManagerClass(): string
158			{
159			return EmailQueueManager::class;
160			}
161
162			/**
163			* @return Closure
164			*/
165			protected function getProcessedQueueCallback(): callable
166			{
167			$climate = $this->climate();
168
169			$callback = function ($success, $failures, $skipped) use ($climate): void {
170			if (!empty($success)) {
171			$climate->green()->out(sprintf('%s emails were successfully sent.', count($success)));
172			}
173
174			if (!empty($failures)) {
175			$climate->red()->out(sprintf('%s emails failed to be sent', count($failures)));
176			}
177
178			if (!empty($skipped)) {
179			$climate->dim()->out(sprintf('%s emails were skipped.', count($skipped)));
180			}
181			};
182
183			return $callback;
184			}
185
186			/**
187			* @param Container $container Pimple DI container.
188			* @return void
189			*/
190			protected function setDependencies(Container $container): void
191			{
192			parent::setDependencies($container);
193			$this->setQueueItemFactory($container['model/factory']);
194			}
195
196			/**
197			* @param FactoryInterface $factory The factory to create queue items.
198			* @return void
199			*/
200			private function setQueueItemFactory(FactoryInterface $factory): void
201			{
202			$this->queueItemFactory = $factory;
203			}
204			}
205

locomotivemtl / charcoal-email

Push — master ( 8924b8...a73d41 )

ProcessQueueScript::defaultArguments() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like