13304001520

Committed 13 Feb 2025 09:00AM UTC coverage: 95.972% (-0.4%) from 96.394%

Build # 13304001520

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #175 from heiglandreas/updatePHPUnit

Update tests so they run with any PHPUnit version

Run Details

405 of 422 relevant lines covered (95.97%)

11.75 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

93.48

/src/HolidayIteratorFactory.php

<?php

declare(strict_types=1);

/**
 * Copyright (c) Andreas Heigl<andreas@heigl.org>
 *
 * 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<andreas@heigl.org>
 * @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\Factory\DateFactory;
use Org_Heigl\Holidaychecker\Factory\DateFollowupFactory;
use Org_Heigl\Holidaychecker\Factory\DecorateFromDomElement;
use Org_Heigl\Holidaychecker\Factory\EasterFactory;
use Org_Heigl\Holidaychecker\Factory\EasterOrthodoxFactory;
use Org_Heigl\Holidaychecker\Factory\ItemFromDomElementCreator;
use Org_Heigl\Holidaychecker\Factory\ObservanceDecoratorFactory;
use Org_Heigl\Holidaychecker\Factory\RelativeFactory;
use Org_Heigl\Holidaychecker\Factory\SwapDecoratorFactory;
use RuntimeException;
use Throwable;
use UnexpectedValueException;
use function is_readable;
use function sprintf;

class HolidayIteratorFactory
{
        /** @var ItemFromDomElementCreator[] */
        private $factories;

        /** @var DecorateFromDomElement[] */
        private $decorators;

        public function __construct()
        {
                $this->factories = [
                        new EasterFactory(),
                        new EasterOrthodoxFactory(),
                        new DateFactory(),
                        new DateFollowupFactory(),
                        new RelativeFactory(),
                ];

                $this->decorators = [
                        new ObservanceDecoratorFactory(),
                        new SwapDecoratorFactory(),
                ];
        }

        /**
         * 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 $this->createIteratorFromXmlFile($file1);
        }

        /**
         * 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');
                }

                $element = $dom->documentElement;
                if ($element === null) {
                        return $iterator;
                }
                foreach ($element->childNodes as $child) {
                        if (!$child instanceof DOMElement) {
                                continue;
                        }
                        if ($child->nodeName === 'resources') {
                                continue;
                        }

                        try {
                                $element = $this->getElement($child);
                                $element = $this->decorateElement($element, $child);
                                $iterator->append($element);
                        } catch (Throwable $e) {
                                // Do nothing on purpose
                        }
                }

                return $iterator;
        }

        private function getElement(DOMElement $child): HolidayIteratorItemInterface
        {
                foreach ($this->factories as $factory) {
                        $element = $factory->itemFromDomElement($child);
                        if ($element instanceof HolidayIteratorItemInterface) {
                                return $element;
                        }
                }

                throw new RuntimeException('Unknown element encountered');
        }

        private function decorateElement(HolidayIteratorItemInterface $element, DOMElement $child): HolidayIteratorItemInterface
        {
                foreach ($this->decorators as $decorator) {
                        $element = $decorator->decorate($element, $child);
                }

                return $element;
        }
}

1	<?php
2
3	declare(strict_types=1);
4
5	/**
6	* Copyright (c) Andreas Heigl<andreas@heigl.org>
7	*
8	* Permission is hereby granted, free of charge, to any person obtaining a copy
9	* of this software and associated documentation files (the "Software"), to deal
10	* in the Software without restriction, including without limitation the rights
11	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12	* copies of the Software, and to permit persons to whom the Software is
13	* furnished to do so, subject to the following conditions:
14	*
15	* The above copyright notice and this permission notice shall be included in
16	* all copies or substantial portions of the Software.
17	*
18	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24	* THE SOFTWARE.
25	*
26	* @author Andreas Heigl<andreas@heigl.org>
27	* @copyright Andreas Heigl
28	* @license http://www.opensource.org/licenses/mit-license.php MIT-License
29	* @since 09.03.2017
30	* @link http://github.com/heiglandreas/org.heigl.Holidaychecker
31	*/
32
33	namespace Org_Heigl\Holidaychecker;
34
35	use DOMDocument;
36	use DOMElement;
37	use Exception;
38	use Org_Heigl\Holidaychecker\Factory\DateFactory;
39	use Org_Heigl\Holidaychecker\Factory\DateFollowupFactory;
40	use Org_Heigl\Holidaychecker\Factory\DecorateFromDomElement;
41	use Org_Heigl\Holidaychecker\Factory\EasterFactory;
42	use Org_Heigl\Holidaychecker\Factory\EasterOrthodoxFactory;
43	use Org_Heigl\Holidaychecker\Factory\ItemFromDomElementCreator;
44	use Org_Heigl\Holidaychecker\Factory\ObservanceDecoratorFactory;
45	use Org_Heigl\Holidaychecker\Factory\RelativeFactory;
46	use Org_Heigl\Holidaychecker\Factory\SwapDecoratorFactory;
47	use RuntimeException;
48	use Throwable;
49	use UnexpectedValueException;
50	use function is_readable;
51	use function sprintf;
52
53	class HolidayIteratorFactory
54	{
55	/** @var ItemFromDomElementCreator[] */
56	private $factories;
57
58	/** @var DecorateFromDomElement[] */
59	private $decorators;
60
61	public function __construct()
62	{
63	$this->factories = [	30✔
64	new EasterFactory(),	30✔
65	new EasterOrthodoxFactory(),	30✔
66	new DateFactory(),	30✔
67	new DateFollowupFactory(),	30✔
68	new RelativeFactory(),	30✔
69	];	30✔
70
71	$this->decorators = [	30✔
72	new ObservanceDecoratorFactory(),	30✔
73	new SwapDecoratorFactory(),	30✔
74	];	30✔
75	}
76
77	/**
78	* Create a HolidayIterator from an ISO 3166-code.
79	*
80	* @param string $isoCode
81	*
82	* @return HolidayIterator
83	*/
84	public function createIteratorFromISO3166(string $isoCode): HolidayIterator
85	{
86	$file = __DIR__ . '/../share/%s.xml';	23✔
87	$file1 = sprintf($file, $isoCode);	23✔
88
89	if (!is_readable($file1)) {	23✔
90	throw new UnexpectedValueException(sprintf(	1✔
91	'There is no holiday-file for %s',	1✔
92	$isoCode	1✔
93	));	1✔
94	}
95
96	return $this->createIteratorFromXmlFile($file1);	22✔
97	}
98
99	/**
100	* Create a HolidayIterator from an XML-File
101	*
102	* The provided XML-File has to validate against the holiday.xsd-file you
103	* can find in this projects "share" folder.
104	*
105	* @param string $file
106	*
107	* @return HolidayIterator
108	*/
109	public function createIteratorFromXmlFile(string $file): HolidayIterator
110	{
111	$iterator = new HolidayIterator();	29✔
112
113	$dom = new DOMDocument('1.0', 'UTF-8');	29✔
114	$dom->load($file);	29✔
115	$dom->xinclude();	29✔
116
117	if (!@$dom->schemaValidate(__DIR__ . '/../share/holidays.xsd')) {	29✔
118	throw new Exception('XML-File does not validate agains schema');	1✔
119	}
120
121	$element = $dom->documentElement;	28✔
122	if ($element === null) {	28✔
123	return $iterator;	×
124	}
125	foreach ($element->childNodes as $child) {	28✔
126	if (!$child instanceof DOMElement) {	28✔
127	continue;	28✔
128	}
129	if ($child->nodeName === 'resources') {	28✔
130	continue;	5✔
131	}
132
133	try {
134	$element = $this->getElement($child);	28✔
135	$element = $this->decorateElement($element, $child);	28✔
136	$iterator->append($element);	28✔
137	} catch (Throwable $e) {	×
138	// Do nothing on purpose
139	}
140	}
141
142	return $iterator;	28✔
143	}
144
145	private function getElement(DOMElement $child): HolidayIteratorItemInterface
146	{
147	foreach ($this->factories as $factory) {	28✔
148	$element = $factory->itemFromDomElement($child);	28✔
149	if ($element instanceof HolidayIteratorItemInterface) {	28✔
150	return $element;	28✔
151	}
152	}
153
154	throw new RuntimeException('Unknown element encountered');	×
155	}
156
157	private function decorateElement(HolidayIteratorItemInterface $element, DOMElement $child): HolidayIteratorItemInterface
158	{
159	foreach ($this->decorators as $decorator) {	28✔
160	$element = $decorator->decorate($element, $child);	28✔
161	}
162
163	return $element;	28✔
164	}
165	}

heiglandreas / holidayChecker / 13304001520

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous