5046041481

Build Type

github

Committed by GitHub

Commit Message

Merge 2cd309b47 into a16355c73

Pull Request Pull Request #1697: perf: native_function_invocation

Run Details

322 of 322 new or added lines in 62 files covered. (100.0%)

2784 of 4121 relevant lines covered (67.56%)

0.68 hits per line

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

86.0

/src/Step/Menus/Create.php

<?php

declare(strict_types=1);

/*
 * This file is part of Cecil.
 *
 * Copyright (c) Arnaud Ligny <arnaud@ligny.fr>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Cecil\Step\Menus;

use Cecil\Collection\Menu\Collection as MenusCollection;
use Cecil\Collection\Menu\Entry;
use Cecil\Collection\Menu\Menu;
use Cecil\Collection\Page\Page;
use Cecil\Exception\RuntimeException;
use Cecil\Logger\PrintLogger;
use Cecil\Renderer\Page as PageRenderer;
use Cecil\Step\AbstractStep;

/**
 * Creates menus collection.
 */
class Create extends AbstractStep
{
    /** @var array */
    protected $menus;

    /**
     * {@inheritdoc}
     */
    public function getName(): string
    {
        return 'Creating menus';
    }

    /**
     * {@inheritdoc}
     *
     * @throws RuntimeException
     */
    public function process(): void
    {
        // creates a 'menus' collection for each language, with a default 'main' menu
        foreach ($this->config->getLanguages() as $language) {
            $this->menus[$language['code']] = new MenusCollection('menus');
            $this->menus[$language['code']]->add(new Menu('main'));
        }

        // collects 'menu' entries from pages
        $this->collectPages();

        /**
         * Removing/adding/replacing menus entries from config.
         * ie:
         *   menus:
         *     main:
         *       - id: example
         *         name: "Example"
         *         url: https://example.com
         *         weight: 999
         *       - id: about
         *         enabled: false.
         */
        foreach ($this->config->getLanguages() as $language) {
            if ($menusConfig = (array) $this->config->get('menus', $language['code'], false)) {
                $totalConfig = array_sum(array_map('count', $menusConfig));
                $countConfig = 0;
                $suffix = '';
                $page404 = '404.html';

                if ($language['code'] !== $this->config->getLanguageDefault()) {
                    $suffix = '.' . $language['code'];
                    $page404 = $language['code'] . '/404.html';
                }

                foreach ($menusConfig as $menuConfig => $entry) {
                    // add Menu if not exists
                    if (!$this->menus[$language['code']]->has($menuConfig)) {
                        $this->menus[$language['code']]->add(new Menu($menuConfig));
                    }
                    /** @var \Cecil\Collection\Menu\Menu $menu */
                    $menu = $this->menus[$language['code']]->get($menuConfig);
                    foreach ($entry as $key => $property) {
                        $countConfig++;
                        $enabled = true;
                        $updated = false;

                        // ID is required
                        if (!isset($property['id'])) {
                            throw new RuntimeException(sprintf('"id" is required for entry at position %s in "%s" menu', $key, $menu));
                        }
                        // enabled?
                        if (isset($property['enabled']) && false === $property['enabled']) {
                            $enabled = false;
                            if (!$menu->has($property['id'])) {
                                $message = sprintf('Config menu entry "%s > %s%s" disabled', (string) $menu, $property['id'], $suffix);
                                $this->builder->getLogger()->info($message, ['progress' => [$countConfig, $totalConfig]]);
                            }
                        }
                        // is entry already exists?
                        if ($menu->has($property['id'])) {
                            // removes a disabled entry
                            if (!$enabled) {
                                $menu->remove($property['id']);

                                $message = sprintf('Config menu entry "%s > %s%s" removed', (string) $menu, $property['id'], $suffix);
                                $this->builder->getLogger()->info($message, ['progress' => [$countConfig, $totalConfig]]);
                                continue;
                            }
                            // merges properties
                            $updated = true;
                            $current = $menu->get($property['id'])->toArray();
                            $property = array_merge($current, $property);

                            $message = sprintf('Config menu entry "%s > %s%s" updated', (string) $menu, $property['id'], $suffix);
                            $this->builder->getLogger()->info($message, ['progress' => [$countConfig, $totalConfig]]);
                        }
                        // adds/replaces entry
                        if ($enabled) {
                            $item = (new Entry($property['id']))
                                ->setName($property['name'] ?? ucfirst($property['id']))
                                ->setUrl($property['url'] ?? $page404)
                                ->setWeight((int) ($property['weight'] ?? 0));
                            $menu->add($item);

                            if (!$updated) {
                                $message = sprintf('Config menu entry "%s > %s%s" created', (string) $menu, $property['id'], $suffix);
                                $this->builder->getLogger()->info($message, ['progress' => [$countConfig, $totalConfig]]);
                            }
                        }
                    }
                }
            }
        }

        $this->builder->setMenus($this->menus);
    }

    /**
     * Collects pages with a menu variable.
     */
    protected function collectPages(): void
    {
        $filteredPages = $this->builder->getPages()->filter(function (Page $page) {
            return $page->hasVariable('menu')
                && $page->getVariable('published')
                && \in_array($page->getVariable('language', $this->config->getLanguageDefault()), array_column($this->config->getLanguages(), 'code'));
        });

        $total = \count($filteredPages);
        $count = 0;
        /** @var \Cecil\Collection\Page\Page $page */
        foreach ($filteredPages as $page) {
            $count++;
            $language = $page->getVariable('language', $this->config->getLanguageDefault());
            /**
             * Array case.
             *
             * ie 1:
             *   menu: [main, navigation]
             * ie 2:
             *   menu:
             *     main:
             *       weight: 999
             */
            if (\is_array($page->getVariable('menu'))) {
                foreach ($page->getVariable('menu') as $key => $value) {
                    $menuName = $key;
                    $property = $value;
                    $weight = null;
                    if (\is_int($key)) {
                        $menuName = $value;
                        $property = null;
                    }
                    if (!\is_string($menuName)) {
                        $this->builder->getLogger()->error(
                            sprintf(
                                'Menu\'s name of page "%s" must be a string, not "%s"',
                                $page->getId(),
                                PrintLogger::format($menuName)
                            ),
                            ['progress' => [$count, $total]]
                        );
                        continue;
                    }
                    $item = (new Entry($page->getIdWithoutLang()))
                        ->setName($page->getVariable('title'))
                        ->setUrl((new PageRenderer($this->config))->getUrl($page));
                    if (isset($property['weight'])) {
                        $weight = $property['weight'];
                        $item->setWeight((int) $property['weight']);
                    }
                    // add Menu if not exists
                    if (!$this->menus[$language]->has($menuName)) {
                        $this->menus[$language]->add(new Menu($menuName));
                    }
                    /** @var \Cecil\Collection\Menu\Menu $menu */
                    $menu = $this->menus[$language]->get($menuName);
                    $menu->add($item);

                    $message = sprintf('Page menu entry "%s > %s" created (weight: %s)', $menuName, $page->getId(), $weight ?? 'N/A');
                    $this->builder->getLogger()->info($message, ['progress' => [$count, $total]]);
                }
                continue;
            }
            /**
             * String case.
             *
             * ie:
             *   menu: main
             */
            $item = (new Entry($page->getIdWithoutLang()))
                ->setName($page->getVariable('title'))
                ->setUrl((new PageRenderer($this->config))->getUrl($page));
            // add Menu if not exists
            if (!$this->menus[$language]->has($page->getVariable('menu'))) {
                $this->menus[$language]->add(new Menu($page->getVariable('menu')));
            }
            /** @var \Cecil\Collection\Menu\Menu $menu */
            $menu = $this->menus[$language]->get($page->getVariable('menu'));
            $menu->add($item);

            $message = sprintf('Page menu entry "%s > %s" created', $page->getVariable('menu'), $page->getId());
            $this->builder->getLogger()->info($message, ['progress' => [$count, $total]]);
        }
    }
}

1	<?php
2
3	declare(strict_types=1);
4
5	/*
6	* This file is part of Cecil.
7	*
8	* Copyright (c) Arnaud Ligny <arnaud@ligny.fr>
9	*
10	* For the full copyright and license information, please view the LICENSE
11	* file that was distributed with this source code.
12	*/
13
14	namespace Cecil\Step\Menus;
15
16	use Cecil\Collection\Menu\Collection as MenusCollection;
17	use Cecil\Collection\Menu\Entry;
18	use Cecil\Collection\Menu\Menu;
19	use Cecil\Collection\Page\Page;
20	use Cecil\Exception\RuntimeException;
21	use Cecil\Logger\PrintLogger;
22	use Cecil\Renderer\Page as PageRenderer;
23	use Cecil\Step\AbstractStep;
24
25	/**
26	* Creates menus collection.
27	*/
28	class Create extends AbstractStep
29	{
30	/** @var array */
31	protected $menus;
32
33	/**
34	* {@inheritdoc}
35	*/
36	public function getName(): string
37	{
38	return 'Creating menus';	1✔
39	}
40
41	/**
42	* {@inheritdoc}
43	*
44	* @throws RuntimeException
45	*/
46	public function process(): void
47	{
48	// creates a 'menus' collection for each language, with a default 'main' menu
49	foreach ($this->config->getLanguages() as $language) {	1✔
50	$this->menus[$language['code']] = new MenusCollection('menus');	1✔
51	$this->menus[$language['code']]->add(new Menu('main'));	1✔
52	}
53
54	// collects 'menu' entries from pages
55	$this->collectPages();	1✔
56
57	/**
58	* Removing/adding/replacing menus entries from config.
59	* ie:
60	* menus:
61	* main:
62	* - id: example
63	* name: "Example"
64	* url: https://example.com
65	* weight: 999
66	* - id: about
67	* enabled: false.
68	*/
69	foreach ($this->config->getLanguages() as $language) {	1✔
70	if ($menusConfig = (array) $this->config->get('menus', $language['code'], false)) {	1✔
71	$totalConfig = array_sum(array_map('count', $menusConfig));	1✔
72	$countConfig = 0;	1✔
73	$suffix = '';	1✔
74	$page404 = '404.html';	1✔
75
76	if ($language['code'] !== $this->config->getLanguageDefault()) {	1✔
77	$suffix = '.' . $language['code'];	1✔
78	$page404 = $language['code'] . '/404.html';	1✔
79	}
80
81	foreach ($menusConfig as $menuConfig => $entry) {	1✔
82	// add Menu if not exists
83	if (!$this->menus[$language['code']]->has($menuConfig)) {	1✔
84	$this->menus[$language['code']]->add(new Menu($menuConfig));	×
85	}
86	/** @var \Cecil\Collection\Menu\Menu $menu */
87	$menu = $this->menus[$language['code']]->get($menuConfig);	1✔
88	foreach ($entry as $key => $property) {	1✔
89	$countConfig++;	1✔
90	$enabled = true;	1✔
91	$updated = false;	1✔
92
93	// ID is required
94	if (!isset($property['id'])) {	1✔
95	throw new RuntimeException(sprintf('"id" is required for entry at position %s in "%s" menu', $key, $menu));	×
96	}
97	// enabled?
98	if (isset($property['enabled']) && false === $property['enabled']) {	1✔
99	$enabled = false;	1✔
100	if (!$menu->has($property['id'])) {	1✔
101	$message = sprintf('Config menu entry "%s > %s%s" disabled', (string) $menu, $property['id'], $suffix);	×
102	$this->builder->getLogger()->info($message, ['progress' => [$countConfig, $totalConfig]]);	×
103	}
104	}
105	// is entry already exists?
106	if ($menu->has($property['id'])) {	1✔
107	// removes a disabled entry
108	if (!$enabled) {	1✔
109	$menu->remove($property['id']);	1✔
110
111	$message = sprintf('Config menu entry "%s > %s%s" removed', (string) $menu, $property['id'], $suffix);	1✔
112	$this->builder->getLogger()->info($message, ['progress' => [$countConfig, $totalConfig]]);	1✔
113	continue;	1✔
114	}
115	// merges properties
116	$updated = true;	1✔
117	$current = $menu->get($property['id'])->toArray();	1✔
118	$property = array_merge($current, $property);	1✔
119
120	$message = sprintf('Config menu entry "%s > %s%s" updated', (string) $menu, $property['id'], $suffix);	1✔
121	$this->builder->getLogger()->info($message, ['progress' => [$countConfig, $totalConfig]]);	1✔
122	}
123	// adds/replaces entry
124	if ($enabled) {	1✔
125	$item = (new Entry($property['id']))	1✔
126	->setName($property['name'] ?? ucfirst($property['id']))	1✔
127	->setUrl($property['url'] ?? $page404)	1✔
128	->setWeight((int) ($property['weight'] ?? 0));	1✔
129	$menu->add($item);	1✔
130
131	if (!$updated) {	1✔
132	$message = sprintf('Config menu entry "%s > %s%s" created', (string) $menu, $property['id'], $suffix);	1✔
133	$this->builder->getLogger()->info($message, ['progress' => [$countConfig, $totalConfig]]);	1✔
134	}
135	}
136	}
137	}
138	}
139	}
140
141	$this->builder->setMenus($this->menus);	1✔
142	}
143
144	/**
145	* Collects pages with a menu variable.
146	*/
147	protected function collectPages(): void
148	{
149	$filteredPages = $this->builder->getPages()->filter(function (Page $page) {	1✔
150	return $page->hasVariable('menu')	1✔
151	&& $page->getVariable('published')	1✔
152	&& \in_array($page->getVariable('language', $this->config->getLanguageDefault()), array_column($this->config->getLanguages(), 'code'));	1✔
153	});	1✔
154
155	$total = \count($filteredPages);	1✔
156	$count = 0;	1✔
157	/** @var \Cecil\Collection\Page\Page $page */
158	foreach ($filteredPages as $page) {	1✔
159	$count++;	1✔
160	$language = $page->getVariable('language', $this->config->getLanguageDefault());	1✔
161	/**
162	* Array case.
163	*
164	* ie 1:
165	* menu: [main, navigation]
166	* ie 2:
167	* menu:
168	* main:
169	* weight: 999
170	*/
171	if (\is_array($page->getVariable('menu'))) {	1✔
172	foreach ($page->getVariable('menu') as $key => $value) {	1✔
173	$menuName = $key;	1✔
174	$property = $value;	1✔
175	$weight = null;	1✔
176	if (\is_int($key)) {	1✔
177	$menuName = $value;	1✔
178	$property = null;	1✔
179	}
180	if (!\is_string($menuName)) {	1✔
181	$this->builder->getLogger()->error(	×
182	sprintf(	×
183	'Menu\'s name of page "%s" must be a string, not "%s"',	×
184	$page->getId(),	×
185	PrintLogger::format($menuName)	×
186	),	×
187	['progress' => [$count, $total]]	×
188	);	×
189	continue;	×
190	}
191	$item = (new Entry($page->getIdWithoutLang()))	1✔
192	->setName($page->getVariable('title'))	1✔
193	->setUrl((new PageRenderer($this->config))->getUrl($page));	1✔
194	if (isset($property['weight'])) {	1✔
195	$weight = $property['weight'];	1✔
196	$item->setWeight((int) $property['weight']);	1✔
197	}
198	// add Menu if not exists
199	if (!$this->menus[$language]->has($menuName)) {	1✔
200	$this->menus[$language]->add(new Menu($menuName));	1✔
201	}
202	/** @var \Cecil\Collection\Menu\Menu $menu */
203	$menu = $this->menus[$language]->get($menuName);	1✔
204	$menu->add($item);	1✔
205
206	$message = sprintf('Page menu entry "%s > %s" created (weight: %s)', $menuName, $page->getId(), $weight ?? 'N/A');	1✔
207	$this->builder->getLogger()->info($message, ['progress' => [$count, $total]]);	1✔
208	}
209	continue;	1✔
210	}
211	/**
212	* String case.
213	*
214	* ie:
215	* menu: main
216	*/
217	$item = (new Entry($page->getIdWithoutLang()))	1✔
218	->setName($page->getVariable('title'))	1✔
219	->setUrl((new PageRenderer($this->config))->getUrl($page));	1✔
220	// add Menu if not exists
221	if (!$this->menus[$language]->has($page->getVariable('menu'))) {	1✔
222	$this->menus[$language]->add(new Menu($page->getVariable('menu')));	×
223	}
224	/** @var \Cecil\Collection\Menu\Menu $menu */
225	$menu = $this->menus[$language]->get($page->getVariable('menu'));	1✔
226	$menu->add($item);	1✔
227
228	$message = sprintf('Page menu entry "%s > %s" created', $page->getVariable('menu'), $page->getId());	1✔
229	$this->builder->getLogger()->info($message, ['progress' => [$count, $total]]);	1✔
230	}
231	}
232	}

Cecilapp / Cecil / 5046041481

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