Merge pull request #17 from ARCANEDEV/update-laravel_7.x

Update the package to support Laravel 7
ARCANEDEV · Mar 5, 2020 · 234961e · 234961e
2 parents 11d24e8 + 12771f9
commit 234961e
Show file tree

Hide file tree

Showing 15 changed files with 96 additions and 65 deletions.
diff --git a/.github/workflows/run-tests.yml b/.github/workflows/run-tests.yml
@@ -1,6 +1,6 @@
 name: run-tests
 
-on: [push]
+on: [push, pull_request]
 
 jobs:
   tests:
@@ -10,7 +10,6 @@ jobs:
       fail-fast: true
       matrix:
         php: [7.2, 7.3, 7.4]
-        laravel: [6.*]
         dependency-version: [prefer-lowest, prefer-stable]
 
     name: PHP ${{ matrix.php }} - ${{ matrix.dependency-version }}
@@ -23,10 +22,10 @@ jobs:
         uses: actions/cache@v1
         with:
           path: ~/.composer/cache/files
-          key: dependencies-laravel-${{ matrix.laravel }}-php-${{ matrix.php }}-composer-${{ hashFiles('composer.json') }}
+          key: dependencies-laravel-7.x-php-${{ matrix.php }}-composer-${{ hashFiles('composer.json') }}
 
       - name: Setup PHP
-        uses: shivammathur/setup-php@v1
+        uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php }}
           extensions: curl, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, iconv

diff --git a/LICENSE.md b/LICENSE.md
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016-2019 | ARCANEDEV <arcanedev.maroc@gmail.com> - LaravelMarkdown
+Copyright (c) 2016-2020 | ARCANEDEV <arcanedev.maroc@gmail.com> - LaravelMarkdown
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -18,7 +18,7 @@ Feel free to check out the [releases](https://github.com/ARCANEDEV/LaravelMarkdo
 
 ### Features
 
-  * Laravel `5.1` to `6.x` are supported.
+  * Laravel `5.1` to `7.x` are supported.
   * Easy setup & configuration.
   * Well tested (100% code coverage with maximum code quality).
   * Made with :heart: &amp; :coffee:.
@@ -43,7 +43,7 @@ If you discover any security related issues, please email arcanedev.maroc@gmail.
 - [All Contributors][link-contributors]
 
 [badge_license]:     https://img.shields.io/packagist/l/arcanedev/laravel-markdown.svg?style=flat-square
-[badge_laravel]:     https://img.shields.io/badge/Laravel-5.1%20to%206.x-orange.svg?style=flat-square
+[badge_laravel]:     https://img.shields.io/badge/Laravel-5.1%20to%207.x-orange.svg?style=flat-square
 [badge_build]:       https://img.shields.io/github/workflow/status/ARCANEDEV/LaravelMarkdown/run-tests?style=flat-square
 [badge_coverage]:    https://img.shields.io/scrutinizer/coverage/g/ARCANEDEV/LaravelMarkdown.svg?style=flat-square
 [badge_quality]:     https://img.shields.io/scrutinizer/g/ARCANEDEV/LaravelMarkdown.svg?style=flat-square

diff --git a/_docs/0-Home.md b/_docs/0-Home.md
@@ -6,7 +6,7 @@ Feel free to check out the [releases](https://github.com/ARCANEDEV/LaravelMarkdo
 
 ### Features
 
-  * Laravel `5.1` to `6.x` are Supported.
+  * Laravel `5.1` to `7.x` are Supported.
   * Easy setup & configuration.
   * Well tested (100% code coverage with maximum code quality).
   * Made with :heart: &amp; :coffee:.

diff --git a/_docs/1-Installation-and-Setup.md b/_docs/1-Installation-and-Setup.md
@@ -4,33 +4,36 @@
 
 | Laravel Markdown                                                                              | Laravel                                                                                                             |
 |:----------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------|
-| ![Laravel Markdown v1.1.x][laravel_markdown_1_1_x]                                            | ![Laravel v5.0][laravel_5_0] ![Laravel v5.1][laravel_5_1] ![Laravel v5.2][laravel_5_2] ![Laravel v5.3][laravel_5_3] |
-| ![Laravel Markdown v1.2.x][laravel_markdown_1_2_x]                                            | ![Laravel v5.4][laravel_5_4]                                                                                        |
-| ![Laravel Markdown v1.3.x][laravel_markdown_1_3_x]                                            | ![Laravel v5.5][laravel_5_5]                                                                                        |
-| ![Laravel Markdown v1.4.x][laravel_markdown_1_4_x]                                            | ![Laravel v5.6][laravel_5_6]                                                                                        |
-| ![Laravel Markdown v1.5.x][laravel_markdown_1_5_x]                                            | ![Laravel v5.7][laravel_5_7]                                                                                        |
-| ![Laravel Markdown v1.6.x][laravel_markdown_1_6_x]                                            | ![Laravel v5.8][laravel_5_8]                                                                                        |
+| ![Laravel Markdown v4.x][laravel_markdown_4_x]                                                | ![Laravel v7.x][laravel_7_x]                                                                                        |
 | ![Laravel Markdown v2.x][laravel_markdown_2_x] ![Laravel Markdown v3.x][laravel_markdown_3_x] | ![Laravel v6.x][laravel_6_x]                                                                                        |
+| ![Laravel Markdown v1.6.x][laravel_markdown_1_6_x]                                            | ![Laravel v5.8][laravel_5_8]                                                                                        |
+| ![Laravel Markdown v1.5.x][laravel_markdown_1_5_x]                                            | ![Laravel v5.7][laravel_5_7]                                                                                        |
+| ![Laravel Markdown v1.4.x][laravel_markdown_1_4_x]                                            | ![Laravel v5.6][laravel_5_6]                                                                                        |
+| ![Laravel Markdown v1.3.x][laravel_markdown_1_3_x]                                            | ![Laravel v5.5][laravel_5_5]                                                                                        |
+| ![Laravel Markdown v1.2.x][laravel_markdown_1_2_x]                                            | ![Laravel v5.4][laravel_5_4]                                                                                        |
+| ![Laravel Markdown v1.1.x][laravel_markdown_1_1_x]                                            | ![Laravel v5.0][laravel_5_0] ![Laravel v5.1][laravel_5_1] ![Laravel v5.2][laravel_5_2] ![Laravel v5.3][laravel_5_3] |
 
-[laravel_5_0]:  https://img.shields.io/badge/v5.0-supported-brightgreen.svg?style=flat-square "Laravel v5.0"
-[laravel_5_1]:  https://img.shields.io/badge/v5.1-supported-brightgreen.svg?style=flat-square "Laravel v5.1"
-[laravel_5_2]:  https://img.shields.io/badge/v5.2-supported-brightgreen.svg?style=flat-square "Laravel v5.2"
-[laravel_5_3]:  https://img.shields.io/badge/v5.3-supported-brightgreen.svg?style=flat-square "Laravel v5.3"
-[laravel_5_4]:  https://img.shields.io/badge/v5.4-supported-brightgreen.svg?style=flat-square "Laravel v5.4"
-[laravel_5_5]:  https://img.shields.io/badge/v5.5-supported-brightgreen.svg?style=flat-square "Laravel v5.5"
-[laravel_5_6]:  https://img.shields.io/badge/v5.6-supported-brightgreen.svg?style=flat-square "Laravel v5.6"
-[laravel_5_7]:  https://img.shields.io/badge/v5.7-supported-brightgreen.svg?style=flat-square "Laravel v5.7"
-[laravel_5_8]:  https://img.shields.io/badge/v5.8-supported-brightgreen.svg?style=flat-square "Laravel v5.8"
+[laravel_7_x]:  https://img.shields.io/badge/v7.x-supported-brightgreen.svg?style=flat-square "Laravel v7.x"
 [laravel_6_x]:  https://img.shields.io/badge/v6.x-supported-brightgreen.svg?style=flat-square "Laravel v6.x"
+[laravel_5_8]:  https://img.shields.io/badge/v5.8-supported-brightgreen.svg?style=flat-square "Laravel v5.8"
+[laravel_5_7]:  https://img.shields.io/badge/v5.7-supported-brightgreen.svg?style=flat-square "Laravel v5.7"
+[laravel_5_6]:  https://img.shields.io/badge/v5.6-supported-brightgreen.svg?style=flat-square "Laravel v5.6"
+[laravel_5_5]:  https://img.shields.io/badge/v5.5-supported-brightgreen.svg?style=flat-square "Laravel v5.5"
+[laravel_5_4]:  https://img.shields.io/badge/v5.4-supported-brightgreen.svg?style=flat-square "Laravel v5.4"
+[laravel_5_3]:  https://img.shields.io/badge/v5.3-supported-brightgreen.svg?style=flat-square "Laravel v5.3"
+[laravel_5_2]:  https://img.shields.io/badge/v5.2-supported-brightgreen.svg?style=flat-square "Laravel v5.2"
+[laravel_5_1]:  https://img.shields.io/badge/v5.1-supported-brightgreen.svg?style=flat-square "Laravel v5.1"
+[laravel_5_0]:  https://img.shields.io/badge/v5.0-supported-brightgreen.svg?style=flat-square "Laravel v5.0"
 
-[laravel_markdown_1_1_x]: https://img.shields.io/badge/version-1.1.x-blue.svg?style=flat-square "Laravel Markdown v1.1.x"
-[laravel_markdown_1_2_x]: https://img.shields.io/badge/version-1.2.x-blue.svg?style=flat-square "Laravel Markdown v1.2.x"
-[laravel_markdown_1_3_x]: https://img.shields.io/badge/version-1.3.x-blue.svg?style=flat-square "Laravel Markdown v1.3.x"
-[laravel_markdown_1_4_x]: https://img.shields.io/badge/version-1.4.x-blue.svg?style=flat-square "Laravel Markdown v1.4.x"
-[laravel_markdown_1_5_x]: https://img.shields.io/badge/version-1.5.x-blue.svg?style=flat-square "Laravel Markdown v1.5.x"
-[laravel_markdown_1_6_x]: https://img.shields.io/badge/version-1.6.x-blue.svg?style=flat-square "Laravel Markdown v1.6.x"
-[laravel_markdown_2_x]:   https://img.shields.io/badge/version-2.x-blue.svg?style=flat-square "Laravel Markdown v2.x"
+[laravel_markdown_4_x]:   https://img.shields.io/badge/version-4.x-blue.svg?style=flat-square "Laravel Markdown v4.x"
 [laravel_markdown_3_x]:   https://img.shields.io/badge/version-3.x-blue.svg?style=flat-square "Laravel Markdown v3.x"
+[laravel_markdown_2_x]:   https://img.shields.io/badge/version-2.x-blue.svg?style=flat-square "Laravel Markdown v2.x"
+[laravel_markdown_1_6_x]: https://img.shields.io/badge/version-1.6.x-blue.svg?style=flat-square "Laravel Markdown v1.6.x"
+[laravel_markdown_1_5_x]: https://img.shields.io/badge/version-1.5.x-blue.svg?style=flat-square "Laravel Markdown v1.5.x"
+[laravel_markdown_1_4_x]: https://img.shields.io/badge/version-1.4.x-blue.svg?style=flat-square "Laravel Markdown v1.4.x"
+[laravel_markdown_1_3_x]: https://img.shields.io/badge/version-1.3.x-blue.svg?style=flat-square "Laravel Markdown v1.3.x"
+[laravel_markdown_1_2_x]: https://img.shields.io/badge/version-1.2.x-blue.svg?style=flat-square "Laravel Markdown v1.2.x"
+[laravel_markdown_1_1_x]: https://img.shields.io/badge/version-1.1.x-blue.svg?style=flat-square "Laravel Markdown v1.1.x"
 
 ## Composer
 

diff --git a/composer.json b/composer.json
@@ -14,15 +14,13 @@
     "type":    "library",
     "license": "MIT",
     "require": {
-        "php":                         ">=7.2.0",
-        "arcanedev/support":           "^5.1",
-        "league/commonmark":           "^1.2",
-        "league/commonmark-ext-table": "^2.1"
+        "php":                         "^7.2.5",
+        "arcanedev/support":           "^7.0",
+        "league/commonmark":           "^1.3"
     },
     "require-dev": {
-        "orchestra/testbench": "^4.0",
-        "phpunit/phpunit":     "^8.0",
-        "phpunit/phpcov":      "^6.0"
+        "orchestra/testbench": "^5.0",
+        "phpunit/phpunit":     "^8.5|^9.0"
     },
     "autoload": {
         "psr-4": {
@@ -42,5 +40,7 @@
                 "Arcanedev\\LaravelMarkdown\\Providers\\DeferredServicesProvider"
             ]
         }
-    }
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true
 }
diff --git a/src/Contracts/Markdown.php b/src/Contracts/Markdown.php
@@ -4,8 +4,6 @@
 
 namespace Arcanedev\LaravelMarkdown\Contracts;
 
-use Illuminate\Support\HtmlString;
-
 /**
  * Interface     Markdown
  *

diff --git a/src/Exceptions/ParserBufferingException.php b/src/Exceptions/ParserBufferingException.php
@@ -1,9 +1,26 @@
-<?php namespace Arcanedev\LaravelMarkdown\Exceptions;
+<?php
+
+declare(strict_types=1);
+
+namespace Arcanedev\LaravelMarkdown\Exceptions;
+
+use Exception;
 
 /**
  * Class     ParserBufferingException
  *
  * @package  Arcanedev\LaravelMarkdown\Exceptions
  * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
  */
-class ParserBufferingException extends \Exception {}
+class ParserBufferingException extends Exception
+{
+    /* -----------------------------------------------------------------
+     |  Main Methods
+     | -----------------------------------------------------------------
+     */
+
+    public static function notStarted(): self
+    {
+        return new static('Markdown buffering have not been started.');
+    }
+}
diff --git a/src/Parsers/AbstractParser.php b/src/Parsers/AbstractParser.php
@@ -61,7 +61,7 @@ public function begin(): void
     public function end(): HtmlString
     {
         if ($this->buffering === false) {
-            throw new ParserBufferingException('Markdown buffering have not been started.');
+            throw ParserBufferingException::notStarted();
         }
 
         $markdown        = ob_get_clean();

diff --git a/src/Parsers/CommonMarkParser.php b/src/Parsers/CommonMarkParser.php
@@ -7,7 +7,7 @@
 use Illuminate\Support\HtmlString;
 use League\CommonMark\CommonMarkConverter;
 use League\CommonMark\Environment;
-use League\CommonMark\Ext\Table\TableExtension;
+use League\CommonMark\Extension\Table\TableExtension;
 
 /**
  * Class     CommonMarkParser
@@ -31,7 +31,7 @@ class CommonMarkParser extends AbstractParser
      */
     public function parse(string $text): HtmlString
     {
-        $environment = tap(Environment::createCommonMarkEnvironment())
+        $environment = Environment::createCommonMarkEnvironment()
             ->addExtension(new TableExtension);
 
         $converter = new CommonMarkConverter([

diff --git a/src/Providers/DeferredServicesProvider.php b/src/Providers/DeferredServicesProvider.php
@@ -1,4 +1,8 @@
-<?php namespace Arcanedev\LaravelMarkdown\Providers;
+<?php
+
+declare(strict_types=1);
+
+namespace Arcanedev\LaravelMarkdown\Providers;
 
 use Arcanedev\LaravelMarkdown\Contracts\Markdown as MarkdownContract;
 use Arcanedev\LaravelMarkdown\Contracts\Parser;

diff --git a/tests/LaravelMarkdownServiceProviderTest.php b/tests/LaravelMarkdownServiceProviderTest.php
@@ -1,4 +1,8 @@
-<?php namespace Arcanedev\LaravelMarkdown\Tests;
+<?php
+
+declare(strict_types=1);
+
+namespace Arcanedev\LaravelMarkdown\Tests;
 
 use Arcanedev\LaravelMarkdown\LaravelMarkdownServiceProvider;
 
@@ -43,13 +47,13 @@ public function tearDown(): void
      */
 
     /** @test */
-    public function it_can_be_instantiated()
+    public function it_can_be_instantiated(): void
     {
         $expectations = [
             \Illuminate\Support\ServiceProvider::class,
             \Arcanedev\Support\Providers\ServiceProvider::class,
             \Arcanedev\Support\Providers\PackageServiceProvider::class,
-            \Arcanedev\LaravelMarkdown\LaravelMarkdownServiceProvider::class,
+            LaravelMarkdownServiceProvider::class,
         ];
 
         foreach ($expectations as $expected) {
@@ -58,7 +62,7 @@ public function it_can_be_instantiated()
     }
 
     /** @test */
-    public function it_can_provides()
+    public function it_can_provides(): void
     {
         $expected = [];
 

diff --git a/tests/MarkdownTest.php b/tests/MarkdownTest.php
@@ -4,9 +4,7 @@
 
 namespace Arcanedev\LaravelMarkdown\Tests;
 
-use Arcanedev\LaravelMarkdown\Parsers\AbstractParser;
 use Illuminate\Support\HtmlString;
-use Illuminate\Support\Manager;
 
 /**
  * Class     MarkdownParserTest
@@ -22,7 +20,7 @@ class MarkdownTest extends TestCase
      */
 
     /** @test */
-    public function it_can_be_instantiated()
+    public function it_can_be_instantiated(): void
     {
         $markdown = $this->markdown();
 
@@ -38,7 +36,7 @@ public function it_can_be_instantiated()
     }
 
     /** @test */
-    public function it_can_get_parser()
+    public function it_can_get_parser(): void
     {
         $parser = $this->markdown()->parser();
 
@@ -54,7 +52,7 @@ public function it_can_get_parser()
     }
 
     /** @test */
-    public function it_can_parse_markdown_into_html()
+    public function it_can_parse_markdown_into_html(): void
     {
         $parsed = $this->markdown()->parse('# Hello');
 
@@ -63,7 +61,7 @@ public function it_can_parse_markdown_into_html()
     }
 
     /** @test */
-    public function it_parse_a_block_of_markdown_into_html()
+    public function it_parse_a_block_of_markdown_into_html(): void
     {
         $md = $this->markdown();
 
@@ -79,7 +77,7 @@ public function it_parse_a_block_of_markdown_into_html()
     }
 
     /** @test */
-    public function it_can_parse_via_blade_directive()
+    public function it_can_parse_via_blade_directive(): void
     {
         /** @var  \Illuminate\Contracts\View\Factory  $view */
         $view = $this->app['view'];
@@ -95,7 +93,7 @@ public function it_can_parse_via_blade_directive()
     }
 
     /** @test */
-    public function it_can_clean_xss()
+    public function it_can_clean_xss(): void
     {
         static::assertStringContainsString(
             '<p><a>Link</a></p>',
@@ -117,7 +115,7 @@ public function it_can_clean_xss()
         );
     }
 
-    public function it_can_skip_clean_xss()
+    public function it_can_skip_clean_xss(): void
     {
         $this->app['config']->set('markdown.parser.options.allow_unsafe_links', true);
 
@@ -128,7 +126,7 @@ public function it_can_skip_clean_xss()
     }
 
     /** @test */
-    public function it_can_skip_escape_markups()
+    public function it_can_skip_escape_markups(): void
     {
         $this->app['config']->set('markdown.parser.options.html_input', false);
 
@@ -139,7 +137,7 @@ public function it_can_skip_escape_markups()
     }
 
     /** @test */
-    public function it_must_throw_an_exception_when_the_buffering_is_not_started()
+    public function it_must_throw_an_exception_when_the_buffering_is_not_started(): void
     {
         $this->expectException(\Arcanedev\LaravelMarkdown\Exceptions\ParserBufferingException::class);
         $this->expectExceptionMessage('Markdown buffering have not been started.');

diff --git a/tests/Providers/DeferredServiceProviderTest.php b/tests/Providers/DeferredServiceProviderTest.php
@@ -1,4 +1,8 @@
-<?php namespace Arcanedev\LaravelMarkdown\Tests\Providers;
+<?php
+
+declare(strict_types=1);
+
+namespace Arcanedev\LaravelMarkdown\Tests\Providers;
 
 use Arcanedev\LaravelMarkdown\Providers\DeferredServicesProvider;
 use Arcanedev\LaravelMarkdown\Tests\TestCase;
@@ -44,7 +48,7 @@ public function tearDown(): void
      */
 
     /** @test */
-    public function it_can_be_instantiated()
+    public function it_can_be_instantiated(): void
     {
         $expectations = [
             \Illuminate\Support\ServiceProvider::class,
@@ -58,7 +62,7 @@ public function it_can_be_instantiated()
     }
 
     /** @test */
-    public function it_can_provides()
+    public function it_can_provides(): void
     {
         $expected = [
             \Arcanedev\LaravelMarkdown\Contracts\Markdown::class,

diff --git a/tests/TestCase.php b/tests/TestCase.php
@@ -1,4 +1,8 @@
-<?php namespace Arcanedev\LaravelMarkdown\Tests;
+<?php
+
+declare(strict_types=1);
+
+namespace Arcanedev\LaravelMarkdown\Tests;
 
 use Orchestra\Testbench\TestCase as BaseTestCase;