Merge pull request #23 from deanblackborough/v0.80

V0.80

.travis.yml

@@ -1,9 +1,7 @@
 language: php
 php:
-  - '5.6'
   - '7.0'
   - '7.1'
-  - hhvm
 
 notifications:
   email:

CHANGELOG.md

@@ -3,6 +3,14 @@
 
 Full changelog for PHP Quill Renderer
 
+## v0.80.0 
+
+* I'm now only testing against PHP 7+. [Tests]
+* Added tests for setting attributes. [Tests]
+* Switched to PSR4
+* Minor change to API if using Quill (Render) class, after the PSR4 change I didn't like Quill/Quill.
+* Basic support for images (outputting the base64 directly via <img> src="")
+
 ## v0.70.0 - 2017-04-19
 
 * Added the ability to set the HTML tag for the following Quill attributes, bold, italic, script, strike and underline. [Feature]

README.md

@@ -18,17 +18,17 @@ Created for use in [Dlayer](https://github.com/Dlayer/dlayer) but works as a sta
 The easiest way to use the renderer is with composer. ```composer require deanblackborough/php-quill-renderer```, 
 alternatively include the classes in src/ in your library.
 
-## Usage, using Quill API
+## Usage
 ```
 try {
-    $quill = new \DBlackborough\Quill($deltas, 'HTML');
+    $quill = new \DBlackborough\Quill\Render($deltas, 'HTML');
     echo $quill->render();
 } catch (\Exception $e) {
     echo $e->getMessage();
 }
 ```
 
-## Usage, direct
+## Usage, direct, parse and then render
 ```
 $parser = new \DBlackborough\Quill\Parser\Html();
 $parser->load($deltas);
@@ -59,13 +59,13 @@ Script:Sub | `<sub>`
 Script:Super | `<sup>`
 Underline | `<u>`
 Header | `<h[n]>`
+Image | `<img>`
 
-## Planned features in possible order
+## Planned features
 
+* Markdown support
 * Lists (Bullets and Ordered)
-* Formatting
+* Formatting options (justification etc.)
 * Improved newline and paragraph support
-* External images
 * Remaining toolbar options
 * Missing tests (options)
-* Markdown support

composer.json

@@ -1,9 +1,9 @@
 {
     "name": "deanblackborough/php-quill-renderer",
-    "description": "Render quill insert deltas to HTML",
+    "description": "Render quill insert deltas to HTML and soon markdown",
     "autoload": {
-        "psr-0" : {
-            "DBlackborough\\Quill" : "src"
+        "psr-4" : {
+            "DBlackborough\\Quill\\" : "src/DBlackborough/Quill"
         }
     },
     "homepage": "https://github.com/deanblackborough/php-quill-renderer",

example/index.php

@@ -1,15 +1,15 @@
 <?php
 
-require_once '../src/DBlackborough/Quill.php';
-require_once '../src/DBlackborough/Quill/Renderer.php';
-require_once '../src/DBlackborough/Quill/Renderer/Html.php';
-require_once '../src/DBlackborough/Quill/Parser.php';
-require_once '../src/DBlackborough/Quill/Parser/Html.php';
+require_once '../src/Render.php';
+require_once '../src/Renderer/Render.php';
+require_once '../src/Renderer/Html.php';
+require_once '../src/Parser/Parse.php';
+require_once '../src/Parser/Html.php';
 
 $deltas = '{"ops":[{"insert":"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed efficitur nibh tempor augue lobortis, nec eleifend velit venenatis. Nullam fringilla dui eget lectus mattis tincidunt. \nDonec sollicitudin, lacus sed luctus ultricies, "},{"attributes":{"strike":true,"italic":true},"insert":"quam sapien "},{"attributes":{"strike":true},"insert":"sollicitudin"},{"insert":" quam, nec auctor eros felis elementum quam. Fusce vel mollis enim. \n\n"},{"attributes":{"bold":true},"insert":"Sed ac augue tincidunt,"},{"insert":" cursus urna a, tempus ipsum. Donec pretium fermentum erat a "},{"attributes":{"underline":true},"insert":"elementum"},{"insert":". In est odio, mattis sed dignissim sed, porta ac nisl. Nunc et tellus imperdiet turpis placerat tristique nec quis justo. Aenean nisi libero, auctor a laoreet sed, fermentum vel massa.\n\nEtiam ultricies leo eget purus tempor dapibus. Integer ac sapien eros. Suspendisse convallis ex."}]}';
 
 try {
-    $quill = new \DBlackborough\Quill($deltas, 'HTML');
+    $quill = new \DBlackborough\Quill\Render($deltas, 'HTML');
     echo $quill->render();
 } catch (\Exception $e) {
     echo $e->getMessage();

src/DBlackborough/Quill/Parser/Html.php → src/Parser/Html.php

@@ -2,8 +2,7 @@
 
 namespace DBlackborough\Quill\Parser;
 
-use DBlackborough\Quill\Parser;
-use PHPUnit\Runner\Exception;
+use \Exception;
 
 /**
  * Parser for HTML, parses the deltas to generate a content array for  deltas into a html redy array
@@ -12,7 +11,7 @@
  * @copyright Dean Blackborough
  * @license https://github.com/deanblackborough/php-quill-renderer/blob/master/LICENSE
  */
-class Html extends Parser
+class Html extends Parse
 {
     /**
      * Renderer constructor.
@@ -199,7 +198,9 @@ private function splitDeltas()
         $this->deltas = array();
 
         foreach ($deltas as $delta) {
-            if (array_key_exists('insert', $delta) === true && array_key_exists('attributes', $delta) === false &&
+            if (array_key_exists('insert', $delta) === true &&
+                array_key_exists('attributes', $delta) === false &&
+                is_array($delta['insert']) === false &&
                 preg_match("/[\n]{2}/", $delta['insert']) !== 0) {
 
                 foreach (explode("\n\n", $delta['insert']) as $match) {
@@ -281,8 +282,15 @@ private function assignTags()
                 }
             }
 
-            if (array_key_exists('insert', $insert) === true && strlen(trim($insert['insert'])) > 0) {
-                $this->content[$i]['content'] = $insert['insert'];
+            if (array_key_exists('insert', $insert) === true) {
+                if (is_array($insert['insert']) === false && strlen(trim($insert['insert'])) > 0) {
+                    $this->content[$i]['content'] = $insert['insert'];
+                } else {
+                    if (is_array($insert['insert']) === true &&
+                        array_key_exists('image', $insert['insert']) === true) {
+                        $this->content[$i]['content'] = [ 'image' => $insert['insert']['image'] ];
+                    }
+                }
             }
 
             $i++;
@@ -357,7 +365,7 @@ private function removeEmptyElements()
         $existing_content = $this->content;
         $this->content = array();
         foreach ($existing_content as $content) {
-            if (strlen($content['content']) !== 0) {
+            if (is_array($content['content']) === true || strlen($content['content']) !== 0) {
                 $this->content[] = $content;
             }
         }
@@ -461,7 +469,7 @@ private function validateAndSetAttributeOption($option, $value)
      * @param mixed $value New Attribute option value
      *
      * @return boolean
-     * @throws Exception
+     * @throws \Exception
      */
     public function setAttributeOption($option, $value)
     {

src/DBlackborough/Quill/Parser.php → src/Parser/Parse.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace DBlackborough\Quill;
+namespace DBlackborough\Quill\Parser;
 
 /**
  * Quill parser, parses deltas json array and generates a content array for the renderer
@@ -9,7 +9,7 @@
  * @copyright Dean Blackborough
  * @license https://github.com/deanblackborough/php-quill-renderer/blob/master/LICENSE
  */
-abstract class Parser
+abstract class Parse
 {
     /**
      * Delta inserts
@@ -147,7 +147,7 @@ public function getOptions()
      * Set all the attribute options for the parser/renderer
      *
      * @param array $options
-     * @return \DBlackborough\Quill\Parser
+     * @return \DBlackborough\Quill\Parse
      */
     abstract public function setAttributeOptions(array $options);
 

src/DBlackborough/Quill.php → src/Render.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace DBlackborough;
+namespace DBlackborough\Quill;
 
 /**
  * Parse Quill generated deltas to the requested format
@@ -9,15 +9,15 @@
  * @copyright Dean Blackborough
  * @license https://github.com/deanblackborough/php-quill-renderer/blob/master/LICENSE
  */
-class Quill
+class Render
 {
     /**
-     * @var \DBlackborough\Quill\Renderer
+     * @var \DBlackborough\Quill\Renderer\Render
      */
     private $renderer;
 
     /**
-     * @var \DBlackborough\Quill\Parser
+     * @var \DBlackborough\Quill\Parser\Parse
      */
     private $parser;
 
@@ -62,7 +62,7 @@ public function __construct($deltas, $format='HTML')
      */
     public function setAttributeOption($option, $value)
     {
-        if (is_a($this->parser, '\DBlackborough\Quill\Parser') === true) {
+        if (is_a($this->parser, '\DBlackborough\Quill\Parser\Parse') === true) {
             return $this->parser->setAttributeOption($option, $value);
         } else {
             throw new \Exception('Parser not instantiated, can only set options after instantiating object');

src/DBlackborough/Quill/Renderer/Html.php → src/Renderer/Html.php

@@ -2,16 +2,14 @@
 
 namespace DBlackborough\Quill\Renderer;
 
-use DBlackborough\Quill\Renderer;
-
 /**
  * Quill renderer, converts quill delta inserts into HTML
  *
  * @author Dean Blackborough <dean@g3d-development.com>
  * @copyright Dean Blackborough
  * @license https://github.com/deanblackborough/php-quill-renderer/blob/master/LICENSE
  */
-class Html extends Renderer
+class Html extends Render
 {
     /**
      * The generated HTML, string generated by the render method from the content array
@@ -46,7 +44,11 @@ public function render()
                 }
             }
 
-            $this->html .= $content['content'];
+            if (is_array($content['content']) === false) {
+                $this->html .= $content['content'];
+            } else {
+                $this->html .= '<img src="' . $content['content']['image'] . '" />';
+            }
 
             foreach (array_reverse($content['tags']) as $tag) {
                 if (array_key_exists('close', $tag) === true && $tag['close'] !== null) {

src/DBlackborough/Quill/Renderer.php → src/Renderer/Render.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace DBlackborough\Quill;
+namespace DBlackborough\Quill\Renderer;
 
 /**
  * Quill renderer, iterates over the content data array and creates html
@@ -9,7 +9,7 @@
  * @copyright Dean Blackborough
  * @license https://github.com/deanblackborough/php-quill-renderer/blob/master/LICENSE
  */
-abstract class Renderer
+abstract class Render
 {
     /**
      * @var array

tests/BlockTest.php

@@ -1,10 +1,10 @@
 <?php
 
-require_once __DIR__ . '../../src/DBlackborough/Quill.php';
-require_once __DIR__ . '../../src/DBlackborough/Quill/Renderer.php';
-require_once __DIR__ . '../../src/DBlackborough/Quill/Renderer/Html.php';
-require_once __DIR__ . '../../src/DBlackborough/Quill/Parser.php';
-require_once __DIR__ . '../../src/DBlackborough/Quill/Parser/Html.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 BlockTest extends \PHPUnit\Framework\TestCase
 {
@@ -14,7 +14,7 @@ final class BlockTest extends \PHPUnit\Framework\TestCase
     public function testValidDeltasSimpleString()
     {
         try {
-            $quill = new \DBlackborough\Quill($this->deltas_simple_string, 'HTML');
+            $quill = new \DBlackborough\Quill\Render($this->deltas_simple_string, 'HTML');
             $this->assertTrue(true);
         } catch (\Exception $e) {
             $this->fail(__METHOD__ . ' failure');
@@ -24,7 +24,7 @@ public function testValidDeltasSimpleString()
     public function testInvalidDeltasCaught()
     {
         try {
-            $quill = new \DBlackborough\Quill($this->deltas_missing_quote, 'HTML');
+            $quill = new \DBlackborough\Quill\Render($this->deltas_missing_quote, 'HTML');
             $this->fail(__METHOD__ . ' failure');
         } catch (\Exception $e) {
             $this->assertTrue(true);
@@ -35,7 +35,7 @@ public function testOutputSimpleString()
     {
         $expected = '<p>Lorem ipsum dolor sit amet</p>';
 
-        $quill = new \DBlackborough\Quill($this->deltas_simple_string);
+        $quill = new \DBlackborough\Quill\Render($this->deltas_simple_string);
         $this->assertEquals($expected, $quill->render());
     }
 }