IndexParser::__construct() - Code Metrics - Inspection of "More unit tests" - thtroyer/noaa-cap-alerts - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 7ef222...7c8367 )

by Tom

created 2018-10-06 02:08 UTC

IndexParser::__construct() A

↳ Parent: IndexParser

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2

Importance

Changes

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

<?php

namespace NoaaCapAlerts\Parser;

class IndexParser
{
    protected $xmlParser;

    function __construct(XmlParser $xmlParser = null)
    {
        if ($xmlParser === null) {
            $this->xmlParser = new XmlParser();
        } else {
            $this->xmlParser = $xmlParser;
        }
    }

    public function parse(string $xml): array
    {
        // parse XML into an array of alerts
        $rawDataArray = $this->xmlParser->getArrayFromXml($xml);
        $alertDataArray = $rawDataArray[0]['children'];

        // Process each alert ("ENTRY")
        $resultArray = array();

        foreach ($alertDataArray as $alert) {
            if (!$this->isAlert($alert)) {
                continue;
            }

            $parsedAlert = $this->parseAlert($alert);

            $resultArray[] = $parsedAlert;
        }

        return $resultArray;
    }

    protected function isAlert(array $alert): bool
    {
        return isset($alert['name']) && $alert['name'] == 'ENTRY';
    }

    protected function parseAlert(array $alert): array
    {
        $parsedAlert = array(
            'idString' => '',
            'idKey' => '',
            'updatedDateTime' => null,
            'publishedDateTime' => null,
            'updatedTime' => '',
            'publishedTime' => '',
            'authorName' => '',
            'title' => '',
            'link' => '',
            'summary' => '',
            'capEvent' => '',
            'capEffectiveTime' => '',
            'capExpiresTime' => '',
            'capEffectiveDateTime' => null,
            'capExpiresDateTime' => null,
            'capStatus' => '',
            'capMsgType' => '',
            'capCategory' => '',
            'capUrgencyExpected' => '',
            'capSeverity' => '',
            'capCertainty' => '',
            'capAreaDesc' => '',
            'capPolygon' => '',
            'capGeo' => array(),
            'capGeoString' => '',
            'vtec' => '',
        );

        // Loop through attributes and set values
        foreach ($alert['children'] as $element) {
            $elementName = $element['name'];
            $elementAttrs = $element['attrs'];
            if (isset($element['tagData'])) {
                $elementData = $element['tagData'];
            } else {
                $elementData = '';
            }

            switch ($elementName) {
                case 'ID':
                    $parsedAlert['idString'] = $elementData;
                    break;
                case 'UPDATED':
                    $parsedAlert['updatedDateTime'] = new \DateTime($elementData);
                    $parsedAlert['updatedTime'] = $parsedAlert['updatedDateTime']->format('Y-m-d H:i:s');
                    break;
                case 'PUBLISHED':
                    $parsedAlert['publishedDateTime'] = new \DateTime($elementData);
                    $parsedAlert['publishedTime'] = $parsedAlert['publishedDateTime']->format('Y-m-d H:i:s');
                    break;
                case 'AUTHOR':
                    $parsedAlert['authorName'] = $element['children'][0]['tagData'];
                    break;
                case 'TITLE':
                    $parsedAlert['title'] = $elementData;
                    break;
                case 'LINK':
                    $parsedAlert['link'] = $elementAttrs['HREF'];
                    break;
                case 'SUMMARY':
                    $parsedAlert['summary'] = $elementData;
                    break;
                case 'CAP:EVENT':
                    $parsedAlert['capEvent'] = $elementData;
                    break;
                case 'CAP:EFFECTIVE':
                    $effectiveDateTime = new \DateTime($elementData);
                    $parsedAlert['capEffectiveTime'] = $effectiveDateTime->format('Y-m-d H:i:s');
                    $parsedAlert['capEffectiveDateTime'] = $effectiveDateTime;
                    break;
                case 'CAP:EXPIRES':
                    $expiresDateTime = new \DateTime($elementData);
                    $parsedAlert['capExpiresTime'] = $expiresDateTime->format('Y-m-d H:i:s');
                    $parsedAlert['capExpiresDateTime'] = $expiresDateTime;
                    break;
                case 'CAP:STATUS':
                    $parsedAlert['capStatus'] = $elementData;
                    break;
                case 'CAP:MSGTYPE':
                    $parsedAlert['capMsgType'] = $elementData;
                    break;
                case 'CAP:CATEGORY':
                    $parsedAlert['capCategory'] = $elementData;
                    break;
                case 'CAP:URGENCY':
                    $parsedAlert['capUrgencyExpected'] = $elementData;
                    break;
                case 'CAP:SEVERITY':
                    $parsedAlert['capSeverity'] = $elementData;
                    break;
                case 'CAP:CERTAINTY':
                    $parsedAlert['capCertainty'] = $elementData;
                    break;
                case 'CAP:AREADESC':
                    $parsedAlert['capAreaDesc'] = $elementData;
                    break;
                case 'CAP:POLYGON':
                    $capPolygonString = $elementData;
                    $parsedAlert['capPolygon'] = explode(' ', $capPolygonString);
                    break;
                case 'CAP:GEOCODE':
                    $geoArray = array();

                    // parse into simple array
                    foreach ($element['children'] as $geo) {
                        if (isset($geo['tagData'])) {
                            $geoArray[] = $geo['tagData'];
                        }
                    }

                    $geoLocArray = $this->parseGeoArray($geoArray);
                    $parsedAlert['capGeoString'] = implode(', ', $geoArray);
                    $parsedAlert['capGeo'] = $geoLocArray;
                    break;
                case 'CAP:PARAMETER':
                    // It appears only vtec is currently stored here
                    if (isset($element['children'][1]['tagData'])) {
                        $parsedAlert['vtec'] = $element['children'][1]['tagData'];
                    }
                    break;
            }

            $parsedAlert['idKey'] = $this->generateIdKey($parsedAlert['idString']);

        }

        return $parsedAlert;
    }

    protected function parseGeoArray(array $geoArray): array
    {
        // organize array by format type
        $locationFormatTypes = array(
            'FIPS6',
            'UGC',
        );

        $currentLocationKey = 'null';
        $geoLocArray = array();

        foreach ($geoArray as $geoLoc) {
            if (in_array($geoLoc, $locationFormatTypes)) {
                $currentLocationKey = $geoLoc;
                $geoLocArray[$geoLoc] = array();
            } else {
                $geoLocArray[$currentLocationKey] = explode(' ', $geoLoc);
            }
        }

        return $geoLocArray;
    }

    protected function generateIdKey(string $idString): string
    {
        // idString contains important data in it as well.
        // Use it to generate a unique key for the alert.
        //
        // Example:
        //    alerts.weather.gov/cap/wwacapget.php?x=AK12539092A414.WinterWeatherAdvisory.125390A09AB0AK.AFGWSWNSB.a59f94b5da45867f6f45272a36df61cc
        //
        // The pieces of idString appears to be
        // 0. State abrev + some strange timestamp format
        // 1. Type
        // 2. Another timestamp with state abrev.
        // 3. ??
        // 4. Hash of some data (32 bit)
        //
        // Since 0,1,2, and 3 aren't unique on their own, but it looks like 4 is, I'll plan on using 0 and 4 just to be sure.

        $idParts = explode('=', $idString);
        $idSplit = explode('.', $idParts[1]);
        $idKey = $idSplit[0] . '.' . $idSplit[4];

        return $idKey;
    }

}


1		<?php
2
3		namespace NoaaCapAlerts\Parser;
4
5		class IndexParser
6		{
7		protected $xmlParser;
8
9	3	function __construct(XmlParser $xmlParser = null)
10		{
11	3	if ($xmlParser === null) {
12	2	$this->xmlParser = new XmlParser();
13		} else {
14	1	$this->xmlParser = $xmlParser;
15		}
16	3	}
17
18	3	public function parse(string $xml): array
19		{
20		// parse XML into an array of alerts
21	3	$rawDataArray = $this->xmlParser->getArrayFromXml($xml);
22	2	$alertDataArray = $rawDataArray[0]['children'];
23
24		// Process each alert ("ENTRY")
25	2	$resultArray = array();
26
27	2	foreach ($alertDataArray as $alert) {
28	2	if (!$this->isAlert($alert)) {
29	2	continue;
30		}
31
32	2	$parsedAlert = $this->parseAlert($alert);
33
34	2	$resultArray[] = $parsedAlert;
35		}
36
37	2	return $resultArray;
38		}
39
40	2	protected function isAlert(array $alert): bool
41		{
42	2	return isset($alert['name']) && $alert['name'] == 'ENTRY';
43		}
44
45	2	protected function parseAlert(array $alert): array
46		{
47		$parsedAlert = array(
48	2	'idString' => '',
49		'idKey' => '',
50		'updatedDateTime' => null,
51		'publishedDateTime' => null,
52		'updatedTime' => '',
53		'publishedTime' => '',
54		'authorName' => '',
55		'title' => '',
56		'link' => '',
57		'summary' => '',
58		'capEvent' => '',
59		'capEffectiveTime' => '',
60		'capExpiresTime' => '',
61		'capEffectiveDateTime' => null,
62		'capExpiresDateTime' => null,
63		'capStatus' => '',
64		'capMsgType' => '',
65		'capCategory' => '',
66		'capUrgencyExpected' => '',
67		'capSeverity' => '',
68		'capCertainty' => '',
69		'capAreaDesc' => '',
70		'capPolygon' => '',
71		'capGeo' => array(),
72		'capGeoString' => '',
73		'vtec' => '',
74		);
75
76		// Loop through attributes and set values
77	2	foreach ($alert['children'] as $element) {
78	2	$elementName = $element['name'];
79	2	$elementAttrs = $element['attrs'];
80	2	if (isset($element['tagData'])) {
81	2	$elementData = $element['tagData'];
82		} else {
83	2	$elementData = '';
84		}
85
86		switch ($elementName) {
87	2	case 'ID':
88	2	$parsedAlert['idString'] = $elementData;
89	2	break;
90	2	case 'UPDATED':
91	2	$parsedAlert['updatedDateTime'] = new \DateTime($elementData);
92	2	$parsedAlert['updatedTime'] = $parsedAlert['updatedDateTime']->format('Y-m-d H:i:s');
93	2	break;
94	2	case 'PUBLISHED':
95	2	$parsedAlert['publishedDateTime'] = new \DateTime($elementData);
96	2	$parsedAlert['publishedTime'] = $parsedAlert['publishedDateTime']->format('Y-m-d H:i:s');
97	2	break;
98	2	case 'AUTHOR':
99	2	$parsedAlert['authorName'] = $element['children'][0]['tagData'];
100	2	break;
101	2	case 'TITLE':
102	2	$parsedAlert['title'] = $elementData;
103	2	break;
104	2	case 'LINK':
105	2	$parsedAlert['link'] = $elementAttrs['HREF'];
106	2	break;
107	2	case 'SUMMARY':
108	2	$parsedAlert['summary'] = $elementData;
109	2	break;
110	2	case 'CAP:EVENT':
111	2	$parsedAlert['capEvent'] = $elementData;
112	2	break;
113	2	case 'CAP:EFFECTIVE':
114	2	$effectiveDateTime = new \DateTime($elementData);
115	2	$parsedAlert['capEffectiveTime'] = $effectiveDateTime->format('Y-m-d H:i:s');
116	2	$parsedAlert['capEffectiveDateTime'] = $effectiveDateTime;
117	2	break;
118	2	case 'CAP:EXPIRES':
119	2	$expiresDateTime = new \DateTime($elementData);
120	2	$parsedAlert['capExpiresTime'] = $expiresDateTime->format('Y-m-d H:i:s');
121	2	$parsedAlert['capExpiresDateTime'] = $expiresDateTime;
122	2	break;
123	2	case 'CAP:STATUS':
124	2	$parsedAlert['capStatus'] = $elementData;
125	2	break;
126	2	case 'CAP:MSGTYPE':
127	2	$parsedAlert['capMsgType'] = $elementData;
128	2	break;
129	2	case 'CAP:CATEGORY':
130	2	$parsedAlert['capCategory'] = $elementData;
131	2	break;
132	2	case 'CAP:URGENCY':
133	2	$parsedAlert['capUrgencyExpected'] = $elementData;
134	2	break;
135	2	case 'CAP:SEVERITY':
136	2	$parsedAlert['capSeverity'] = $elementData;
137	2	break;
138	2	case 'CAP:CERTAINTY':
139	2	$parsedAlert['capCertainty'] = $elementData;
140	2	break;
141	2	case 'CAP:AREADESC':
142	2	$parsedAlert['capAreaDesc'] = $elementData;
143	2	break;
144	2	case 'CAP:POLYGON':
145	2	$capPolygonString = $elementData;
146	2	$parsedAlert['capPolygon'] = explode(' ', $capPolygonString);
147	2	break;
148	2	case 'CAP:GEOCODE':
149	2	$geoArray = array();
150
151		// parse into simple array
152	2	foreach ($element['children'] as $geo) {
153	2	if (isset($geo['tagData'])) {
154	2	$geoArray[] = $geo['tagData'];
155		}
156		}
157
158	2	$geoLocArray = $this->parseGeoArray($geoArray);
159	2	$parsedAlert['capGeoString'] = implode(', ', $geoArray);
160	2	$parsedAlert['capGeo'] = $geoLocArray;
161	2	break;
162	2	case 'CAP:PARAMETER':
163		// It appears only vtec is currently stored here
164	2	if (isset($element['children'][1]['tagData'])) {
165	2	$parsedAlert['vtec'] = $element['children'][1]['tagData'];
166		}
167	2	break;
168		}
169
170	2	$parsedAlert['idKey'] = $this->generateIdKey($parsedAlert['idString']);
171
172		}
173
174	2	return $parsedAlert;
175		}
176
177	2	protected function parseGeoArray(array $geoArray): array
178		{
179		// organize array by format type
180		$locationFormatTypes = array(
181	2	'FIPS6',
182		'UGC',
183		);
184
185	2	$currentLocationKey = 'null';
186	2	$geoLocArray = array();
187
188	2	foreach ($geoArray as $geoLoc) {
189	2	if (in_array($geoLoc, $locationFormatTypes)) {
190	2	$currentLocationKey = $geoLoc;
191	2	$geoLocArray[$geoLoc] = array();
192		} else {
193	2	$geoLocArray[$currentLocationKey] = explode(' ', $geoLoc);
194		}
195		}
196
197	2	return $geoLocArray;
198		}
199
200	2	protected function generateIdKey(string $idString): string
201		{
202		// idString contains important data in it as well.
203		// Use it to generate a unique key for the alert.
204		//
205		// Example:
206		// alerts.weather.gov/cap/wwacapget.php?x=AK12539092A414.WinterWeatherAdvisory.125390A09AB0AK.AFGWSWNSB.a59f94b5da45867f6f45272a36df61cc
207		//
208		// The pieces of idString appears to be
209		// 0. State abrev + some strange timestamp format
210		// 1. Type
211		// 2. Another timestamp with state abrev.
212		// 3. ??
213		// 4. Hash of some data (32 bit)
214		//
215		// Since 0,1,2, and 3 aren't unique on their own, but it looks like 4 is, I'll plan on using 0 and 4 just to be sure.
216
217	2	$idParts = explode('=', $idString);
218	2	$idSplit = explode('.', $idParts[1]);
219	2	$idKey = $idSplit[0] . '.' . $idSplit[4];
220
221	2	return $idKey;
222		}
223
224		}
225

thtroyer / noaa-cap-alerts

Push — master ( 7ef222...7c8367 )

IndexParser::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like