5046064611

Build Type

push

github

Committed by GitHub

Commit Message

perf: native_function_invocation (#1697)

Run Details

322 of 322 new or added lines in 62 files covered. (100.0%)

2784 of 4121 relevant lines covered (67.56%)

0.68 hits per line

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

98.78

/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
        /** @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 $language => $pagesAsArray) {
                    $pageId = $path = Page::slugify($section);
                    if ($language != $this->config->getLanguageDefault()) {
                        $pageId = sprintf('%s.%s', $pageId, $language);
                    }
                    $page = (new Page($pageId))->setVariable('title', ucfirst($section))
                        ->setPath($path);
                    if ($this->builder->getPages()->has($pageId)) {
                        $page = clone $this->builder->getPages()->get($pageId);
                    }
                    $pages = new PagesCollection("section-$pageId", $pagesAsArray);
                    // cascade
                    /** @var \Cecil\Collection\Page\Page $page */
                    if ($page->hasVariable('cascade')) {
                        $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 (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" section "%s" is not a valid value for "sortby" variable.', $page->getId(), $sortby));
                        }
                        $pages = $pages->$sortMethod(['variable' => $sortby, 'descTitle' => $descTitle, 'reverse' => $reverse]);
                    }
                    // adds navigation links (excludes taxonomy pages)
                    if (!\in_array($page->getId(), array_keys((array) $this->config->get('taxonomies')))) {
                        $this->addNavigationLinks($pages, $sortby ?? 'date', $page->getVariable('circular'));
                    }
                    // creates page for each section
                    $page->setType(Type::SECTION)
                        ->setSection($path)
                        ->setPages($pages)
                        ->setVariable('language', $language)
                        ->setVariable('date', $pages->first()->getVariable('date'))
                        ->setVariable('langref', $path);
                    // clean 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;
            }
        }
    }

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

Cecilapp / Cecil / 5046064611

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