minor #117 Abandon this bundle (bocharsky-bw)

This PR was squashed before being merged into the 1.5.x-dev branch.

Discussion
----------

Abandon this bundle

Closes #116

Commits
-------

091cff2 Abandon this bundle

.github/workflows/phpunit.yaml

@@ -0,0 +1,91 @@
+name: PHPUnit
+
+on:
+  pull_request:
+
+jobs:
+  phpunit:
+    name: "PHPUnit - PHP ${{ matrix.php-version }}"
+    runs-on: ubuntu-20.04
+    continue-on-error: false
+    env:
+      SYMFONY_REQUIRE: ${{matrix.symfony-require}}
+      SYMFONY_DEPRECATIONS_HELPER: ${{matrix.symfony-deprecations-helper}}
+
+    strategy:
+      matrix:
+        php-version:
+          - "7.4"
+          - "8.0"
+          - "8.1"
+        deps:
+          - "stable"
+        symfony-require:
+          - "5.4.*"
+        symfony-deprecations-helper:
+          - "5"
+        include:
+          - symfony-require: "4.4.*"
+            php-version: "7.4"
+            deps: "low"
+            symfony-deprecations-helper: ""
+
+          - symfony-require: "4.4.*"
+            php-version: "7.4"
+            deps: "stable"
+            symfony-deprecations-helper: "5"
+
+          - symfony-require: "6.0.*"
+            php-version: "8.0"
+            deps: "stable"
+            symfony-deprecations-helper: "5"
+
+          - symfony-require: "6.0.*"
+            php-version: "8.1"
+            deps: "stable"
+            symfony-deprecations-helper: "5"
+
+      fail-fast: true
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Install PHP with extensions
+        uses: shivammathur/setup-php@v2
+        with:
+          coverage: none
+          php-version: ${{ matrix.php-version }}
+          extensions: mbstring, intl, pdo, pdo_sqlite, sqlite3
+          ini-values: date.timezone=UTC
+
+      - name: Validate composer.json and composer.lock
+        run: composer validate --strict
+
+      - name: Install dependencies with Composer
+        run: composer update --no-interaction --prefer-dist --optimize-autoloader --prefer-stable
+
+      - name: Cache dependencies installed with Composer
+        uses: actions/cache@v2
+        with:
+          path: ~/.composer/cache
+          key: "php-${{ matrix.php-version }}-composer-locked-${{ hashFiles('composer.lock') }}"
+          restore-keys: "php-${{ matrix.php-version }}-composer-locked-"
+
+      - name: Install stable dependencies with Composer
+        run: composer update --no-interaction --prefer-dist --prefer-stable
+        if: "${{ matrix.deps == 'stable' }}"
+
+      - name: Install dev dependencies with Composer
+        run: composer update --no-interaction --prefer-dist
+        if: "${{ matrix.deps == 'dev' }}"
+
+      - name: Install lowest possible dependencies with Composer
+        run: composer update --no-interaction --prefer-dist --prefer-stable --prefer-lowest
+        if: "${{ matrix.deps == 'low' }}"
+
+      - name: Install PHPUnit
+        run: composer run-script test install
+
+      - name: Run tests
+        run: composer run-script test -v

.gitignore

@@ -1,4 +1,6 @@
+.phpunit.result.cache
 phpunit.xml
+var/
 vendor/*
 composer.lock
 Tests/fixtures/app/cache

.travis.yml

@@ -1,39 +1,39 @@
 language: php
-
 sudo: false
-
 cache:
     directories:
         - $HOME/.composer/cache/files
+        - $HOME/symfony-bridge/.phpunit
 
-php:
+env:
-    - 5.5
+    global:
-    - 5.6
+        - PHPUNIT_FLAGS="-v"
-    - 7.0
+        - SYMFONY_PHPUNIT_DIR="$HOME/symfony-bridge/.phpunit"
-    - 7.1
 
 matrix:
     fast_finish: true
     include:
-        # Test against lowest bounds of dependencies to ensure they are right
-        - php: 5.6
-          env: COMPOSER_FLAGS='--prefer-lowest --prefer-stable'
-        # Test against dev versions of dependencies
-        - php: 5.6
-          env: deps=dev
-        # test the latest release (including beta releases)
         - php: 7.1
-          env: deps=beta
+        - php: 7.2
+        - php: 7.3
+          env: deps=low
+        - php: 7.4
+        - php: 8.0
 
 before_install:
-    - if [ "$deps" = 'beta' ]; then perl -pi -e 's/^}$/,"minimum-stability":"beta"}/' composer.json; fi;
+    - phpenv config-rm xdebug.ini || true
-    - if [ "$deps" = 'dev' ]; then perl -pi -e 's/^}$/,"minimum-stability":"dev"}/' composer.json; fi;
+    - composer global require --no-progress --no-scripts --no-plugins symfony/flex dev-main
 
 install:
-    - composer update $COMPOSER_FLAGS
+    - |
+        if [[ $deps = low ]]; then
+            export SYMFONY_DEPRECATIONS_HELPER=weak
+            composer update --prefer-dist --prefer-lowest --prefer-stable
+        else
+            composer update --prefer-dist
+        fi
+    - ./vendor/bin/simple-phpunit install
 
-script: phpunit --coverage-text
+script:
-
+    - composer validate --strict --no-check-lock
-notifications:
+    - ./vendor/bin/simple-phpunit $PHPUNIT_FLAGS
-    email:
-        - travis@knplabs.com

CHANGELOG.md

@@ -0,0 +1,6 @@
+1.7
+===
+
+* The MarkdownHelper Templating component integration (and corresponding
+  `templating.helper.markdown` services) are no longer added unless you
+  have the `symfony/templating` component installed.

DependencyInjection/Configuration.php

@@ -12,11 +12,12 @@ class Configuration implements ConfigurationInterface
      *
      * @return TreeBuilder
      */
-    public function getConfigTreeBuilder()
+    public function getConfigTreeBuilder(): TreeBuilder
     {
-        $treeBuilder = new TreeBuilder();
+        $treeBuilder = new TreeBuilder('knp_markdown');
+        $rootNode = $treeBuilder->getRootNode();
 
-        $treeBuilder->root('knp_markdown', 'array')
+        $rootNode
             ->addDefaultsIfNotSet()
             ->children()
                 ->arrayNode('parser')

DependencyInjection/KnpMarkdownExtension.php

@@ -10,6 +10,7 @@ use Symfony\Component\DependencyInjection\Alias;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
+use Symfony\Component\Templating\EngineInterface;
 
 class KnpMarkdownExtension extends Extension
 {
@@ -29,7 +30,10 @@ class KnpMarkdownExtension extends Extension
 
         $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
         $loader->load('parser.xml');
-        $loader->load('helper.xml');
+        // BC to support the PHP templates in the Templating component
+        if (interface_exists(EngineInterface::class)) {
+            $loader->load('helper.xml');
+        }
         $loader->load('twig.xml');
 
         if ('markdown.parser.sundown' == $config['parser']['service']) {

Helper/MarkdownHelper.php

@@ -5,6 +5,9 @@ namespace Knp\Bundle\MarkdownBundle\Helper;
 use Knp\Bundle\MarkdownBundle\Parser\ParserManager;
 use Symfony\Component\Templating\Helper\HelperInterface;
 
+/**
+ * @deprecated The MarkdownHelper was deprecated in 1.7 and will be removed in 2.0.
+ */
 class MarkdownHelper implements HelperInterface
 {
     private $parserManager;
@@ -27,6 +30,8 @@ class MarkdownHelper implements HelperInterface
      */
     public function transform($markdownText, $parserName = null)
     {
+        trigger_error('The MarkdownHelper was deprecated in 1.7 and will be removed in KnpMarkdownBundle 2.0.', E_USER_DEPRECATED);
+
         return $this->parserManager->transform($markdownText, $parserName);
     }
 
@@ -45,7 +50,7 @@ class MarkdownHelper implements HelperInterface
      *
      * @return string The default charset
      */
-    public function getCharset()
+    public function getCharset(): string
     {
         return $this->charset;
     }

Parser/MarkdownParser.php

@@ -124,7 +124,7 @@ class MarkdownParser extends MarkdownExtra implements MarkdownParserInterface
     /**
      * Simplify detab
      */
-    public function detab($text)
+    public function detab($text): string
     {
         return str_replace("\t", str_repeat(' ', $this->tab_width), $text);
     }

Parser/Preset/Min.php

@@ -15,7 +15,7 @@ class Min extends MarkdownParser
             $this->features[$name] = false;
         }
 
-        return parent::__construct($features);
+        parent::__construct($features);
     }
 }
 

README.markdown

@@ -1,7 +1,14 @@
-Provide markdown conversion (based on [Michel Fortin work](https://github.com/michelf/php-markdown)) to your Symfony2 projects.
+> **WARNING:** This bundle is **abandoned** in favor of [markdown_to_html](https://twig.symfony.com/doc/3.x/filters/markdown_to_html.html)
+> Twig filter. Please, consider using it instead. Migration should be easy because it also supports
+> `michelf/php-markdown` Markdown parser that is used in this project under the hood.
+
+Provide markdown conversion (based on [Michel Fortin work](https://github.com/michelf/php-markdown)) to your Symfony projects.
 
 [![Build Status](https://secure.travis-ci.org/KnpLabs/KnpMarkdownBundle.svg)](http://travis-ci.org/KnpLabs/KnpMarkdownBundle)
 
+![ci.yml](https://github.com/tacman/KnpMarkdownBundle/actions/workflows/ci.yml/badge.svg)
+![php.yml](https://github.com/tacman/KnpMarkdownBundle/actions/workflows/php.yml/badge.svg)
+
 ## INSTALLATION
 
 Add KnpMarkdownBundle to your project via [Composer](https://getcomposer.org/):
@@ -40,7 +47,7 @@ public function __construct(MarkdownParserInterface $parser)
 
 public function someMethod()
 {
-    $html = $parser->transformMarkdown($text);
+    $html = $this->parser->transformMarkdown($text);
 }
 ```
 
@@ -52,6 +59,11 @@ In Twig, you can use the `markdown` filter:
 {# Use default parser #}
 {{ my_data|markdown }}
 
+{# If my_data is entered by a user, escape HTML tags before printing it #}
+{{ my_data|escape|markdown }}
+{# or strip HTML tags #}
+{{ my_data|striptags|markdown }}
+
 {# Or select specific parser #}
 {{ my_data|markdown('parserName') }}
 ```
@@ -62,6 +74,8 @@ Create a service implementing `Knp\Bundle\MarkdownBundle\MarkdownParserInterface
 then configure the bundle to use it:
 
 ```yaml
+# Symfony 3: app/config/config.yml
+# Symfony 4: config/packages/knp_markdown.yaml (you'll need to create this)
 knp_markdown:
     parser:
         service: my.markdown.parser
@@ -71,7 +85,7 @@ Alternatively if you are using the ``markdown.parser.sundown`` there are
 options for enabling sundown extensions and render flags, see the
 default Configuration with:
 
-    php app/console config:dump-reference knp_markdown
+    php bin/console config:dump-reference knp_markdown
 
 This bundle comes with 5 parser services, 4 based on the same algorithm
 but providing different levels of compliance to the markdown specification,

Twig/Extension/MarkdownTwigExtension.php

@@ -3,8 +3,10 @@
 namespace Knp\Bundle\MarkdownBundle\Twig\Extension;
 
 use Knp\Bundle\MarkdownBundle\Parser\ParserManager;
+use Twig\Extension\AbstractExtension;
+use Twig\TwigFilter;
 
-class MarkdownTwigExtension extends \Twig_Extension
+class MarkdownTwigExtension extends AbstractExtension
 {
     private $parserManager;
 
@@ -13,19 +15,19 @@ class MarkdownTwigExtension extends \Twig_Extension
         $this->parserManager = $parserManager;
     }
 
-    public function getFilters()
+    public function getFilters(): array
     {
         return array(
-            new \Twig_SimpleFilter('markdown', array($this, 'markdown'), array('is_safe' => array('html'))),
+            new TwigFilter('markdown', array($this, 'markdown'), array('is_safe' => array('html'))),
         );
     }
 
-    public function markdown($text, $parser = null)
+    public function markdown($text, $parser = null): string
     {
         return $this->parserManager->transform($text, $parser);
     }
 
-    public function getName()
+    public function getName(): string
     {
         return 'markdown';
     }

composer.json

@@ -18,15 +18,18 @@
     ],
 
     "require": {
-        "php":                      ">=5.5.9",
+        "php": "^7.4|^8.0",
-        "symfony/framework-bundle": "~2.8|~3.0|^4.0",
+        "symfony/framework-bundle": "^4.4|^5.0|^6.0",
-        "symfony/dependency-injection": "~2.8|~3.0|^4.0",
+        "symfony/dependency-injection": "^4.4|^5.0|^6.0",
-        "symfony/templating": "~2.8|~3.0|^4.0",
+        "michelf/php-markdown": "^1.9"
-        "michelf/php-markdown":     "~1.4"
     },
     "require-dev": {
-        "phpunit/phpunit":          "~4.5"
+        "symfony/phpunit-bridge": "^4.4.11|^5.0|^6.0",
+        "symfony/templating": "^4.4|^5.0|^6.0",
+        "phpstan/phpstan": "^1.2",
+        "phpstan/phpstan-symfony": "^1.0"
     },
+    "abandoned": "twig/markdown-extra",
     "suggest": {
         "symfony/twig-bundle": "to use the Twig markdown filter",
         "ext-sundown": "to use optional support for php-sundown extension instead of php implementation"
@@ -38,6 +41,18 @@
         }
     },
 
+    "scripts": {
+        "test": [
+            "php ./vendor/bin/simple-phpunit"
+        ]
+    },
+
+    "autoload-dev": {
+        "psr-4": {
+            "Knp\\Bundle\\MarkdownBundle\\Tests\\": "tests/"
+        }
+    },
+
     "autoload": {
         "psr-4": {
             "Knp\\Bundle\\MarkdownBundle\\": ""

phpunit.xml.dist

@@ -1,30 +1,31 @@
 <?xml version="1.0" encoding="UTF-8"?>
 
-<phpunit backupGlobals="false"
+<!-- http://phpunit.de/manual/4.1/en/appendixes.configuration.html -->
-         backupStaticAttributes="false"
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
+         backupGlobals="false"
+         bootstrap="vendor/autoload.php"
          colors="true"
-         convertErrorsToExceptions="true"
+         failOnRisky="true"
-         convertNoticesToExceptions="true"
+         failOnWarning="true"
-         convertWarningsToExceptions="true"
+         failOnIncomplete="false"
-         processIsolation="false"
-         stopOnFailure="false"
-         syntaxCheck="false"
-         bootstrap="./vendor/autoload.php"
 >
+    <php>
+        <server name="SYMFONY_PHPUNIT_VERSION" value="9.5" />
+    </php>
+
+    <coverage processUncoveredFiles="true">
+      <include>
+          <directory>.</directory>
+      </include>
+      <exclude>
+          <directory>tests</directory>
+          <directory>vendor</directory>
+      </exclude>
+    </coverage>
     <testsuites>
         <testsuite name="Markdown Test Suite">
-            <directory>./Tests/</directory>
+            <directory>tests</directory>
         </testsuite>
     </testsuites>
-
-    <filter>
-        <whitelist>
-            <directory>./</directory>
-            <exclude>
-                <directory>./Resources</directory>
-                <directory>./Tests</directory>
-                <directory>./vendor</directory>
-            </exclude>
-        </whitelist>
-    </filter>
 </phpunit>

tests/EscapingTest.php

@@ -2,13 +2,14 @@
 
 namespace Knp\Bundle\MarkdownBundle\Tests;
 
+use PHPUnit\Framework\TestCase;
 use Knp\Bundle\MarkdownBundle\Parser\MarkdownParser as Parser;
 
-class EscapingTest extends \PHPUnit_Framework_TestCase
+class EscapingTest extends TestCase
 {
     protected $parser;
 
-    public function setUp()
+    protected function setUp(): void
     {
         $this->parser = new Parser();
     }

tests/FeatureTest.php

@@ -3,8 +3,9 @@
 namespace Knp\Bundle\MarkdownBundle\Tests;
 
 use Knp\Bundle\MarkdownBundle\Parser\MarkdownParser as Parser;
+use PHPUnit\Framework\TestCase;
 
-class FeatureTest extends \PHPUnit_Framework_TestCase
+class FeatureTest extends TestCase
 {
     public function testParser()
     {
@@ -749,31 +750,15 @@ That's some text with a footnote.[^1]
 [^1]: And that's the footnote.
 EOF;
 
-        $html = <<<EOF
-<p>That's some text with a footnote.<sup id="fnref:1"><a href="#fn:1" class="footnote-ref">1</a></sup></p>
-
-<div class="footnotes">
-<hr />
-<ol>
-
-<li id="fn:1">
-<p>And that's the footnote.&#160;<a href="#fnref:1" class="footnote-backref">&#8617;&#xFE0E;</a></p>
-</li>
-
-</ol>
-</div>
-
-EOF;
-
-        // newer versions of Michelf add an extra &#xFE0E; To make the tests
-        // pass against ALL versions, we just hack the &#xFE0E; into the
-        // expected string if it isn't there
         $actualHtml = $parser->transform($text);
-        if (strpos($actualHtml, '&#xFE0E;') === false) {
-            $actualHtml = str_replace('&#8617;', '&#8617;&#xFE0E;', $actualHtml);
-        }
 
-        $this->assertEquals($html, $actualHtml);
+        // asserting a few things instead of comparing full final HTML
+        // because a few minor things have changed over versions of Michelf
+        // With assertContains(), tests will pass across all versions
+        $this->assertStringContainsString('<p>That\'s some text with a footnote.<sup id="fnref:1"><a href="#fn:1"', $actualHtml);
+        $this->assertStringContainsString('<div class="footnotes"', $actualHtml);
+        $this->assertStringContainsString('<li id="fn:1"', $actualHtml);
+        $this->assertStringContainsString('<p>And that\'s the footnote.&#160;<a href="#fnref:1" class="footnote-backref"', $actualHtml);
     }
 
     /**

tests/IntegrationTest.php

@@ -4,14 +4,16 @@ namespace Knp\Bundle\MarkdownBundle\Tests;
 
 use Knp\Bundle\MarkdownBundle\KnpMarkdownBundle;
 use Knp\Bundle\MarkdownBundle\Parser\MarkdownParser;
+use PHPUnit\Framework\TestCase;
 use Symfony\Bundle\FrameworkBundle\FrameworkBundle;
 use Symfony\Bundle\FrameworkBundle\Kernel\MicroKernelTrait;
 use Symfony\Component\Config\Loader\LoaderInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Kernel;
+use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;
 use Symfony\Component\Routing\RouteCollectionBuilder;
 
-class IntegrationTest extends \PHPUnit_Framework_TestCase
+class IntegrationTest extends TestCase
 {
     public function testServicesAvailable()
     {
@@ -29,7 +31,7 @@ class IntegrationKernel extends Kernel
 
     private $cacheDir;
 
-    public function registerBundles()
+    public function registerBundles(): iterable
     {
         return [
             new FrameworkBundle(),
@@ -37,16 +39,20 @@ class IntegrationKernel extends Kernel
         ];
     }
 
-    protected function configureRoutes(RouteCollectionBuilder $routes)
+    protected function configureRoutes(RoutingConfigurator $routes)
     {
     }
 
     protected function configureContainer(ContainerBuilder $c, LoaderInterface $loader)
     {
-        $c->setParameter('kernel.secret', '1234');
+
+            $c->loadFromExtension('framework', [
+                'secret' => 'F00',
+                'router' => ['utf8' => true]
+            ]);
     }
 
-    public function getCacheDir()
+    public function getCacheDir(): string
     {
         if (null === $this->cacheDir) {
             $this->cacheDir = sys_get_temp_dir().'/'.rand(100, 999);

tests/Parser/ParserManagerTest.php

@@ -5,8 +5,9 @@ namespace Knp\Bundle\MarkdownBundle\Tests\Parser;
 use Knp\Bundle\MarkdownBundle\Helper\MarkdownHelper;
 use Knp\Bundle\MarkdownBundle\Tests\fixtures\app\TestKernel;
 use Knp\Bundle\MarkdownBundle\Parser\ParserManager;
+use PHPUnit\Framework\TestCase;
 
-class ParserManagerTest extends \PHPUnit_Framework_TestCase
+class ParserManagerTest extends TestCase
 {
     public function testIntegration()
     {
@@ -24,10 +25,5 @@ class ParserManagerTest extends \PHPUnit_Framework_TestCase
 
         $actual = $parserManager->transform('*hi*', 'light');
         $this->assertEquals("<p><em>hi</em></p>\n", $actual, 'Specific parsers are registered');
-
-        /** @var MarkdownHelper $markdownHelper */
-        $markdownHelper = $container->get('templating.helper.markdown');
-        $actual = $markdownHelper->transform('*yo*');
-        $this->assertEquals("<p><em>yo</em></p>\n", $actual, 'The templating helper also works');
     }
 }

tests/PresetTest.php

@@ -3,8 +3,9 @@
 namespace Knp\Bundle\MarkdownBundle\Tests;
 
 use Knp\Bundle\MarkdownBundle\Parser\Preset as Preset;
+use PHPUnit\Framework\TestCase;
 
-class PresetTest extends \PHPUnit_Framework_TestCase
+class PresetTest extends TestCase
 {
     public function testMax()
     {

tests/fixtures/app/TestKernel.php

@@ -5,13 +5,14 @@ namespace Knp\Bundle\MarkdownBundle\Tests\fixtures\app;
 use Knp\Bundle\MarkdownBundle\KnpMarkdownBundle;
 use Symfony\Bundle\FrameworkBundle\FrameworkBundle;
 use Symfony\Component\Config\Loader\LoaderInterface;
+use Symfony\Component\DependencyInjection\Alias;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\HttpKernel\Kernel;
 
 class TestKernel extends Kernel
 {
-    public function registerBundles()
+    public function registerBundles(): iterable
     {
         return array(
             new FrameworkBundle(),
@@ -27,7 +28,7 @@ class TestKernel extends Kernel
             ));
 
             // add a public alias so we can fetch for testing
-            $c->setAlias('markdown.parser.parser_manager.public', 'markdown.parser.parser_manager');
+            $c->setAlias('markdown.parser.parser_manager.public', new Alias('markdown.parser.parser_manager', true));
         });
     }
-}
+}