Cecil\Collection\Page\Parser

Complexity

Total Complexity

7

Size/Duplication

Total Lines	70
Duplicated Lines	0 %

Test Coverage

Coverage

95.24%

Importance

Changes	1
Bugs	1	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	parse()	0	22	4
A	getBody()	0	3	1
A	getFrontmatter()	0	3	1
A	__construct()	0	3	1

<?php

/**
 * This file is part of Cecil.
 *
 * (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.
 */

declare(strict_types=1);

namespace Cecil\Collection\Page;

use Cecil\Exception\RuntimeException;
use Symfony\Component\Finder\SplFileInfo;

/**
 * Parser class.
 *
 * Parses the front matter and body of a file, extracting metadata and content.
 */
class Parser
{
    // https://regex101.com/r/uZ79Gu/1, https://regex101.com/r/0w5ZvL/1, https://regex101.com/r/GLnaKs/1
    //public const PATTERN = '^\s*(?:<!--|---|\+\+\+){1}[\n\r]+(.*?)[\n\r]+(?:-->|---|\+\+\+){1}[\n\r\s]+(.*)$';
    public const PATTERN = '^\s*(?:<!--|---|\+\+\+){1}[\n\r\s]*(.*?)[\n\r\s]*(?:-->|---|\+\+\+){1}[\n\r\s]*(.*)$';

    /** @var SplFileInfo */
    protected $file;

    /** @var string */
    protected $frontmatter;

    /** @var string */
    protected $body;

    public function __construct(SplFileInfo $file)
    {
        $this->file = $file;
    }

    /**
     * Parse the contents of the file.
     *
     * Example:
     * ---
     * title: Title
     * date: 2016-07-29
     * ---
     * Lorem Ipsum.
     *
     * @throws RuntimeException
     */
    public function parse(): self
    {
        if ($this->file->isFile()) {
            if (!$this->file->isReadable()) {
                throw new RuntimeException('Cannot read file.');
            }
            preg_match(
                '/' . self::PATTERN . '/s',
                $this->file->getContents(),
                $matches
            );
            // if there is not front matter, set body only
            if (empty($matches)) {
                $this->body = $this->file->getContents();

                return $this;
            }
            $this->frontmatter = trim($matches[1]);
            $this->body = trim($matches[2]);
        }

        return $this;
    }

    /**
     * Get front matter.
     */
    public function getFrontmatter(): ?string
    {
        return $this->frontmatter;
    }

    /**
     * Get body.
     */
    public function getBody(): string
    {
        return $this->body;
    }
}