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

Passed

Push — analysis-2QWbr9 ( 8a61dc )

by Arnaud

created 2021-11-05 23:34 UTC

MenusCreate::collectPages() C

↳ Parent: MenusCreate

Complexity

Conditions	13
Paths	44

Size

Total Lines	94
Code Lines	51

Duplication

Lines	0
Ratio	0 %

Importance

Changes	5
Bugs	3	Features	1

Metric	Value
cc	13
eloc	51
c	5
b	3
f	1
nc	44
nop	0
dl	0
loc	94
rs	6.6166

How to fix Long Method Complexity

<?php
/**
 * This file is part of the Cecil/Cecil package.
 *
 * 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;

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\Exception;
use Cecil\Logger\PrintLogger;

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

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

    /**
     * {@inheritdoc}
     */
    public function process()
    {
        // creates a 'menus' collection for each language, with a default 'main' menu
        foreach ($this->config->getLanguages() as $language) {
            $lang = $language['code'] == $this->config->getLanguageDefault() ? null : $language['code'];
            $this->menus[$lang] = new MenusCollection('menus');
            $this->menus[$lang]->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 = $this->builder->getConfig()->get('menus', $language['code'], false)) {
                $this->builder->getLogger()->debug('Creating config menus');

                $totalConfig = array_sum(array_map('count', $menusConfig));
                $countConfig = 0;
                $lang = $language['code'] == $this->config->getLanguageDefault() ? null : $language['code'];

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

                        // ID is required
                        if (!array_key_exists('id', $property)) {
                            throw new Exception(sprintf('"id" is required for menu entry "%s"', $key));
                        }
                        // enabled?
                        if (array_key_exists('enabled', $property) && false === $property['enabled']) {
                            $enabled = false;
                            if (!$menu->has($property['id'])) {
                                $message = sprintf('%s > %s (disabled)', (string) $menu, $property['id']);
                                $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('%s > %s (removed)', $menu, $property['id']);
                                $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('%s > %s (updated)', $menu, $property['id']);
                            $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'] ?? '/404')
                                ->setWeight($property['weight'] ?? 0);
                            $menu->add($item);

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

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

    /**
     * Collects pages with a menu variable.
     */
    protected function collectPages()
    {
        $count = 0;

        $filteredPages = $this->builder->getPages()->filter(function (Page $page) {
            return $page->hasVariable('menu') && $page->getVariable('published');
        });

        $total = count($filteredPages);

        if ($total > 0) {
            $this->builder->getLogger()->debug('Creating pages menus');
        }

        /** @var \Cecil\Collection\Page\Page $page */
        foreach ($filteredPages as $page) {
            $count++;
            $lang = $page->getVariable('language');
            /**
             * Array case.
             *
             * ie 1:
             *   menu:
             *     main:
             *       weight: 999
             * ie 2:
             *   menu: [main, navigation]
             */
            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 name of page "%s" must be string, not "%s"',
                                $page->getId(),
                                PrintLogger::format($menuName)
                            ),
                            ['progress' => [$count, $total]]
                        );
                        continue;
                    }
                    $item = (new Entry($page->getIdWithoutLang()))
                        ->setName($page->getVariable('title'))
                        ->setUrl($page->getId());
                    if (array_key_exists('weight', (array) $property)) {
                        $weight = $property['weight'];
                        $item->setWeight($property['weight']);
                    }
                    // checks if page's language exists
                    if (!array_key_exists($lang, $this->menus)) {
                        if ($lang === null) {
                            throw new Exception('The default language is not correctly defined in config.');
                        }

                        throw new Exception(sprintf('Language "%s" is not defined in config.', $lang));
                    }
                    // add Menu if not exists
                    if (!$this->menus[$lang]->has($menuName)) {
                        $this->menus[$lang]->add(new Menu($menuName));
                    }
                    /** @var \Cecil\Collection\Menu\Menu $menu */
                    $menu = $this->menus[$lang]->get($menuName);
                    $menu->add($item);

                    $message = sprintf('%s > %s (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->getId()))
                ->setName($page->getVariable('title'))
                ->setUrl($page->getUrl());
            if (!$this->menus[$lang]->has($page->getVariable('menu'))) {
                $this->menus[$lang]->add(new Menu($page->getVariable('menu')));
            }
            /** @var \Cecil\Collection\Menu\Menu $menu */
            $menu = $this->menus[$lang]->get($page->getVariable('menu'));
            $menu->add($item);

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


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

Cecilapp / Cecil

Push — analysis-2QWbr9 ( 8a61dc )

MenusCreate::collectPages() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like