7079797847

Committed 03 Dec 2023 10:36PM UTC coverage: 82.523%. First build

Build # 7079797847

Build Type

Pull #1855

github

Committed by

web-flow

Commit Message

Merge b36488927 into 88411271b

Pull Request Pull Request #1855: refactor: menus creation enhanced

Run Details

28 of 31 new or added lines in 2 files covered. (90.32%)

2819 of 3416 relevant lines covered (82.52%)

0.83 hits per line

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

92.59

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

        $this->createMenusFromPages();

        /**
         * Removing/adding/replacing menus entries from config.
         * ie:
         *   menus:
         *     main:
         *       # remove
         *       - id: about
         *         enabled: false
         *       # add
         *       - id: example
         *         name: "Example"
         *         url: https://example.com
         *         weight: 999
         *       # replace
         *       - id: index
         *         name: "Home page"
         */
        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;

                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 => $properties) {
                        $countConfig++;
                        $updated = false;

                        // ID is required
                        if (!isset($properties['id'])) {
                            $this->builder->getLogger()->error(sprintf('Config menu entry: key "id" is required for entry at position %s in "%s" menu', $key, $menu), ['progress' => [$countConfig, $totalConfig]]);
                            continue;
                        }
                        /** @var \Cecil\Collection\Menu\Entry $item */
                        $item = (new Entry($properties['id']))
                            ->setName($properties['name'] ?? ucfirst($properties['id']))
                            ->setUrl($properties['url'] ?? '404')
                            ->setWeight((int) ($properties['weight'] ?? 0));
                        // is entry already exists?
                        if ($menu->has($properties['id'])) {
                            // removes a not enabled entry
                            if (isset($properties['enabled']) && $properties['enabled'] === false) {
                                $menu->remove($properties['id']);

                                $message = sprintf('Config menu entry "%s (%s) > %s" removed', (string) $menu, $language['code'], $properties['id']);
                                $this->builder->getLogger()->info($message, ['progress' => [$countConfig, $totalConfig]]);
                                continue;
                            }
                            // merges properties
                            $current = $menu->get($properties['id'])->toArray();
                            $properties = array_merge($current, $properties);
                            /** @var \Cecil\Collection\Menu\Entry $item */
                            $item = clone $menu->get($properties['id']);
                            $item->setName($properties['name'])
                                ->setUrl($properties['url'])
                                ->setWeight($properties['weight']);
                            $updated = true;
                        }
                        // adds/replaces entry
                        $menu->add($item);

                        $message = sprintf('Config menu entry "%s (%s) > %s" %s {name: %s, url: %s, weight: %s}', (string) $menu, $language['code'], $item->getId(), $updated ? 'updated' : 'created', $item-> getName(), $item->getUrl(), $item->getWeight());
                        $this->builder->getLogger()->info($message, ['progress' => [$countConfig, $totalConfig]]);
                    }
                }
            }
        }

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

    /**
     * Create menus from pages' `menu` variable.
     */
    protected function createMenusFromPages(): 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.
             *
             * case 1:
             *   menu: [main, navigation]
             * case 2:
             *   menu:
             *     main:
             *       weight: 999
             */
            if (\is_array($page->getVariable('menu'))) {
                foreach ($page->getVariable('menu') as $key => $value) {
                    $menuName = $key;
                    $properties = $value;
                    if (\is_int($key)) {
                        $menuName = $value;
                        $properties = 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($properties['weight'])) {
                        $item->setWeight((int) $properties['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) > %s" created {name: %s, weight: %s}', $menu->getId(), $language, $item->getId(), $item->getName(), $properties['weight'] ?? 'N/A');
                    $this->builder->getLogger()->info($message, ['progress' => [$count, $total]]);
                }
                continue;
            }
            /**
             * String case.
             *
             * e.g.:
             *   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) > %s" created {name: %s}', $menu->getId(), $language, $item->getId(), $item->getName());
            $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 Menu 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	$this->createMenusFromPages();	1✔
55
56	/**
57	* Removing/adding/replacing menus entries from config.
58	* ie:
59	* menus:
60	* main:
61	* # remove
62	* - id: about
63	* enabled: false
64	* # add
65	* - id: example
66	* name: "Example"
67	* url: https://example.com
68	* weight: 999
69	* # replace
70	* - id: index
71	* name: "Home page"
72	*/
73	foreach ($this->config->getLanguages() as $language) {	1✔
74	if ($menusConfig = (array) $this->config->get('menus', $language['code'], false)) {	1✔
75	$totalConfig = array_sum(array_map('count', $menusConfig));	1✔
76	$countConfig = 0;	1✔
77
78	foreach ($menusConfig as $menuConfig => $entry) {	1✔
79	// add Menu if not exists
80	if (!$this->menus[$language['code']]->has($menuConfig)) {	1✔
81	$this->menus[$language['code']]->add(new Menu($menuConfig));	×
82	}
83	/** @var \Cecil\Collection\Menu\Menu $menu */
84	$menu = $this->menus[$language['code']]->get($menuConfig);	1✔
85	foreach ($entry as $key => $properties) {	1✔
86	$countConfig++;	1✔
87	$updated = false;	1✔
88
89	// ID is required
90	if (!isset($properties['id'])) {	1✔
NEW 91	$this->builder->getLogger()->error(sprintf('Config menu entry: key "id" is required for entry at position %s in "%s" menu', $key, $menu), ['progress' => [$countConfig, $totalConfig]]);	×
NEW 92	continue;	×
93	}
94	/** @var \Cecil\Collection\Menu\Entry $item */
95	$item = (new Entry($properties['id']))	1✔
96	->setName($properties['name'] ?? ucfirst($properties['id']))	1✔
97	->setUrl($properties['url'] ?? '404')	1✔
98	->setWeight((int) ($properties['weight'] ?? 0));	1✔
99	// is entry already exists?
100	if ($menu->has($properties['id'])) {	1✔
101	// removes a not enabled entry
102	if (isset($properties['enabled']) && $properties['enabled'] === false) {	1✔
103	$menu->remove($properties['id']);	1✔
104
105	$message = sprintf('Config menu entry "%s (%s) > %s" removed', (string) $menu, $language['code'], $properties['id']);	1✔
106	$this->builder->getLogger()->info($message, ['progress' => [$countConfig, $totalConfig]]);	1✔
107	continue;	1✔
108	}
109	// merges properties
110	$current = $menu->get($properties['id'])->toArray();	1✔
111	$properties = array_merge($current, $properties);	1✔
112	/** @var \Cecil\Collection\Menu\Entry $item */
113	$item = clone $menu->get($properties['id']);	1✔
114	$item->setName($properties['name'])	1✔
115	->setUrl($properties['url'])	1✔
116	->setWeight($properties['weight']);	1✔
117	$updated = true;	1✔
118	}
119	// adds/replaces entry
120	$menu->add($item);	1✔
121
122	$message = sprintf('Config menu entry "%s (%s) > %s" %s {name: %s, url: %s, weight: %s}', (string) $menu, $language['code'], $item->getId(), $updated ? 'updated' : 'created', $item-> getName(), $item->getUrl(), $item->getWeight());	1✔
123	$this->builder->getLogger()->info($message, ['progress' => [$countConfig, $totalConfig]]);	1✔
124	}
125	}
126	}
127	}
128
129	$this->builder->setMenus($this->menus);	1✔
130	}
131
132	/**
133	* Create menus from pages' `menu` variable.
134	*/
135	protected function createMenusFromPages(): void
136	{
137	$filteredPages = $this->builder->getPages()->filter(function (Page $page) {	1✔
138	return $page->hasVariable('menu')	1✔
139	&& $page->getVariable('published')	1✔
140	&& \in_array($page->getVariable('language', $this->config->getLanguageDefault()), array_column($this->config->getLanguages(), 'code'));	1✔
141	});	1✔
142
143	$total = \count($filteredPages);	1✔
144	$count = 0;	1✔
145	/** @var \Cecil\Collection\Page\Page $page */
146	foreach ($filteredPages as $page) {	1✔
147	$count++;	1✔
148	$language = $page->getVariable('language', $this->config->getLanguageDefault());	1✔
149	/**
150	* Array case.
151	*
152	* case 1:
153	* menu: [main, navigation]
154	* case 2:
155	* menu:
156	* main:
157	* weight: 999
158	*/
159	if (\is_array($page->getVariable('menu'))) {	1✔
160	foreach ($page->getVariable('menu') as $key => $value) {	1✔
161	$menuName = $key;	1✔
162	$properties = $value;	1✔
163	if (\is_int($key)) {	1✔
164	$menuName = $value;	1✔
165	$properties = null;	1✔
166	}
167	if (!\is_string($menuName)) {	1✔
NEW 168	$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]]);	×
169	continue;	×
170	}
171	$item = (new Entry($page->getIdWithoutLang()))	1✔
172	->setName($page->getVariable('title'))	1✔
173	->setUrl((new PageRenderer($this->config))->getUrl($page));	1✔
174	if (isset($properties['weight'])) {	1✔
175	$item->setWeight((int) $properties['weight']);	1✔
176	}
177	// add Menu if not exists
178	if (!$this->menus[$language]->has($menuName)) {	1✔
179	$this->menus[$language]->add(new Menu($menuName));	1✔
180	}
181	/** @var \Cecil\Collection\Menu\Menu $menu */
182	$menu = $this->menus[$language]->get($menuName);	1✔
183	$menu->add($item);	1✔
184
185	$message = sprintf('Page menu entry "%s (%s) > %s" created {name: %s, weight: %s}', $menu->getId(), $language, $item->getId(), $item->getName(), $properties['weight'] ?? 'N/A');	1✔
186	$this->builder->getLogger()->info($message, ['progress' => [$count, $total]]);	1✔
187	}
188	continue;	1✔
189	}
190	/**
191	* String case.
192	*
193	* e.g.:
194	* menu: main
195	*/
196	$item = (new Entry($page->getIdWithoutLang()))	1✔
197	->setName($page->getVariable('title'))	1✔
198	->setUrl((new PageRenderer($this->config))->getUrl($page));	1✔
199	// add Menu if not exists
200	if (!$this->menus[$language]->has($page->getVariable('menu'))) {	1✔
201	$this->menus[$language]->add(new Menu($page->getVariable('menu')));	×
202	}
203	/** @var \Cecil\Collection\Menu\Menu $menu */
204	$menu = $this->menus[$language]->get($page->getVariable('menu'));	1✔
205	$menu->add($item);	1✔
206
207	$message = sprintf('Page menu entry "%s (%s) > %s" created {name: %s}', $menu->getId(), $language, $item->getId(), $item->getName());	1✔
208	$this->builder->getLogger()->info($message, ['progress' => [$count, $total]]);	1✔
209	}
210	}
211	}

Cecilapp / Cecil / 7079797847

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