Tests\DataValues\Geo\Values\GlobeCoordinateValueTest

Complexity

Total Complexity

15

Size/Duplication

Total Lines	180
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	testGetGlobe()	0	14	2
A	getClass()	0	3	1
A	validConstructorArgumentsProvider()	0	23	1
A	invalidConstructorArgumentsProvider()	0	17	1
A	testGetLatitude()	0	6	1
A	testGetLongitude()	0	6	1
A	testGetPrecision()	0	9	3
A	provideIllegalArrayValue()	0	9	1
A	testNewFromArrayErrorHandling()	0	4	1
B	testArrayValueCompatibility()	0	32	1
A	testSerializeCompatibility()	0	15	1
A	testHashIsConsistentAcrossDifferentRuntimeEnvironments()	0	7	1

<?php

namespace Tests\DataValues\Geo\Values;

use DataValues\Geo\Values\GlobeCoordinateValue;
use DataValues\Geo\Values\LatLongValue;
use DataValues\IllegalValueException;
use DataValues\Tests\DataValueTest;

/**
 * @covers DataValues\Geo\Values\GlobeCoordinateValue
 *
 * @group DataValue
 * @group DataValueExtensions
 *
 * @license GPL-2.0+
 * @author Jeroen De Dauw < jeroendedauw@gmail.com >
 */
class GlobeCoordinateValueTest extends DataValueTest {

	/**
	 * @see DataValueTest::getClass
	 *
	 * @return string
	 */
	public function getClass() {
		return 'DataValues\Geo\Values\GlobeCoordinateValue';
	}

	public function validConstructorArgumentsProvider() {
		$argLists = array();

		$argLists[] = array( new LatLongValue( 4.2, 4.2 ), 1 );
		$argLists[] = array( new LatLongValue( 4.2, 42 ), 1 );
		$argLists[] = array( new LatLongValue( 42, 4.2 ), 0.1 );
		$argLists[] = array( new LatLongValue( 42, 42 ), 0.1 );
		$argLists[] = array( new LatLongValue( -4.2, -4.2 ), 0.1 );
		$argLists[] = array( new LatLongValue( 4.2, -42 ), 0.1 );
		$argLists[] = array( new LatLongValue( -42, 4.2 ), 10 );
		$argLists[] = array( new LatLongValue( 0, 0 ), 0.001 );
		$argLists[] = array( new LatLongValue( 0, 0 ), 360 );
		$argLists[] = array( new LatLongValue( 0, 0 ), -360 );

		$argLists[] = array( new LatLongValue( 4.2, 4.2 ), 1, GlobeCoordinateValue::GLOBE_EARTH );
		$argLists[] = array( new LatLongValue( 4.2, 4.2 ), 1, 'terminus' );
		$argLists[] = array( new LatLongValue( 4.2, 4.2 ), 1, "Schar's World" );
		$argLists[] = array( new LatLongValue( 4.2, 4.2 ), 1, 'coruscant' );
		$argLists[] = array( new LatLongValue( 4.2, 4.2 ), 1, null );
		$argLists[] = array( new LatLongValue( 4.2, 4.2 ), null );

		return $argLists;
	}

	public function invalidConstructorArgumentsProvider() {
		$argLists = array();

		$argLists[] = array( new LatLongValue( 4.2, 4.2 ), 361 );
		$argLists[] = array( new LatLongValue( 4.2, 4.2 ), -361 );
		$argLists[] = array( new LatLongValue( 4.2, 4.2 ), 'foo' );
		$argLists[] = array( new LatLongValue( 4.2, 4.2 ), true );
		$argLists[] = array( new LatLongValue( 4.2, 4.2 ), array( 1 ) );
		$argLists[] = array( new LatLongValue( 4.2, 4.2 ), '1' );

		$argLists[] = array( new LatLongValue( 4.2, 4.2 ), 1, '' );
		$argLists[] = array( new LatLongValue( 4.2, 4.2 ), 1, true );
		$argLists[] = array( new LatLongValue( 4.2, 4.2 ), 1, array( 1 ) );
		$argLists[] = array( new LatLongValue( 4.2, 4.2 ), 1, 1 );

		return $argLists;
	}

	/**
	 * @dataProvider instanceProvider
	 */
	public function testGetLatitude( GlobeCoordinateValue $globeCoordinate, array $arguments ) {
		$actual = $globeCoordinate->getLatitude();

		$this->assertInternalType( 'float', $actual );
		$this->assertSame( $arguments[0]->getLatitude(), $actual );
	}

	/**
	 * @dataProvider instanceProvider
	 */
	public function testGetLongitude( GlobeCoordinateValue $globeCoordinate, array $arguments ) {
		$actual = $globeCoordinate->getLongitude();

		$this->assertInternalType( 'float', $actual );
		$this->assertSame( $arguments[0]->getLongitude(), $actual );
	}

	/**
	 * @dataProvider instanceProvider
	 */
	public function testGetPrecision( GlobeCoordinateValue $globeCoordinate, array $arguments ) {
		$actual = $globeCoordinate->getPrecision();

		$this->assertTrue(
			is_float( $actual ) || is_int( $actual ) || $actual === null,
			'Precision is int or float or null'
		);
		$this->assertSame( $arguments[1], $actual );
	}

	/**
	 * @dataProvider instanceProvider
	 */
	public function testGetGlobe( GlobeCoordinateValue $globeCoordinate, array $arguments ) {
		$expected = isset( $arguments[2] )
			? $arguments[2]
			: GlobeCoordinateValue::GLOBE_EARTH;

		$actual = $globeCoordinate->getGlobe();

		$this->assertTrue(
			is_string( $actual ),
			'getGlobe should return a string'
		);

		$this->assertSame( $expected, $actual );
	}

	public function provideIllegalArrayValue() {
		return [
			[ null ],
			[ '' ],
			[ [] ],
			[ [ 'latitude' => 0 ] ],
			[ [ 'longitude' => 0 ] ],
		];
	}

	/**
	 * @dataProvider provideIllegalArrayValue
	 */
	public function testNewFromArrayErrorHandling( $data ) {
		$this->setExpectedException( IllegalValueException::class );
		GlobeCoordinateValue::newFromArray( $data );

The method DataValues\Geo\Values\GlobeCoordinateValue::newFromArray() has been deprecated with message: since 2.0.1. Static DataValue::newFromArray constructors like this are underspecified (not in the DataValue interface), and misleadingly named (should be named newFromArrayValue). Instead, use DataValue builder callbacks in @see DataValueDeserializer.

	}

	public function testArrayValueCompatibility() {
		// These serializations where generated using revision f91f65f989cc3ffacbe924012d8f5b574e0b710c
		// The strings are the result of calling getArrayValue on the objects and then feeding this to serialize.

		$serialization = 'a:5:{s:8:"latitude";d:-4.2000000000000002;'
			. 's:9:"longitude";d:42;'
			. 's:8:"altitude";N;'
			. 's:9:"precision";d:0.01;'
			. 's:5:"globe";s:4:"mars";}';

		$arrayForm = unserialize( $serialization );
		$globeCoordinate = GlobeCoordinateValue::newFromArray( $arrayForm );

The method DataValues\Geo\Values\GlobeCoordinateValue::newFromArray() has been deprecated with message: since 2.0.1. Static DataValue::newFromArray constructors like this are underspecified (not in the DataValue interface), and misleadingly named (should be named newFromArrayValue). Instead, use DataValue builder callbacks in @see DataValueDeserializer.

		$this->assertSame( -4.2, $globeCoordinate->getLatitude() );
		$this->assertSame( 42.0, $globeCoordinate->getLongitude() );
		$this->assertSame( 0.01, $globeCoordinate->getPrecision() );
		$this->assertSame( 'mars', $globeCoordinate->getGlobe() );

		$serialization = 'a:5:{s:8:"latitude";d:-4.2000000000000002;'
			. 's:9:"longitude";d:-42;'
			. 's:8:"altitude";d:9001;'
			. 's:9:"precision";d:1;'
			. 's:5:"globe";s:33:"http://www.wikidata.org/entity/Q2";}';

		$arrayForm = unserialize( $serialization );
		$globeCoordinate = GlobeCoordinateValue::newFromArray( $arrayForm );

The method DataValues\Geo\Values\GlobeCoordinateValue::newFromArray() has been deprecated with message: since 2.0.1. Static DataValue::newFromArray constructors like this are underspecified (not in the DataValue interface), and misleadingly named (should be named newFromArrayValue). Instead, use DataValue builder callbacks in @see DataValueDeserializer.

		$this->assertSame( -4.2, $globeCoordinate->getLatitude() );
		$this->assertSame( -42.0, $globeCoordinate->getLongitude() );
		$this->assertSame( 1.0, $globeCoordinate->getPrecision() );
		$this->assertSame( 'http://www.wikidata.org/entity/Q2', $globeCoordinate->getGlobe() );
	}

	public function testSerializeCompatibility() {
		// These serializations where generated using revision f91f65f989cc3ffacbe924012d8f5b574e0b710c
		// The strings are the result of feeding the objects directly into PHPs serialize method.

		$globeCoordinate = unserialize( 'C:31:"DataValues\GlobeCoordinateValue":27:{[-4.2,-42,null,0.01,"mars"]}' );
		$this->assertInstanceOf( $this->getClass(), $globeCoordinate );

		$this->assertSame( -4.2, $globeCoordinate->getLatitude() );
		$this->assertSame( -42.0, $globeCoordinate->getLongitude() );
		$this->assertSame( 0.01, $globeCoordinate->getPrecision() );
		$this->assertSame( 'mars', $globeCoordinate->getGlobe() );

		$globeCoordinate = unserialize( 'C:31:"DataValues\GlobeCoordinateValue":27:{[-4.2,-42,9001,0.01,"mars"]}' );
		$this->assertInstanceOf( $this->getClass(), $globeCoordinate );
	}

	public function testHashIsConsistentAcrossDifferentRuntimeEnvironments() {
		$latLongValue = new LatLongValue( 12.2, 12.2 );

		$globeCoordinateValue = new GlobeCoordinateValue( $latLongValue, 0.1, 'does not matter' );

		$this->assertEquals( '08a33f1bbb4c8bd91b6531b5bffd91fd', $globeCoordinateValue->getHash() );
	}

}