Add simplified tool settings

n0str · n0str · commit 3734340da9fa · 2018-10-31T20:12:52.000+03:00
diff --git a/EditorJS/BlockHandler.php b/EditorJS/BlockHandler.php
@@ -119,6 +119,9 @@ private function validate($rules, $blockData)
             }
 
             $rule = $rules[$key];
+
+            $rule = $this->expandToolSettings($rule);
+
             $elementType = $rule['type'];
 
             /**
@@ -128,6 +131,9 @@ private function validate($rules, $blockData)
                 if (!in_array($value, $rule['canBeOnly'])) {
                     throw new EditorJSException("Option '$key' with value `$value` has invalid value. Check canBeOnly param.");
                 }
+
+                // Do not perform additional elements validation in any case
+                continue;
             }
 
             /**
@@ -191,6 +197,7 @@ private function sanitize($rules, $blockData)
                 $rule = $rules[$key];
             }
 
+            $rule = $this->expandToolSettings($rule);
             $elementType = $rule['type'];
 
             /**
@@ -259,4 +266,48 @@ private function getDefaultPurifier()
 
         return $sanitizer;
     }
+
+    /**
+     * Check whether the array is associative or sequential
+     *
+     * @param array $arr – array to check
+     *
+     * @return bool – true if the array is associative
+     */
+    private function isAssoc(array $arr)
+    {
+        if ([] === $arr) {
+            return false;
+        }
+
+        return array_keys($arr) !== range(0, count($arr) - 1);
+    }
+
+    /**
+     * Expand shortified tool settings
+     *
+     * @param $rule – tool settings
+     *
+     * @throws EditorJSException
+     *
+     * @return array – expanded tool settings
+     */
+    private function expandToolSettings($rule)
+    {
+        if (is_string($rule)) {
+            // 'blockName': 'string' – tool with string type and default settings
+            $expandedRule = ["type" => "string"];
+        } elseif (is_array($rule)) {
+            if ($this->isAssoc($rule)) {
+                $expandedRule = $rule;
+            } else {
+                // 'blockName': [] – tool with canBeOnly and default settings
+                $expandedRule = ["type" => "string", "canBeOnly" => $rule];
+            }
+        } else {
+            throw new EditorJSException("Cannot determine element type of the rule `$rule`.");
+        }
+
+        return $expandedRule;
+    }
 }
diff --git a/tests/SyntaxSugarTest.php b/tests/SyntaxSugarTest.php
@@ -0,0 +1,59 @@
+<?php
+
+use EditorJS\EditorJS;
+use EditorJS\EditorJSException;
+
+/**
+ * Class SyntaxSugarTest
+ *
+ * Check simplified configuration structure
+ */
+class SyntaxSugarTest extends TestCase
+{
+    const CONFIGURATION_FILE = TESTS_DIR . "/samples/syntax-sugar.json";
+
+    /**
+     * Sample configuration
+     */
+    public $configuration;
+
+    /**
+     * Setup configuration
+     */
+    public function setUp()
+    {
+        $this->configuration = file_get_contents(SyntaxSugarTest::CONFIGURATION_FILE);
+    }
+
+    public function testShortTypeField()
+    {
+        $data = '{"blocks":[{"type":"header","data":{"text":"CodeX <b>Editor</b>", "level": 2}}]}';
+
+        $editor = new EditorJS($data, $this->configuration);
+        $result = $editor->getBlocks();
+
+        $this->assertEquals('CodeX Editor', $result[0]['data']['text']);
+        $this->assertEquals(2, $result[0]['data']['level']);
+    }
+
+    public function testShortTypeFieldCanBeOnly()
+    {
+        $callable = function () {
+            new EditorJS('{"blocks":[{"type":"header","data":{"text":"CodeX <b>Editor</b>", "level": 5}}]}',
+                $this->configuration);
+        };
+
+        $this->assertException($callable, EditorJSException::class, null, 'Option \'level\' with value `5` has invalid value. Check canBeOnly param.');
+    }
+
+    public function testMixedStructure()
+    {
+        $data = '{"time":1539180803359,"blocks":[{"type":"header","data":{"text":"<b>t</b><i>e</i><u>st</u>","level":2}}, {"type":"quote","data":{"text":"<b>t</b><i>e</i><u>st</u>","caption":"", "alignment":"left"}}]}';
+        $editor = new EditorJS($data, $this->configuration);
+        $result = $editor->getBlocks();
+
+        $this->assertEquals(2, count($result));
+        $this->assertEquals('test', $result[0]['data']['text']);
+        $this->assertEquals('<b>t</b><i>e</i>st', $result[1]['data']['text']);
+    }
+}
diff --git a/tests/samples/syntax-sugar.json b/tests/samples/syntax-sugar.json
@@ -0,0 +1,16 @@
+{
+  "tools": {
+    "header": {
+      "text": "string",
+      "level": [2, 3, 4]
+    },
+    "quote": {
+      "text": {
+        "type": "string",
+        "allowedTags": "i,b"
+      },
+      "caption": "string",
+      "alignment": ["left", "center"]
+    }
+  }
+}
