massivedynamic
/
Parkdown
1
0
Fork 0
Code Issues Pull Requests 1 Projects 1 Releases 3 Wiki Activity

Compare commits

base: massivedynamic:master
Branches Tags
massivedynamic:development
massivedynamic:feature/strict-mode
massivedynamic:feature/tests
massivedynamic:master
..
compare: massivedynamic:feature/tests
Branches Tags
massivedynamic:development
massivedynamic:feature/strict-mode
massivedynamic:feature/tests
massivedynamic:master

No commits in common. 'master' and 'feature/tests' have entirely different histories.
master ... feature/te

12 changed files with 15 additions and 345 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats
  1. 35
      CHANGELOG.md
  2. 18
      LICENSE.md
  3. 52
      README.md
  4. 4
      composer.json
  5. 13
      index.php
  6. 8
      src/Lexer.php
  7. 73
      src/Parser.php
  8. 2
      src/Token.php
  9. 70
      tests/AnnotationsTest.php
  10. 4
      tests/CodeBlocksTest.php
  11. 16
      tests/GenericBlocksTest.php
  12. 65
      tests/HeadingsTest.php

35
CHANGELOG.md
Unescape View File

@ -1,35 +0,0 @@
# Changelog
## Version 1.2.0
The *"annotation release"*
### Added
* paragraph annotations *(now can set HTML ids and classes with `{.someClass, #someId}` syntax)*
* unit tests for annotation
* unit for headings *(`h1` to `h5`)*
### Removed
* Testing code in `index.php`
## Version 1.1.2
No major changes introduced, getting ready for release
### Changed
* added compatibility for `prism` code highlighting inside code blocks
## Version 1.1.0
No major changes introduced, getting ready for release
### Added
* unit tests via `PHPUnit`
### Changed
* Parser does not generate unnessecary empty paragraphs anymore
* Fix: parse does not get stuck on blockquotes that are not followed by an empty
line anymore
### Removed
* "Monkey test" `.md` files in `tests` folder
## Version 1.0.0
Basic implementation

18
LICENSE.md
Unescape View File

@ -1,18 +0,0 @@
Copyright (C) 2022, MikO <miko@massivedynamic.eu>
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

52
README.md
Unescape View File

@ -33,27 +33,11 @@ Parkdown currently support the following block types:
### Paragraphs ### Paragraphs
```markdown ```markdown
A simple paragraph can contain **bold text**, `inline codeblocks` and *italic text*. We can also link [with a direct url][https://google.com] *(i.e. to google)* A simple paragraph can contain **bold text**, `inline codeblocks` and *italic text*. We can also link [with a direct url][https://google.com] *(i.e. to google)*
or via reference to [a later defined url][massivedynamic], if we so desire. or via reference to [a later defined url][massivedynamic], i we so desire.
``` ```
A simple paragraph can contain **bold text**, `inline codeblocks` and *italic text*. We can also link [with a direct url](https://google.com) *(i.e. to google)* A simple paragraph can contain **bold text**, `inline codeblocks` and *italic text*. We can also link [with a direct url](https://google.com) *(i.e. to google)*
or via reference to [a later defined url][massivedynamic], if we so desire. or via reference to [a later defined url][massivedynamic], i we so desire.
Paragraphs can be annotated with `id` and `class` attributes:
```markdown
Paragraphs can be annotated with ids and classes {.thisIsAClass, .anotherClass, #thisIsAnID}
```
results in
Paragraphs can be annotated with ids and classes {.thisIsAClass, .anotherClass, #thisIsAnID}
```html
<p class="thisIsAClass anotherClass" id="thisIsAnID">
Paragraphs can be annotated with ids and classes
</p>
```
### Images ### Images
```markdown ```markdown
@ -73,14 +57,14 @@ Paragraphs can be annotated with ids and classes {.thisIsAClass, .anotherClass,
> Only two things are infinite, > Only two things are infinite,
> the universe and human stupidity, > the universe and human stupidity,
> i am not totally shure about the universe, though... > i am not totally shure about the universe, though...
> – Albert Einstein > - Albert Einstein
``` ```
> Only two things are infinite, > Only two things are infinite,
> the universe and human stupidity, > the universe and human stupidity,
> i am not totally shure about the universe, though... > i am not totally shure about the universe, though...
> – Albert Einstein > - Albert Einstein
### Code blocks ### Code blocks
```markdown ```markdown
@ -126,30 +110,4 @@ Paragraphs can be annotated with ids and classes {.thisIsAClass, .anotherClass,
[massivedynamic]: https://massivedynamic.eu [massivedynamic]: https://massivedynamic.eu
``` ```
[massivedynamic]: https://massivedynamic.eu [massivedynamic]: https://massivedynamic.eu
## Usage
Simply construct an new `parkdown\Parkdown` object and pass the Markdown source code to it's constructor. The parsed `DOMDocument` or it's `HTML` output can then be retrieved through the `::html()` and `::tree()` member functions.
**Example**
```php
use parkdown\Parkdown;
$source = "
This is a **bold** word in a paragraph.
";
$parser = new Parkdown($source);
$tree = $parser->tree();
print_r($tree);
echo $parser->html();
```
## Testing
Unit tests can be run via `composer`:
```
composer test
```

4
composer.json
Unescape View File

@ -1,7 +1,6 @@
{ {
"name": "massivedynamic/parkdown", "name": "massivedynamic/parkdown",
"type": "library", "type": "library",
"version": "v1.2.0",
"license": "MIT", "license": "MIT",
"autoload": { "autoload": {
"psr-4": { "psr-4": {
@ -14,9 +13,6 @@
"email": "miko@massivedynamic.eu" "email": "miko@massivedynamic.eu"
} }
], ],
"require": {
"php" : ">=8.1"
},
"require-dev": { "require-dev": {
"phpunit/phpunit": "^9" "phpunit/phpunit": "^9"
}, },

13
index.php
Unescape View File

@ -4,24 +4,15 @@ require __DIR__."/vendor/autoload.php";
$source = file_get_contents(dirname(__FILE__)."/README.md"); $source = file_get_contents(dirname(__FILE__)."/README.md");
//$source = file_get_contents(dirname(__FILE__)."/tests/paragraph.md");
//$source = file_get_contents(dirname(__FILE__)."/tests/list.md");
echo " echo "
<style> <style>
body { body {
padding: 4rem;
margin: 0;
font-family: sans-serif; font-family: sans-serif;
} }
img {
max-width: 100%;
}
code {
word-break: break-word;
white-space: break-spaces;
}
table { table {
width: 100%; width: 100%;
} }

8
src/Lexer.php
Unescape View File

@ -104,14 +104,6 @@ class Lexer {
$clearBuffer(); $clearBuffer();
array_push($tokens, new Token(TokenType::COLON, $char)); array_push($tokens, new Token(TokenType::COLON, $char));
break; break;
case '{':
$clearBuffer();
array_push($tokens, new Token(TokenType::LBRACE, $char));
break;
case '}':
$clearBuffer();
array_push($tokens, new Token(TokenType::RBRACE, $char));
break;
default: default:
$buffer .= $char; $buffer .= $char;
break; break;

73
src/Parser.php
Unescape View File

@ -2,7 +2,6 @@
namespace parkdown; namespace parkdown;
use Attribute;
use DOMDocument; use DOMDocument;
use DOMElement; use DOMElement;
use DOMNode; use DOMNode;
@ -12,11 +11,6 @@ enum ListType {
case UNORDERED; case UNORDERED;
} }
class Attributes {
public array $classes = [];
public ?string $id = null;
}
class Parser { class Parser {
const MAGIC_CHAR = "*"; const MAGIC_CHAR = "*";
@ -154,8 +148,8 @@ class Parser {
} }
private function parseText($paragraph = false) : array { private function parseText($paragraph = false) : array {
$elms = []; $elms = [];
$buffer = ""; $buffer = "";
$clearBuffer = function() use (&$elms, &$buffer) { $clearBuffer = function() use (&$elms, &$buffer) {
array_push($elms, $this->document->createTextNode($buffer)); array_push($elms, $this->document->createTextNode($buffer));
@ -170,8 +164,7 @@ class Parser {
TokenType::BACKTICK, TokenType::BACKTICK,
TokenType::ASTERISK, TokenType::ASTERISK,
TokenType::LBRACKET, TokenType::LBRACKET,
TokenType::BANG, TokenType::BANG
TokenType::LBRACE
])) { ])) {
$this->consume()->data; // backslash $this->consume()->data; // backslash
$buffer .= $this->consume()->data; $buffer .= $this->consume()->data;
@ -235,41 +228,6 @@ class Parser {
$clearBuffer(); $clearBuffer();
array_push($elms, $elm); array_push($elms, $elm);
continue; continue;
} elseif ($this->current()->type === TokenType::LBRACE) {
$lbrace = $this->consume();
assert($lbrace->type === TokenType::LBRACE, "expected left brace, got ".$lbrace->type->name);
$content = "";
while ($this->current()->type !== TokenType::EOF &&
$this->current()->type !== TokenType::EOL &&
$this->current()->type !== TokenType::RBRACE) {
$content .= $this->consume()->data;
}
$rbrace = $this->consume();
assert($rbrace->type === TokenType::RBRACE, "expected right brace, got ".$rbrace->type->name);
$attributes = array_map(function($element) {
return trim($element);
}, explode(',', $content));
$obj = new Attributes();
foreach($attributes as $attribute) {
if (!in_array($attribute[0], [".", "#"]))
continue;
switch ($attribute[0]) {
case ".":
array_push($obj->classes, substr($attribute, 1));
break;
case "#":
$obj->id = substr($attribute, 1);
break;
default:
continue 2;
}
}
array_push($elms, $obj);
} else } else
$buffer .= self::StripBackslashes($this->consume()->data); $buffer .= self::StripBackslashes($this->consume()->data);
} }
@ -310,7 +268,6 @@ class Parser {
// then we parse the node content // then we parse the node content
$elm = $this->document->createElement("li"); $elm = $this->document->createElement("li");
foreach ($this->parseText() as $node) foreach ($this->parseText() as $node)
if ($node instanceof DOMNode)
$elm->appendChild($node); $elm->appendChild($node);
// now we check, if the level of the next line is higher than the current level. // now we check, if the level of the next line is higher than the current level.
@ -346,17 +303,10 @@ class Parser {
private function buildParagraph(array $elms) : void { private function buildParagraph(array $elms) : void {
if (count($elms) < 1) if (count($elms) < 1)
return; return;
$elm = $this->document->createElement("p"); $elm = $this->document->createElement("p");
$i = 0; $i = 0;
foreach ($elms as $node) { foreach ($elms as $node) {
if ($node instanceof Attributes) {
if (count($node->classes) > 0)
$elm->setAttribute("class", join(" ", $node->classes));
if ($node->id)
$elm->setAttribute("id", $node->id);
continue;
}
if ($node->nodeName === "#text" && trim($node->textContent) === "") if ($node->nodeName === "#text" && trim($node->textContent) === "")
continue; continue;
$elm->appendChild($node); $elm->appendChild($node);
@ -376,8 +326,7 @@ class Parser {
} }
$elm = $this->document->createElement("h".$level); $elm = $this->document->createElement("h".$level);
foreach ($this->parseText() as $node) foreach ($this->parseText() as $node)
if ($node instanceof DOMNode) $elm->appendChild($node);
$elm->appendChild($node);
$this->document->appendChild($elm); $this->document->appendChild($elm);
} }
@ -395,10 +344,8 @@ class Parser {
$lang = count($lang) > 0 ? trim($lang[0]->data) : null; $lang = count($lang) > 0 ? trim($lang[0]->data) : null;
$container = $this->document->createElement("pre"); $container = $this->document->createElement("pre");
if ($lang) { if ($lang)
$container->setAttribute("data-lang", $lang); $container->setAttribute("data-lang", $lang);
$container->setAttribute("class", "language-$lang");
}
$buffer = ""; $buffer = "";
while (!($this->current()->type === TokenType::BACKTICK && while (!($this->current()->type === TokenType::BACKTICK &&
@ -413,10 +360,6 @@ class Parser {
} }
$elm = $this->document->createElement("code", htmlspecialchars($buffer)); $elm = $this->document->createElement("code", htmlspecialchars($buffer));
if ($lang) {
$elm->setAttribute("data-lang", $lang);
$elm->setAttribute("class", "language-$lang");
}
$container->appendChild($elm); $container->appendChild($elm);
$this->document->appendChild($container); $this->document->appendChild($container);
$this->consume(); $this->consume();
@ -562,10 +505,6 @@ class Parser {
while ($this->current()->type !== TokenType::EOF) { while ($this->current()->type !== TokenType::EOF) {
switch($this->current()->type) { switch($this->current()->type) {
case TokenType::ASTERISK: case TokenType::ASTERISK:
if ($this->next()->type === TokenType::ASTERISK) {
$this->buildParagraph($this->parseText(true));
break;
}
$list = $this->parseList(); $list = $this->parseList();
$this->document->appendChild($list); $this->document->appendChild($list);
break; break;

2
src/Token.php
Unescape View File

@ -22,8 +22,6 @@ enum TokenType {
case PIPE ; case PIPE ;
case GT ; case GT ;
case TAB ; case TAB ;
case LBRACE ;
case RBRACE ;
} }
class Token { class Token {

70
tests/AnnotationsTest.php
Unescape View File

@ -1,70 +0,0 @@
<?php declare(strict_types=1);
use PHPUnit\Framework\TestCase;
final class AnnotationsTest extends TestCase {
public function testAnnotationsDoNotBreakHeadings() : void {
$source = "
# This is an H1 {.withAClass}
## This is an H2 {.withAClass}
### This is an H3 {.withAClass}
#### This is an H4 {.withAClass}
##### This is an H5 {.withAClass}
";
$target = "
<h1>This is an H1</h1>
<h2>This is an H2</h2>
<h3>This is an H3</h3>
<h4>This is an H4</h4>
<h5>This is an H5</h5>
";
[$source, $result] = createTest($source, $target);
$this->assertEquals($source, $result);
}
public function testAnnotationsDoNotBreakLists() : void {
$source = "
* this is a list
* with annotations {#someID}
1. this is an ordered list
1. with an annotation {.someClass}
";
$target = "
<ul>
<li>this is a list</li>
<li>with annotations</li>
</ul>
<ol>
<li>
this is an ordered list
<ol>
<li>with an annotation</li>
</ol>
</li>
</ol>
";
[$source, $result] = createTest($source, $target);
$this->assertEquals($source, $result);
}
public function testAnnotationsDoNotBreakCodeblocks() : void {
$source = "
```
this is a code block
``` {.someClass}
";
$target = "
<pre>
<code>this is a code block</code>
</pre>
";
[$source, $result] = createTest($source, $target);
$this->assertEquals($source, $result);
}
}

4
tests/CodeBlocksTest.php
Unescape View File

@ -31,8 +31,8 @@ final class CodeBlocksTest extends TestCase {
``` ```
"; ";
$target = " $target = "
<pre data-lang=\"php\" class=\"language-php\"> <pre data-lang=\"php\">
<code data-lang=\"php\" class=\"language-php\"> <code>
public function testLanguageAnnotationParsesCorrectly() : bool { public function testLanguageAnnotationParsesCorrectly() : bool {
return true; return true;
} }

16
tests/GenericBlocksTest.php
Unescape View File

@ -44,20 +44,4 @@ this is a paragraph
[$source, $result] = createTest($source, $target); [$source, $result] = createTest($source, $target);
$this->assertEquals($source, $result); $this->assertEquals($source, $result);
} }
public function testParagraphAnnotations() : void {
$source = "
this is an annotated paragraph {.classA, .classB}
";
$target = "
<p class=\"classA classB\">
this is an annotated paragraph
</p>
";
[$source, $result] = createTest($source, $target);
$this->assertEquals($source, $result);
}
} }

65
tests/HeadingsTest.php
Unescape View File

@ -1,65 +0,0 @@
<?php declare(strict_types=1);
use PHPUnit\Framework\TestCase;
final class HeadingsTest extends TestCase {
public function testH1ParsesCorrectly() : void {
$source = "
# This is an H1
";
$target = "
<h1>This is an H1</h1>
";
[$source, $result] = createTest($source, $target);
$this->assertEquals($source, $result);
}
public function testH2ParsesCorrectly() : void {
$source = "
## This is an H2
";
$target = "
<h2>This is an H2</h2>
";
[$source, $result] = createTest($source, $target);
$this->assertEquals($source, $result);
}
public function testH3ParsesCorrectly() : void {
$source = "
### This is an H3
";
$target = "
<h3>This is an H3</h3>
";
[$source, $result] = createTest($source, $target);
$this->assertEquals($source, $result);
}
public function testH4ParsesCorrectly() : void {
$source = "
#### This is an H4
";
$target = "
<h4>This is an H4</h4>
";
[$source, $result] = createTest($source, $target);
$this->assertEquals($source, $result);
}
public function testH5ParsesCorrectly() : void {
$source = "
##### This is an H5
";
$target = "
<h5>This is an H5</h5>
";
[$source, $result] = createTest($source, $target);
$this->assertEquals($source, $result);
}
}
Write Preview
Loading…
Cancel
Save