Create::collectPages() - Code Metrics - Inspection of "refactor: menus creation enhanced" - Cecilapp/Cecil - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — menu ( d2268d )

by Arnaud

created 2023-12-01 17:36 UTC

Create::collectPages() B

↳ Parent: Create

Complexity

Conditions	11
Paths	14

Size

Total Lines	83
Code Lines	47

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	11
eloc	47
c	0
b	0
f	0
nc	14
nop	0
dl	0
loc	83
rs	7.3166

How to fix Long Method Complexity

<?php

declare(strict_types=1);

/*
 * This file is part of Cecil.
 *
 * Copyright (c) Arnaud Ligny <[email protected]>
 *
 * 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;
                $page404 = '404.html';

                if ($language['code'] !== $this->config->getLanguageDefault()) {
                    $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 => $properties) {
                        $countConfig++;
                        $enabled = true;
                        $updated = false;

                        // ID is required
                        if (!isset($properties['id'])) {
                            throw new RuntimeException(sprintf('Key "id" is required for entry at position %s in "%s" menu', $key, $menu));
                        }
                        // is entry already exists?
                        if ($menu->has($properties['id'])) {
                            // removes a not enabled entry
                            if (isset($properties['enabled']) && $properties['enabled'] === false) {
                                $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
                            $updated = true;
                            $current = $menu->get($properties['id'])->toArray();
                            $properties = array_merge($current, $properties);
                        }
                        // adds/replaces entry
                        if ($enabled) {
                            $item = (new Entry($properties['id']))
                                ->setName($properties['name'] ?? ucfirst($properties['id']))
                                ->setUrl((new \Cecil\Assets\Url($this->builder, $properties['url'] ?? $page404))->getUrl())
                                ->setWeight((int) ($properties['weight'] ?? 0));
                            $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);
    }

    /**
     * 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;
                    $properties = $value;
                    $weight = null;
                    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'])) {
                        $weight = $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(), $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) > %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 <[email protected]>
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';
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) {
50			$this->menus[$language['code']] = new MenusCollection('menus');
51			$this->menus[$language['code']]->add(new Menu('main'));
52			}
53
54			// collects 'menu' entries from pages
55			$this->collectPages();
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) {
70			if ($menusConfig = (array) $this->config->get('menus', $language['code'], false)) {
71			$totalConfig = array_sum(array_map('count', $menusConfig));
72			$countConfig = 0;
73			$page404 = '404.html';
74
75			if ($language['code'] !== $this->config->getLanguageDefault()) {
76			$page404 = $language['code'] . '/404.html';
77			}
78
79			foreach ($menusConfig as $menuConfig => $entry) {
80			// add Menu if not exists
81			if (!$this->menus[$language['code']]->has($menuConfig)) {
82			$this->menus[$language['code']]->add(new Menu($menuConfig));
83			}
84			/** @var \Cecil\Collection\Menu\Menu $menu */
85			$menu = $this->menus[$language['code']]->get($menuConfig);
86			foreach ($entry as $key => $properties) {
87			$countConfig++;
88			$enabled = true;
89			$updated = false;
90
91			// ID is required
92			if (!isset($properties['id'])) {
93			throw new RuntimeException(sprintf('Key "id" is required for entry at position %s in "%s" menu', $key, $menu));
94			}
95			// is entry already exists?
96			if ($menu->has($properties['id'])) {
97			// removes a not enabled entry
98			if (isset($properties['enabled']) && $properties['enabled'] === false) {
99			$enabled = false;
			0 ignored issues – show Unused Code introduced 2023-12-01 17:40 UTC by Report Bug Copy Issue Report The assignment to `$enabled` is dead and can be removed. Loading history...
100			$menu->remove($properties['id']);
101
102			$message = sprintf('Config menu entry "%s (%s) > %s" removed', (string) $menu, $language['code'], $properties['id']);
103			$this->builder->getLogger()->info($message, ['progress' => [$countConfig, $totalConfig]]);
104			continue;
105			}
106			// merges properties
107			$updated = true;
108			$current = $menu->get($properties['id'])->toArray();
109			$properties = array_merge($current, $properties);
110			}
111			// adds/replaces entry
112			if ($enabled) {
113			$item = (new Entry($properties['id']))
114			->setName($properties['name'] ?? ucfirst($properties['id']))
115			->setUrl((new \Cecil\Assets\Url($this->builder, $properties['url'] ?? $page404))->getUrl())
116			->setWeight((int) ($properties['weight'] ?? 0));
117			$menu->add($item);
118
119			$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());
120			$this->builder->getLogger()->info($message, ['progress' => [$countConfig, $totalConfig]]);
121			}
122			}
123			}
124			}
125			}
126
127			$this->builder->setMenus($this->menus);
128			}
129
130			/**
131			* Collects pages with a menu variable.
132			*/
133			protected function collectPages(): void
134			{
135			$filteredPages = $this->builder->getPages()->filter(function (Page $page) {
136			return $page->hasVariable('menu')
137			&& $page->getVariable('published')
138			&& \in_array($page->getVariable('language', $this->config->getLanguageDefault()), array_column($this->config->getLanguages(), 'code'));
139			});
140
141			$total = \count($filteredPages);
142			$count = 0;
143			/** @var \Cecil\Collection\Page\Page $page */
144			foreach ($filteredPages as $page) {
145			$count++;
146			$language = $page->getVariable('language', $this->config->getLanguageDefault());
147			/**
148			* Array case.
149			*
150			* ie 1:
151			* menu: [main, navigation]
152			* ie 2:
153			* menu:
154			* main:
155			* weight: 999
156			*/
157			if (\is_array($page->getVariable('menu'))) {
158			foreach ($page->getVariable('menu') as $key => $value) {
159			$menuName = $key;
160			$properties = $value;
161			$weight = null;
162			if (\is_int($key)) {
163			$menuName = $value;
164			$properties = null;
165			}
166			if (!\is_string($menuName)) {
167			$this->builder->getLogger()->error(
168			sprintf(
169			'Menu\'s name of page "%s" must be a string, not "%s"',
170			$page->getId(),
171			PrintLogger::format($menuName)
172			),
173			['progress' => [$count, $total]]
174			);
175			continue;
176			}
177			$item = (new Entry($page->getIdWithoutLang()))
178			->setName($page->getVariable('title'))
179			->setUrl((new PageRenderer($this->config))->getUrl($page));
180			if (isset($properties['weight'])) {
181			$weight = $properties['weight'];
182			$item->setWeight((int) $properties['weight']);
183			}
184			// add Menu if not exists
185			if (!$this->menus[$language]->has($menuName)) {
186			$this->menus[$language]->add(new Menu($menuName));
187			}
188			/** @var \Cecil\Collection\Menu\Menu $menu */
189			$menu = $this->menus[$language]->get($menuName);
190			$menu->add($item);
191
192			$message = sprintf('Page menu entry "%s (%s) > %s" created (name: %s, weight: %s)', $menu->getId(), $language, $item->getId(), $item->getName(), $weight ?? 'N/A');
193			$this->builder->getLogger()->info($message, ['progress' => [$count, $total]]);
194			}
195			continue;
196			}
197			/**
198			* String case.
199			*
200			* ie:
201			* menu: main
202			*/
203			$item = (new Entry($page->getIdWithoutLang()))
204			->setName($page->getVariable('title'))
205			->setUrl((new PageRenderer($this->config))->getUrl($page));
206			// add Menu if not exists
207			if (!$this->menus[$language]->has($page->getVariable('menu'))) {
208			$this->menus[$language]->add(new Menu($page->getVariable('menu')));
209			}
210			/** @var \Cecil\Collection\Menu\Menu $menu */
211			$menu = $this->menus[$language]->get($page->getVariable('menu'));
212			$menu->add($item);
213
214			$message = sprintf('Page menu entry "%s (%s) > %s" created (name: %s)', $menu->getId(), $language, $item->getId(), $item->getName());
215			$this->builder->getLogger()->info($message, ['progress' => [$count, $total]]);
216			}
217			}
218			}
219

Cecilapp / Cecil

Push — menu ( d2268d )

Create::collectPages() B

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like