Parser::getFrontmatter() - Code Metrics - Inspection of "Fix file permissions for LICENSE and README.md" - Cecilapp/Cecil - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#1013)

by lee

created 2021-03-13 19:09 UTC

Parser::getFrontmatter() A

↳ Parent: Parser

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
ccs	2
cts	2
cp	1
crap	1
rs	10
c	0
b	0
f	0

<?php
/**
 * This file is part of the Cecil/Cecil package.
 *
 * Copyright (c) Arnaud Ligny <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Cecil\Collection\Page;

use Symfony\Component\Finder\SplFileInfo;

/**
 * Class Parser.
 */
class Parser
{
    // https://regex101.com/r/xH7cL3/2
    const PATTERN = '^\s*(?:<!--|---|\+\+\+){1}[\n\r\s]*(.*?)[\n\r\s]*(?:-->|---|\+\+\+){1}[\s\n\r]*(.*)$';
    /** @var SplFileInfo */
    protected $file;
    /** @var string */
    protected $frontmatter;
    /** @var string */
    protected $body;

    /**
     * @param SplFileInfo $file
     */
    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
     *
     * @return self
     */
    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 frontmatter.
     *
     * @return string|null
     */
    public function getFrontmatter(): ?string
    {
        return $this->frontmatter;
    }

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


1		<?php
2		/**
3		* This file is part of the Cecil/Cecil package.
4		*
5		* Copyright (c) Arnaud Ligny <[email protected]>
6		*
7		* For the full copyright and license information, please view the LICENSE
8		* file that was distributed with this source code.
9		*/
10
11		namespace Cecil\Collection\Page;
12
13		use Symfony\Component\Finder\SplFileInfo;
14
15		/**
16		* Class Parser.
17		*/
18		class Parser
19		{
20		// https://regex101.com/r/xH7cL3/2
21		const PATTERN = '^\s(?:<!--\|---\|\+\+\+){1}[\n\r\s](.?)[\n\r\s](?:-->\|---\|\+\+\+){1}[\s\n\r](.)$';
22		/** @var SplFileInfo */
23		protected $file;
24		/** @var string */
25		protected $frontmatter;
26		/** @var string */
27		protected $body;
28
29		/**
30		* @param SplFileInfo $file
31		*/
32	1	public function __construct(SplFileInfo $file)
33		{
34	1	$this->file = $file;
35	1	}
36
37		/**
38		* Parse the contents of the file.
39		*
40		* Example:
41		* ---
42		* title: Title
43		* date: 2016-07-29
44		* ---
45		* Lorem Ipsum.
46		*
47		* @throws \RuntimeException
48		*
49		* @return self
50		*/
51	1	public function parse(): self
52		{
53	1	if ($this->file->isFile()) {
54	1	if (!$this->file->isReadable()) {
55		throw new \RuntimeException('Cannot read file');
56		}
57	1	preg_match(
58	1	'/'.self::PATTERN.'/s',
59	1	$this->file->getContents(),
60	1	$matches
61		);
62		// if there is not front matter, set body only
63	1	if (empty($matches)) {
64	1	$this->body = $this->file->getContents();
65
66	1	return $this;
67		}
68	1	$this->frontmatter = trim($matches[1]);
69	1	$this->body = trim($matches[2]);
70		}
71
72	1	return $this;
73		}
74
75		/**
76		* Get frontmatter.
77		*
78		* @return string\|null
79		*/
80	1	public function getFrontmatter(): ?string
81		{
82	1	return $this->frontmatter;
83		}
84
85		/**
86		* Get body.
87		*
88		* @return string
89		*/
90	1	public function getBody(): string
91		{
92	1	return $this->body;
93		}
94		}
95

Cecilapp / Cecil

Pull Request — master (#1013)

Parser::getFrontmatter() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like