tests/src/Content/Text/MarkdownTest.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2023, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Test\src\Content\Text;
  23
  24 use Exception;
  25 use Friendica\Content\Text\Markdown;
  26 use Friendica\Test\FixtureTest;
  27
  28 class MarkdownTest extends FixtureTest
  29 {
  30         public function dataMarkdown()
  31         {
  32                 $inputFiles = glob(__DIR__ . '/../../../datasets/content/text/markdown/*.md');
  33
  34                 $data = [];
  35
  36                 foreach ($inputFiles as $file) {
  37                         $data[str_replace('.md', '', $file)] = [
  38                                 'input'    => file_get_contents($file),
  39                                 'expected' => file_get_contents(str_replace('.md', '.html', $file))
  40                         ];
  41                 }
  42
  43                 return $data;
  44         }
  45
  46         /**
  47          * Test convert different input Markdown text into HTML
  48          *
  49          * @dataProvider dataMarkdown
  50          *
  51          * @param string $input    The Markdown text to test
  52          * @param string $expected The expected HTML output
  53          *
  54          * @throws Exception
  55          */
  56         public function testConvert(string $input, string $expected)
  57         {
  58                 $output = Markdown::convert($input);
  59
  60                 self::assertEquals($expected, $output);
  61         }
  62
  63         public function dataMarkdownText()
  64         {
  65                 return [
  66                         'bug-8358-double-decode' => [
  67                                 'expectedBBCode' => 'with the <sup> and </sup> tag',
  68                                 'markdown' => 'with the &lt;sup&gt; and &lt;/sup&gt; tag',
  69                         ],
  70                 ];
  71         }
  72
  73         /**
  74          * Test convert Markdown to BBCode
  75          *
  76          * @dataProvider dataMarkdownText
  77          *
  78          * @param string $expectedBBCode Expected BBCode output
  79          * @param string $html           Markdown text
  80          */
  81         public function testToBBCode(string $expectedBBCode, string $html)
  82         {
  83                 $actual = Markdown::toBBCode($html);
  84
  85                 self::assertEquals($expectedBBCode, $actual);
  86         }
  87 }