MarkdownFileParser::get() - Code Metrics - Inspection of "Return the MarkdownService when needed" - hydephp/develop - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Branch — refactor-markdown-helper (02b3eb)

by Caen

created 2022-08-01 20:22 UTC

MarkdownFileParser::get() A

↳ Parent: MarkdownFileParser

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
c	0
b	0
f	0
nc	1
nop	0
dl	0
loc	3
rs	10

<?php

namespace Hyde\Framework\Modules\Markdown;

use Hyde\Framework\Models\MarkdownDocument;
use Spatie\YamlFrontMatter\YamlFrontMatter;

/**
 * Prepares a Markdown file for further usage by extracting the Front Matter and creating MarkdownDocument object.
 *
 * @see \Hyde\Framework\Testing\Feature\MarkdownFileServiceTest
 */
class MarkdownFileParser
{
    /**
     * The extracted Front Matter.
     *
     * @var array
     */
    public array $matter = [];

    /**
     * The extracted Markdown body.
     *
     * @var string
     */
    public string $body = '';

    public function __construct(string $filepath)
    {
        $stream = file_get_contents($filepath);

        // Check if the file has Front Matter.
        if (str_starts_with($stream, '---')) {
            $object = YamlFrontMatter::markdownCompatibleParse($stream);

            if ($object->matter()) {
                $this->matter = $object->matter();
            }

            if ($object->body()) {
                $this->body = $object->body();
            }
        } else {
            $this->body = $stream;
        }
    }

    /**
     * Get the processed Markdown file as a MarkdownDocument.
     */
    public function get(): MarkdownDocument
    {
        return new MarkdownDocument($this->matter, $this->body);
    }
}


1			<?php
2
3			namespace Hyde\Framework\Modules\Markdown;
4
5			use Hyde\Framework\Models\MarkdownDocument;
6			use Spatie\YamlFrontMatter\YamlFrontMatter;
7
8			/**
9			* Prepares a Markdown file for further usage by extracting the Front Matter and creating MarkdownDocument object.
10			*
11			* @see \Hyde\Framework\Testing\Feature\MarkdownFileServiceTest
12			*/
13			class MarkdownFileParser
14			{
15			/**
16			* The extracted Front Matter.
17			*
18			* @var array
19			*/
20			public array $matter = [];
21
22			/**
23			* The extracted Markdown body.
24			*
25			* @var string
26			*/
27			public string $body = '';
28
29			public function __construct(string $filepath)
30			{
31			$stream = file_get_contents($filepath);
32
33			// Check if the file has Front Matter.
34			if (str_starts_with($stream, '---')) {
35			$object = YamlFrontMatter::markdownCompatibleParse($stream);
36
37			if ($object->matter()) {
38			$this->matter = $object->matter();
39			}
40
41			if ($object->body()) {
42			$this->body = $object->body();
43			}
44			} else {
45			$this->body = $stream;
46			}
47			}
48
49			/**
50			* Get the processed Markdown file as a MarkdownDocument.
51			*/
52			public function get(): MarkdownDocument
53			{
54			return new MarkdownDocument($this->matter, $this->body);
55			}
56			}
57

hydephp / develop

Branch — refactor-markdown-helper (02b3eb)

MarkdownFileParser::get() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like