HolidayIteratorFactory::createIteratorFromXmlFile() - Code Metrics - Inspection of "Merge pull request #110 from heiglandreas/allowFir..." - heiglandreas/holidayChecker - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Branch — main (2e4b54)

by Andreas
created 2022-10-19 15:55 UTC
createIteratorFromXmlFile() B

↳ Parent: HolidayIteratorFactory
Complexity

Conditions	10
Paths	11
Size

Total Lines	36
Code Lines	21
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
eloc	21
c	1
b	0
f	0
dl	0
loc	36
rs	7.6666
cc	10
nc	11
nop	1
How to fix Complexity

<?php

declare(strict_types=1);

/**
 * Copyright (c) Andreas Heigl<[email protected]>
 *
 * 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.
 *
 * @author    Andreas Heigl<[email protected]>
 * @copyright Andreas Heigl
 * @license   http://www.opensource.org/licenses/mit-license.php MIT-License
 * @since     09.03.2017
 * @link      http://github.com/heiglandreas/org.heigl.Holidaychecker
 */

namespace Org_Heigl\Holidaychecker;

use DOMDocument;
use DOMElement;
use Exception;
use Org_Heigl\Holidaychecker\IteratorItem\Date;
use Org_Heigl\Holidaychecker\IteratorItem\DateFollowUp;
use Org_Heigl\Holidaychecker\IteratorItem\Easter;
use Org_Heigl\Holidaychecker\IteratorItem\EasterOrthodox;
use Org_Heigl\Holidaychecker\IteratorItem\Relative;
use RuntimeException;
use Throwable;
use UnexpectedValueException;
use function explode;
use function is_readable;
use function sprintf;

class HolidayIteratorFactory
{
    /**
     * Create a HolidayIterator from an XML-File
     *
     * The provided XML-File has to validate against the holiday.xsd-file you
     * can find in this projects "share" folder.
     *
     * @param string $file
     *
     * @return HolidayIterator
     */
    public function createIteratorFromXmlFile(string $file): HolidayIterator
    {
        $iterator = new HolidayIterator();

        $dom = new DOMDocument('1.0', 'UTF-8');
        $dom->load($file);
        $dom->xinclude();

        if (! @$dom->schemaValidate(__DIR__ . '/../share/holidays.xsd')) {
            throw new Exception('XML-File does not validate agains schema');
        }
        foreach ($dom->documentElement->childNodes as $child) {
            if (! $child instanceof DOMElement) {
                continue;
            }
            if ($child->nodeName === 'resources') {
                continue;
            }

			try {
				$element = $this->getElement($child);
				if ($child->hasAttribute('firstobservance') || $child->hasAttribute('lastobservance')) {
					$element = new ObservanceDecorator(
						$element,
						$child->hasAttribute('firstobservance') ? (int) $child->getAttribute('firstobservance') : null,
						$child->hasAttribute('lastobservance') ? (int) $child->getAttribute('lastobservance') : null,
					);
				}

				$iterator->append($element);
			} catch (Throwable $e) {
				// Do nothing on purpose
			}
        }

        return $iterator;
    }

    /**
     * Create a HolidayIterator from an ISO 3166-code.
     *
     * @param string $isoCode
     *
     * @return HolidayIterator
     */
    public function createIteratorFromISO3166(string $isoCode): HolidayIterator
    {
        $file = __DIR__ . '/../share/%s.xml';
        $file1 = sprintf($file, $isoCode);

        if (! is_readable($file1)) {
            throw new UnexpectedValueException(sprintf(
                'There is no holiday-file for %s',
                $isoCode
            ));
        }

        return self::createIteratorFromXmlFile($file1);
        return self::/** @scrutinizer ignore-call */ createIteratorFromXmlFile($file1);
    }

    private function getElement(DOMElement $child): HolidayIteratorItemInterface
    {
        switch ($child->nodeName) {
            case 'easter':
                return new Easter(
                    $child->textContent,
                    $this->getFree($child),
                    (int) $child->getAttribute('offset')
                );
            case 'easterorthodox':
                return new EasterOrthodox(
                    $child->textContent,
                    $this->getFree($child),
                    (int) $child->getAttribute('offset')
                );
            case 'date':
                $day = CalendarDayFactory::createCalendarDay(
                    (int) $child->getAttribute('day'),
                    (int) $child->getAttribute('month'),
                    ($child->hasAttribute('calendar')?$child->getAttribute('calendar'): 'gregorian')
                );
                if ($child->hasAttribute('year')) {
                    $day->setYear((int) $child->getAttribute('year'));
                }
                return new Date(
                    $child->textContent,
                    $this->getFree($child),
                    $day,
                    $child->hasAttribute('forwardto')?$child->getAttribute('forwardto'):'',
                    $child->hasAttribute('forwardwhen')?explode(' ', $child->getAttribute('forwardwhen')):[],
                    $child->hasAttribute('rewindto')?$child->getAttribute('rewindto'):'',
                    $child->hasAttribute('rewindwhen')?explode(' ', $child->getAttribute('rewindwhen')):[],
                );
            case 'dateFollowUp':
                $day = CalendarDayFactory::createCalendarDay(
                    (int) $child->getAttribute('day'),
                    (int) $child->getAttribute('month'),
                    ($child->hasAttribute('calendar')?$child->getAttribute('calendar'): 'gregorian')
                );

                return new DateFollowUp(
                    $child->textContent,
                    $this->getFree($child),
                    $day,
                    $child->getAttribute('followup'),
                    ($child->hasAttribute('replaced')?explode(' ', $child->getAttribute('replaced')):[])
                );
            case 'relative':
                return new Relative(
                    $child->textContent,
                    $this->getFree($child),
                    (int) $child->getAttribute('day'),
                    (int) $child->getAttribute('month'),
                    $child->getAttribute('relation')
                );
            default:
                throw new RuntimeException('Unknown element encountered');
        }
	}

    private function getFree(DOMElement $element): bool
    {
        return ($element->getAttribute('free') === "true");
    }
}

heiglandreas / holidayChecker

Branch — main (2e4b54)

createIteratorFromXmlFile() B

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like
