CreatesNewPageSourceFile::prepareOutputDirectory() - Code Metrics - Inspection of "Merge pull request #639 from hydephp/refactor-acti..." - hydephp/develop - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 10105b...1efe78 )

by Caen

created 2022-11-03 18:23 UTC

CreatesNewPageSourceFile::prepareOutputDirectory() A

↳ Parent: CreatesNewPageSourceFile

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php

declare(strict_types=1);

namespace Hyde\Framework\Actions;

use function file_exists;
use Hyde\Framework\Concerns\InteractsWithDirectories;
use Hyde\Framework\Exceptions\FileConflictException;
use Hyde\Framework\Exceptions\UnsupportedPageTypeException;
use Hyde\Hyde;
use Hyde\Pages\BladePage;
use Hyde\Pages\DocumentationPage;
use Hyde\Pages\MarkdownPage;
use Illuminate\Support\Str;
use function in_array;
use function rtrim;
use function unslash;

/**
 * Scaffold a new Markdown, Blade, or documentation page.
 *
 * @see \Hyde\Framework\Testing\Feature\Actions\CreatesNewPageSourceFileTest
 */
class CreatesNewPageSourceFile
{
    use InteractsWithDirectories;

    protected string $title;
    protected string $slug;
    protected string $outputPath;
    protected string $subDir = '';
    protected bool $force = false;

    public function __construct(string $title, string $type = MarkdownPage::class, bool $force = false)
    {
        $this->validateType($type);

        $this->title = $this->parseTitle($title);
        $this->slug = $this->parseSlug($title);
        $this->force = $force;

        $this->outputPath = $this->makeOutputPath($type);

        $this->createPage($type);
    }

    public function getOutputPath(): string
    {
        return $this->outputPath;
    }

    protected function parseTitle(string $title): string
    {
        return Str::afterLast($title, '/');
    }

    protected function parseSlug(string $title): string
    {
        // If title contains a slash, it's a subdirectory
        if (str_contains($title, '/')) {
            // So we normalize the subdirectory name
            $this->subDir = $this->normalizeSubdirectory($title);
        }

        // And return a slug made from just the title without the subdirectory
        return Str::slug(basename($title));
    }

    protected function normalizeSubdirectory(string $title): string
    {
        return unslash('/'.rtrim(Str::beforeLast($title, '/').'/', '/\\'));
    }

    protected function makeOutputPath(string $pageClass): string
    {
        /** @var \Hyde\Pages\Concerns\HydePage $pageClass */
        return Hyde::path($pageClass::sourcePath($this->formatIdentifier()));
    }

    protected function createPage(string $type): void
    {
        match ($type) {
            BladePage::class => $this->createBladeFile(),
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
            MarkdownPage::class => $this->createMarkdownFile(),
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
            DocumentationPage::class => $this->createDocumentationFile(),
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
        };
    }

    protected function createBladeFile(): void
    {
        $this->createFile(<<<BLADE
            @extends('hyde::layouts.app')
            @section('content')
            @php(\$title = "$this->title")
            
            <main class="mx-auto max-w-7xl py-16 px-8">
                <h1 class="text-center text-3xl font-bold">$this->title</h1>
            </main>
            
            @endsection

            BLADE
        );
    }

    protected function createMarkdownFile(): void
    {
        $this->createFile("---\ntitle: $this->title\n---\n\n# $this->title\n");
    }

    protected function createDocumentationFile(): void
    {
        $this->createFile("# $this->title\n");
    }

    protected function formatIdentifier(): string
    {
        return "$this->subDir/$this->slug";
    }

    protected function validateType(string $pageClass): void
    {
        if (! in_array($pageClass, [MarkdownPage::class, BladePage::class, DocumentationPage::class])) {
            throw new UnsupportedPageTypeException('The page type must be either "markdown", "blade", or "documentation"');
        }
    }

    protected function failIfFileCannotBeSaved(string $path): void
    {
        if (file_exists($path) && ! $this->force) {
            throw new FileConflictException($path);
        }
    }

    protected function prepareOutputDirectory(): void
    {
        $this->needsParentDirectory($this->outputPath);
        $this->failIfFileCannotBeSaved($this->outputPath);
    }

    protected function createFile(string $contents): void
    {
        $this->prepareOutputDirectory();

        file_put_contents($this->outputPath, $contents);
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Hyde\Framework\Actions;
6
7			use function file_exists;
8			use Hyde\Framework\Concerns\InteractsWithDirectories;
9			use Hyde\Framework\Exceptions\FileConflictException;
10			use Hyde\Framework\Exceptions\UnsupportedPageTypeException;
11			use Hyde\Hyde;
12			use Hyde\Pages\BladePage;
13			use Hyde\Pages\DocumentationPage;
14			use Hyde\Pages\MarkdownPage;
15			use Illuminate\Support\Str;
16			use function in_array;
17			use function rtrim;
18			use function unslash;
19
20			/**
21			* Scaffold a new Markdown, Blade, or documentation page.
22			*
23			* @see \Hyde\Framework\Testing\Feature\Actions\CreatesNewPageSourceFileTest
24			*/
25			class CreatesNewPageSourceFile
26			{
27			use InteractsWithDirectories;
28
29			protected string $title;
30			protected string $slug;
31			protected string $outputPath;
32			protected string $subDir = '';
33			protected bool $force = false;
34
35			public function __construct(string $title, string $type = MarkdownPage::class, bool $force = false)
36			{
37			$this->validateType($type);
38
39			$this->title = $this->parseTitle($title);
40			$this->slug = $this->parseSlug($title);
41			$this->force = $force;
42
43			$this->outputPath = $this->makeOutputPath($type);
44
45			$this->createPage($type);
46			}
47
48			public function getOutputPath(): string
49			{
50			return $this->outputPath;
51			}
52
53			protected function parseTitle(string $title): string
54			{
55			return Str::afterLast($title, '/');
56			}
57
58			protected function parseSlug(string $title): string
59			{
60			// If title contains a slash, it's a subdirectory
61			if (str_contains($title, '/')) {
62			// So we normalize the subdirectory name
63			$this->subDir = $this->normalizeSubdirectory($title);
64			}
65
66			// And return a slug made from just the title without the subdirectory
67			return Str::slug(basename($title));
68			}
69
70			protected function normalizeSubdirectory(string $title): string
71			{
72			return unslash('/'.rtrim(Str::beforeLast($title, '/').'/', '/\\'));
73			}
74
75			protected function makeOutputPath(string $pageClass): string
76			{
77			/** @var \Hyde\Pages\Concerns\HydePage $pageClass */
78			return Hyde::path($pageClass::sourcePath($this->formatIdentifier()));
79			}
80
81			protected function createPage(string $type): void
82			{
83			match ($type) {
84			BladePage::class => $this->createBladeFile(),
			0 ignored issues – show Bug introduced 2022-11-03 18:26 UTC by Report Bug Copy Issue Report Are you sure the usage of `$this->createBladeFile()` targeting `Hyde\Framework\Actions\C...File::createBladeFile()` seems to always return null. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
85			MarkdownPage::class => $this->createMarkdownFile(),
			0 ignored issues – show Bug introduced 2022-11-03 18:26 UTC by Report Bug Copy Issue Report Are you sure the usage of `$this->createMarkdownFile()` targeting `Hyde\Framework\Actions\C...e::createMarkdownFile()` seems to always return null. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
86			DocumentationPage::class => $this->createDocumentationFile(),
			0 ignored issues – show Bug introduced 2022-11-03 18:26 UTC by Report Bug Copy Issue Report Are you sure the usage of `$this->createDocumentationFile()` targeting `Hyde\Framework\Actions\C...eateDocumentationFile()` seems to always return null. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
87			};
88			}
89
90			protected function createBladeFile(): void
91			{
92			$this->createFile(<<<BLADE
93			@extends('hyde::layouts.app')
94			@section('content')
95			@php(\$title = "$this->title")
96
97			<main class="mx-auto max-w-7xl py-16 px-8">
98			<h1 class="text-center text-3xl font-bold">$this->title</h1>
99			</main>
100
101			@endsection
102
103			BLADE
104			);
105			}
106
107			protected function createMarkdownFile(): void
108			{
109			$this->createFile("---\ntitle: $this->title\n---\n\n# $this->title\n");
110			}
111
112			protected function createDocumentationFile(): void
113			{
114			$this->createFile("# $this->title\n");
115			}
116
117			protected function formatIdentifier(): string
118			{
119			return "$this->subDir/$this->slug";
120			}
121
122			protected function validateType(string $pageClass): void
123			{
124			if (! in_array($pageClass, [MarkdownPage::class, BladePage::class, DocumentationPage::class])) {
125			throw new UnsupportedPageTypeException('The page type must be either "markdown", "blade", or "documentation"');
126			}
127			}
128
129			protected function failIfFileCannotBeSaved(string $path): void
130			{
131			if (file_exists($path) && ! $this->force) {
132			throw new FileConflictException($path);
133			}
134			}
135
136			protected function prepareOutputDirectory(): void
137			{
138			$this->needsParentDirectory($this->outputPath);
139			$this->failIfFileCannotBeSaved($this->outputPath);
140			}
141
142			protected function createFile(string $contents): void
143			{
144			$this->prepareOutputDirectory();
145
146			file_put_contents($this->outputPath, $contents);
147			}
148			}
149

hydephp / develop

Push — master ( 10105b...1efe78 )

CreatesNewPageSourceFile::prepareOutputDirectory() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like