AddressExampleFactory::getProvinceCode() - Code Metrics - Inspection of "Merge pull request #7055 from lchrusciel/example-f..." - Sylius/Sylius - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 7d844f...319af7 )

by Kamil

created 2017-01-05 13:24 UTC

AddressExampleFactory::getProvinceCode() A

↳ Parent: AddressExampleFactory

Complexity

Conditions	3
Paths	3

Size

Total Lines	11
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	11
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	5
nc	3
nop	2

<?php

/*
 * This file is part of the Sylius package.
 *
 * (c) Paweł Jędrzejewski
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Sylius\Bundle\CoreBundle\Fixture\Factory;

use Doctrine\Common\Collections\Collection;
use Sylius\Bundle\CoreBundle\Fixture\OptionsResolver\LazyOption;
use Sylius\Component\Addressing\Model\Country;
use Sylius\Component\Addressing\Model\ProvinceInterface;
use Sylius\Component\Core\Model\AddressInterface;
use Sylius\Component\Core\Model\CustomerInterface;
use Sylius\Component\Resource\Factory\FactoryInterface;
use Sylius\Component\Resource\Repository\RepositoryInterface;
use Symfony\Component\OptionsResolver\Options;
use Symfony\Component\OptionsResolver\OptionsResolver;
use Webmozart\Assert\Assert;

/**
 * @author Jan Góralski <[email protected]>
 */
class AddressExampleFactory extends AbstractExampleFactory
{
    /**
     * @var FactoryInterface
     */
    private $addressFactory;

    /**
     * @var RepositoryInterface
     */
    private $countryRepository;

    /**
     * @var RepositoryInterface
     */
    private $customerRepository;

    /**
     * @var \Faker\Generator
     */
    private $faker;

    /**
     * @var OptionsResolver
     */
    private $optionsResolver;

    /**
     * @param FactoryInterface $addressFactory
     * @param RepositoryInterface $countryRepository
     * @param RepositoryInterface $customerRepository
     */
    public function __construct(
        FactoryInterface $addressFactory,
        RepositoryInterface $countryRepository,
        RepositoryInterface $customerRepository
    ) {
        $this->addressFactory = $addressFactory;
        $this->countryRepository = $countryRepository;
        $this->customerRepository = $customerRepository;

        $this->faker = \Faker\Factory::create();
        $this->optionsResolver = new OptionsResolver();

        $this->configureOptions($this->optionsResolver);
    }

    /**
     * {@inheritdoc}
     */
    protected function configureOptions(OptionsResolver $resolver)
    {
        $resolver
            ->setDefault('first_name', function (Options $options) {

                return $this->faker->firstName;
            })
            ->setDefault('last_name', function (Options $options) {

                return $this->faker->lastName;
            })
            ->setDefault('phone_number', function (Options $options) {

                return mt_rand(1, 100) > 50 ? $this->faker->phoneNumber : null;
            })
            ->setDefault('company', function (Options $options) {

                return mt_rand(1, 100) > 50 ? $this->faker->company : null;
            })
            ->setDefault('street', function (Options $options) {

                return $this->faker->streetAddress;
            })
            ->setDefault('city', function (Options $options) {

                return $this->faker->city;
            })
            ->setDefault('postcode', function (Options $options) {

                return $this->faker->postcode;
            })
            ->setDefault('country_code', function (Options $options) {

                $countries = $this->countryRepository->findAll();
                shuffle($countries);

                return array_pop($countries)->getCode();
            })
            ->setAllowedTypes('country_code', ['string'])
            ->setDefault('province_name', null)
            ->setAllowedTypes('province_name', ['null', 'string'])
            ->setDefault('province_code', null)
            ->setAllowedTypes('province_code', ['null', 'string'])
            ->setDefault('customer', LazyOption::randomOne($this->customerRepository))
            ->setAllowedTypes('customer', ['string', CustomerInterface::class, 'null'])
            ->setNormalizer('customer', LazyOption::findOneBy($this->customerRepository, 'email'))
        ;
    }

    /**
     * {@inheritdoc}
     */
    public function create(array $options = [])
    {
        $options = $this->optionsResolver->resolve($options);

        /** @var AddressInterface $address */
        $address = $this->addressFactory->createNew();
        $address->setFirstName($options['first_name']);
        $address->setLastName($options['last_name']);
        $address->setPhoneNumber($options['phone_number']);
        $address->setCompany($options['company']);
        $address->setStreet($options['street']);
        $address->setCity($options['city']);
        $address->setPostcode($options['postcode']);

        $this->assertCountryCodeIsValid($options['country_code']);
        $address->setCountryCode($options['country_code']);

        $this->resolveCountryProvince($options, $address);

        if (isset($options['customer'])) {
            $options['customer']->addAddress($address);
        }

        return $address;
    }

    /**
     * @param string $code
     */
    private function assertCountryCodeIsValid($code)
    {
        $country = $this->countryRepository->findOneBy(['code' => $code]);
        Assert::notNull($country);
    }

    /**
     * @param string $provinceCode
     * @param string $countryCode
     */
    private function assertProvinceCodeIsValid($provinceCode, $countryCode)
    {
        $country = $this->countryRepository->findOneBy(['code' => $countryCode]);

        /** @var ProvinceInterface $province */
        foreach ($country->getProvinces() as $province) {
            if ($province->getCode() === $provinceCode) {
                return;
            }
        }
        throw new \InvalidArgumentException('Provided province code is not valid for "%s"', $country->getName());
    }

    /**
     * @param array $options
     * @param AddressInterface $address
     *
     * @return string
     */
    private function provideProvince(array $options, AddressInterface $address)
    {
        /** @var Country $country */
        $country = $this->countryRepository->findOneBy(['code' => $options['country_code']]);

        if ($country->hasProvinces()) {
            $address->setProvinceCode($this->getProvinceCode($country->getProvinces(), $options['province_name']));


            return;
        }

        $address->setProvinceName($options['province_name']);
    }

    /**
     * @param Collection $provinces
     * @param string $provinceName
     *
     * @return string
     */
    private function getProvinceCode(Collection $provinces, $provinceName)
    {
        /** @var ProvinceInterface $province */
        foreach ($provinces as $province) {
            if ($province->getName() === $provinceName) {
                return $province->getCode();
            }
        }

        throw new \InvalidArgumentException(sprintf('Country has defined provinces, but %s is not one of them', $provinceName));
    }

    /**
     * @param array $options
     * @param AddressInterface $address
     */
    private function resolveCountryProvince(array $options, AddressInterface $address)
    {
        if (null !== $options['province_code']) {
            $this->assertProvinceCodeIsValid($options['province_code'], $options['country_code']);
            $address->setProvinceCode($options['province_code']);

            return;
        }

        if (null !== $options['province_name']){
            $this->provideProvince($options, $address);
        }
    }
}


1			<?php
2
3			/*
4			* This file is part of the Sylius package.
5			*
6			* (c) Paweł Jędrzejewski
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Sylius\Bundle\CoreBundle\Fixture\Factory;
13
14			use Doctrine\Common\Collections\Collection;
15			use Sylius\Bundle\CoreBundle\Fixture\OptionsResolver\LazyOption;
16			use Sylius\Component\Addressing\Model\Country;
17			use Sylius\Component\Addressing\Model\ProvinceInterface;
18			use Sylius\Component\Core\Model\AddressInterface;
19			use Sylius\Component\Core\Model\CustomerInterface;
20			use Sylius\Component\Resource\Factory\FactoryInterface;
21			use Sylius\Component\Resource\Repository\RepositoryInterface;
22			use Symfony\Component\OptionsResolver\Options;
23			use Symfony\Component\OptionsResolver\OptionsResolver;
24			use Webmozart\Assert\Assert;
25
26			/**
27			* @author Jan Góralski <[email protected]>
28			*/
29			class AddressExampleFactory extends AbstractExampleFactory
30			{
31			/**
32			* @var FactoryInterface
33			*/
34			private $addressFactory;
35
36			/**
37			* @var RepositoryInterface
38			*/
39			private $countryRepository;
40
41			/**
42			* @var RepositoryInterface
43			*/
44			private $customerRepository;
45
46			/**
47			* @var \Faker\Generator
48			*/
49			private $faker;
50
51			/**
52			* @var OptionsResolver
53			*/
54			private $optionsResolver;
55
56			/**
57			* @param FactoryInterface $addressFactory
58			* @param RepositoryInterface $countryRepository
59			* @param RepositoryInterface $customerRepository
60			*/
61			public function __construct(
62			FactoryInterface $addressFactory,
63			RepositoryInterface $countryRepository,
64			RepositoryInterface $customerRepository
65			) {
66			$this->addressFactory = $addressFactory;
67			$this->countryRepository = $countryRepository;
68			$this->customerRepository = $customerRepository;
69
70			$this->faker = \Faker\Factory::create();
71			$this->optionsResolver = new OptionsResolver();
72
73			$this->configureOptions($this->optionsResolver);
74			}
75
76			/**
77			* {@inheritdoc}
78			*/
79			protected function configureOptions(OptionsResolver $resolver)
80			{
81			$resolver
82			->setDefault('first_name', function (Options $options) {
			0 ignored issues – show Unused Code introduced 2016-12-06 15:43 UTC by Report Bug Copy Issue Report The parameter `$options` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
83			return $this->faker->firstName;
84			})
85			->setDefault('last_name', function (Options $options) {
			0 ignored issues – show Unused Code introduced 2016-12-06 15:43 UTC by Report Bug Copy Issue Report The parameter `$options` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
86			return $this->faker->lastName;
87			})
88			->setDefault('phone_number', function (Options $options) {
			0 ignored issues – show Unused Code introduced 2016-12-06 15:43 UTC by Report Bug Copy Issue Report The parameter `$options` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
89			return mt_rand(1, 100) > 50 ? $this->faker->phoneNumber : null;
90			})
91			->setDefault('company', function (Options $options) {
			0 ignored issues – show Unused Code introduced 2016-12-06 15:43 UTC by Report Bug Copy Issue Report The parameter `$options` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
92			return mt_rand(1, 100) > 50 ? $this->faker->company : null;
93			})
94			->setDefault('street', function (Options $options) {
			0 ignored issues – show Unused Code introduced 2016-12-06 15:43 UTC by Report Bug Copy Issue Report The parameter `$options` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
95			return $this->faker->streetAddress;
96			})
97			->setDefault('city', function (Options $options) {
			0 ignored issues – show Unused Code introduced 2016-12-06 15:43 UTC by Report Bug Copy Issue Report The parameter `$options` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
98			return $this->faker->city;
99			})
100			->setDefault('postcode', function (Options $options) {
			0 ignored issues – show Unused Code introduced 2016-12-06 15:43 UTC by Report Bug Copy Issue Report The parameter `$options` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
101			return $this->faker->postcode;
102			})
103			->setDefault('country_code', function (Options $options) {
			0 ignored issues – show Unused Code introduced 2016-12-06 15:43 UTC by Report Bug Copy Issue Report The parameter `$options` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
104			$countries = $this->countryRepository->findAll();
105			shuffle($countries);
106
107			return array_pop($countries)->getCode();
108			})
109			->setAllowedTypes('country_code', ['string'])
110			->setDefault('province_name', null)
111			->setAllowedTypes('province_name', ['null', 'string'])
112			->setDefault('province_code', null)
113			->setAllowedTypes('province_code', ['null', 'string'])
114			->setDefault('customer', LazyOption::randomOne($this->customerRepository))
115			->setAllowedTypes('customer', ['string', CustomerInterface::class, 'null'])
116			->setNormalizer('customer', LazyOption::findOneBy($this->customerRepository, 'email'))
117			;
118			}
119
120			/**
121			* {@inheritdoc}
122			*/
123			public function create(array $options = [])
124			{
125			$options = $this->optionsResolver->resolve($options);
126
127			/** @var AddressInterface $address */
128			$address = $this->addressFactory->createNew();
129			$address->setFirstName($options['first_name']);
130			$address->setLastName($options['last_name']);
131			$address->setPhoneNumber($options['phone_number']);
132			$address->setCompany($options['company']);
133			$address->setStreet($options['street']);
134			$address->setCity($options['city']);
135			$address->setPostcode($options['postcode']);
136
137			$this->assertCountryCodeIsValid($options['country_code']);
138			$address->setCountryCode($options['country_code']);
139
140			$this->resolveCountryProvince($options, $address);
141
142			if (isset($options['customer'])) {
143			$options['customer']->addAddress($address);
144			}
145
146			return $address;
147			}
148
149			/**
150			* @param string $code
151			*/
152			private function assertCountryCodeIsValid($code)
153			{
154			$country = $this->countryRepository->findOneBy(['code' => $code]);
155			Assert::notNull($country);
156			}
157
158			/**
159			* @param string $provinceCode
160			* @param string $countryCode
161			*/
162			private function assertProvinceCodeIsValid($provinceCode, $countryCode)
163			{
164			$country = $this->countryRepository->findOneBy(['code' => $countryCode]);
165
166			/** @var ProvinceInterface $province */
167			foreach ($country->getProvinces() as $province) {
168			if ($province->getCode() === $provinceCode) {
169			return;
170			}
171			}
172			throw new \InvalidArgumentException('Provided province code is not valid for "%s"', $country->getName());
173			}
174
175			/**
176			* @param array $options
177			* @param AddressInterface $address
178			*
179			* @return string
180			*/
181			private function provideProvince(array $options, AddressInterface $address)
182			{
183			/** @var Country $country */
184			$country = $this->countryRepository->findOneBy(['code' => $options['country_code']]);
185
186			if ($country->hasProvinces()) {
187			$address->setProvinceCode($this->getProvinceCode($country->getProvinces(), $options['province_name']));
			0 ignored issues – show Bug introduced 2016-12-19 15:54 UTC by Report Bug Copy Issue Report It seems like `$country->getProvinces()` targeting `Sylius\Component\Address...Country::getProvinces()` can also be of type `array<integer,object<Syl...del\ProvinceInterface>>`; however, `Sylius\Bundle\CoreBundle...tory::getProvinceCode()` does only seem to accept `object<Doctrine\Common\Collections\Collection>`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
188
189			return;
190			}
191
192			$address->setProvinceName($options['province_name']);
193			}
194
195			/**
196			* @param Collection $provinces
197			* @param string $provinceName
198			*
199			* @return string
200			*/
201			private function getProvinceCode(Collection $provinces, $provinceName)
202			{
203			/** @var ProvinceInterface $province */
204			foreach ($provinces as $province) {
205			if ($province->getName() === $provinceName) {
206			return $province->getCode();
207			}
208			}
209
210			throw new \InvalidArgumentException(sprintf('Country has defined provinces, but %s is not one of them', $provinceName));
211			}
212
213			/**
214			* @param array $options
215			* @param AddressInterface $address
216			*/
217			private function resolveCountryProvince(array $options, AddressInterface $address)
218			{
219			if (null !== $options['province_code']) {
220			$this->assertProvinceCodeIsValid($options['province_code'], $options['country_code']);
221			$address->setProvinceCode($options['province_code']);
222
223			return;
224			}
225
226			if (null !== $options['province_name']){
227			$this->provideProvince($options, $address);
228			}
229			}
230			}
231

Sylius / Sylius

Push — master ( 7d844f...319af7 )

AddressExampleFactory::getProvinceCode() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like