release: 1.1.0

Author: Genert Org

CHANGELOG.MD

@@ -3,6 +3,13 @@ All notable changes to this project will be documented in this file.
 
 The project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [1.1.0] - 2018-03-04
+### Added
+- `addLinebreakParser` adds linebreak parser to support changing newlines to `<br />`.
+
+### Changed
+- Removed linebreak parser from BBCode default parsers list.
+
 ## [1.0.3] - 2017-07-18
 ### Added
 - Newline parser

README.md

@@ -119,6 +119,9 @@ $bbCode->addParser(
 $bbCode->convertToHtml('[link target=www.yourlinkhere.com]Text to be displayed[/link].');
 ```
 
+### `addLinebreakParser()`
+
+Adds linebreak parser to BBCode parsers list to convert newlines to `<br />` in HTML.
 
 ## Laravel installation
 

src/BBCode.php

@@ -11,7 +11,8 @@
 use Genert\BBCode\Parser\BBCodeParser;
 use Genert\BBCode\Parser\HTMLParser;
 
-final class BBCode {
+final class BBCode
+{
     private $htmlParser;
     private $bbCodeParser;
 
@@ -60,4 +61,9 @@ public function addParser(string $name, string $pattern, string $replace, string
 
         return $this;
     }
+
+    public function addLinebreakParser()
+    {
+        return $this->addParser('linebreak', '/[\r\n]/', '<br />', '');
+    }
 }

src/Parser/BBCodeParser.php

@@ -8,7 +8,8 @@
 
 namespace Genert\BBCode\Parser;
 
-final class BBCodeParser extends Parser {
+final class BBCodeParser extends Parser
+{
     protected $parsers = [
         'bold' => [
             'pattern' => '/\[b\](.*?)\[\/b\]/s',
@@ -110,11 +111,6 @@ final class BBCodeParser extends Parser {
             'replace' => '<td>$1</td>',
             'content' => '$1',
         ],
-        'linebreak' => [
-            'pattern' => '/\r\n/',
-            'replace' => '<br />',
-            'content' => '',
-        ],
     ];
 
     public function stripTags(string $source): string

src/Parser/HTMLParser.php

@@ -8,7 +8,8 @@
 
 namespace Genert\BBCode\Parser;
 
-final class HTMLParser extends Parser {
+final class HTMLParser extends Parser
+{
     protected $parsers = [
         'bold' => [
             'pattern' => '/<strong>(.*?)<\/strong>|<b>(.*?)<\/b>/s',

src/Parser/Parser.php

@@ -8,7 +8,8 @@
 
 namespace Genert\BBCode\Parser;
 
-class Parser {
+class Parser
+{
     /**
      * Static case insensitive flag to enable
      * case insensitivity when parsing BBCode.

tests/ParserTest.php

@@ -9,8 +9,10 @@
 use PHPUnit\Framework\TestCase;
 use Genert\BBCode\BBCode;
 
-class ParserTest extends TestCase {
-    public function testParser() {
+class ParserTest extends TestCase
+{
+    public function testParser()
+    {
         $bbCode = new BBCode();
 
         $this->assertNotNull($bbCode);
@@ -160,6 +162,60 @@ public function testBBCodeReturnsCorrectHtml() {
         $this->assertEquals($output, $bbCode->convertToHtml($input));
     }
 
+    // https://github.com/Genert/bbcode/issues/2
+    public function testCustomBulletsListBBCodeConversion()
+    {
+        $bbCode = new BBCode();
+
+        $input = '
+            [ul]
+                [li]List item 1[/li]
+                [li]List item 2[/li]
+                [li]List item 3[/li]
+            [/ul]
+        ';
+
+        $bbCode->addParser(
+            'bullet_list',
+            '/\[ul\](.*?)\[\/ul\]/s',
+            '<ul>$1</ul>',
+            '$1'
+        );
+
+        $bbCode->addParser(
+            'list_item',
+            '/\[li\](.*?)\[\/li\]/',
+            '<li>$1</li>',
+            '$1'
+        );
+
+        $output = '
+            <ul>
+                <li>List item 1</li>
+                <li>List item 2</li>
+                <li>List item 3</li>
+            </ul>
+        ';
+
+        $this->assertEquals($output, $bbCode->convertToHtml($input));
+    }
+
+    public function testAddNewLineBBCodeConversion()
+    {
+        $bbCode = new BBCode();
+
+        $bbCode->addNewlineParser();
+
+        $input = '[b]bold[/b]
+            [i]italic[/i]
+            [u]underline[/u]
+            [s]line through[/s]';
+
+        $output = trim('<b>bold</b><br />            <i>italic</i><br />            <u>underline</u><br />            <s>line through</s>');
+
+        $this->assertEquals($output, $bbCode->convertToHtml($input));
+    }
+
     public function testCaseSensitivity()
     {
         $bbCode = new BBCode();