ExportContactCommand::getCustomerIds() - Code Metrics - Inspection of "refactor export contact process" - commerceleague/magento2-module-activecampaign - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( 81648c...b3bc9a )

by Andreas
created 2019-07-10 19:28 UTC
ExportContactCommand::getCustomerIds() A

↳ Parent: ExportContactCommand
Complexity

Conditions	3
Paths	4
Size

Total Lines	14
Code Lines	6
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	3
eloc	6
c	0
b	0
f	0
nc	4
nop	1
dl	0
loc	14
rs	10
<?php
declare(strict_types=1);
/**
 */

namespace CommerceLeague\ActiveCampaign\Console\Command;

use CommerceLeague\ActiveCampaign\MessageQueue\Topics;
use CommerceLeague\ActiveCampaign\Model\ResourceModel\Magento\CustomerCollectionFactory;
filter:
    dependency_paths: ["lib/*"]
use CommerceLeague\ActiveCampaign\Model\ResourceModel\Magento\CustomerCollection;
use Magento\Framework\Console\Cli;
use Magento\Framework\MessageQueue\PublisherInterface;
use CommerceLeague\ActiveCampaign\Model\ResourceModel\Magento\SubscriberCollectionFactory as SubscriberCollectionFactory;
filter:
    dependency_paths: ["lib/*"]
use CommerceLeague\ActiveCampaign\Model\ResourceModel\Magento\SubscriberCollection as SubscriberCollection;
use Magento\Newsletter\Model\Subscriber;
use Symfony\Component\Console\Exception\RuntimeException;
use Symfony\Component\Console\Helper\ProgressBarFactory;
filter:
    dependency_paths: ["lib/*"]
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;

/**
 * Class ExportContactCommand
 */
class ExportContactCommand extends AbstractExportCommand
{
    private const NAME = 'activecampaign:export:contact';
    private const OPTION_EMAIL = 'email';
    private const OPTION_OMITTED = 'omitted';
    private const OPTION_ALL = 'all';

    /**
     * @var CustomerCollectionFactory
     */
    private $customerCollectionFactory;

    /**
     * @var SubscriberCollectionFactory
     */
    private $subscriberCollectionFactory;

    /**
     * @param CustomerCollectionFactory $customerCollectionFactory
     * @param SubscriberCollectionFactory $subscriberCollectionFactory
     * @param PublisherInterface $publisher
     * @param ProgressBarFactory $progressBarFactory
     */
    public function __construct(
        CustomerCollectionFactory $customerCollectionFactory,
        SubscriberCollectionFactory $subscriberCollectionFactory,
        PublisherInterface $publisher,
        ProgressBarFactory $progressBarFactory
    ) {
        $this->customerCollectionFactory = $customerCollectionFactory;
        $this->subscriberCollectionFactory = $subscriberCollectionFactory;
        parent::__construct($progressBarFactory, $publisher);
    }

    /**
     * @inheritDoc
     */
    protected function configure()
    {
        $this->setName(self::NAME)
            ->setDescription('Export contacts')
            ->addOption(
                self::OPTION_EMAIL,
                null,
                InputOption::VALUE_REQUIRED,
                'The contact email'
            )
            ->addOption(
                self::OPTION_OMITTED,
                null,
                InputOption::VALUE_NONE,
                'Only export omitted contacts'
            )
            ->addOption(
                self::OPTION_ALL,
                null,
                InputOption::VALUE_NONE,
                'Export all contacts'
            );
    }

    /**
     * @inheritDoc
     */
    protected function interact(InputInterface $input, OutputInterface $output)
    {
        $email = $input->getOption(self::OPTION_EMAIL);
        $omitted = $input->getOption(self::OPTION_OMITTED);
        $all = $input->getOption(self::OPTION_ALL);

        if ($email === null && $omitted === false && $all === false) {
            throw new RuntimeException('Please provide at least one option');
        }

        if ($email !== null && ($omitted === true || $all === true)) {
            throw new RuntimeException('You cannot use --email together with another option');
        }

        if ($omitted === true && $all === true) {
            throw new RuntimeException('You cannot use --omitted and --all together');
        }
    }

    /**
     * @inheritDoc
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $customerIds = $this->getCustomerIds($input);
        $customerIdsCount = count($customerIds);
        $subscriberEmails = $this->getSubscriberEmails($input);
        $subscriberEmailsCount = count($subscriberEmails);

        if (($customerIdsCount + $subscriberEmailsCount) === 0) {
            $output->writeln('<error>No contact(s) found matching your criteria</error>');
            return Cli::RETURN_FAILURE;
        }

        if ($customerIdsCount > 0) {
            $progressBar = $this->createProgressBar(
                $output,
                $customerIdsCount,
                'Customer(s)'
            );

            foreach ($customerIds as $customerId) {
                $this->publisher->publish(
                    Topics::CUSTOMER_CONTACT_EXPORT,
                    json_encode(['magento_customer_id' => $customerId])
                    /** @scrutinizer ignore-type */ json_encode(['magento_customer_id' => $customerId])
                );

                $progressBar->advance();
            }

            $output->writeln('');
        }

        if ($subscriberEmailsCount > 0) {
            $progressBar = $this->createProgressBar(
                $output,
                $subscriberEmailsCount,
                'Subscriber(s)'
            );

            foreach ($subscriberEmails as $subscriberEmail) {
                $this->publisher->publish(
                    Topics::NEWSLETTER_CONTACT_EXPORT,
                    json_encode(['email' => $subscriberEmail])
                );

                $progressBar->advance();
            }

            $output->writeln('');
        }

        $output->writeln(sprintf(
                '<info>%s contacts(s) have been scheduled for export.</info>',
            ($customerIdsCount + $subscriberEmailsCount))
        );

        return Cli::RETURN_SUCCESS;
    }

    /**
     * @param InputInterface $input
     * @return array
     */
    private function getCustomerIds(InputInterface $input): array
    {
        /** @var CustomerCollection $customerCollection */
        $customerCollection = $this->customerCollectionFactory->create();

        if (($email = $input->getOption(self::OPTION_EMAIL)) !== null) {
            $customerCollection->addEmailFilter($email);
        }

        if ($input->getOption(self::OPTION_OMITTED)) {
            $customerCollection->addContactOmittedFilter();
        }

        return $customerCollection->getAllIds();
    }

    /**
     * @param InputInterface $input
     * @return array
     */
    private function getSubscriberEmails(InputInterface $input): array
    {
        /** @var SubscriberCollection $subscriberCollection */
        $subscriberCollection = $this->subscriberCollectionFactory->create();
        $subscriberCollection->excludeCustomers();

        if (($email = $input->getOption(self::OPTION_EMAIL)) !== null) {
            $subscriberCollection->addEmailFilter($email);
        }

        if ($input->getOption(self::OPTION_OMITTED)) {
            $subscriberCollection->addContactOmittedFilter();
        }

        return $subscriberCollection->getAllEmails();
    }
}

commerceleague / magento2-module-activecampaign

GitHub Access Token became invalid

Push — master ( 81648c...b3bc9a )

ExportContactCommand::getCustomerIds() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
