EmailVerifiedSecondFactorRemindersCommand::configure() - Code Metrics - Inspection of "Feature/component info" - OpenConext/Stepup-Middleware - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#312)

unknown

created 2020-09-17 12:16 UTC

configure() A

↳ Parent: EmailVerifiedSecondFactorRemindersCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	18
rs	9.6666
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

/**
 * Copyright 2014 SURFnet bv
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace Surfnet\StepupMiddleware\MiddlewareBundle\Console\Command;

use Assert\Assertion;
use DateInterval;
use DateTime;
use Exception;
use InvalidArgumentException;
use Psr\Log\LoggerInterface;
use Rhumsaa\Uuid\Uuid;
use Surfnet\StepupMiddleware\CommandHandlingBundle\EventHandling\BufferedEventBus;
use Surfnet\StepupMiddleware\CommandHandlingBundle\Identity\Command\SendVerifiedSecondFactorRemindersCommand;
use Surfnet\StepupMiddleware\CommandHandlingBundle\Pipeline\TransactionAwarePipeline;
use Surfnet\StepupMiddleware\MiddlewareBundle\Service\DBALConnectionHelper;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;

/**
 * The EmailVerifiedSecondFactorRemindersCommand can be run to send reminders to token registrants.
 *
 * The command utilizes a specific service for this task (VerifiedSecondFactorReminderService). Input validation is
 * performed on the incoming request parameters.
 *
 * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
 */
final class EmailVerifiedSecondFactorRemindersCommand extends Command
{
    /**
     * @var TransactionAwarePipeline
     */
    private $pipeline;

    /**
     * @var BufferedEventBus
     */
    private $eventBus;

    /**
     * @var DBALConnectionHelper
     */
    private $connection;

    /**
     * @var LoggerInterface
     */
    private $logger;

    protected function configure()
    {
        $this
            ->setName('middleware:cron:email-reminder')
            ->setDescription('Sends email reminders to identities with verified tokens more than 7 days old.')
            ->addOption(
                'dry-run',
                null,
                InputOption::VALUE_NONE,
                'Run in dry mode, not sending any email'
            )
            ->addOption(
                'date',
                null,
                InputOption::VALUE_OPTIONAL,
                'The date (Y-m-d) that should be used for sending reminder email messages, defaults to TODAY - 7'
            );
    }

    public function __construct(

        TransactionAwarePipeline $pipeline,
        BufferedEventBus $eventBus,
        DBALConnectionHelper $connection,
        LoggerInterface $logger
    ) {
        $this->pipeline = $pipeline;
        $this->eventBus = $eventBus;
        $this->connection = $connection;
        $this->logger = $logger;
        parent::__construct();
    }

    protected function execute(InputInterface $input, OutputInterface $output)
    {
        try {
            $this->validateInput($input);
        } catch (InvalidArgumentException $e) {
            $output->writeln('<error>' . $e->getMessage() . '</error>');
            $this->logger->error(sprintf('Invalid arguments passed to the %s', $this->getName()), [$e->getMessage()]);
            return 1;
        }

        $date = new DateTime();
        $date->sub(new DateInterval('P7D'));
        if ($input->hasOption('date') && !is_null($input->getOption('date'))) {
            $date = DateTime::createFromFormat('Y-m-d', $input->getOption('date'));
        }

        $dryRun = false;
        if ($input->hasOption('dry-run') && !is_null($input->getOption('dry-run'))) {
            $dryRun = $input->getOption('dry-run');
        }

        $command = new SendVerifiedSecondFactorRemindersCommand();
        $command->requestedAt = $date;
class Id
{
    public $id;

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

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
        $command->dryRun = $dryRun;
class Id
{
    public $id;

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

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
        $command->UUID = Uuid::uuid4()->toString();

        $this->connection->beginTransaction();
        try {
            $this->pipeline->process($command);
            $this->eventBus->flush();

            $this->connection->commit();
        } catch (Exception $e) {
            $output->writeln('<error>An Error occurred while sending reminder email messages.</error>');
            $this->connection->rollBack();
            throw $e;
        }
    }

    private function validateInput(InputInterface $input)
    {
        if ($input->hasOption('date')) {
            $date = $input->getOption('date');
            Assertion::nullOrDate($date, 'Y-m-d', 'Expected date to be a string and formatted in the Y-m-d date format');
        }

        if ($input->hasOption('dry-run')) {
            $dryRun = $input->getOption('dry-run');
            Assertion::nullOrBoolean($dryRun, 'Expected dry-run parameter to be a boolean value.');
        }
    }
}


1		<?php
2
3		/**
4		* Copyright 2014 SURFnet bv
5		*
6		* Licensed under the Apache License, Version 2.0 (the "License");
7		* you may not use this file except in compliance with the License.
8		* You may obtain a copy of the License at
9		*
10		* http://www.apache.org/licenses/LICENSE-2.0
11		*
12		* Unless required by applicable law or agreed to in writing, software
13		* distributed under the License is distributed on an "AS IS" BASIS,
14		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15		* See the License for the specific language governing permissions and
16		* limitations under the License.
17		*/
18
19		namespace Surfnet\StepupMiddleware\MiddlewareBundle\Console\Command;
20
21		use Assert\Assertion;
22		use DateInterval;
23		use DateTime;
24		use Exception;
25		use InvalidArgumentException;
26		use Psr\Log\LoggerInterface;
27		use Rhumsaa\Uuid\Uuid;
28		use Surfnet\StepupMiddleware\CommandHandlingBundle\EventHandling\BufferedEventBus;
29		use Surfnet\StepupMiddleware\CommandHandlingBundle\Identity\Command\SendVerifiedSecondFactorRemindersCommand;
30		use Surfnet\StepupMiddleware\CommandHandlingBundle\Pipeline\TransactionAwarePipeline;
31		use Surfnet\StepupMiddleware\MiddlewareBundle\Service\DBALConnectionHelper;
32		use Symfony\Component\Console\Command\Command;
33		use Symfony\Component\Console\Input\InputInterface;
34		use Symfony\Component\Console\Input\InputOption;
35		use Symfony\Component\Console\Output\OutputInterface;
36
37		/**
38		* The EmailVerifiedSecondFactorRemindersCommand can be run to send reminders to token registrants.
39		*
40		* The command utilizes a specific service for this task (VerifiedSecondFactorReminderService). Input validation is
41		* performed on the incoming request parameters.
42		*
43		* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
44		*/
45		final class EmailVerifiedSecondFactorRemindersCommand extends Command
46		{
47		/**
48		* @var TransactionAwarePipeline
49		*/
50		private $pipeline;
51
52		/**
53		* @var BufferedEventBus
54		*/
55		private $eventBus;
56
57		/**
58		* @var DBALConnectionHelper
59		*/
60		private $connection;
61
62		/**
63		* @var LoggerInterface
64		*/
65		private $logger;
66
67		protected function configure()
68		{
69		$this
70		->setName('middleware:cron:email-reminder')
71		->setDescription('Sends email reminders to identities with verified tokens more than 7 days old.')
72		->addOption(
73		'dry-run',
74		null,
75		InputOption::VALUE_NONE,
76		'Run in dry mode, not sending any email'
77		)
78		->addOption(
79		'date',
80		null,
81		InputOption::VALUE_OPTIONAL,
82		'The date (Y-m-d) that should be used for sending reminder email messages, defaults to TODAY - 7'
83		);
84		}
85
86	View Code Duplication	public function __construct(
		0 ignored issues – show Duplication introduced 2020-09-17 07:35 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...
87		TransactionAwarePipeline $pipeline,
88		BufferedEventBus $eventBus,
89		DBALConnectionHelper $connection,
90		LoggerInterface $logger
91		) {
92		$this->pipeline = $pipeline;
93		$this->eventBus = $eventBus;
94		$this->connection = $connection;
95		$this->logger = $logger;
96		parent::__construct();
97		}
98
99		protected function execute(InputInterface $input, OutputInterface $output)
100		{
101		try {
102		$this->validateInput($input);
103		} catch (InvalidArgumentException $e) {
104		$output->writeln('<error>' . $e->getMessage() . '</error>');
105		$this->logger->error(sprintf('Invalid arguments passed to the %s', $this->getName()), [$e->getMessage()]);
106		return 1;
107		}
108
109		$date = new DateTime();
110		$date->sub(new DateInterval('P7D'));
111		if ($input->hasOption('date') && !is_null($input->getOption('date'))) {
112		$date = DateTime::createFromFormat('Y-m-d', $input->getOption('date'));
113		}
114
115		$dryRun = false;
116		if ($input->hasOption('dry-run') && !is_null($input->getOption('dry-run'))) {
117		$dryRun = $input->getOption('dry-run');
118		}
119
120		$command = new SendVerifiedSecondFactorRemindersCommand();
121		$command->requestedAt = $date;
		0 ignored issues – show Documentation Bug introduced 2017-11-16 08:15 UTC by Report Bug Copy Issue Report It seems like `$date` can also be of type `false`. However, the property `$requestedAt` is declared as type `object<DateTime>`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
122		$command->dryRun = $dryRun;
		0 ignored issues – show Documentation Bug introduced 2019-01-21 15:32 UTC by Report Bug Copy Issue Report It seems like `$dryRun` can also be of type `string` or `array<integer,string>`. However, the property `$dryRun` is declared as type `boolean`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
123		$command->UUID = Uuid::uuid4()->toString();
124
125		$this->connection->beginTransaction();
126		try {
127		$this->pipeline->process($command);
128		$this->eventBus->flush();
129
130		$this->connection->commit();
131		} catch (Exception $e) {
132		$output->writeln('<error>An Error occurred while sending reminder email messages.</error>');
133		$this->connection->rollBack();
134		throw $e;
135		}
136		}
137
138		private function validateInput(InputInterface $input)
139		{
140		if ($input->hasOption('date')) {
141		$date = $input->getOption('date');
142		Assertion::nullOrDate($date, 'Y-m-d', 'Expected date to be a string and formatted in the Y-m-d date format');
143		}
144
145		if ($input->hasOption('dry-run')) {
146		$dryRun = $input->getOption('dry-run');
147		Assertion::nullOrBoolean($dryRun, 'Expected dry-run parameter to be a boolean value.');
148		}
149		}
150		}
151

OpenConext / Stepup-Middleware

Pull Request — develop (#312)

configure() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like