NormalizeLabelsCommand::shippingMethodMapping() - Code Metrics - Inspection of "coding..." - loevgaard/pakkelabels-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 20e80f...9e4566 )

by Joachim

created 2017-10-23 12:15 UTC

NormalizeLabelsCommand::shippingMethodMapping() A

↳ Parent: NormalizeLabelsCommand

Complexity

Conditions	3
Paths	2

Size

Total Lines	13
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	13
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	7
nc	2
nop	1

<?php

namespace Loevgaard\PakkelabelsBundle\Command;

use Assert\Assert;
use Doctrine\Common\Persistence\ObjectManager;
use League\ISO3166\ISO3166;
use Loevgaard\PakkelabelsBundle\Entity\Label;
use Loevgaard\PakkelabelsBundle\Entity\ShippingMethodMapping;
use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
use Symfony\Component\Console\Command\LockableTrait;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;

class NormalizeLabelsCommand extends ContainerAwareCommand
{
    use LockableTrait;

    protected function configure()
    {
        $this->setName('loevgaard:pakkelabels:normalize-labels')
            ->setDescription('Normalizes labels before creation')
            ->addOption('limit', 'l', InputOption::VALUE_REQUIRED, 'The number of labels to normalize', 20)
        ;
    }

    protected function execute(InputInterface $input, OutputInterface $output)
    {
        if (!$this->lock($this->getName())) {
            $output->writeln('The command is already running in another process.');

            return 0;
        }

        $limit = (int)$input->getOption('limit');
        Assert::that($limit)->integer()->greaterThan(0);

        $manager = $this->getManager();

        /** @var Label[] $labels */
        $labels = $manager->getRepository('LoevgaardPakkelabelsBundle:Label')->findBy([
            'status' => Label::STATUS_PENDING_NORMALIZATION
        ], null, $limit);

        if($output->isVerbose()) {
            $output->writeln('Label count: '.count($labels));
        }

        $iso3166 = new ISO3166();

        foreach ($labels as $label) {
            $output->writeln('Normalizing label id: '.$label->getId().' with order id: '.$label->getOrderId(), OutputInterface::VERBOSITY_VERBOSE);

            // check that countries are valid ISO 3166 alpha 2 codes
            $senderCountryValid = false;
            try {
                $iso3166->alpha2($label->getSenderCountryCode());
                $senderCountryValid = true;
            } catch (\Exception $e) {}


            if(!$senderCountryValid) {

                $senderCountry = $this->countryMapping($label->getSenderCountryCode());
                if($senderCountry) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                    $label->setSenderCountryCode($senderCountry);
                } else {
                    $output->writeln('Sender country code `'.$label->getSenderCountryCode().'` is not a valid ISO 3166 alpha 2 country code. Create a mapping or change the country manually.', OutputInterface::VERBOSITY_VERBOSE);
                    $label->markAsError('Sender country code `'.$label->getSenderCountryCode().'` is not a valid ISO 3166 alpha 2 country code. Create a mapping or change the country manually.');
                    $manager->flush();
                    continue;
                }
            }

            $receiverCountryValid = false;
            try {
                $iso3166->alpha2($label->getReceiverCountryCode());
                $receiverCountryValid = true;
            } catch (\Exception $e) {}


            if(!$receiverCountryValid) {

                $receiverCountry = $this->countryMapping($label->getReceiverCountryCode());
                if($receiverCountry) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                    $label->setReceiverCountryCode($receiverCountry);
                } else {
                    $output->writeln('Receiver country code `'.$label->getReceiverCountryCode().'` is not a valid ISO 3166 alpha 2 country code. Create a mapping or change the country manually.', OutputInterface::VERBOSITY_VERBOSE);
                    $label->markAsError('Receiver country code `'.$label->getReceiverCountryCode().'` is not a valid ISO 3166 alpha 2 country code. Create a mapping or change the country manually.');
                    $manager->flush();
                    continue;
                }
            }

            // check that the shipping method is mapped
            if($label->getShippingMethod()) {
                $shippingMethodMapping = $this->shippingMethodMapping($label->getShippingMethod());
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
                if($shippingMethodMapping) {
                    $label->setProductCode($shippingMethodMapping->getProductCode());
                    if(!empty($shippingMethodMapping->getServiceCodes())) {
                        $label->setServiceCodes(join(',', $shippingMethodMapping->getServiceCodes()));
                    }
                } else {
                    $output->writeln('Shipping method `'.$label->getShippingMethod().'` is not mapped. Map it manually.', OutputInterface::VERBOSITY_VERBOSE);
                    $label->markAsError('Shipping method `'.$label->getShippingMethod().'` is not mapped. Map it manually.');
                    $manager->flush();
                    continue;
                }
            }

            $label->setStatus(Label::STATUS_PENDING_CREATION);

            $manager->flush();

            $output->writeln('Label was normalized', OutputInterface::VERBOSITY_VERBOSE);
        }
    }

    /**
     * @param string $country
     * @return null|string
     */
    protected function countryMapping(string $country)
    {
        $manager = $this->getManager();
        $countryMapping = $manager->getRepository('LoevgaardPakkelabelsBundle:CountryMapping')->findOneBy([
            'source' => $country
        ]);

        if($countryMapping && $countryMapping->getCountryCode()) {
            return $countryMapping->getCountryCode();
        }

        return null;
    }

    /**
     * @param string $shippingMethod
     * @return ShippingMethodMapping|null
     */
    protected function shippingMethodMapping(string $shippingMethod)
    {
        $manager = $this->getManager();
        $shippingMethodMapping = $manager->getRepository('LoevgaardPakkelabelsBundle:ShippingMethodMapping')->findOneBy([
            'source' => $shippingMethod
        ]);

        if($shippingMethodMapping && $shippingMethodMapping->getProductCode()) {
            return $shippingMethodMapping;
        }

        return null;
    }

    /**
     * @return ObjectManager
     */
    protected function getManager()
    {
        $em = $this->getContainer()->get('doctrine')->getManager();

        return $em;
    }
}


1		<?php
2
3		namespace Loevgaard\PakkelabelsBundle\Command;
4
5		use Assert\Assert;
6		use Doctrine\Common\Persistence\ObjectManager;
7		use League\ISO3166\ISO3166;
8		use Loevgaard\PakkelabelsBundle\Entity\Label;
9		use Loevgaard\PakkelabelsBundle\Entity\ShippingMethodMapping;
10		use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
11		use Symfony\Component\Console\Command\LockableTrait;
12		use Symfony\Component\Console\Input\InputInterface;
13		use Symfony\Component\Console\Input\InputOption;
14		use Symfony\Component\Console\Output\OutputInterface;
15
16		class NormalizeLabelsCommand extends ContainerAwareCommand
17		{
18		use LockableTrait;
19
20		protected function configure()
21		{
22		$this->setName('loevgaard:pakkelabels:normalize-labels')
23		->setDescription('Normalizes labels before creation')
24		->addOption('limit', 'l', InputOption::VALUE_REQUIRED, 'The number of labels to normalize', 20)
25		;
26		}
27
28		protected function execute(InputInterface $input, OutputInterface $output)
29		{
30		if (!$this->lock($this->getName())) {
31		$output->writeln('The command is already running in another process.');
32
33		return 0;
34		}
35
36		$limit = (int)$input->getOption('limit');
37		Assert::that($limit)->integer()->greaterThan(0);
38
39		$manager = $this->getManager();
40
41		/** @var Label[] $labels */
42		$labels = $manager->getRepository('LoevgaardPakkelabelsBundle:Label')->findBy([
43		'status' => Label::STATUS_PENDING_NORMALIZATION
44		], null, $limit);
45
46		if($output->isVerbose()) {
47		$output->writeln('Label count: '.count($labels));
48		}
49
50		$iso3166 = new ISO3166();
51
52		foreach ($labels as $label) {
53		$output->writeln('Normalizing label id: '.$label->getId().' with order id: '.$label->getOrderId(), OutputInterface::VERBOSITY_VERBOSE);
54
55		// check that countries are valid ISO 3166 alpha 2 codes
56		$senderCountryValid = false;
57		try {
58		$iso3166->alpha2($label->getSenderCountryCode());
59		$senderCountryValid = true;
60		} catch (\Exception $e) {}
		0 ignored issues – show Coding Style Comprehensibility introduced 2017-10-16 14:15 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
61
62	View Code Duplication	if(!$senderCountryValid) {
		0 ignored issues – show Duplication introduced 2017-10-23 12:23 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
63		$senderCountry = $this->countryMapping($label->getSenderCountryCode());
64		if($senderCountry) {
		0 ignored issues – show Bug Best Practice introduced 2017-10-16 14:15 UTC by Report Bug Copy Issue Report The expression `$senderCountry` of type `null\|string` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
65		$label->setSenderCountryCode($senderCountry);
66		} else {
67		$output->writeln('Sender country code `'.$label->getSenderCountryCode().'` is not a valid ISO 3166 alpha 2 country code. Create a mapping or change the country manually.', OutputInterface::VERBOSITY_VERBOSE);
68		$label->markAsError('Sender country code `'.$label->getSenderCountryCode().'` is not a valid ISO 3166 alpha 2 country code. Create a mapping or change the country manually.');
69		$manager->flush();
70		continue;
71		}
72		}
73
74		$receiverCountryValid = false;
75		try {
76		$iso3166->alpha2($label->getReceiverCountryCode());
77		$receiverCountryValid = true;
78		} catch (\Exception $e) {}
		0 ignored issues – show Coding Style Comprehensibility introduced 2017-10-16 14:15 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
79
80	View Code Duplication	if(!$receiverCountryValid) {
		0 ignored issues – show Duplication introduced 2017-10-23 12:23 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
81		$receiverCountry = $this->countryMapping($label->getReceiverCountryCode());
82		if($receiverCountry) {
		0 ignored issues – show Bug Best Practice introduced 2017-10-16 14:15 UTC by Report Bug Copy Issue Report The expression `$receiverCountry` of type `null\|string` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
83		$label->setReceiverCountryCode($receiverCountry);
84		} else {
85		$output->writeln('Receiver country code `'.$label->getReceiverCountryCode().'` is not a valid ISO 3166 alpha 2 country code. Create a mapping or change the country manually.', OutputInterface::VERBOSITY_VERBOSE);
86		$label->markAsError('Receiver country code `'.$label->getReceiverCountryCode().'` is not a valid ISO 3166 alpha 2 country code. Create a mapping or change the country manually.');
87		$manager->flush();
88		continue;
89		}
90		}
91
92		// check that the shipping method is mapped
93		if($label->getShippingMethod()) {
94		$shippingMethodMapping = $this->shippingMethodMapping($label->getShippingMethod());
		0 ignored issues – show Bug introduced 2017-10-23 12:23 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$shippingMethodMapping` is correct as `$this->shippingMethodMap...l->getShippingMethod())` (which targets `Loevgaard\PakkelabelsBun...shippingMethodMapping()`) seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
95		if($shippingMethodMapping) {
96		$label->setProductCode($shippingMethodMapping->getProductCode());
97		if(!empty($shippingMethodMapping->getServiceCodes())) {
98		$label->setServiceCodes(join(',', $shippingMethodMapping->getServiceCodes()));
99		}
100		} else {
101		$output->writeln('Shipping method `'.$label->getShippingMethod().'` is not mapped. Map it manually.', OutputInterface::VERBOSITY_VERBOSE);
102		$label->markAsError('Shipping method `'.$label->getShippingMethod().'` is not mapped. Map it manually.');
103		$manager->flush();
104		continue;
105		}
106		}
107
108		$label->setStatus(Label::STATUS_PENDING_CREATION);
109
110		$manager->flush();
111
112		$output->writeln('Label was normalized', OutputInterface::VERBOSITY_VERBOSE);
113		}
114		}
115
116		/**
117		* @param string $country
118		* @return null\|string
119		*/
120		protected function countryMapping(string $country)
121		{
122		$manager = $this->getManager();
123		$countryMapping = $manager->getRepository('LoevgaardPakkelabelsBundle:CountryMapping')->findOneBy([
124		'source' => $country
125		]);
126
127		if($countryMapping && $countryMapping->getCountryCode()) {
128		return $countryMapping->getCountryCode();
129		}
130
131		return null;
132		}
133
134		/**
135		* @param string $shippingMethod
136		* @return ShippingMethodMapping\|null
137		*/
138		protected function shippingMethodMapping(string $shippingMethod)
139		{
140		$manager = $this->getManager();
141		$shippingMethodMapping = $manager->getRepository('LoevgaardPakkelabelsBundle:ShippingMethodMapping')->findOneBy([
142		'source' => $shippingMethod
143		]);
144
145		if($shippingMethodMapping && $shippingMethodMapping->getProductCode()) {
146		return $shippingMethodMapping;
147		}
148
149		return null;
150		}
151
152		/**
153		* @return ObjectManager
154		*/
155		protected function getManager()
156		{
157		$em = $this->getContainer()->get('doctrine')->getManager();
158
159		return $em;
160		}
161		}
162

loevgaard / pakkelabels-bundle

Push — master ( 20e80f...9e4566 )

NormalizeLabelsCommand::shippingMethodMapping() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like