13307234714

Committed 13 Feb 2025 12:03PM UTC coverage: 83.409% (-0.08%) from 83.484%

Build # 13307234714

Build Type

push

github

Committed by

web-flow

Commit Message

refactor: better log/console messages (#2117)

Run Details

2 of 7 new or added lines in 4 files covered. (28.57%)

2951 of 3538 relevant lines covered (83.41%)

0.83 hits per line

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

60.42

/src/Step/Pages/Load.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\Step\Pages;

use Cecil\Exception\RuntimeException;
use Cecil\Step\AbstractStep;
use Cecil\Util;
use Symfony\Component\Finder\Finder;
use Symfony\Component\Finder\SplFileInfo;

/**
 * Loads pages.
 */
class Load extends AbstractStep
{
    /** @var string */
    protected $page;

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

    /**
     * {@inheritdoc}
     */
    public function init(array $options): void
    {
        if (!is_dir($this->config->getPagesPath())) {
            $this->builder->getLogger()->debug(\sprintf('"%s" is not a valid pages directory', $this->config->getPagesPath()));
            $this->canProcess = false;

            return;
        }

        $this->page = $options['page'];
        $this->canProcess = true;
    }

    /**
     * {@inheritdoc}
     */
    public function process(): void
    {
        $namePattern = '/\.(' . implode('|', (array) $this->config->get('pages.ext')) . ')$/';
        $pages = Finder::create()
            ->files()
            ->in($this->config->getPagesPath())
            ->sort(function (SplFileInfo $a, SplFileInfo $b): int {
                // section's index first
                if ($a->getRelativePath() == $b->getRelativePath() && $a->getBasename('.' . $a->getExtension()) == 'index') {
                    return -1;
                }
                if ($b->getRelativePath() == $a->getRelativePath() && $b->getBasename('.' . $b->getExtension()) == 'index') {
                    return 1;
                }
                // sort by name
                return strnatcasecmp($a->getRealPath(), $b->getRealPath());
            });
        // load only one page?
        if ($this->page) {
            // is the page path starts with the `pages.dir` configuration option?
            // (i.e.: `pages/...`, `/pages/...`, `./pages/...`)
            $pagePathAsArray = explode(DIRECTORY_SEPARATOR, Util::joinFile($this->page));
            if ($pagePathAsArray[0] == (string) $this->config->get('pages.dir')) {
                unset($pagePathAsArray[0]);
                $this->page = implode(DIRECTORY_SEPARATOR, $pagePathAsArray);
            }
            if ($pagePathAsArray[0] == '.' && $pagePathAsArray[1] == (string) $this->config->get('pages.dir')) {
                unset($pagePathAsArray[0]);
                unset($pagePathAsArray[1]);
                $this->page = implode(DIRECTORY_SEPARATOR, $pagePathAsArray);
            }
            if (!util\File::getFS()->exists(Util::joinFile($this->config->getPagesPath(), $this->page))) {
                $this->builder->getLogger()->error(\sprintf('File "%s" doesn\'t exist.', $this->page));
            }
            $pages->path('.')->path(\dirname($this->page));
            $pages->name('/index\.(' . implode('|', (array) $this->config->get('pages.ext')) . ')$/');
            $namePattern = basename($this->page);
        }
        $pages->name($namePattern);
        if (\is_array($exclude = $this->config->get('pages.exclude'))) {
            $pages->exclude($exclude);
            $pages->notPath($exclude);
            $pages->notName($exclude);
        }
        if (file_exists(Util::joinFile($this->config->getPagesPath(), '.gitignore'))) {
            $pages->ignoreVCSIgnored(true);
        }
        $this->builder->setPagesFiles($pages);

        $total = $pages->count();
        $count = 0;
        if ($total === 0) {
            $this->builder->getLogger()->info('Nothing to load');

            return;
        }
        foreach ($pages as $file) {
            $count++;
            $this->builder->getLogger()->info(\sprintf('File "%s" loaded', $file->getRelativePathname()), ['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 <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\Step\Pages;
15
16	use Cecil\Exception\RuntimeException;
17	use Cecil\Step\AbstractStep;
18	use Cecil\Util;
19	use Symfony\Component\Finder\Finder;
20	use Symfony\Component\Finder\SplFileInfo;
21
22	/**
23	* Loads pages.
24	*/
25	class Load extends AbstractStep
26	{
27	/** @var string */
28	protected $page;
29
30	/**
31	* {@inheritdoc}
32	*/
33	public function getName(): string
34	{
35	return 'Loading pages';	1✔
36	}
37
38	/**
39	* {@inheritdoc}
40	*/
41	public function init(array $options): void
42	{
43	if (!is_dir($this->config->getPagesPath())) {	1✔
NEW 44	$this->builder->getLogger()->debug(\sprintf('"%s" is not a valid pages directory', $this->config->getPagesPath()));	×
NEW 45	$this->canProcess = false;	×
46
NEW 47	return;	×
48	}
49
50	$this->page = $options['page'];	1✔
51	$this->canProcess = true;	1✔
52	}
53
54	/**
55	* {@inheritdoc}
56	*/
57	public function process(): void
58	{
59	$namePattern = '/\.(' . implode('\|', (array) $this->config->get('pages.ext')) . ')$/';	1✔
60	$pages = Finder::create()	1✔
61	->files()	1✔
62	->in($this->config->getPagesPath())	1✔
63	->sort(function (SplFileInfo $a, SplFileInfo $b): int {	1✔
64	// section's index first
65	if ($a->getRelativePath() == $b->getRelativePath() && $a->getBasename('.' . $a->getExtension()) == 'index') {	1✔
66	return -1;	1✔
67	}
68	if ($b->getRelativePath() == $a->getRelativePath() && $b->getBasename('.' . $b->getExtension()) == 'index') {	1✔
69	return 1;	1✔
70	}
71	// sort by name
72	return strnatcasecmp($a->getRealPath(), $b->getRealPath());	1✔
73	});	1✔
74	// load only one page?
75	if ($this->page) {	1✔
76	// is the page path starts with the `pages.dir` configuration option?
77	// (i.e.: `pages/...`, `/pages/...`, `./pages/...`)
78	$pagePathAsArray = explode(DIRECTORY_SEPARATOR, Util::joinFile($this->page));	×
79	if ($pagePathAsArray[0] == (string) $this->config->get('pages.dir')) {	×
80	unset($pagePathAsArray[0]);	×
81	$this->page = implode(DIRECTORY_SEPARATOR, $pagePathAsArray);	×
82	}
83	if ($pagePathAsArray[0] == '.' && $pagePathAsArray[1] == (string) $this->config->get('pages.dir')) {	×
84	unset($pagePathAsArray[0]);	×
85	unset($pagePathAsArray[1]);	×
86	$this->page = implode(DIRECTORY_SEPARATOR, $pagePathAsArray);	×
87	}
88	if (!util\File::getFS()->exists(Util::joinFile($this->config->getPagesPath(), $this->page))) {	×
89	$this->builder->getLogger()->error(\sprintf('File "%s" doesn\'t exist.', $this->page));	×
90	}
91	$pages->path('.')->path(\dirname($this->page));	×
92	$pages->name('/index\.(' . implode('\|', (array) $this->config->get('pages.ext')) . ')$/');	×
93	$namePattern = basename($this->page);	×
94	}
95	$pages->name($namePattern);	1✔
96	if (\is_array($exclude = $this->config->get('pages.exclude'))) {	1✔
97	$pages->exclude($exclude);	1✔
98	$pages->notPath($exclude);	1✔
99	$pages->notName($exclude);	1✔
100	}
101	if (file_exists(Util::joinFile($this->config->getPagesPath(), '.gitignore'))) {	1✔
102	$pages->ignoreVCSIgnored(true);	×
103	}
104	$this->builder->setPagesFiles($pages);	1✔
105
106	$total = $pages->count();	1✔
107	$count = 0;	1✔
108	if ($total === 0) {	1✔
109	$this->builder->getLogger()->info('Nothing to load');	×
110
111	return;	×
112	}
113	foreach ($pages as $file) {	1✔
114	$count++;	1✔
115	$this->builder->getLogger()->info(\sprintf('File "%s" loaded', $file->getRelativePathname()), ['progress' => [$count, $total]]);	1✔
116	}
117	}
118	}

Cecilapp / Cecil / 13307234714

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