Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clean up the build service class #666

Merged
merged 14 commits into from
Nov 16, 2022
Merged

Clean up the build service class #666

Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
366b47e
Rename helper method to be more descriptive
caendesilva Nov 16, 2022
44cc5db
Type hint base class to prevent internal helper from being misleading
caendesilva Nov 16, 2022
67eaf72
Join comma-separated values into a single line
caendesilva Nov 16, 2022
3cf477a
Inline helper method
caendesilva Nov 16, 2022
2df8312
Add type annotation
caendesilva Nov 16, 2022
3acabf1
No need to return voided value
caendesilva Nov 16, 2022
2925e6d
Add 'void' as the function's return type
caendesilva Nov 16, 2022
6ee1627
Add strong types
caendesilva Nov 16, 2022
c5d67b6
Extract method
caendesilva Nov 16, 2022
d83574a
Join comma-separated values into a single line
caendesilva Nov 16, 2022
6ab1b55
Inline local variable
caendesilva Nov 16, 2022
e25e0b9
Formatting
caendesilva Nov 16, 2022
a1564fe
Rename helper method
caendesilva Nov 16, 2022
b6bdb57
Apply fixes from StyleCI
StyleCIBot Nov 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 23 additions & 30 deletions packages/framework/src/Framework/Services/BuildService.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@

namespace Hyde\Framework\Services;

use Closure;
use Hyde\Facades\Site;
use Hyde\Foundation\RouteCollection;
use Hyde\Framework\Actions\StaticPageBuilder;
Expand All @@ -13,6 +12,7 @@
use Hyde\Support\Models\Route;
use Illuminate\Console\Concerns\InteractsWithIO;
use Illuminate\Console\OutputStyle;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\File;

/**
Expand All @@ -39,7 +39,7 @@ public function __construct(OutputStyle $output)

public function compileStaticPages(): void
{
$this->getDiscoveredModels()->each(function (string $pageClass) {
$this->getClassNamesForDiscoveredPageModels()->each(function (string $pageClass) {
$this->compilePagesForClass($pageClass);
});
}
Expand All @@ -60,51 +60,42 @@ public function transferMediaAssets(): void
{
$this->needsDirectory(Hyde::sitePath('media'));

$collection = DiscoveryService::getMediaAssetFiles();
$this->comment('Transferring Media Assets...');

$this->withProgressBar(
$collection,
function ($filepath) {
copy($filepath, Hyde::sitePath('media/'.basename($filepath)));
}
);
$this->withProgressBar(DiscoveryService::getMediaAssetFiles(), function (string $filepath): void {
copy($filepath, Hyde::sitePath('media/'.basename($filepath)));
});

$this->newLine(2);
}

/**
* @return \Hyde\Foundation\RouteCollection<array-key, class-string<\Hyde\Pages\Concerns\HydePage>>
* @return \Illuminate\Support\Collection<array-key, class-string<\Hyde\Pages\Concerns\HydePage>>
*/
protected function getDiscoveredModels(): RouteCollection
protected function getClassNamesForDiscoveredPageModels(): Collection
{
return $this->router->getRoutes()->map(function (Route $route) {
return $this->router->getRoutes()->map(function (Route $route): string {
return $route->getPageClass();
})->unique();
}

/**
* @param class-string<\Hyde\Pages\Concerns\HydePage> $pageClass
*/
protected function compilePagesForClass(string $pageClass): void
{
$this->comment("Creating {$this->getModelPluralName($pageClass)}...");
$this->comment("Creating {$this->getClassPluralName($pageClass)}...");

$collection = $this->router->getRoutes($pageClass);

$this->withProgressBar(
$collection,
$this->compileRoute()
);
$this->withProgressBar($collection, function (Route $route): void {
(new StaticPageBuilder($route->getPage()))->__invoke();
});

$this->newLine(2);
}

/** @psalm-return \Closure(\Hyde\Support\Models\Route):string */
protected function compileRoute(): Closure
{
return function (Route $route) {
return (new StaticPageBuilder($route->getPage()))->__invoke();
};
}

protected function getModelPluralName(string $pageClass): string
protected function getClassPluralName(string $pageClass): string
{
return preg_replace('/([a-z])([A-Z])/', '$1 $2', class_basename($pageClass)).'s';
}
Expand All @@ -122,10 +113,7 @@ protected function isItSafeToCleanOutputDirectory(): bool

protected function isOutputDirectoryWhitelisted(): bool
{
return in_array(
basename(Hyde::sitePath()),
config('hyde.safe_output_directories', ['_site', 'docs', 'build'])
);
return in_array(basename(Hyde::sitePath()), $this->safeOutputDirectories());
}

protected function askIfUnsafeDirectoryShouldBeEmptied(): bool
Expand All @@ -136,4 +124,9 @@ protected function askIfUnsafeDirectoryShouldBeEmptied(): bool
Site::$outputPath
));
}

protected function safeOutputDirectories(): array
{
return config('hyde.safe_output_directories', ['_site', 'docs', 'build']);
}
}