Cecil\Generator\Section

Complexity

Total Complexity

26

Size/Duplication

Total Lines	159
Duplicated Lines	0 %

Test Coverage

Coverage

95.18%

Importance

Changes	3
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
F	generate()	0	76	17
B	addNavigationLinks()	0	64	9

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

use Cecil\Collection\Page\Collection as PagesCollection;
use Cecil\Collection\Page\Page;
use Cecil\Collection\Page\Type;
use Cecil\Exception\Exception;

/**
 * Class Generator\Section.
 */
class Section extends AbstractGenerator implements GeneratorInterface
{
    /**
     * {@inheritdoc}
     */
    public function generate(): void
    {
        $sections = [];

        // identifying sections
        /** @var Page $page */
        foreach ($this->builder->getPages() as $page) {
            if ($page->getSection()) {
                // excludes page from its section?
                if ($page->getVariable('published') !== true || $page->getVariable('exclude')) {
                    $alteredPage = clone $page;
                    $alteredPage->setSection('');
                    $this->builder->getPages()->replace($page->getId(), $alteredPage);
                    continue;
                }
                $sections[$page->getSection()][$page->getVariable('language') ?? $this->config->getLanguageDefault()][] = $page;
            }
        }

        // adds section to pages collection
        if (count($sections) > 0) {
            $menuWeight = 100;

            foreach ($sections as $section => $languages) {
                foreach ($languages as $lang => $pagesAsArray) {
                    $pageId = $path = Page::slugify($section);
                    if ($lang != $this->config->getLanguageDefault()) {
                        $pageId = sprintf('%s.%s', Page::slugify($section), $lang);
                    }
                    $page = (new Page($pageId))->setVariable('title', ucfirst($section));
                    if ($this->builder->getPages()->has($pageId)) {
                        $page = clone $this->builder->getPages()->get($pageId);
                    }
                    $pages = new PagesCollection($section, $pagesAsArray);
                    // cascade
                    if ($page->hasVariable('cascade')) {

The method hasVariable() does not exist on Cecil\Collection\ItemInterface. It seems like you code against a sub-type of Cecil\Collection\ItemInterface such as Cecil\Collection\Page\Page.

                        $cascade = $page->getVariable('cascade');
                        $pages->map(function (Page $page) use ($cascade) {
                            foreach ($cascade as $key => $value) {
                                if (!$page->hasVariable($key)) {
                                    $page->setVariable($key, $value);
                                }
                            }
                        });
                    }
                    // sorts
                    $pages = $pages->sortByDate();
                    if ($page->getVariable('sortby')) {
                        $sortMethod = sprintf('sortBy%s', ucfirst($page->getVariable('sortby')));

It seems like $page->getVariable('sortby') can also be of type null; however, parameter $string of ucfirst() does only seem to accept string, maybe add an additional type check?

                        if (!method_exists($pages, $sortMethod)) {
                            throw new Exception(sprintf(
                                'In "%s" section "%s" is not a valid value for "sortby" variable.',
                                $page->getId(),
                                $page->getVariable('sortby')
                            ));
                        }
                        $pages = $pages->$sortMethod();
                    }
                    // adds navigation links
                    $this->addNavigationLinks($pages, $page->getVariable('sortby'), $page->getVariable('circular'));
                    // creates page for each section
                    $page->setPath($path)

The method setPath() does not exist on Cecil\Collection\ItemInterface. It seems like you code against a sub-type of Cecil\Collection\ItemInterface such as Cecil\Collection\Page\Page.

                        ->setType(Type::SECTION)

The method setType() does not exist on Cecil\Collection\ItemInterface. It seems like you code against a sub-type of Cecil\Collection\ItemInterface such as Cecil\Collection\Page\Page.

                        ->setVariable('pages', $pages)

The method setVariable() does not exist on Cecil\Collection\ItemInterface. It seems like you code against a sub-type of Cecil\Collection\ItemInterface such as Cecil\Collection\Page\Page.

                        ->setVariable('date', $pages->first()->getVariable('date'));
                    if ($lang != $this->config->getLanguageDefault()) {
                        $page->setVariable('language', $lang);
                    }
                    // default menu
                    if (!$page->getVariable('menu')) {
                        $page->setVariable('menu', [
                            'main' => ['weight' => $menuWeight],
                        ]);
                    }
                    $this->generatedPages->add($page);
                    $menuWeight += 10;
                }
            }
        }
    }

    /**
     * Adds navigation (next and prev) to section sub pages.
     *
     * @param PagesCollection $pages
     * @param string          $sort
     * @param bool            $circular
     *
     * @return void
     */
    protected function addNavigationLinks(PagesCollection $pages, string $sort = null, $circular = false): void
    {
        $pagesAsArray = $pages->toArray();
        if ($sort === null || $sort == 'date') {
            $pagesAsArray = array_reverse($pagesAsArray);
        }
        $count = count($pagesAsArray);
        if ($count > 1) {
            foreach ($pagesAsArray as $position => $page) {
                switch ($position) {
                    // first
                    case 0:
                        if ($circular) {
                            $page->setVariables([
                                'prev' => [
                                    'id'    => $pagesAsArray[$count - 1]->getId(),
                                    'path'  => $pagesAsArray[$count - 1]->getPath(),
                                    'title' => $pagesAsArray[$count - 1]->getVariable('title'),
                                ],
                            ]);
                        }
                        $page->setVariables([
                            'next' => [
                                'id'    => $pagesAsArray[$position + 1]->getId(),
                                'path'  => $pagesAsArray[$position + 1]->getPath(),
                                'title' => $pagesAsArray[$position + 1]->getVariable('title'),
                            ],
                        ]);
                        break;
                    // last
                    case $count - 1:
                        $page->setVariables([
                            'prev' => [
                                'id'    => $pagesAsArray[$position - 1]->getId(),
                                'path'  => $pagesAsArray[$position - 1]->getPath(),
                                'title' => $pagesAsArray[$position - 1]->getVariable('title'),
                            ],
                        ]);
                        if ($circular) {
                            $page->setVariables([
                                'next' => [
                                    'id'    => $pagesAsArray[0]->getId(),
                                    'path'  => $pagesAsArray[0]->getPath(),
                                    'title' => $pagesAsArray[0]->getVariable('title'),
                                ],
                            ]);
                        }
                        break;
                    default:
                        $page->setVariables([
                            'prev' => [
                                'id'    => $pagesAsArray[$position - 1]->getId(),
                                'path'  => $pagesAsArray[$position - 1]->getPath(),
                                'title' => $pagesAsArray[$position - 1]->getVariable('title'),
                            ],
                            'next' => [
                                'id'    => $pagesAsArray[$position + 1]->getId(),
                                'path'  => $pagesAsArray[$position + 1]->getPath(),
                                'title' => $pagesAsArray[$position + 1]->getVariable('title'),
                            ],
                        ]);
                        break;
                }
                $this->generatedPages->add($page);
            }
        }
    }
}