AddressMutatorTrait::setLabel() - Code Metrics - Inspection of "Finished contact object repository" - apparat/dev - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 7e9b13...1ec5c0 )

by Joschi

created 2016-06-10 21:50 UTC

AddressMutatorTrait::setLabel() A

↳ Parent: AddressMutatorTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
cc	1
eloc	2
c	1
b	0
f	1
nc	1
nop	1
dl	0
loc	4
ccs	0
cts	2
cp	0
crap	2
rs	10

<?php

/**
 * apparat-dev
 *
 * @category    Apparat
 * @package     Apparat\Dev
 * @subpackage  Apparat\Dev\Infrastructure
 * @author      Joschi Kuphal <[email protected]> / @jkphl
 * @copyright   Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
 * @license     http://opensource.org/licenses/MIT The MIT License (MIT)
 */

/***********************************************************************************
 *  The MIT License (MIT)
 *
 *  Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of
 *  this software and associated documentation files (the "Software"), to deal in
 *  the Software without restriction, including without limitation the rights to
 *  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 *  the Software, and to permit persons to whom the Software is furnished to do so,
 *  subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all
 *  copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ***********************************************************************************/

namespace Apparat\Dev\Infrastructure\Mutator\Traits;

use Apparat\Dev\Application\Utility\Random;
use Apparat\Object\Application\Model\Properties\Domain\Contact as ContactProperties;
use Apparat\Object\Domain\Model\Object\ObjectInterface;
use Apparat\Object\Ports\Types\Object;
use Faker\Generator;

/**
 * Address mutator trait
 *
 * @package Apparat\Dev
 * @subpackage Apparat\Dev\Infrastructure
 * @property Generator $generator
 * @method ObjectInterface setRandomAdr(ObjectInterface $object, $probability)
 * @method ObjectInterface setRandomPostOfficeBox(ObjectInterface $object, $probability)
 * @method ObjectInterface setRandomExtendedAddress(ObjectInterface $object, $probability)
 * @method ObjectInterface setRandomStreetAddress(ObjectInterface $object, $probability)
 * @method ObjectInterface setRandomLocality(ObjectInterface $object, $probability)
 * @method ObjectInterface setRandomRegion(ObjectInterface $object, $probability)
 * @method ObjectInterface setRandomPostalCode(ObjectInterface $object, $probability)
 * @method ObjectInterface setRandomCountryName(ObjectInterface $object, $probability)
 * @method ObjectInterface setRandomLabel(ObjectInterface $object, $probability)
 * @method ObjectInterface setRandomGeo(ObjectInterface $object, $probability)
 * @method ObjectInterface setRandomLatitude(ObjectInterface $object, $probability)
 * @method ObjectInterface setRandomLongitude(ObjectInterface $object, $probability)
 * @method ObjectInterface setRandomAltitude(ObjectInterface $object, $probability)
 */
trait AddressMutatorTrait
{
    /**
     * Initialize a postal address
     *
     * @param ObjectInterface $object Object
     */
    protected function initializeAddress(ObjectInterface $object)
    {
        $this->setRandomPostOfficeBox($object, .2);
        $this->setRandomExtendedAddress($object, .4);
        $this->setRandomStreetAddress($object, .9);
        $this->setLocality($object);
        $this->setRandomRegion($object, .5);
        $this->setRandomPostalCode($object, .9);
        $this->setRandomCountryName($object, .7);
        $this->setRandomLabel($object, .5);
    }

    /**
     * Set an embedded apparat address
     *
     * @param ObjectInterface $object Contact
     * @return ObjectInterface $object Contact
     */
    protected function setAdr(ObjectInterface $object)
    {
        return $object->setDomainProperty(ContactProperties::ADR, Random::apparatUrl(Object::ADDRESS));
    }

    /**
     * Set the post office box
     *
     * @param ObjectInterface $object Contact
     * @return ObjectInterface $object Contact
     */
    protected function setPostOfficeBox(ObjectInterface $object)
    {
        return $object->setDomainProperty(ContactProperties::POST_OFFICE_BOX, $this->generator->postcode);
    }

    /**
     * Set the extended address
     *
     * @param ObjectInterface $object Contact
     * @return ObjectInterface $object Contact
     */
    protected function setExtendedAddress(ObjectInterface $object)
    {
        return $object->setDomainProperty(ContactProperties::EXTENDED_ADDRESS, $this->generator->secondaryAddress);
    }

    /**
     * Set the street address
     *
     * @param ObjectInterface $object Contact
     * @return ObjectInterface $object Contact
     */
    protected function setStreetAddress(ObjectInterface $object)
    {
        return $object->setDomainProperty(ContactProperties::STREET_ADDRESS, $this->generator->streetAddress);
    }

    /**
     * Set the locality
     *
     * @param ObjectInterface $object Contact
     * @return ObjectInterface $object Contact
     */
    protected function setLocality(ObjectInterface $object)
    {
        return $object->setDomainProperty(ContactProperties::LOCALITY, $this->generator->city);
    }

    /**
     * Set the region
     *
     * @param ObjectInterface $object Contact
     * @return ObjectInterface $object Contact
     */
    protected function setRegion(ObjectInterface $object)
    {
        return $object->setDomainProperty(ContactProperties::REGION, $this->generator->state);
    }

    /**
     * Set the postal code
     *
     * @param ObjectInterface $object Contact
     * @return ObjectInterface $object Contact
     */
    protected function setPostalCode(ObjectInterface $object)
    {
        return $object->setDomainProperty(ContactProperties::POSTAL_CODE, $this->generator->postcode);
    }

    /**
     * Set the postal code
     *
     * @param ObjectInterface $object Contact
     * @return ObjectInterface $object Contact
     */
    protected function setCountryName(ObjectInterface $object)
    {
        return $object->setDomainProperty(ContactProperties::COUNTRY_NAME, $this->generator->country);
    }

    /**
     * Set the label
     *
     * @param ObjectInterface $object Contact
     * @return ObjectInterface $object Contact
     */
    protected function setLabel(ObjectInterface $object)
    {
        return $object->setDomainProperty(ContactProperties::LABEL, $this->generator->address);
    }

    /**
     * Set the geo data
     *
     * @param ObjectInterface $object Contact
     * @return ObjectInterface $object Contact
     */
    protected function setGeo(ObjectInterface $object)
    {
        // If an apparat URL should be used
        if (rand(0, 1)) {
            return $object->setDomainProperty(ContactProperties::GEO, Random::apparatUrl(Object::GEO));
        }

        // Else: Use a geo URI
        $geoUriParts = array_filter([
            $this->generator->latitude,
            $this->generator->longitude,
            rand(0, 1) ? (rand(-1000, 100000) / 100) : null,
        ]);
        return $object->setDomainProperty(ContactProperties::LABEL, 'geo:'.implode(',', $geoUriParts));
    }

    /**
     * Set the latitude
     *
     * @param ObjectInterface $object Contact
     * @return ObjectInterface $object Contact
     */
    protected function setLatitude(ObjectInterface $object)
    {
        return $object->setDomainProperty(ContactProperties::LATITUDE, $this->generator->latitude);
    }

    /**
     * Set the longitude
     *
     * @param ObjectInterface $object Contact
     * @return ObjectInterface $object Contact
     */
    protected function setLongitude(ObjectInterface $object)
    {
        return $object->setDomainProperty(ContactProperties::LONGITUDE, $this->generator->longitude);
    }

    /**
     * Set the altitude
     *
     * @param ObjectInterface $object Contact
     * @return ObjectInterface $object Contact
     */
    protected function setAltitude(ObjectInterface $object)
    {
        return $object->setDomainProperty(ContactProperties::ALTITUDE, rand(-1000, 100000) / 100);
    }
}


1		<?php
2
3		/**
4		* apparat-dev
5		*
6		* @category Apparat
7		* @package Apparat\Dev
8		* @subpackage Apparat\Dev\Infrastructure
9		* @author Joschi Kuphal <[email protected]> / @jkphl
10		* @copyright Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
11		* @license http://opensource.org/licenses/MIT The MIT License (MIT)
12		*/
13
14		/***********************************************************************************
15		* The MIT License (MIT)
16		*
17		* Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
18		*
19		* Permission is hereby granted, free of charge, to any person obtaining a copy of
20		* this software and associated documentation files (the "Software"), to deal in
21		* the Software without restriction, including without limitation the rights to
22		* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
23		* the Software, and to permit persons to whom the Software is furnished to do so,
24		* subject to the following conditions:
25		*
26		* The above copyright notice and this permission notice shall be included in all
27		* copies or substantial portions of the Software.
28		*
29		* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
30		* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
31		* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
32		* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
33		* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
34		* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
35		***********************************************************************************/
36
37		namespace Apparat\Dev\Infrastructure\Mutator\Traits;
38
39		use Apparat\Dev\Application\Utility\Random;
40		use Apparat\Object\Application\Model\Properties\Domain\Contact as ContactProperties;
41		use Apparat\Object\Domain\Model\Object\ObjectInterface;
42		use Apparat\Object\Ports\Types\Object;
43		use Faker\Generator;
44
45		/**
46		* Address mutator trait
47		*
48		* @package Apparat\Dev
49		* @subpackage Apparat\Dev\Infrastructure
50		* @property Generator $generator
51		* @method ObjectInterface setRandomAdr(ObjectInterface $object, $probability)
52		* @method ObjectInterface setRandomPostOfficeBox(ObjectInterface $object, $probability)
53		* @method ObjectInterface setRandomExtendedAddress(ObjectInterface $object, $probability)
54		* @method ObjectInterface setRandomStreetAddress(ObjectInterface $object, $probability)
55		* @method ObjectInterface setRandomLocality(ObjectInterface $object, $probability)
56		* @method ObjectInterface setRandomRegion(ObjectInterface $object, $probability)
57		* @method ObjectInterface setRandomPostalCode(ObjectInterface $object, $probability)
58		* @method ObjectInterface setRandomCountryName(ObjectInterface $object, $probability)
59		* @method ObjectInterface setRandomLabel(ObjectInterface $object, $probability)
60		* @method ObjectInterface setRandomGeo(ObjectInterface $object, $probability)
61		* @method ObjectInterface setRandomLatitude(ObjectInterface $object, $probability)
62		* @method ObjectInterface setRandomLongitude(ObjectInterface $object, $probability)
63		* @method ObjectInterface setRandomAltitude(ObjectInterface $object, $probability)
64		*/
65		trait AddressMutatorTrait
66		{
67		/**
68		* Initialize a postal address
69		*
70		* @param ObjectInterface $object Object
71		*/
72	1	protected function initializeAddress(ObjectInterface $object)
73		{
74	1	$this->setRandomPostOfficeBox($object, .2);
75	1	$this->setRandomExtendedAddress($object, .4);
76	1	$this->setRandomStreetAddress($object, .9);
77	1	$this->setLocality($object);
78	1	$this->setRandomRegion($object, .5);
79	1	$this->setRandomPostalCode($object, .9);
80	1	$this->setRandomCountryName($object, .7);
81	1	$this->setRandomLabel($object, .5);
82	1	}
83
84		/**
85		* Set an embedded apparat address
86		*
87		* @param ObjectInterface $object Contact
88		* @return ObjectInterface $object Contact
89		*/
90		protected function setAdr(ObjectInterface $object)
91		{
92		return $object->setDomainProperty(ContactProperties::ADR, Random::apparatUrl(Object::ADDRESS));
93		}
94
95		/**
96		* Set the post office box
97		*
98		* @param ObjectInterface $object Contact
99		* @return ObjectInterface $object Contact
100		*/
101		protected function setPostOfficeBox(ObjectInterface $object)
102		{
103		return $object->setDomainProperty(ContactProperties::POST_OFFICE_BOX, $this->generator->postcode);
104		}
105
106		/**
107		* Set the extended address
108		*
109		* @param ObjectInterface $object Contact
110		* @return ObjectInterface $object Contact
111		*/
112	1	protected function setExtendedAddress(ObjectInterface $object)
113		{
114	1	return $object->setDomainProperty(ContactProperties::EXTENDED_ADDRESS, $this->generator->secondaryAddress);
115		}
116
117		/**
118		* Set the street address
119		*
120		* @param ObjectInterface $object Contact
121		* @return ObjectInterface $object Contact
122		*/
123	1	protected function setStreetAddress(ObjectInterface $object)
124		{
125	1	return $object->setDomainProperty(ContactProperties::STREET_ADDRESS, $this->generator->streetAddress);
126		}
127
128		/**
129		* Set the locality
130		*
131		* @param ObjectInterface $object Contact
132		* @return ObjectInterface $object Contact
133		*/
134	1	protected function setLocality(ObjectInterface $object)
135		{
136	1	return $object->setDomainProperty(ContactProperties::LOCALITY, $this->generator->city);
137		}
138
139		/**
140		* Set the region
141		*
142		* @param ObjectInterface $object Contact
143		* @return ObjectInterface $object Contact
144		*/
145	1	protected function setRegion(ObjectInterface $object)
146		{
147	1	return $object->setDomainProperty(ContactProperties::REGION, $this->generator->state);
148		}
149
150		/**
151		* Set the postal code
152		*
153		* @param ObjectInterface $object Contact
154		* @return ObjectInterface $object Contact
155		*/
156	1	protected function setPostalCode(ObjectInterface $object)
157		{
158	1	return $object->setDomainProperty(ContactProperties::POSTAL_CODE, $this->generator->postcode);
159		}
160
161		/**
162		* Set the postal code
163		*
164		* @param ObjectInterface $object Contact
165		* @return ObjectInterface $object Contact
166		*/
167	1	protected function setCountryName(ObjectInterface $object)
168		{
169	1	return $object->setDomainProperty(ContactProperties::COUNTRY_NAME, $this->generator->country);
170		}
171
172		/**
173		* Set the label
174		*
175		* @param ObjectInterface $object Contact
176		* @return ObjectInterface $object Contact
177		*/
178		protected function setLabel(ObjectInterface $object)
179		{
180		return $object->setDomainProperty(ContactProperties::LABEL, $this->generator->address);
181		}
182
183		/**
184		* Set the geo data
185		*
186		* @param ObjectInterface $object Contact
187		* @return ObjectInterface $object Contact
188		*/
189	1	protected function setGeo(ObjectInterface $object)
190		{
191		// If an apparat URL should be used
192	1	if (rand(0, 1)) {
193	1	return $object->setDomainProperty(ContactProperties::GEO, Random::apparatUrl(Object::GEO));
194		}
195
196		// Else: Use a geo URI
197		$geoUriParts = array_filter([
198		$this->generator->latitude,
199		$this->generator->longitude,
200		rand(0, 1) ? (rand(-1000, 100000) / 100) : null,
201		]);
202		return $object->setDomainProperty(ContactProperties::LABEL, 'geo:'.implode(',', $geoUriParts));
203		}
204
205		/**
206		* Set the latitude
207		*
208		* @param ObjectInterface $object Contact
209		* @return ObjectInterface $object Contact
210		*/
211	1	protected function setLatitude(ObjectInterface $object)
212		{
213	1	return $object->setDomainProperty(ContactProperties::LATITUDE, $this->generator->latitude);
214		}
215
216		/**
217		* Set the longitude
218		*
219		* @param ObjectInterface $object Contact
220		* @return ObjectInterface $object Contact
221		*/
222	1	protected function setLongitude(ObjectInterface $object)
223		{
224	1	return $object->setDomainProperty(ContactProperties::LONGITUDE, $this->generator->longitude);
225		}
226
227		/**
228		* Set the altitude
229		*
230		* @param ObjectInterface $object Contact
231		* @return ObjectInterface $object Contact
232		*/
233	1	protected function setAltitude(ObjectInterface $object)
234		{
235	1	return $object->setDomainProperty(ContactProperties::ALTITUDE, rand(-1000, 100000) / 100);
236		}
237		}
238

apparat / dev

Push — master ( 7e9b13...1ec5c0 )

AddressMutatorTrait::setLabel() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like