7276268815

Committed 20 Dec 2023 01:47PM UTC coverage: 83.406%. First build

Build # 7276268815

Build Type

Pull #1864

github

Committed by

web-flow

Commit Message

Merge 5ee34d6fa into 80190b8ec

Pull Request Pull Request #1864: feat: config to define a default sort method

Run Details

27 of 37 new or added lines in 3 files covered. (72.97%)

2875 of 3447 relevant lines covered (83.41%)

0.83 hits per line

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

96.51

/src/Generator/Section.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\Generator;

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

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

        // identifying sections
        foreach ($this->builder->getPages() as $page) {
            /** @var Page $page */
            if ($page->getSection()) {
                // do not add not published and not excluded pages to its section
                if ($page->getVariable('published') !== true || $page->getVariable('exclude')) {
                    continue;
                }
                $sections[$page->getSection()][$page->getVariable('language', $this->config->getLanguageDefault())][] = $page;
            }
        }

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

            foreach ($sections as $section => $languages) {
                foreach ($languages as $language => $pagesAsArray) {
                    $pageId = $path = Page::slugify($section);
                    if ($language != $this->config->getLanguageDefault()) {
                        $pageId = "$language/$pageId";
                    }
                    $page = (new Page($pageId))->setVariable('title', ucfirst($section))
                        ->setPath($path);
                    if ($this->builder->getPages()->has($pageId)) {
                        $page = clone $this->builder->getPages()->get($pageId);
                    }
                    $subPages = new PagesCollection("section-$pageId", $pagesAsArray);
                    // cascade variables
                    if ($page->hasVariable('cascade')) {
                        $cascade = $page->getVariable('cascade');
                        $subPages->map(function (Page $page) use ($cascade) {
                            foreach ($cascade as $key => $value) {
                                if (!$page->hasVariable($key)) {
                                    $page->setVariable($key, $value);
                                }
                            }
                        });
                    }
                    // sorts pages
                    $pages = $subPages->sortBy($this->config->get('pages.sortby'));
                    if ($page->hasVariable('sortby')) {
                        try {
                            $pages = $pages->sortBy($page->getVariable('sortby'));
                        } catch (RuntimeException $e) {
                            throw new RuntimeException(sprintf('In page "%s", %s', $page->getId(), $e->getMessage()));
                        }
                    }
                    // adds navigation links (excludes taxonomy pages)
                    $sortBy = $page->getVariable('sortby')['variable'] ?? $page->getVariable('sortby') ?? $this->config->get('pages.sortby') ?? 'date';
                    if (!\in_array($page->getId(), array_keys((array) $this->config->get('taxonomies')))) {
                        $this->addNavigationLinks($pages, $sortBy, $page->getVariable('circular') ?? false);
                    }
                    // creates page for each section
                    $page->setType(Type::SECTION->value)
                        ->setSection($path)
                        ->setPages($pages)
                        ->setVariable('language', $language)
                        ->setVariable('date', $pages->first()->getVariable('date'))
                        ->setVariable('langref', $path);
                    // human readable title
                    if ($page->getVariable('title') == 'index') {
                        $page->setVariable('title', $section);
                    }
                    // default menu
                    if (!$page->getVariable('menu')) {
                        $page->setVariable('menu', ['main' => ['weight' => $menuWeight]]);
                    }
                    $this->generatedPages->add($page);
                }
                $menuWeight += 10;
            }
        }
    }

    /**
     * Sorts subpages.
     */
    public static function sortSubPages(Page $page, PagesCollection $pages): PagesCollection
    {
        // sorts (by date by default)
        $pages = $pages->sortByDate();
        /*
         * sortby: date|updated|title|weight
         *
         * sortby:
         *   variable: date|updated
         *   desc_title: false|true
         *   reverse: false|true
         */
        if ($page->hasVariable('sortby')) {
            $sortby = (string) $page->getVariable('sortby');
            // options?
            $sortby = $page->getVariable('sortby')['variable'] ?? $sortby;
            $descTitle = $page->getVariable('sortby')['desc_title'] ?? false;
            $reverse = $page->getVariable('sortby')['reverse'] ?? false;
            // sortby: date, title or weight
            $sortMethod = sprintf('sortBy%s', ucfirst(str_replace('updated', 'date', $sortby)));
            if (!method_exists($pages, $sortMethod)) {
                throw new RuntimeException(sprintf('In "%s" "%s" is not a valid value for "sortby" variable.', $page->getId(), $sortby));
            }

            return $pages->$sortMethod(['variable' => $sortby, 'descTitle' => $descTitle, 'reverse' => $reverse]);
        }

        return $pages;
    }

    /**
     * Adds navigation (next and prev) to section subpages.
     */
    protected function addNavigationLinks(PagesCollection $pages, string|null $sortBy = null, bool $circular = false): void
    {
        $pagesAsArray = $pages->toArray();
        if ($sortBy === null || $sortBy == 'date' || $sortBy == 'updated') {
            $pagesAsArray = array_reverse($pagesAsArray);
        }
        $count = \count($pagesAsArray);
        if ($count > 1) {
            foreach ($pagesAsArray as $position => $page) {
                switch ($position) {
                    case 0: // first
                        if ($circular) {
                            $page->setVariables([
                                'prev' => $pagesAsArray[$count - 1],
                            ]);
                        }
                        $page->setVariables([
                            'next' => $pagesAsArray[$position + 1],
                        ]);
                        break;
                    case $count - 1: // last
                        $page->setVariables([
                            'prev' => $pagesAsArray[$position - 1],
                        ]);
                        if ($circular) {
                            $page->setVariables([
                                'next' => $pagesAsArray[0],
                            ]);
                        }
                        break;
                    default:
                        $page->setVariables([
                            'prev' => $pagesAsArray[$position - 1],
                            'next' => $pagesAsArray[$position + 1],
                        ]);
                        break;
                }
                $this->generatedPages->add($page);
            }
        }
    }
}

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\Generator;
15
16	use Cecil\Collection\Page\Collection as PagesCollection;
17	use Cecil\Collection\Page\Page;
18	use Cecil\Collection\Page\Type;
19	use Cecil\Exception\RuntimeException;
20
21	/**
22	* Class Generator\Section.
23	*/
24	class Section extends AbstractGenerator implements GeneratorInterface
25	{
26	/**
27	* {@inheritdoc}
28	*/
29	public function generate(): void
30	{
31	$sections = [];	1✔
32
33	// identifying sections
34	foreach ($this->builder->getPages() as $page) {	1✔
35	/** @var Page $page */
36	if ($page->getSection()) {	1✔
37	// do not add not published and not excluded pages to its section
38	if ($page->getVariable('published') !== true \|\| $page->getVariable('exclude')) {	1✔
39	continue;	1✔
40	}
41	$sections[$page->getSection()][$page->getVariable('language', $this->config->getLanguageDefault())][] = $page;	1✔
42	}
43	}
44
45	// adds each section to pages collection
46	if (\count($sections) > 0) {	1✔
47	$menuWeight = 100;	1✔
48
49	foreach ($sections as $section => $languages) {	1✔
50	foreach ($languages as $language => $pagesAsArray) {	1✔
51	$pageId = $path = Page::slugify($section);	1✔
52	if ($language != $this->config->getLanguageDefault()) {	1✔
53	$pageId = "$language/$pageId";	1✔
54	}
55	$page = (new Page($pageId))->setVariable('title', ucfirst($section))	1✔
56	->setPath($path);	1✔
57	if ($this->builder->getPages()->has($pageId)) {	1✔
58	$page = clone $this->builder->getPages()->get($pageId);	1✔
59	}
60	$subPages = new PagesCollection("section-$pageId", $pagesAsArray);	1✔
61	// cascade variables
62	if ($page->hasVariable('cascade')) {	1✔
63	$cascade = $page->getVariable('cascade');	1✔
64	$subPages->map(function (Page $page) use ($cascade) {	1✔
65	foreach ($cascade as $key => $value) {	1✔
66	if (!$page->hasVariable($key)) {	1✔
67	$page->setVariable($key, $value);	1✔
68	}
69	}
70	});	1✔
71	}
72	// sorts pages
73	$pages = $subPages->sortBy($this->config->get('pages.sortby'));	1✔
74	if ($page->hasVariable('sortby')) {	1✔
75	try {
76	$pages = $pages->sortBy($page->getVariable('sortby'));	1✔
NEW 77	} catch (RuntimeException $e) {	×
NEW 78	throw new RuntimeException(sprintf('In page "%s", %s', $page->getId(), $e->getMessage()));	×
79	}
80	}
81	// adds navigation links (excludes taxonomy pages)
82	$sortBy = $page->getVariable('sortby')['variable'] ?? $page->getVariable('sortby') ?? $this->config->get('pages.sortby') ?? 'date';	1✔
83	if (!\in_array($page->getId(), array_keys((array) $this->config->get('taxonomies')))) {	1✔
84	$this->addNavigationLinks($pages, $sortBy, $page->getVariable('circular') ?? false);	1✔
85	}
86	// creates page for each section
87	$page->setType(Type::SECTION->value)	1✔
88	->setSection($path)	1✔
89	->setPages($pages)	1✔
90	->setVariable('language', $language)	1✔
91	->setVariable('date', $pages->first()->getVariable('date'))	1✔
92	->setVariable('langref', $path);	1✔
93	// human readable title
94	if ($page->getVariable('title') == 'index') {	1✔
95	$page->setVariable('title', $section);	1✔
96	}
97	// default menu
98	if (!$page->getVariable('menu')) {	1✔
99	$page->setVariable('menu', ['main' => ['weight' => $menuWeight]]);	1✔
100	}
101	$this->generatedPages->add($page);	1✔
102	}
103	$menuWeight += 10;	1✔
104	}
105	}
106	}
107
108	/**
109	* Sorts subpages.
110	*/
111	public static function sortSubPages(Page $page, PagesCollection $pages): PagesCollection
112	{
113	// sorts (by date by default)
114	$pages = $pages->sortByDate();	1✔
115	/*
116	* sortby: date\|updated\|title\|weight
117	*
118	* sortby:
119	* variable: date\|updated
120	* desc_title: false\|true
121	* reverse: false\|true
122	*/
123	if ($page->hasVariable('sortby')) {	1✔
124	$sortby = (string) $page->getVariable('sortby');	1✔
125	// options?
126	$sortby = $page->getVariable('sortby')['variable'] ?? $sortby;	1✔
127	$descTitle = $page->getVariable('sortby')['desc_title'] ?? false;	1✔
128	$reverse = $page->getVariable('sortby')['reverse'] ?? false;	1✔
129	// sortby: date, title or weight
130	$sortMethod = sprintf('sortBy%s', ucfirst(str_replace('updated', 'date', $sortby)));	1✔
131	if (!method_exists($pages, $sortMethod)) {	1✔
132	throw new RuntimeException(sprintf('In "%s" "%s" is not a valid value for "sortby" variable.', $page->getId(), $sortby));	×
133	}
134
135	return $pages->$sortMethod(['variable' => $sortby, 'descTitle' => $descTitle, 'reverse' => $reverse]);	1✔
136	}
137
138	return $pages;	1✔
139	}
140
141	/**
142	* Adds navigation (next and prev) to section subpages.
143	*/
144	protected function addNavigationLinks(PagesCollection $pages, string\|null $sortBy = null, bool $circular = false): void
145	{
146	$pagesAsArray = $pages->toArray();	1✔
147	if ($sortBy === null \|\| $sortBy == 'date' \|\| $sortBy == 'updated') {	1✔
148	$pagesAsArray = array_reverse($pagesAsArray);	1✔
149	}
150	$count = \count($pagesAsArray);	1✔
151	if ($count > 1) {	1✔
152	foreach ($pagesAsArray as $position => $page) {	1✔
153	switch ($position) {
154	case 0: // first	1✔
155	if ($circular) {	1✔
156	$page->setVariables([	1✔
157	'prev' => $pagesAsArray[$count - 1],	1✔
158	]);	1✔
159	}
160	$page->setVariables([	1✔
161	'next' => $pagesAsArray[$position + 1],	1✔
162	]);	1✔
163	break;	1✔
164	case $count - 1: // last	1✔
165	$page->setVariables([	1✔
166	'prev' => $pagesAsArray[$position - 1],	1✔
167	]);	1✔
168	if ($circular) {	1✔
169	$page->setVariables([	1✔
170	'next' => $pagesAsArray[0],	1✔
171	]);	1✔
172	}
173	break;	1✔
174	default:
175	$page->setVariables([	1✔
176	'prev' => $pagesAsArray[$position - 1],	1✔
177	'next' => $pagesAsArray[$position + 1],	1✔
178	]);	1✔
179	break;	1✔
180	}
181	$this->generatedPages->add($page);	1✔
182	}
183	}
184	}
185	}

Cecilapp / Cecil / 7276268815

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