Skip to content

Commit

Permalink
Allowed direct append for nodes
Browse files Browse the repository at this point in the history
  • Loading branch information
@sgrigorjev
sgrigorjev committed Sep 30, 2024
1 parent b7bb3d7 commit 7ee2685
Show file tree
Hide file tree
Showing 6 changed files with 218 additions and 8 deletions.
3 changes: 2 additions & 1 deletion src/Builder/BuilderInterface.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@

namespace DH\Adf\Builder;

use DH\Adf\Node\BlockNode;
use DH\Adf\Node\Node;

trait BuilderInterface
{
abstract protected function append(Node $node): void;
abstract public function append(Node ...$nodes): BlockNode;
}
3 changes: 2 additions & 1 deletion src/Builder/InlineNodeBuilder.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

namespace DH\Adf\Builder;

use DH\Adf\Node\BlockNode;
use DH\Adf\Node\Inline\Emoji;
use DH\Adf\Node\Inline\Hardbreak;
use DH\Adf\Node\Inline\Mention;
Expand Down Expand Up @@ -34,5 +35,5 @@ public function break(?Node $parent = null): self
return $this;
}

abstract protected function append(Node $node): void;
abstract public function append(Node ...$nodes): BlockNode;
}
3 changes: 2 additions & 1 deletion src/Builder/TextBuilder.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

namespace DH\Adf\Builder;

use DH\Adf\Node\BlockNode;
use DH\Adf\Node\Inline\Text;
use DH\Adf\Node\Mark\Em;
use DH\Adf\Node\Mark\Link;
Expand Down Expand Up @@ -79,5 +80,5 @@ public function link(string $text, string $href, ?string $title = null): self
return $this;
}

abstract protected function append(Node $node): void;
abstract public function append(Node ...$nodes): BlockNode;
}
23 changes: 18 additions & 5 deletions src/Node/BlockNode.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,16 +52,29 @@ public function getContent(): array
return $this->content;
}

protected function append(Node $node): void
public function append(Node ...$nodes): BlockNode
{
foreach ($this->allowedContentTypes as $type) {
if ($node instanceof $type) {
foreach ($nodes as $node) {
if ($this->isAppendAllowed($node)) {
$this->content[] = $node;
} else {
throw new InvalidArgumentException(
sprintf('Invalid content type "%s" for block node "%s".', $node->getType(), $this->getType())
);
}
}

return;
return $this;
}

protected function isAppendAllowed(Node $node): bool
{
foreach ($this->allowedContentTypes as $allowedContentType) {
if ($node instanceof $allowedContentType) {
return true;
}
}

throw new InvalidArgumentException(sprintf('Invalid content type "%s" for block node "%s".', $node->type, $this->type));
return false;
}
}
5 changes: 5 additions & 0 deletions src/Node/Node.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,11 @@ public static function load(array $data): self
return $node;
}

public function getType(): string
{
return $this->type;
}

protected function attrs(): array
{
return [];
Expand Down
189 changes: 189 additions & 0 deletions tests/Node/Block/DirectAppendTest.php
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,189 @@
<?php

declare(strict_types=1);

namespace DH\Adf\Tests\Node\Block;

use DH\Adf\Node\Block\Document;
use DH\Adf\Node\Block\Panel;
use DH\Adf\Node\Block\Paragraph;
use DH\Adf\Node\Inline\Text;
use DH\Adf\Node\Mark\Em;
use DH\Adf\Node\Mark\Link;
use DH\Adf\Node\Mark\Strike;
use DH\Adf\Node\Mark\Strong;
use DH\Adf\Node\Mark\Subsup;
use DH\Adf\Node\Mark\TextColor;
use DH\Adf\Node\Mark\Underline;
use InvalidArgumentException;
use PHPUnit\Framework\TestCase;

/**
* @internal
*
* @small
*/
class DirectAppendTest extends TestCase
{
public function testDocumentWithEmptyParagraph(): void
{
$document = (new Document())
->append(
new Paragraph()
)
;

$doc = json_encode($document);

self::assertJsonStringEqualsJsonString($doc, json_encode([
'version' => 1,
'type' => 'doc',
'content' => [
[
'type' => 'paragraph',
'content' => [],
],
],
]));
}

public function testDocumentWithTextInParagraph(): void
{
$document = (new Document())
->append(
(new Paragraph())
->append(
new Text('Luke, ', new TextColor('red')),
new Text('may '),
new Text('the ', new Em()),
new Text('force ', new Strong()),
new Text('be '),
new Text('with ', new Underline()),
new Text('you! ', new Strike()),
new Text('Obi-Wan', new Subsup('sub')),
new Text('Kenobi', new Subsup('sup')),
new Text('Star Wars @ Wikipedia', new Link('https://wikipedia.org/wiki/Star_Wars'))
),
)
;

$doc = json_encode($document);

self::assertJsonStringEqualsJsonString($doc, json_encode([
'version' => 1,
'type' => 'doc',
'content' => [
[
'type' => 'paragraph',
'content' => [
[
'type' => 'text',
'text' => 'Luke, ',
'marks' => [
[
'type' => 'textColor',
'attrs' => [
'color' => 'red',
],
],
],
],
[
'type' => 'text',
'text' => 'may ',
],
[
'type' => 'text',
'text' => 'the ',
'marks' => [
[
'type' => 'em',
],
],
],
[
'type' => 'text',
'text' => 'force ',
'marks' => [
[
'type' => 'strong',
],
],
],
[
'type' => 'text',
'text' => 'be ',
],
[
'type' => 'text',
'text' => 'with ',
'marks' => [
[
'type' => 'underline',
],
],
],
[
'type' => 'text',
'text' => 'you! ',
'marks' => [
[
'type' => 'strike',
],
],
],
[
'type' => 'text',
'text' => 'Obi-Wan',
'marks' => [
[
'type' => 'subsup',
'attrs' => [
'type' => 'sub',
],
],
],
],
[
'type' => 'text',
'text' => 'Kenobi',
'marks' => [
[
'type' => 'subsup',
'attrs' => [
'type' => 'sup',
],
],
],
],
[
'type' => 'text',
'text' => 'Star Wars @ Wikipedia',
'marks' => [
[
'type' => 'link',
'attrs' => [
'href' => 'https://wikipedia.org/wiki/Star_Wars',
],
],
],
],
],
],
],
]));
}

public function testIllegalAppend()
{
$this->expectException(InvalidArgumentException::class);
$this->expectExceptionMessage('Invalid content type "panel" for block node "paragraph".');

(new Document())
->append(
(new Paragraph())
->append(new Panel())
)
;
}
}

0 comments on commit 7ee2685

Please sign in to comment.