Merge pull request alaminfirdows#8 from alaminfirdows/tests

test: introduce unit-testing

Author: alaminfirdows

.gitignore

@@ -3,6 +3,7 @@
 /public/storage
 /storage/*.key
 /vendor
+/.phpunit.cache
 composer.lock
 .env
 .env.backup

composer.json

@@ -28,6 +28,9 @@
 			"AlAminFirdows\\LaravelEditorJs\\Tests\\": "tests/"
 		}
 	},
+    "scripts": {
+        "test": "./vendor/bin/phpunit"
+    },
 	"extra": {
 		"laravel": {
 			"providers": [

phpunit.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.6/phpunit.xsd" bootstrap="vendor/autoload.php" cacheResultFile=".phpunit.cache/test-results" colors="true">
+    <testsuites>
+        <testsuite name="Unit">
+            <directory suffix="Test.php">./tests/Unit</directory>
+        </testsuite>
+        <testsuite name="Feature">
+            <directory suffix="Test.php">./tests/Feature</directory>
+        </testsuite>
+    </testsuites>
+
+    <coverage cacheDirectory=".phpunit.cache/code-coverage" processUncoveredFiles="true">
+        <include>
+            <directory suffix=".php">src</directory>
+        </include>
+    </coverage>
+</phpunit>

resources/views/blocks/paragraph.blade.php

@@ -1,3 +1 @@
-<p>
-    {{ $data['text'] }}
-</p>
+<p>{{ $data['text'] }}</p>

src/LaravelEditorJs.php

@@ -4,8 +4,9 @@
 
 use EditorJS\EditorJS;
 use EditorJS\EditorJSException;
-use Illuminate\Support\Str;
+use Exception;
 use Illuminate\Support\Facades\View;
+use Illuminate\Support\Str;
 
 class LaravelEditorJs
 {
@@ -15,7 +16,7 @@ class LaravelEditorJs
      * @param string $data
      * @return string
      */
-    public function render(string $data) : string
+    public function render(string $data): string
     {
         try {
             $configJson = json_encode(config('laravel_editorjs.config') ?: []);
@@ -28,7 +29,7 @@ public function render(string $data) : string
 
                 $viewName = "laravel_editorjs::blocks." . Str::snake($block['type'], '-');
 
-                if (! View::exists($viewName)) {
+                if (!View::exists($viewName)) {
                     $viewName = 'laravel_editorjs::blocks.not-found';
                 }
 
@@ -40,7 +41,7 @@ public function render(string $data) : string
 
             return implode($renderedBlocks);
         } catch (EditorJSException $e) {
-            throw new \Exception($e->getMessage());
+            throw new Exception($e->getMessage());
         }
     }
 }

src/LaravelEditorJsServiceProvider.php

@@ -39,4 +39,4 @@ public function boot()
             ], 'laravel_editorjs-views');
         }
     }
-}
+}

tests/Feature/Blocks/ListBlockTest.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace AlAminFirdows\LaravelEditorJs\Tests\Feature\Blocks;
+
+use AlAminFirdows\LaravelEditorJs\Tests\TestCase;
+
+class ListBlockTest extends TestCase
+{
+    protected function getBlockData()
+    {
+        return [
+            'type' => 'list',
+            'data' => [
+                'type' => 'unordered',
+                'items' => [
+                    'Hello',
+                    'World',
+                ],
+            ],
+        ];
+    }
+
+    protected function getBlockHtml()
+    {
+        return "<ul>        <li>Hello</li>        <li>World</li>    </ul>";
+    }
+
+    /** @test */
+    public function render_paragraph_block_test(): void
+    {
+        $this->assertEquals(
+            $this->renderBlocks($this->getEditorData([$this->getBlockData()])),
+            $this->getBlockHtml()
+        );
+    }
+}

tests/Feature/Blocks/ParagraphBlockTest.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace AlAminFirdows\LaravelEditorJs\Tests\Feature\Blocks;
+
+use AlAminFirdows\LaravelEditorJs\Tests\TestCase;
+
+class ParagraphBlockTest extends TestCase
+{
+    protected function getBlockData()
+    {
+        return [
+            'type' => 'paragraph',
+            'data' => [
+                'text' => 'Hello world!',
+            ],
+        ];
+    }
+
+    protected function getBlockHtml()
+    {
+        return "<p>Hello world!</p>";
+    }
+
+    /** @test */
+    public function render_paragraph_block_test(): void
+    {
+        $this->assertEquals(
+            $this->renderBlocks($this->getEditorData([$this->getBlockData()])),
+            $this->getBlockHtml()
+        );
+    }
+}

tests/TestCase.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace AlAminFirdows\LaravelEditorJs\Tests;
+
+use AlAminFirdows\LaravelEditorJs\Facades\LaravelEditorJs;
+use AlAminFirdows\LaravelEditorJs\LaravelEditorJsServiceProvider;
+
+abstract class TestCase extends \Orchestra\Testbench\TestCase
+{
+    protected function getPackageProviders($app)
+    {
+        return [
+            LaravelEditorJsServiceProvider::class,
+        ];
+    }
+
+    protected function getEditorData(array $blocks)
+    {
+        return json_encode([
+            'time'      => time(),
+            'blocks'    => $blocks,
+            'version'   => '2.28.0',
+        ]);
+    }
+
+    protected function renderBlocks(string $content)
+    {
+        return preg_replace('/\R+/', '', LaravelEditorJs::render($content));
+    }
+}

tests/Unit/RenderTest.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace AlAminFirdows\LaravelEditorJs\Tests\Unit;
+
+use AlAminFirdows\LaravelEditorJs\Tests\TestCase;
+
+class RenderTest extends TestCase
+{
+
+    /** @test */
+    public function render_test():void
+    {
+        $this->assertTrue(true);
+    }
+}