Add basic tests and MarkdownConverter interface

Author: alies-dev

.editorconfig

@@ -0,0 +1,14 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+max_line_length = 120
+tab_width = 4
+
+[*.{yml,yaml}]
+indent_size = 2

.github/workflows/run-tests.yml

@@ -0,0 +1,46 @@
+name: run-tests
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: true
+      matrix:
+        os: [ubuntu-latest]
+        php: [8.0, 8.1]
+        laravel: [8.*]
+        dependency-version: [prefer-stable]
+        include:
+          -   laravel: 8.*
+              testbench: 6.*
+
+    name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.dependency-version }} - ${{ matrix.os }}
+
+    steps:
+      -   name: Checkout code
+          uses: actions/checkout@v2
+
+      -   name: Setup PHP
+          uses: shivammathur/setup-php@v2
+          with:
+            php-version: ${{ matrix.php }}
+            extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick, fileinfo
+            coverage: none
+
+      -   name: Setup problem matchers
+          run: |
+            echo "::add-matcher::${{ runner.tool_cache }}/php.json"
+            echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
+
+      -   name: Install dependencies
+          run: |
+            composer config "http-basic.nova.laravel.com" "${{ secrets.NOVA_USERNAME }}" "${{ secrets.NOVA_PASSWORD }}"
+            composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" --no-interaction --no-update
+            composer update --${{ matrix.dependency-version }} --prefer-dist --no-interaction
+          env:
+            COMPOSER_AUTH: ${{ secrets.COMPOSER_AUTH }}
+
+      -   name: Execute tests
+          run: vendor/bin/phpunit

.gitignore

@@ -1,10 +1,15 @@
-/.idea
-/vendor
 /node_modules
+yarn.lock
 package-lock.json
+
+/vendor
 composer.phar
 composer.lock
+auth.json
+
 phpunit.xml
 .phpunit.result.cache
+
 .DS_Store
 Thumbs.db
+/.idea

composer.json

@@ -11,13 +11,29 @@
     ],
     "license": "MIT",
     "require": {
-        "php": ">=7.1.0"
+        "php": ">=8.0",
+        "laravel/nova": "^3.0"
     },
+    "require-dev": {
+        "mockery/mockery": "^1.4",
+        "orchestra/testbench": "^6.0",
+        "phpunit/phpunit": "^9.4"
+    },
+    "repositories": [
+        {
+            "type": "composer", "url": "https://nova.laravel.com"
+        }
+    ],
     "autoload": {
         "psr-4": {
             "IDF\\HtmlCard\\": "src/"
         }
     },
+    "autoload-dev": {
+        "psr-4": {
+            "IDF\\HtmlCard\\Tests\\": "tests"
+        }
+    },
     "extra": {
         "laravel": {
             "providers": [

phpunit.xml.dist

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/autoload.php" backupGlobals="false" backupStaticAttributes="false" colors="true" verbose="true" convertErrorsToExceptions="true" convertNoticesToExceptions="true" convertWarningsToExceptions="true" processIsolation="false" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.4/phpunit.xsd">
+    <coverage>
+        <include>
+            <directory suffix=".php">src/</directory>
+        </include>
+    </coverage>
+    <testsuites>
+        <testsuite name="IxDF Test Suite">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+    <php>
+    </php>
+</phpunit>

src/CardServiceProvider.php

@@ -2,16 +2,15 @@
 
 namespace IDF\HtmlCard;
 
+use Illuminate\Contracts\Support\DeferrableProvider;
 use Laravel\Nova\Nova;
 use Laravel\Nova\Events\ServingNova;
-use Illuminate\Support\Facades\Route;
 use Illuminate\Support\ServiceProvider;
 
-class CardServiceProvider extends ServiceProvider
+class CardServiceProvider extends ServiceProvider implements DeferrableProvider
 {
     /**
      * Bootstrap any application services.
-     *
      * @return void
      */
     public function boot()
@@ -20,4 +19,18 @@ public function boot()
             Nova::script('html-card', __DIR__.'/../dist/js/card.js');
         });
     }
+
+    /** @inheritDoc */
+    public function register(): void
+    {
+        $this->app->singleton(MarkdownConverter::class, LaravelMarkdownConverter::class);
+    }
+
+    /** @inheritDoc */
+    public function provides(): array
+    {
+        return [
+            MarkdownConverter::class,
+        ];
+    }
 }

src/HtmlCard.php

@@ -3,6 +3,7 @@
 namespace IDF\HtmlCard;
 
 use Illuminate\Mail\Markdown;
+use Illuminate\Support\Facades\App;
 use Laravel\Nova\Card;
 
 class HtmlCard extends Card
@@ -18,7 +19,6 @@ class HtmlCard extends Card
      * Create a new element.
      *
      * @param  string|null  $component
-     * @return void
      */
     public function __construct($component = null)
     {
@@ -59,7 +59,7 @@ public function html(string $htmlContent)
      */
     public function markdown(string $markdownContent)
     {
-        $htmlContent = Markdown::parse($markdownContent)->toHtml();
+        $htmlContent = App::make(MarkdownConverter::class)::parse($markdownContent)->toHtml();
 
         return $this->html($htmlContent);
     }
@@ -74,7 +74,7 @@ public function markdown(string $markdownContent)
      */
     public function view(string $view, array $viewData = [])
     {
-        $htmlContent = view($view, $viewData);
+        $htmlContent = view($view, $viewData)->render();
 
         return $this->html($htmlContent);
     }

src/LaravelMarkdownConverter.php

@@ -0,0 +1,10 @@
+<?php declare(strict_types=1);
+
+namespace IDF\HtmlCard;
+
+use Illuminate\Mail\Markdown;
+
+final class LaravelMarkdownConverter extends Markdown implements MarkdownConverter
+{
+
+}

src/MarkdownConverter.php

@@ -0,0 +1,13 @@
+<?php declare(strict_types=1);
+
+namespace IDF\HtmlCard;
+
+interface MarkdownConverter
+{
+    /**
+     * Parse the given Markdown text into HTML.
+     * @param string $text
+     * @return \Illuminate\Support\HtmlString
+     */
+    public static function parse($text);
+}

tests/CardServiceProviderTest.php

@@ -0,0 +1,17 @@
+<?php declare(strict_types=1);
+
+namespace IDF\HtmlCard\Tests;
+
+use IDF\HtmlCard\MarkdownConverter;
+use Illuminate\Support\Facades\App;
+
+final class CardServiceProviderTest extends TestCase
+{
+    /** @test */
+    public function it_registers_markdown_converter_implementation(): void
+    {
+        $converter = App::make(MarkdownConverter::class);
+
+        $this->assertInstanceOf(MarkdownConverter::class, $converter);
+    }
+}