Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion src/Bootstrap/HandleExceptions.php
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ private function handleError($level, $message, $file = '', $line = 0, $context =
/**
* Handle a deprecation.
*
* @throws \TightenCo\Jigsaw\Exceptions\DeprecationException
* @throws DeprecationException
*/
private function handleDeprecation(Throwable $e): void
{
Expand Down
60 changes: 60 additions & 0 deletions src/Builders/PlainMarkdownBuilder.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
<?php

namespace TightenCo\Jigsaw\Builders;

use Illuminate\Support\Str;

class PlainMarkdownBuilder
{
public function build($content, $title = null, array $options = [])
{
$titleAsHeadingOne = $options['title_as_h1'] ?? true;
$tableOfContents = $options['table_of_contents'] ?? true;

$headings = $tableOfContents ? $this->extractHeadings($content) : [];

if ($headings) {
$content = $this->addAnchors($content, $headings);
}

$parts = [];

if ($titleAsHeadingOne && $title) {
$parts[] = "# {$title}";
}

if ($headings) {
$parts[] = implode("\n", array_map(function ($heading) {
return "- [{$heading['text']}](#{$heading['slug']})";
}, $headings));
}

$parts[] = $content;

return implode("\n\n", $parts) . "\n";
}

private function extractHeadings($content)
{
preg_match_all('/^(#{2,6})\s+(.+)$/m', $content, $matches, PREG_SET_ORDER);

return array_map(function ($match) {
return [
'level' => strlen($match[1]),
'text' => trim($match[2]),
'slug' => Str::slug($match[2]),
];
}, $matches);
}

private function addAnchors($content, $headings)
{
foreach ($headings as $heading) {
$pattern = '/^(#{' . $heading['level'] . '})\s+(' . preg_quote($heading['text'], '/') . ')$/m';
$replacement = '<a name="' . $heading['slug'] . '"></a>' . "\n" . '$1 $2';
$content = preg_replace($pattern, $replacement, $content, 1);
}

return $content;
}
}
6 changes: 4 additions & 2 deletions src/Container.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
use Illuminate\Container\Container as Illuminate;
use Illuminate\Support\Env;
use Illuminate\Support\Str;
use Illuminate\View\Factory;
use Psr\Container\ContainerInterface;
use Symfony\Component\Console\Output\ConsoleOutput;

class Container extends Illuminate
Expand Down Expand Up @@ -200,8 +202,8 @@ private function registerConfiguredProviders(): void
private function registerCoreAliases(): void
{
foreach ([
'app' => [self::class, \Illuminate\Contracts\Container\Container::class, \Psr\Container\ContainerInterface::class],
'view' => [\Illuminate\View\Factory::class, \Illuminate\Contracts\View\Factory::class],
'app' => [self::class, \Illuminate\Contracts\Container\Container::class, ContainerInterface::class],
'view' => [Factory::class, \Illuminate\Contracts\View\Factory::class],
] as $key => $aliases) {
foreach ($aliases as $alias) {
$this->alias($key, $alias);
Expand Down
7 changes: 4 additions & 3 deletions src/Events/EventBus.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
namespace TightenCo\Jigsaw\Events;

use Illuminate\Support\Arr;
use Illuminate\Support\Collection;
use TightenCo\Jigsaw\Jigsaw;

/**
Expand All @@ -12,13 +13,13 @@
*/
class EventBus
{
/** @var \Illuminate\Support\Collection */
/** @var Collection */
public $beforeBuild;

/** @var \Illuminate\Support\Collection */
/** @var Collection */
public $afterCollections;

/** @var \Illuminate\Support\Collection */
/** @var Collection */
public $afterBuild;

public function __construct()
Expand Down
5 changes: 3 additions & 2 deletions src/Exceptions/Handler.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
use Symfony\Component\Console\Application as ConsoleApplication;
use Symfony\Component\Console\Exception\CommandNotFoundException;
use Symfony\Component\Console\Exception\ExceptionInterface as SymfonyConsoleExceptionInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Throwable;

class Handler implements ExceptionHandler
Expand All @@ -40,7 +41,7 @@ public function render($request, Throwable $e): void
}

/**
* @param \Symfony\Component\Console\Output\OutputInterface $output
* @param OutputInterface $output
*/
public function renderForConsole($output, Throwable $e): void
{
Expand Down Expand Up @@ -79,7 +80,7 @@ public function renderForConsole($output, Throwable $e): void

$e = $this->mapException($e);

/** @var \NunoMaduro\Collision\Provider $provider */
/** @var Provider $provider */
$provider = app(Provider::class);

$handler = $provider->register()->getHandler()->setOutput($output);
Expand Down
49 changes: 46 additions & 3 deletions src/Handlers/CollectionItemHandler.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,26 @@
use Illuminate\Support\Arr;
use Illuminate\Support\Collection;
use Illuminate\Support\Str;
use TightenCo\Jigsaw\Builders\PlainMarkdownBuilder;
use TightenCo\Jigsaw\File\OutputFile;
use TightenCo\Jigsaw\Parsers\FrontMatterParser;

class CollectionItemHandler
{
private $config;

private $handlers;

public function __construct(Collection $config, $handlers)
private $parser;

private $plainMarkdownBuilder;

public function __construct(Collection $config, $handlers, FrontMatterParser $parser, PlainMarkdownBuilder $plainMarkdownBuilder)
{
$this->config = $config;
$this->handlers = collect($handlers);
$this->parser = $parser;
$this->plainMarkdownBuilder = $plainMarkdownBuilder;
}

public function shouldHandle($file)
Expand Down Expand Up @@ -47,13 +55,14 @@ public function handle($file, $pageData)
$handler = $this->handlers->first(function ($handler) use ($file) {
return $handler->shouldHandle($file);
});
$pageData->setPageVariableToCollectionItem($this->getCollectionName($file), $file->getFilenameWithoutExtension());
$collectionName = $this->getCollectionName($file);
$pageData->setPageVariableToCollectionItem($collectionName, $file->getFilenameWithoutExtension());

if ($pageData->page === null) {
return null;
}

return $handler->handleCollectionItem($file, $pageData)
$outputFiles = $handler->handleCollectionItem($file, $pageData)
->map(function ($outputFile, $templateToExtend) use ($file) {
if ($templateToExtend) {
$outputFile->data()->setExtending($templateToExtend);
Expand All @@ -70,5 +79,39 @@ public function handle($file, $pageData)
$outputFile->data(),
) : null;
})->filter()->values();

$outputMarkdown = Arr::get($this->config, "collections.{$collectionName}.output_markdown");

if ($outputMarkdown && $handler instanceof MarkdownHandler) {
$options = is_array($outputMarkdown) ? $outputMarkdown : [];

if ($markdownOutput = $this->buildMarkdownOutput($file, $pageData, $options)) {
$outputFiles->push($markdownOutput);
}
}

return $outputFiles;
}

private function buildMarkdownOutput($file, $pageData, array $options = [])
{
$path = rtrim($pageData->page->getPath(), '/');

if (! $path) {
return null;
}

$pathInfo = pathinfo($path);
$rawContent = rtrim($this->parser->extractContent($file->getContents()));
$content = $this->plainMarkdownBuilder->build($rawContent, $pageData->page->title ?? null, $options);

return new OutputFile(
$file,
$pathInfo['dirname'],
$pathInfo['filename'],
'md',
$content,
$pageData,
);
}
}
3 changes: 2 additions & 1 deletion src/Providers/CollectionServiceProvider.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

namespace TightenCo\Jigsaw\Providers;

use TightenCo\Jigsaw\Builders\PlainMarkdownBuilder;
use TightenCo\Jigsaw\Collection\CollectionPaginator;
use TightenCo\Jigsaw\CollectionItemHandlers\BladeCollectionItemHandler;
use TightenCo\Jigsaw\CollectionItemHandlers\MarkdownCollectionItemHandler;
Expand Down Expand Up @@ -55,7 +56,7 @@ private function registerHandlers(): void
return new CollectionItemHandler($app['config'], [
$app[MarkdownHandler::class],
$app[BladeHandler::class],
]);
], $app[FrontMatterParser::class], new PlainMarkdownBuilder);
});
}

Expand Down
6 changes: 3 additions & 3 deletions src/Support/helpers.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@
* @template TClass of object
*
* @param string|class-string<TClass>|null $abstract
* @return ($abstract is class-string<TClass> ? TClass : ($abstract is null ? \TightenCo\Jigsaw\Container : mixed))
* @return ($abstract is class-string<TClass> ? TClass : ($abstract is null ? TightenCo\Jigsaw\Container : mixed))
*/
function app(?string $abstract = null, array $parameters = []): mixed
{
if (is_null($abstract)) {
return \TightenCo\Jigsaw\Container::getInstance();
return TightenCo\Jigsaw\Container::getInstance();
}

return \TightenCo\Jigsaw\Container::getInstance()->make($abstract, $parameters);
return TightenCo\Jigsaw\Container::getInstance()->make($abstract, $parameters);
}
}

Expand Down
6 changes: 4 additions & 2 deletions stubs/site/bootstrap.php
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
<?php

use Illuminate\Container\Container;
use TightenCo\Jigsaw\Events\EventBus;
use TightenCo\Jigsaw\Jigsaw;

/** @var \Illuminate\Container\Container $container */
/** @var \TightenCo\Jigsaw\Events\EventBus $events */
/** @var Container $container */
/** @var EventBus $events */

/*
* You can run custom code at different stages of the build process by
Expand Down
Loading
Loading