MapAPITest - Code Metrics - Inspection of "ENHANCEMENT: Geocoding and add mappable marker tes..." - gordonbanderson/Mappable - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — AUTOMATED_TESTING ( 6591ac...6229f9 )

by Gordon

created 2015-12-25 04:45 UTC

MapAPITest B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	550
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	7

Metric	Value
wmc	40
lcom	2
cbo	7
dl	0
loc	550
rs	8.2609

37 Methods

Rating	Name	Size	Complexity
A	setUpOnce()	6	1
A	setUp()	4	1
A	testSetKey()	8	1
A	testSetClusterer()	22	1
A	testSetShowInlineMapDivStyle()	11	1
A	testSetAdditionalCSSClasses()	8	1
A	testSetMapStyle()	57	1
A	testSetDivId()	7	1
A	testSetSize()	6	1
A	testSetLang()	6	1
A	testSetZoom()	9	1
A	testSetInfoWindowZoom()	10	1
A	testSetEnableWindowZoom()	9	1
A	testSetEnableAutomaticCenterZoom()	6	1
A	testSetNoLocation()	8	1
A	testSetCenter()	10	1
B	testSetLatLongCenter()	35	3
A	testSetMapType()	22	2
A	testSetAllowFullScreen()	17	1
A	testMapWithMarkers()	11	1
A	testMapWithMarkersDifferentCategory()	3	1
A	testSetDefaultHideMarker()	17	1
A	testGetContent()	9	1
A	testGeocoding()	10	1
A	testGeocodingNoResultsFound()	6	1
A	testAddMarkerByAddress()	13	1
A	testAddArrayMarkerByCoords()	15	1
A	testAddMarkerByCoords()	15	1
A	testAddMarkerAsObject()	18	1
A	testAddMarkerThatIsMappableAsObject()	14	1
A	testConnectPoints()	10	1
A	testAddKML()	8	1
A	testAddLine()	17	1
B	testProcessTemplate()	29	1
A	getMap()	4	1
A	getMapMultipleItems()	4	1
A	getGeolocatedMembers()	23	1

How to fix Complexity

<?php

class MapAPITest extends SapphireTest {

	public function setUpOnce() {
		$this->requiredExtensions = array(
			'Member' => array('MapExtension')
		);
		parent::setupOnce();
	}


	public function setUp() {
		MapUtil::reset();
		parent::setUp();
	}

	public function testSetKey() {
		$map = $this->getMap();
		$map->setKey('PRETEND_KEY');
		$html = $map->forTemplate();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
		$map->setKey(null);

		$this->fail('where to check effect?');
	}

	public function testSetClusterer() {
		$map = $this->getMap();
		$map->setClusterer(true);
		$html = $map->forTemplate();
		$this->assertContains('data-clusterergridsize=50', $html);
		$this->assertContains('data-clusterermaxzoom=17', $html);
		$this->assertContains('data-useclusterer=1', $html);

		$map = $this->getMap();
		$map->setClusterer(true, 60,14);
		$html = $map->forTemplate();
		$this->assertContains('data-clusterergridsize=60', $html);
		$this->assertContains('data-clusterermaxzoom=14', $html);
		$this->assertContains('data-useclusterer=1', $html);

		$map = $this->getMap();
		$map->setClusterer(false);
		$html = $map->forTemplate();
		$this->assertContains('data-useclusterer=false', $html);
		$this->assertContains('data-clusterergridsize=50', $html);
		$this->assertContains('data-clusterermaxzoom=17', $html);
	}

	/*
	Toggle as to whether or not to include a style= attribute with width/height
	 */
	public function testSetShowInlineMapDivStyle() {
		$map = $this->getMap();
		$map->setShowInlineMapDivStyle(true);
		$html = $map->forTemplate();
		$expected = 'style="width:100%; height: 400px;"';
		$this->assertContains($expected, $html);

		$map->setShowInlineMapDivStyle(false);
		$html = $map->forTemplate();
		$this->assertNotContains($expected, $html);
	}

	public function testSetAdditionalCSSClasses() {
		$map = $this->getMap();
		$map->setAdditionalCSSClasses('bigMap shadowMap');
		$html = $map->forTemplate();
		$expected = 'class="bigMap shadowMap mappable"';
		$this->assertContains($expected, $html);
		$map->setAdditionalCSSClasses('bigMap shadowMap');
	}


	public function testSetMapStyle() {
		$style = <<<STYLE
[{
	"featureType": "landscape",
	"stylers": [{
		"hue": "#FFBB00"
	}, {
		"saturation": 43.400000000000006
	}, {
		"lightness": 37.599999999999994
	}, {
		"gamma": 1
	}]
}]
STYLE;
		$map = $this->getMap();
		$map->setMapStyle($style);
		$html = $map->forTemplate()->getValue();
		$expected = <<<HTML


<div id="google_map_1" style="width:100%; height: 400px;"
 class=" mappable"
data-map
data-centre='{"lat":48.856614,"lng":2.3522219}'
data-zoom=9
data-maptype='road'
data-allowfullscreen='1'
data-clusterergridsize=50,
data-clusterermaxzoom=17,
data-enableautocentrezoom=false
data-enablewindowzoom=false
data-infowindowzoom=13
data-mapmarkers='[]'
data-defaulthidemarker=false
data-lines='[]'
data-kmlfiles='[]'
data-mapstyles='[{
	"featureType": "landscape",
	"stylers": [{
		"hue": "#FFBB00"
	}, {
		"saturation": 43.400000000000006
	}, {
		"lightness": 37.599999999999994
	}, {
		"gamma": 1
	}]
}]'
data-useclusterer=false
>
</div>

HTML;
		$this->assertEquals($expected, $html);

		$map->setMapStyle(null);
	}

	public function testSetDivId() {
		$map = $this->getMap();
		$map->setDivId('mymapid');
		$html = $map->forTemplate();
		$expected = '<div id="mymapid" style=';
		$this->assertContains($expected, $html);
	}

	public function testSetSize() {
		$map = $this->getMap();
		$map->setSize('432px', '1234px');
		$html = $map->forTemplate();
		$this->assertContains('style="width:432px; height: 1234px;"', $html);
	}

	public function testSetLang() {
		$map = $this->getMap();
		$map->setLang('fr');
		$html = $map->forTemplate();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
		$this->fail('Response needs checked');
	}


	public function testSetZoom() {
		$map = $this->getMap();
		$map->setZoom(4);
		$html = $map->forTemplate();
		$this->assertContains('data-zoom=4', $html);
		$map->setZoom(12);
		$html = $map->forTemplate();
		$this->assertContains('data-zoom=12', $html);
	}

	public function testSetInfoWindowZoom() {
		$map = $this->getMap();
		$map->setInfoWindowZoom(4);
		$html = $map->forTemplate();
		$this->assertContains('data-infowindowzoom=4', $html);
		$map->setInfoWindowZoom(12);
		$html = $map->forTemplate();
		$this->assertContains('data-infowindowzoom=12', $html);

	}

	public function testSetEnableWindowZoom() {
		$map = $this->getMap();
		$map->setEnableWindowZoom(false);
		$html = $map->forTemplate();
		$this->assertContains('data-enablewindowzoom=false', $html);
		$map->setEnableWindowZoom(true);
		$html = $map->forTemplate();
		$this->assertContains('data-enablewindowzoom=1', $html);
	}

	public function testSetEnableAutomaticCenterZoom() {
		$map = $this->getMap();
		$map->setEnableAutomaticCenterZoom(true);
		$html = $map->forTemplate();
		$this->assertContains('data-enableautocentrezoom=1', $html);
	}

	public function testSetNoLocation() {
		$map = $this->getMap();
		$html = $map->forTemplate();
		$this->assertContains(
			'data-centre=\'{"lat":48.856614,"lng":2.3522219}\'',
			$html
		);
	}

	/**
	 * setCentre is mis-named, as the method expects text for a geocoder
	 */
	public function testSetCenter() {
		$map = $this->getMap();
		$map->setCenter('Klong Tan, Bangkok, Thailand');
		$html = $map->forTemplate();

		//coordinates of Klong Tan in Bangkok
		$expected = 'data-centre=\'{"lat":13.7243075,"lng":100.5718086}';
		$this->assertContains($expected, $html);
		$map->setCenter('Paris, France');
	}


	public function testSetLatLongCenter() {
		$map = $this->getMap();
		$llc = array('lat' => -23.714, 'lng' => 47.419);
		$map->setLatLongCenter($llc);
		$html = $map->forTemplate();
		$expected = "data-centre='{\"lat\":-23.714,\"lng\":47.419}'";
		$this->assertContains($expected, $html);

		// now test error conditions
		try {
			$map->setLatLongCenter('This is not a coordinate');
			$this->fail('Should not be able to set coordinate as text');
		} catch (InvalidArgumentException $e) {
			$message = $e->getMessage();
			$this->assertEquals(

				'Center must be an associative array containing lat,lng',
				$message
			);
		}

		try {
			$badKeys = array('lat' => 47.2, 'wibble' => 76.10);
			$map->setLatLongCenter($badKeys);
			$this->fail('Should not be able to set coordinate as text');
		} catch (InvalidArgumentException $e) {
			$message = $e->getMessage();

			$this->assertEquals(

				'Keys provided must be lat, lng',
				$message
			);
		}


	}


	public function testSetMapType() {
		$map = $this->getMap();

		$mapTypes = array(
			'road' => 'road',
			'satellite' => 'satellite',
			'hybrid' => 'hybrid',
			'terrain' => 'terrain',
			'google.maps.MapTypeId.ROADMAP' => 'road',
			'google.maps.MapTypeId.SATELLITE' => 'satellite',
			'google.maps.MapTypeId.G_HYBRID_MAP' => 'hybrid',
			'google.maps.MapTypeId.G_PHYSICAL_MAP' => 'terrain',
			'custom_layer' => 'custom_layer'
		);

		foreach (array_keys($mapTypes) as $mapType) {
			$map->setMapType($mapType);
			$expected = "data-maptype='".$mapTypes[$mapType]."'";
			$html = $map->forTemplate();
			$this->assertContains($expected, $html);
		}
	}


	public function testSetAllowFullScreen() {
		$map = $this->getMap();
		$map->setAllowFullScreen(false);
		$html = $map->forTemplate();

		$this->assertContains("data-allowfullscreen='false'", $html);

		$map->setAllowFullScreen(true);
		$html = $map->forTemplate();
		$this->assertContains("data-allowfullscreen='1'", $html);

		// deal with the null calse
		$map->setAllowFullScreen(null);
		$html = $map->forTemplate();
		$expected = Config::inst()->get('Mappable', 'allow_full_screen');
		$this->assertContains("data-allowfullscreen='{$expected}'", $html);
	}

	public function testMapWithMarkers() {
		$config = Config::inst();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

		$map = $this->getMapMultipleItems();
		$html = $map->forTemplate();
		$expected = 'data-mapmarkers=\'[{"latitude":23,"longitude":78,"html":"'
				  . 'MEMBER: Fred Bloggs","category":"default","icon":false},{"latitude'
				  . '":-12,"longitude":42.1,"html":"MEMBER: Kane Williamson","category"'
				  . ':"default","icon":false}]\'';
		$this->assertContains($expected, $html);
	}


	public function testMapWithMarkersDifferentCategory() {
		$this->markTestSkipped('TODO');
	}


	public function testSetDefaultHideMarker() {
		$map = $this->getMapMultipleItems();
		$map->setDefaultHideMarker(false);
		$html = $map->forTemplate();
		$this->assertContains(
			'data-defaulthidemarker=false',
			$html
		);

		$map = $this->getMapMultipleItems();
		$map->setDefaultHideMarker(true);
		$html = $map->forTemplate();
		$this->assertContains(
			'data-defaulthidemarker=1',
			$html
		);
	}

	public function testGetContent() {
		$map = $this->getMap();
		$filepath = 'file://' . Director::baseFolder()
				  . '/mappable/tests/kml/example.kml';
		$content = $map->getContent($filepath);
		$textHash = hash('ripemd160', $content);
		$fileHash = hash_file('ripemd160', $filepath);
		$this->assertEquals($fileHash, $textHash);

	}

	public function testGeocoding() {
		$map = $this->getMap();
		$location = $map->geocoding("Nonthaburi, Thailand");
		$expected = array(
			'lat' => 13.8621125,
			'lon' => 100.5143528,
    		'geocoded' => true
		);
		$this->assertEquals($expected, $location);

	}

	public function testGeocodingNoResultsFound() {
		$map = $this->getMap();
		$location = $map->geocoding("aasdfsafsfdsfasdf");
		$expected = array();
		$this->assertEquals($expected, $location);

	}

	public function testAddMarkerByAddress() {
		//$address, $content = '', $category = '', $icon = ''

		$map = $this->getMap();
		$map->addMarkerByAddress(
			'Koh Kred, Nonthaburi, Thailand',
			'Small island in the Chao Phraya river',
			'testing',
			'http://www.test.com/icon.png'
		);
		$html = $map->forTemplate();
		$expected = 'data-mapmarkers=\'[{"latitude":13.9114455,"longitude":100.4761897,"html":"Small island in the Chao Phraya river","category":"testing","icon":"http://www.test.com/icon.png"}]\'';
		$this->assertContains($expected, $html);
	}


	public function testAddArrayMarkerByCoords() {
		$map = $this->getMap();

		$markerArray = array();
		$marker1 = array(48.2, 27, 'Description marker 1', 'Marker Test', '');
		$marker2 = array(-12.2, 47, 'Description marker 2', 'Marker Test', '');

		array_push($markerArray, $marker1);
		array_push($markerArray, $marker2);

		$map->addArrayMarkerByCoords($markerArray);
		$html = $map->forTemplate();
		$expected = 'data-mapmarkers=\'[{"latitude":48.2,"longitude":27,"html":"Description marker 1","category":"","icon":""},{"latitude":-12.2,"longitude":47,"html":"Description marker 2","category":"","icon":""}]\'';
		$this->assertContains($expected, $html);
	}

	public function testAddMarkerByCoords() {
		$map = $this->getMap();
		$map->addMarkerByCoords(
			13.91,
			100.47,
			'Description of marker',
			'testing',
			'http://www.test.com/icon.png'
		);
		$html = $map->forTemplate();
		$expected =
		'data-mapmarkers=\'[{"latitude":13.91,"longitude":100.47,"html":"Description of marker","category":"testing","icon":"http://www.test.com/icon.png"}]';

		$this->assertContains($expected, $html);
	}


	public function testAddMarkerAsObject() {
		$map = $this->getMap();
		$member = new Member();
		$member->FirstName = 'Test';
		$member->Surname = 'User';
		$member->Lat = 24.2;
		$member->Lon = -40;
		$member->write();
		$params = array();
		$map->addMarkerAsObject(
			$member,
			$params
		);

		$html = $map->forTemplate();
		$expected = 'data-mapmarkers=\'[{"latitude":24.2,"longitude":-40,"html":"MEMBER: Test User","category":"default","icon":false}]\'';
		$this->assertContains($expected, $html);
	}


	public function testAddMarkerThatIsMappableAsObject() {
		$map = $this->getMap();
		$member = new MappableExampleClass();
		//$member->write();

		$params = array();
		$map->addMarkerAsObject(
			$member,
			$params
		);

		$html = $map->forTemplate();
		$expected = 'data-mapmarkers=\'[{"latitude":13.4,"longitude":100.7,"html":"example content","category":"default","icon":null}]\'';
		$this->assertContains($expected, $html);
	}


	public function testConnectPoints() {
		$members = $this->getGeolocatedMembers();
		$member1 = $members->pop();
		$member2 = $members->pop();
		$map = $this->getMap();
		$map->connectPoints($member1, $member2);
		$html = $map->forTemplate();
		$expected = 'data-lines=\'[{"lat1":-12,"lon1":42.1,"lat2":23,"lon2":78,"color":"#FF3300"}]\'';
		$this->assertContains($expected, $html);
	}


	public function testAddKML() {
		$map = $this->getMap();
		$map->addKml('http://www.test.com/route1.kml');
		$map->addKml('http://www.test.com/route2.kml');
		$html = $map->forTemplate();
		$expected = 'data-kmlfiles=\'["http://www.test.com/route1.kml","http://www.test.com/route2.kml"]\'';
		$this->assertContains($expected, $html);
	}


	public function testAddLine() {
		$map = $this->getMap();
		$map->addLine(
			array(13,101),
			array(13.2, 101.4),
			'#F32'
		);

		$map->addLine(
			array(13.2, 101.4),
			array(14.2,99.8)
		);

		$html = $map->forTemplate();
		$expected = 'data-lines=\'[{"lat1":13,"lon1":101,"lat2":13.2,"lon2":101.4,"color":"#F32"},{"lat1":13.2,"lon1":101.4,"lat2":14.2,"lon2":99.8,"color":"#FF3300"}]\'';
		$this->assertContains($expected, $html);
	}

	/**
	 * This tests out a specific case of passing null for template values
	 */
	public function testProcessTemplate() {
		$map = $this->getMap();
		$html = $map->processTemplateHTML('Map', null);
		$expected = <<<HTML


<div id=""
data-map
data-centre=''
data-zoom=
data-maptype=''
data-allowfullscreen=''
data-clusterergridsize=,
data-clusterermaxzoom=,
data-enableautocentrezoom=
data-enablewindowzoom=
data-infowindowzoom=
data-mapmarkers=''
data-defaulthidemarker=
data-lines=''
data-kmlfiles=''
data-mapstyles=''
data-useclusterer=
>
</div>

HTML;
		$this->assertEquals($expected, $html->getValue());

	}

	private function getMap() {
		$instance = new Member();
		return $instance->getRenderableMap();
	}

	private function getMapMultipleItems() {
		$members = $this->getGeolocatedMembers();
		return $members->getRenderableMap();
	}

	private function getGeolocatedMembers() {
		$members = new ArrayList();

		$member1 = new Member();
		$member1->Lat = 23;
		$member1->Lon = 78;
		$member1->MapPinEdited = true;
		$member1->FirstName = 'Fred';
		$member1->Surname = 'Bloggs';
		$member1->write();
		$members->push($member1);

		$member2 = new Member();
		$member2->Lat = -12;
		$member2->Lon = 42.1;
		$member2->MapPinEdited = true;
		$member2->FirstName = 'Kane';
		$member2->Surname = 'Williamson';
		$member2->write();
		$members->push($member2);

		return $members;
	}

}



// basic implementation of Mappable interface for some of the tests
class MappableExampleClass extends ViewableData implements TestOnly, Mappable {


	public function getMappableLatitude() {
		return 13.4;
	}

	public function getMappableLongitude() {
		return 100.7;
	}

	public function getMappableMapPin() {
		return null;
	}

	public function getMappableMapContent() {
		return 'example content';
	}
}


1			<?php
2
3			class MapAPITest extends SapphireTest {
4
5			public function setUpOnce() {
6			$this->requiredExtensions = array(
7			'Member' => array('MapExtension')
8			);
9			parent::setupOnce();
10			}
11
12
13			public function setUp() {
14			MapUtil::reset();
15			parent::setUp();
16			}
17
18			public function testSetKey() {
19			$map = $this->getMap();
20			$map->setKey('PRETEND_KEY');
21			$html = $map->forTemplate();
			0 ignored issues – show Unused Code introduced 2015-12-22 18:35 UTC by Report Bug Copy Issue Report `$html` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
22			$map->setKey(null);
23
24			$this->fail('where to check effect?');
25			}
26
27			public function testSetClusterer() {
28			$map = $this->getMap();
29			$map->setClusterer(true);
30			$html = $map->forTemplate();
31			$this->assertContains('data-clusterergridsize=50', $html);
32			$this->assertContains('data-clusterermaxzoom=17', $html);
33			$this->assertContains('data-useclusterer=1', $html);
34
35			$map = $this->getMap();
36			$map->setClusterer(true, 60,14);
37			$html = $map->forTemplate();
38			$this->assertContains('data-clusterergridsize=60', $html);
39			$this->assertContains('data-clusterermaxzoom=14', $html);

gordonbanderson / Mappable

Push — AUTOMATED_TESTING ( 6591ac...6229f9 )

MapAPITest B

Complexity

Size/Duplication

Coupling/Cohesion

37 Methods

How to fix Complexity

Complex Class

Duplication Side-by-Side

Filter issues like