Create::collectPages() - Code Metrics - Inspection of "Apply fixes from StyleCI (#1439)" - Cecilapp/Cecil - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — menus ( e8d7e9...326f40 )

by Arnaud

created 2022-08-15 18:56 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;
                $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($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->getLanguage() ?? $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->getLanguage() ?? $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($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 <[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			$suffix = '';
74			$page404 = '404.html';
75
76			if ($language['code'] !== $this->config->getLanguageDefault()) {
77			$suffix = '.'.$language['code'];
78			$page404 = $language['code'].'/404.html';
79			}
80
81			foreach ($menusConfig as $menuConfig => $entry) {
82			// add Menu if not exists
83			if (!$this->menus[$language['code']]->has($menuConfig)) {
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);
88			foreach ($entry as $key => $property) {
89			$countConfig++;
90			$enabled = true;
91			$updated = false;
92
93			// ID is required
94			if (!isset($property['id'])) {
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']) {
99			$enabled = false;
100			if (!$menu->has($property['id'])) {
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'])) {
107			// removes a disabled entry
108			if (!$enabled) {
109			$menu->remove($property['id']);
110
111			$message = \sprintf('Config menu entry "%s > %s%s" removed', (string) $menu, $property['id'], $suffix);
112			$this->builder->getLogger()->info($message, ['progress' => [$countConfig, $totalConfig]]);
113			continue;
114			}
115			// merges properties
116			$updated = true;
117			$current = $menu->get($property['id'])->toArray();
118			$property = array_merge($current, $property);
119
120			$message = \sprintf('Config menu entry "%s > %s%s" updated', (string) $menu, $property['id'], $suffix);
121			$this->builder->getLogger()->info($message, ['progress' => [$countConfig, $totalConfig]]);
122			}
123			// adds/replaces entry
124			if ($enabled) {
125			$item = (new Entry($property['id']))
126			->setName($property['name'] ?? ucfirst($property['id']))
127			->setUrl($property['url'] ?? $page404)
128			->setWeight($property['weight'] ?? 0);
129			$menu->add($item);
130
131			if (!$updated) {
132			$message = \sprintf('Config menu entry "%s > %s%s" created', (string) $menu, $property['id'], $suffix);
133			$this->builder->getLogger()->info($message, ['progress' => [$countConfig, $totalConfig]]);
134			}
135			}
136			}
137			}
138			}
139			}
140
141			$this->builder->setMenus($this->menus);
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) {
150			return $page->hasVariable('menu')
151			&& $page->getVariable('published')
152			&& in_array($page->getLanguage() ?? $this->config->getLanguageDefault(), array_column($this->config->getLanguages(), 'code'));
153			});
154
155			$total = count($filteredPages);
156			$count = 0;
157			/** @var \Cecil\Collection\Page\Page $page */
158			foreach ($filteredPages as $page) {
159			$count++;
160			$language = $page->getLanguage() ?? $this->config->getLanguageDefault();
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'))) {
172			foreach ($page->getVariable('menu') as $key => $value) {
173			$menuName = $key;
174			$property = $value;
175			$weight = null;
176			if (is_int($key)) {
177			$menuName = $value;
178			$property = null;
179			}
180			if (!is_string($menuName)) {
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()))
192			->setName($page->getVariable('title'))
193			->setUrl((new PageRenderer($this->config))->getUrl($page));
194			if (isset($property['weight'])) {
195			$weight = $property['weight'];
196			$item->setWeight($property['weight']);
197			}
198			// add Menu if not exists
199			if (!$this->menus[$language]->has($menuName)) {
200			$this->menus[$language]->add(new Menu($menuName));
201			}
202			/** @var \Cecil\Collection\Menu\Menu $menu */
203			$menu = $this->menus[$language]->get($menuName);
204			$menu->add($item);
205
206			$message = \sprintf('Page menu entry "%s > %s" created (weight: %s)', $menuName, $page->getId(), $weight ?? 'N/A');
207			$this->builder->getLogger()->info($message, ['progress' => [$count, $total]]);
208			}
209			continue;
210			}
211			/**
212			* String case.
213			*
214			* ie:
215			* menu: main
216			*/
217			$item = (new Entry($page->getIdWithoutLang()))
218			->setName($page->getVariable('title'))
219			->setUrl((new PageRenderer($this->config))->getUrl($page));
220			// add Menu if not exists
221			if (!$this->menus[$language]->has($page->getVariable('menu'))) {
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'));
226			$menu->add($item);
227
228			$message = \sprintf('Page menu entry "%s > %s" created', $page->getVariable('menu'), $page->getId());
229			$this->builder->getLogger()->info($message, ['progress' => [$count, $total]]);
230			}
231			}
232			}
233

Cecilapp / Cecil

Push — menus ( e8d7e9...326f40 )

Create::collectPages() B

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like