Merge pull request deanblackborough#27 from deanblackborough/v1.00.0

V1.00.0

Author: deanblackborough

CHANGELOG.md

@@ -3,6 +3,11 @@
 
 Full changelog for PHP Quill Renderer
 
+## 1.00.0 - 2017-08-31
+
+* Added support for ordered and unordered lists.
+* Updated README, notes on version 2.00.0
+
 ## v0.90 - 2017-06-06
 
 * Added support for paragraph breaks, converts double newlines from quill insert into a new p tag, the

README.md

@@ -9,9 +9,11 @@
 
 ## Description
 
-Simple Quill delta insert renderer, currently it only supports the attributes listed below, I will add support for additional attributes as I need them in Dlayer.
+Quill deltas renderer, converts deltas to HTML, the attributes supported by version 1.00.0 are listed below. 
+Version 2.00.0 is in development, I'm working on support for additional Quill attributes, markdown support and a 
+full rewrite of the parser, version 2.00.0 will only support PHP7+. 
 
-Created for use in [Dlayer](https://github.com/Dlayer/dlayer) but works as a stand-alone tool.
+Created for use within [Dlayer](https://github.com/Dlayer/dlayer) but works as a stand-alone tool.
 
 ## Installation
 
@@ -60,14 +62,16 @@ Script:Super | `<sup>`
 Underline | `<u>`
 Header | `<h[n]>`
 Image | `<img>`
+List | `<ul>` `<ol>`
 
-## Planned features
+## Planned features for version 2.00.0
 
+* Parser logic rework
 * Markdown support
-* Lists (Bullets and Ordered)
 * Formatting options (justification etc.)
-* Remaining toolbar options
-* Missing tests (options)
+* Remaining Quill toolbar options
+* Full options management
+* Tests
 
 ## Warnings
 

src/Parser/Html.php

@@ -95,6 +95,20 @@ protected function defaultAttributeOptions()
                     'href' => null
                 )
             ),
+            'list' => array(
+                'ordered' => array(
+                    'tag' => 'li',
+                    'type' => 'block',
+                    'assign' => 'previous',
+                    'parent_tag' => 'ol'
+                ),
+                'unordered' => array(
+                    'tag' => 'li',
+                    'type' => 'block',
+                    'assign' => 'previous',
+                    'parent_tag' => 'ul'
+                )
+            ),
             'script' => array(
                 'sub' => array(
                     'type' => 'inline',
@@ -136,6 +150,7 @@ private function getTagAndAttributes($attribute, $value)
                 break;
 
             case 'header':
+            case 'list':
             case 'script':
                 return $this->options['attributes'][$attribute][$value];
                 break;
@@ -281,10 +296,19 @@ private function assignTags()
                         $tag_counter = $i - 1;
                     }
 
+                    $parent_tags = array('open' => null, 'close' => null);
+                    if (array_key_exists('parent_tag', $tag) === true) {
+                        $parent_tags = array (
+                            'open' => '<' . $tag['parent_tag'] . '>',
+                            'close' => '</' . $tag['parent_tag'] . '>',
+                        );
+                    }
+
                     $this->content[$tag_counter]['tags'][] = array(
                         'open' => $open,
                         'close' => '</' . $tag['tag'] . '>',
-                        'type' => $tag['type']
+                        'type' => $tag['type'],
+                        'parent_tags' => $parent_tags
                     );
                 }
             }
@@ -357,7 +381,8 @@ private function convertBreaks()
     /**
      * Loops through the deltas object and generate the contents array
      *
-     * @todo Not keen on the close and remove methods, need to go through logic and try to remove need for them
+     * @todo Not keen on the close*() and remove*() methods, I need to go through the logic and try to
+     * remove the need for them by moving the logic into the assign tags function
      *
      * @return boolean
      */
@@ -379,6 +404,8 @@ public function parse()
 
             $this->convertBreaks();
 
+            $this->removeRedundantParentTags();
+
             return true;
         } else {
             return false;
@@ -518,9 +545,43 @@ public function setAttributeOption($option, $value)
                 break;
             case 'header':
             case 'link':
+            case 'list':
                 return false;
                 break;
 
         }
     }
+
+    /**
+     * Remove any redundant parent tags. Using lists as an example, each LI will have open and close
+     * parent tags assigned to it.
+     *
+     * @return void
+     */
+    private function removeRedundantParentTags()
+    {
+        $existing_content = $this->content;
+        $this->content = array();
+        foreach ($existing_content as $k => $content) {
+            if ($k !== 0 &&
+                array_key_exists('tags', $content) === true &&
+                count($content['tags']) === 1 &&
+                array_key_exists('parent_tags', $content['tags'][0]) === true) {
+                /**
+                 * Check the preview content item, if it has parent tags, remove the close and
+                 * remove the parent tag open from the current item before assigning back to the
+                 * new content array
+                 */
+                if (array_key_exists('tags', $this->content[($k-1)]) === true &&
+                    count($this->content[($k-1)]['tags']) === 1 &&
+                    array_key_exists('parent_tags', $this->content[($k-1)]['tags'][0]) === true) {
+
+                    $this->content[($k-1)]['tags'][0]['parent_tags']['close'] = null;
+                    $content['tags'][0]['parent_tags']['open'] = null;
+                }
+            }
+
+            $this->content[] = $content;
+        }
+    }
 }

src/Parser/Parse.php

@@ -107,23 +107,30 @@ protected function isAttributeValid($attribute, $value)
                     $valid = true;
                 }
                 break;
-            case 'script':
+            case 'link':
                 if (array_key_exists('attributes', $this->options) === true &&
                     array_key_exists($attribute, $this->options['attributes']) === true &&
-                    in_array($value, array('sub', 'super')) === true) {
+                    strlen($value) > 0) {
 
                     $valid = true;
                 }
                 break;
-            case 'link':
+            case 'list':
                 if (array_key_exists('attributes', $this->options) === true &&
                     array_key_exists($attribute, $this->options['attributes']) === true &&
-                    strlen($value) > 0) {
+                    in_array($value, array('ordered', 'unordered')) === true) {
 
                     $valid = true;
                 }
                 break;
+            case 'script':
+                if (array_key_exists('attributes', $this->options) === true &&
+                    array_key_exists($attribute, $this->options['attributes']) === true &&
+                    in_array($value, array('sub', 'super')) === true) {
 
+                    $valid = true;
+                }
+                break;
 
             default:
                 // Do nothing, valid already set to false

src/Renderer/Html.php

@@ -39,6 +39,11 @@ public function render()
     {
         foreach ($this->content as $content) {
             foreach ($content['tags'] as $tag) {
+                if (array_key_exists('parent_tags', $tag) === true && $tag['parent_tags'] !== null &&
+                    array_key_exists('open', $tag['parent_tags']) && $tag['parent_tags']['open'] !== null) {
+                    $this->html .= $tag['parent_tags']['open'];
+                }
+
                 if (array_key_exists('open', $tag) === true && $tag['open'] !== null) {
                     $this->html .= $tag['open'];
                 }
@@ -54,6 +59,11 @@ public function render()
                 if (array_key_exists('close', $tag) === true && $tag['close'] !== null) {
                     $this->html .= $tag['close'];
                 }
+
+                if (array_key_exists('parent_tags', $tag) === true && $tag['parent_tags'] !== null &&
+                    array_key_exists('close', $tag['parent_tags']) && $tag['parent_tags']['close'] !== null) {
+                    $this->html .= $tag['parent_tags']['close'];
+                }
             }
         }
 

tests/ListTest.php

@@ -0,0 +1,28 @@
+<?php
+
+require_once __DIR__ . '../../src/Render.php';
+require_once __DIR__ . '../../src/Renderer/Render.php';
+require_once __DIR__ . '../../src/Renderer/Html.php';
+require_once __DIR__ . '../../src/Parser/Parse.php';
+require_once __DIR__ . '../../src/Parser/Html.php';
+
+final class ListTest extends \PHPUnit\Framework\TestCase
+{
+    public function testSimpleOrderedList()
+    {
+        $delta = '{"ops":[{"insert":"Item 1"},{"attributes":{"list":"ordered"},"insert":"\n"},{"insert":"Item 2"},{"attributes":{"list":"ordered"},"insert":"\n"},{"insert":"Item 3"},{"attributes":{"list":"ordered"},"insert":"\n"}]}';
+        $expected = '<ol><li>Item 1</li><li>Item 2</li><li>Item 3</li></ol>';
+
+        $quill = new \DBlackborough\Quill\Render($delta);
+        $this->assertEquals($expected, $quill->render());
+    }
+
+    public function testSimpleUnorderedList()
+    {
+        $delta = '{"ops":[{"insert":"Item 1"},{"attributes":{"list":"unordered"},"insert":"\n"},{"insert":"Item 2"},{"attributes":{"list":"unordered"},"insert":"\n"},{"insert":"Item 3"},{"attributes":{"list":"unordered"},"insert":"\n"}]}';
+        $expected = '<ul><li>Item 1</li><li>Item 2</li><li>Item 3</li></ul>';
+
+        $quill = new \DBlackborough\Quill\Render($delta);
+        $this->assertEquals($expected, $quill->render());
+    }
+}