Merge pull request #61 from j0k3r/github-actions

Ditch Travis to use GitHub Actions

.editorconfig

@@ -4,9 +4,10 @@ root = true
 ; Unix-style newlines
 [*]
 end_of_line = LF
-
-[*.php]
 indent_style = space
 indent_size = 4
 trim_trailing_whitespace = true
 insert_final_newline = true
+
+[.github/**.yml]
+indent_size = 2

.gitattributes

@@ -4,6 +4,7 @@
 /.scrutinizer.yml export-ignore
 /.travis.yml export-ignore
 /.php_cs export-ignore
-/README.md export-ignore
 /phpunit.xml.dist export-ignore
+/phpstan.neon export-ignore
+/.github export-ignore
 /tests export-ignore

.github/workflows/coding-standards.yml

@@ -0,0 +1,53 @@
+name: "CS"
+
+on:
+  pull_request:
+    branches:
+      - master
+  push:
+    branches:
+      - master
+
+env:
+  SYMFONY_PHPUNIT_VERSION: 7.5
+
+jobs:
+  coding-standards:
+    name: "CS Fixer & PHPStan"
+    runs-on: "ubuntu-18.04"
+
+    strategy:
+      matrix:
+        php:
+          - "7.3"
+
+    steps:
+      - name: "Checkout"
+        uses: "actions/checkout@v2"
+
+      - name: "Install PHP"
+        uses: "shivammathur/setup-php@v2"
+        with:
+          coverage: "none"
+          php-version: "${{ matrix.php }}"
+          tools: cs2pr, composer:v1
+          ini-values: "date.timezone=Europe/Paris"
+        env:
+          COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: "Add PHPStan"
+        run: "composer require phpstan/phpstan phpstan/phpstan-phpunit --dev --no-progress --no-suggest"
+
+      - name: "Install dependencies with Composer"
+        uses: "ramsey/composer-install@v1"
+        with:
+          composer-options: "--optimize-autoloader --prefer-dist"
+
+      - name: "Run PHP CS Fixer"
+        run: "php vendor/bin/php-cs-fixer fix --verbose --dry-run --format=checkstyle | cs2pr"
+
+      - name: "Install PHPUnit for PHPStan"
+        run: "php vendor/bin/simple-phpunit install"
+
+      - name: "Run PHPStan"
+        run: "php vendor/bin/phpstan analyse --error-format=checkstyle | cs2pr"

.github/workflows/continuous-integration.yml

@@ -0,0 +1,202 @@
+name: "CI"
+
+on:
+  pull_request:
+    branches:
+      - "master"
+  push:
+    branches:
+      - "master"
+
+env:
+  fail-fast: true
+
+jobs:
+  phpunit:
+    name: "PHPUnit (PHP ${{ matrix.php }})"
+    runs-on: "ubuntu-18.04"
+
+    strategy:
+      matrix:
+        php:
+          - "5.6"
+          - "7.0"
+          - "7.1"
+          - "7.2"
+          - "7.3"
+          - "7.4"
+
+    steps:
+      - name: "Checkout"
+        uses: "actions/checkout@v2"
+        with:
+          fetch-depth: 2
+
+      - name: "Install PHP"
+        uses: "shivammathur/setup-php@v2"
+        with:
+          php-version: "${{ matrix.php }}"
+          coverage: "none"
+          tools: composer:v1
+          extensions: tidy
+          ini-values: "date.timezone=Europe/Paris"
+        env:
+          COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: "Force PHPUnit version"
+        if: matrix.php >= '7.2'
+        run: "echo $SYMFONY_PHPUNIT_VERSION"
+        env:
+          SYMFONY_PHPUNIT_VERSION: 7.5
+
+      - name: "Remove useless deps"
+        run: "composer remove friendsofphp/php-cs-fixer --dev --no-progress --no-update"
+
+      - name: "Install dependencies with Composer"
+        uses: "ramsey/composer-install@v1"
+        with:
+          composer-options: "--optimize-autoloader --prefer-dist"
+
+      - name: "Setup logs"
+        run: "mkdir -p build/logs"
+
+      - name: "Run PHPUnit"
+        run: "php vendor/bin/simple-phpunit -v"
+
+  phpunit-coverage:
+    name: "PHPUnit coverage (PHP ${{ matrix.php }})"
+    runs-on: "ubuntu-18.04"
+
+    strategy:
+      matrix:
+        php:
+          - "7.4"
+
+    steps:
+      - name: "Checkout"
+        uses: "actions/checkout@v2"
+        with:
+          fetch-depth: 2
+
+      - name: "Install PHP with Xdebug"
+        uses: "shivammathur/setup-php@v2"
+        with:
+          php-version: "${{ matrix.php }}"
+          coverage: "xdebug"
+          tools: composer:v1
+          extensions: tidy
+          ini-values: "date.timezone=Europe/Paris"
+        env:
+          COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: "Remove useless deps"
+        run: "composer remove friendsofphp/php-cs-fixer --dev --no-progress --no-update"
+
+      - name: "Install dependencies with Composer"
+        uses: "ramsey/composer-install@v1"
+        with:
+          composer-options: "--optimize-autoloader --prefer-dist"
+
+      - name: "Setup logs"
+        run: "mkdir -p build/logs"
+
+      - name: "Run PHPUnit (with coverage)"
+        run: "php vendor/bin/simple-phpunit -v --coverage-clover build/logs/clover.xml"
+        env:
+          SYMFONY_PHPUNIT_VERSION: 7.5
+
+      - name: "Retrieve Coveralls phar"
+        run: "wget https://github.com/php-coveralls/php-coveralls/releases/download/v2.4.2/php-coveralls.phar"
+
+      - name: "Enable Coveralls phar"
+        run: "chmod +x php-coveralls.phar"
+
+      - name: "Upload to Coveralls"
+        run: "php php-coveralls.phar -v -x build/logs/clover.xml"
+        env:
+          COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  phpunit-lowest:
+    name: "PHPUnit lowest deps (PHP ${{ matrix.php }})"
+    runs-on: "ubuntu-18.04"
+
+    strategy:
+      matrix:
+        php:
+          - "7.2"
+
+    steps:
+      - name: "Checkout"
+        uses: "actions/checkout@v2"
+        with:
+          fetch-depth: 2
+
+      - name: "Install PHP"
+        uses: "shivammathur/setup-php@v2"
+        with:
+          php-version: "${{ matrix.php }}"
+          coverage: "none"
+          tools: composer:v1
+          extensions: tidy
+          ini-values: "date.timezone=Europe/Paris"
+        env:
+          COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: "Remove useless deps"
+        run: "composer remove friendsofphp/php-cs-fixer --dev --no-progress --no-update"
+
+      - name: "Install dependencies with Composer"
+        uses: "ramsey/composer-install@v1"
+        with:
+          composer-options: "--optimize-autoloader --prefer-dist"
+          dependency-versions: "lowest"
+
+      - name: "Setup logs"
+        run: "mkdir -p build/logs"
+
+      - name: "Run PHPUnit"
+        run: "php vendor/bin/simple-phpunit -v"
+        env:
+          SYMFONY_PHPUNIT_VERSION: 7.5
+
+  phpunit-composerv2:
+    name: "PHPUnit with Composer v2 (PHP ${{ matrix.php }})"
+    runs-on: "ubuntu-18.04"
+
+    strategy:
+      matrix:
+        php:
+          - "7.4"
+
+    steps:
+      - name: "Checkout"
+        uses: "actions/checkout@v2"
+        with:
+          fetch-depth: 2
+
+      - name: "Install PHP"
+        uses: "shivammathur/setup-php@v2"
+        with:
+          php-version: "${{ matrix.php }}"
+          coverage: "none"
+          tools: composer:v2
+          extensions: tidy
+          ini-values: "date.timezone=Europe/Paris"
+        env:
+          COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: "Remove useless deps"
+        run: "composer remove friendsofphp/php-cs-fixer --dev --no-progress --no-update"
+
+      - name: "Install dependencies with Composer"
+        uses: "ramsey/composer-install@v1"
+        with:
+          composer-options: "--optimize-autoloader --prefer-dist"
+
+      - name: "Setup logs"
+        run: "mkdir -p build/logs"
+
+      - name: "Run PHPUnit"
+        run: "php vendor/bin/simple-phpunit -v"
+        env:
+          SYMFONY_PHPUNIT_VERSION: 7.5

.gitignore

@@ -2,3 +2,4 @@ vendor/
 coverage/
 composer.lock
 .php_cs.cache
+.phpunit.result.cache

.php_cs

@@ -1,20 +1,30 @@
 <?php
 
-return Symfony\CS\Config\Config::create()
+return PhpCsFixer\Config::create()
     ->setUsingCache(true)
-    ->level(Symfony\CS\FixerInterface::SYMFONY_LEVEL)
+    ->setRiskyAllowed(true)
-    // use default SYMFONY_LEVEL and extra fixers:
+    ->setRules([
-    ->fixers(array(
+        '@Symfony' => true,
-        'concat_with_spaces',
+        '@Symfony:risky' => true,
-        'ordered_use',
+        'array_syntax' => ['syntax' => 'short'],
-        'phpdoc_order',
+        'combine_consecutive_unsets' => true,
-        'strict',
+        'heredoc_to_nowdoc' => true,
-        'strict_param',
+        'no_extra_consecutive_blank_lines' => ['break', 'continue', 'extra', 'return', 'throw', 'use', 'parenthesis_brace_block', 'square_brace_block', 'curly_brace_block'],
-        'long_array_syntax',
+        'no_unreachable_default_argument_value' => true,
-    ))
+        'no_useless_else' => true,
-    ->finder(
+        'no_useless_return' => true,
-        Symfony\CS\Finder\DefaultFinder::create()
+        'ordered_class_elements' => true,
+        'ordered_imports' => true,
+        'php_unit_strict' => false,
+        'phpdoc_order' => true,
+        // 'psr4' => true,
+        'strict_comparison' => true,
+        'strict_param' => true,
+        'concat_space' => ['spacing' => 'one'],
+    ])
+    ->setFinder(
+        PhpCsFixer\Finder::create()
+            ->exclude(['vendor'])
             ->in(__DIR__)
-            ->exclude(array('vendor'))
     )
 ;

.scrutinizer.yml

@@ -1,2 +1,12 @@
 tools:
     external_code_coverage: false
+
+build:
+    nodes:
+        analysis:
+            tests:
+                override:
+                    - php-scrutinizer-run
+            environment:
+                php:
+                    version: 7.2

.travis.yml

@@ -1,53 +1,34 @@
+dist: xenial
+os: linux
 language: php
 
-php:
+# avoid double Travis build when the PR is created on upstream
-    - 5.3.3
+if: |
-    - 5.3
+    type = pull_request OR \
-    - 5.4
+    branch = master
-    - 5.5
-    - 5.6
-    - 7.0
-    - 7.1
-    - nightly
-    - hhvm
 
-matrix:
+jobs:
     include:
-        - php: 7.0
+        - php: 8.0
-          env: CS_FIXER=run
+          env: SYMFONY_PHPUNIT_VERSION=7.5
     fast_finish: true
     allow_failures:
-        - php: hhvm
+        - php: 8.0
-        - php: nightly
 
-# faster builds on new travis setup not using sudo
-sudo: false
-
-# cache vendor dirs
 cache:
     directories:
-        - vendor
+        - $HOME/.composer/cache/files
-        - $HOME/.composer/cache
 
 before_install:
     - if [ -n "$GH_TOKEN" ]; then composer config github-oauth.github.com ${GH_TOKEN}; fi;
-    # disable TLS for composer because openssl is disabled for PHP 5.3.3 on travis
-    # see: https://blog.travis-ci.com/upcoming_ubuntu_11_10_migration/
-    - if [[ $TRAVIS_PHP_VERSION = 5.3.3 ]]; then composer config -g -- disable-tls true; fi;
-    - if [[ $TRAVIS_PHP_VERSION = 5.3.3 ]]; then composer config -g -- secure-http false; fi;
-    # no version compatible with PHP > 7.1
-    - if [[ $TRAVIS_PHP_VERSION = 7.2.* ]]; then composer remove friendsofphp/php-cs-fixer; fi;
 
 install:
-    - composer self-update
+    - if [ "$CS_FIXER" != "run" ]; then composer remove friendsofphp/php-cs-fixer --dev --no-progress --no-update ; fi;
+    - composer update --prefer-dist --no-progress --no-suggest -o $
+    - php vendor/bin/simple-phpunit install
 
 before_script:
-    - composer install --prefer-dist --no-interaction
+    - mkdir -p build/logs
 
 script:
-    - mkdir -p build/logs
+    - php vendor/bin/simple-phpunit -v
-    - php vendor/bin/simple-phpunit -v --coverage-clover build/logs/clover.xml
-    - if [ "$CS_FIXER" = "run" ]; then php vendor/bin/php-cs-fixer fix --verbose --dry-run ; fi;
-
-after_script:
-    - php vendor/bin/coveralls -v

README.md

@@ -1,7 +1,10 @@
 # Readability
 
+![CI](https://github.com/j0k3r/php-readability/workflows/CI/badge.svg)
 [![Build Status](https://travis-ci.org/j0k3r/php-readability.svg?branch=master)](https://travis-ci.org/j0k3r/php-readability)
 [![Coverage Status](https://coveralls.io/repos/j0k3r/php-readability/badge.svg?branch=master&service=github)](https://coveralls.io/github/j0k3r/php-readability/?branch=master)
+[![Total Downloads](https://poser.pugx.org/j0k3r/php-readability/downloads)](https://packagist.org/packages/j0k3r/php-readability)
+[![License](https://poser.pugx.org/j0k3r/php-readability/license)](https://packagist.org/packages/j0k3r/php-readability)
 
 This is an extract of the Readability class from this [full-text-rss](https://github.com/Dither/full-text-rss) fork. It can be defined as a better version of the original [php-readability](https://bitbucket.org/fivefilters/php-readability/overview).
 

composer.json

@@ -24,20 +24,23 @@
         "role": "Developer (original JS version)"
     }],
     "require": {
-        "php": ">=5.3.3",
+        "php": ">=5.6.0",
         "ext-mbstring": "*",
-        "psr/log": "^1.0"
+        "psr/log": "^1.0",
+        "masterminds/html5": "^2.7"
     },
     "require-dev": {
-        "satooshi/php-coveralls": "~0.6",
+        "friendsofphp/php-cs-fixer": "^2.14",
-        "friendsofphp/php-cs-fixer": "<2",
+        "monolog/monolog": "^1.24|^2.1",
-        "monolog/monolog": "^1.13",
+        "symfony/phpunit-bridge": "^4.2.3"
-        "symfony/phpunit-bridge": "^3.2"
     },
     "suggest": {
         "ext-tidy": "Used to clean up given HTML and to avoid problems with bad HTML structure."
     },
     "autoload": {
         "psr-4": { "Readability\\": "src/" }
+    },
+    "autoload-dev": {
+        "psr-4": { "Tests\\Readability\\": "tests/" }
     }
 }

phpstan.neon

@@ -0,0 +1,13 @@
+parameters:
+    level: 1
+    paths:
+        - src
+        - tests
+
+    # https://github.com/phpstan/phpstan/issues/694#issuecomment-350724288
+    bootstrapFiles:
+        - vendor/bin/.phpunit/phpunit-7.5-0/vendor/autoload.php
+
+includes:
+    - vendor/phpstan/phpstan-phpunit/extension.neon
+    - vendor/phpstan/phpstan-phpunit/rules.neon

phpunit.xml.dist

@@ -7,7 +7,6 @@
     convertWarningsToExceptions="true"
     processIsolation="false"
     stopOnFailure="false"
-    syntaxCheck="false"
     bootstrap="vendor/autoload.php"
     >
 
@@ -27,6 +26,6 @@
     </filter>
 
     <!-- <logging>
-        <log type="coverage-html" target="coverage" title="Readability" charset="UTF-8" yui="true" highlight="true" lowUpperBound="35" highLowerBound="70"/>
+        <log type="coverage-html" target="coverage" lowUpperBound="35" highLowerBound="70"/>
     </logging> -->
 </phpunit>

src/JSLikeHTMLElement.php

@@ -45,7 +45,7 @@ class JSLikeHTMLElement extends \DOMElement
      */
     public function __set($name, $value)
     {
-        if ($name !== 'innerHTML') {
+        if ('innerHTML' !== $name) {
             $trace = debug_backtrace();
             trigger_error('Undefined property via __set(): ' . $name . ' in ' . $trace[0]['file'] . ' on line ' . $trace[0]['line'], E_USER_NOTICE);
 
@@ -109,7 +109,7 @@ class JSLikeHTMLElement extends \DOMElement
      */
     public function __get($name)
     {
-        if ($name === 'innerHTML') {
+        if ('innerHTML' === $name) {
             $inner = '';
 
             foreach ($this->childNodes as $child) {
@@ -121,12 +121,20 @@ class JSLikeHTMLElement extends \DOMElement
 
         $trace = debug_backtrace();
         trigger_error('Undefined property via __get(): ' . $name . ' in ' . $trace[0]['file'] . ' on line ' . $trace[0]['line'], E_USER_NOTICE);
-
-        return;
     }
 
     public function __toString()
     {
         return '[' . $this->tagName . ']';
     }
+
+    public function getInnerHtml()
+    {
+        return $this->__get('innerHTML');
+    }
+
+    public function setInnerHtml($value)
+    {
+        return $this->__set('innerHTML', $value);
+    }
 }

tests/ReadabilityTest.php

@@ -6,22 +6,11 @@ use Monolog\Handler\TestHandler;
 use Monolog\Logger;
 use Readability\Readability;
 
-class ReadabilityTest extends \PHPUnit_Framework_TestCase
+class ReadabilityTest extends \PHPUnit\Framework\TestCase
 {
     public $logHandler;
     public $logger;
 
-    private function getReadability($html, $url = null, $parser = 'libxml', $useTidy = true)
-    {
-        $readability = new Readability($html, $url, $parser, $useTidy);
-
-        $this->logHandler = new TestHandler();
-        $this->logger = new Logger('test', array($this->logHandler));
-        $readability->setLogger($this->logger);
-
-        return $readability;
-    }
-
     /**
      * @requires extension tidy
      */
@@ -33,6 +22,15 @@ class ReadabilityTest extends \PHPUnit_Framework_TestCase
         $this->assertInstanceOf('DomDocument', $readability->dom);
     }
 
+    public function testConstructHtml5Parser()
+    {
+        $readability = $this->getReadability('<html/>', 'http://0.0.0.0', 'html5lib');
+
+        $this->assertEquals('http://0.0.0.0', $readability->url);
+        $this->assertInstanceOf('DomDocument', $readability->dom);
+        $this->assertEquals('<html/>', $readability->original_html);
+    }
+
     /**
      * @requires extension tidy
      */
@@ -75,8 +73,8 @@ class ReadabilityTest extends \PHPUnit_Framework_TestCase
         $this->assertFalse($res);
         $this->assertInstanceOf('Readability\JSLikeHTMLElement', $readability->getContent());
         $this->assertInstanceOf('Readability\JSLikeHTMLElement', $readability->getTitle());
-        $this->assertEmpty($readability->getTitle()->innerHTML);
+        $this->assertEmpty($readability->getTitle()->getInnerHtml());
-        $this->assertContains('Sorry, Readability was unable to parse this page for content.', $readability->getContent()->innerHTML);
+        $this->assertContains('Sorry, Readability was unable to parse this page for content.', $readability->getContent()->getInnerHtml());
     }
 
     public function testInitP()
@@ -87,9 +85,9 @@ class ReadabilityTest extends \PHPUnit_Framework_TestCase
         $this->assertTrue($res);
         $this->assertInstanceOf('Readability\JSLikeHTMLElement', $readability->getContent());
         $this->assertInstanceOf('Readability\JSLikeHTMLElement', $readability->getTitle());
-        $this->assertContains('<div readability=', $readability->getContent()->innerHTML);
+        $this->assertContains('<div readability=', $readability->getContent()->getInnerHtml());
-        $this->assertEmpty($readability->getTitle()->innerHTML);
+        $this->assertEmpty($readability->getTitle()->getInnerHtml());
-        $this->assertContains('This is the awesome content :)', $readability->getContent()->innerHTML);
+        $this->assertContains('This is the awesome content :)', $readability->getContent()->getInnerHtml());
     }
 
     public function testInitDivP()
@@ -100,9 +98,9 @@ class ReadabilityTest extends \PHPUnit_Framework_TestCase
         $this->assertTrue($res);
         $this->assertInstanceOf('Readability\JSLikeHTMLElement', $readability->getContent());
         $this->assertInstanceOf('Readability\JSLikeHTMLElement', $readability->getTitle());
-        $this->assertContains('<div readability=', $readability->getContent()->innerHTML);
+        $this->assertContains('<div readability=', $readability->getContent()->getInnerHtml());
-        $this->assertEmpty($readability->getTitle()->innerHTML);
+        $this->assertEmpty($readability->getTitle()->getInnerHtml());
-        $this->assertContains('This is the awesome content :)', $readability->getContent()->innerHTML);
+        $this->assertContains('This is the awesome content :)', $readability->getContent()->getInnerHtml());
     }
 
     public function testInitDiv()
@@ -114,9 +112,9 @@ class ReadabilityTest extends \PHPUnit_Framework_TestCase
         $this->assertTrue($res);
         $this->assertInstanceOf('Readability\JSLikeHTMLElement', $readability->getContent());
         $this->assertInstanceOf('Readability\JSLikeHTMLElement', $readability->getTitle());
-        $this->assertContains('<div readability=', $readability->getContent()->innerHTML);
+        $this->assertContains('<div readability=', $readability->getContent()->getInnerHtml());
-        $this->assertEmpty($readability->getTitle()->innerHTML);
+        $this->assertEmpty($readability->getTitle()->getInnerHtml());
-        $this->assertContains('This is the awesome content :)', $readability->getContent()->innerHTML);
+        $this->assertContains('This is the awesome content :)', $readability->getContent()->getInnerHtml());
     }
 
     public function testWithFootnotes()
@@ -129,11 +127,11 @@ class ReadabilityTest extends \PHPUnit_Framework_TestCase
         $this->assertTrue($res);
         $this->assertInstanceOf('Readability\JSLikeHTMLElement', $readability->getContent());
         $this->assertInstanceOf('Readability\JSLikeHTMLElement', $readability->getTitle());
-        $this->assertContains('<div readability=', $readability->getContent()->innerHTML);
+        $this->assertContains('<div readability=', $readability->getContent()->getInnerHtml());
-        $this->assertEmpty($readability->getTitle()->innerHTML);
+        $this->assertEmpty($readability->getTitle()->getInnerHtml());
-        $this->assertContains('This is an awesome text with some links, here there are', $readability->getContent()->innerHTML);
+        $this->assertContains('This is an awesome text with some links, here there are', $readability->getContent()->getInnerHtml());
-        $this->assertContains('readabilityFootnoteLink', $readability->getContent()->innerHTML);
+        $this->assertContains('readabilityFootnoteLink', $readability->getContent()->getInnerHtml());
-        $this->assertContains('readabilityLink-3', $readability->getContent()->innerHTML);
+        $this->assertContains('readabilityLink-3', $readability->getContent()->getInnerHtml());
     }
 
     public function testStandardClean()
@@ -146,11 +144,11 @@ class ReadabilityTest extends \PHPUnit_Framework_TestCase
         $this->assertTrue($res);
         $this->assertInstanceOf('Readability\JSLikeHTMLElement', $readability->getContent());
         $this->assertInstanceOf('Readability\JSLikeHTMLElement', $readability->getTitle());
-        $this->assertContains('<div readability=', $readability->getContent()->innerHTML);
+        $this->assertContains('<div readability=', $readability->getContent()->getInnerHtml());
-        $this->assertEmpty($readability->getTitle()->innerHTML);
+        $this->assertEmpty($readability->getTitle()->getInnerHtml());
-        $this->assertContains('This is an awesome text with some links, here there are', $readability->getContent()->innerHTML);
+        $this->assertContains('This is an awesome text with some links, here there are', $readability->getContent()->getInnerHtml());
-        $this->assertContains('will NOT be removed', $readability->getContent()->innerHTML);
+        $this->assertContains('will NOT be removed', $readability->getContent()->getInnerHtml());
-        $this->assertNotContains('<h2>', $readability->getContent()->innerHTML);
+        $this->assertNotContains('<h2>', $readability->getContent()->getInnerHtml());
     }
 
     public function testWithIframe()
@@ -162,10 +160,10 @@ class ReadabilityTest extends \PHPUnit_Framework_TestCase
         $this->assertTrue($res);
         $this->assertInstanceOf('Readability\JSLikeHTMLElement', $readability->getContent());
         $this->assertInstanceOf('Readability\JSLikeHTMLElement', $readability->getTitle());
-        $this->assertContains('<div readability=', $readability->getContent()->innerHTML);
+        $this->assertContains('<div readability=', $readability->getContent()->getInnerHtml());
-        $this->assertEmpty($readability->getTitle()->innerHTML);
+        $this->assertEmpty($readability->getTitle()->getInnerHtml());
-        $this->assertContains('This is an awesome text with some links, here there are', $readability->getContent()->innerHTML);
+        $this->assertContains('This is an awesome text with some links, here there are', $readability->getContent()->getInnerHtml());
-        $this->assertContains('nofollow', $readability->getContent()->innerHTML);
+        $this->assertContains('nofollow', $readability->getContent()->getInnerHtml());
     }
 
     public function testWithArticle()
@@ -177,10 +175,10 @@ class ReadabilityTest extends \PHPUnit_Framework_TestCase
         $this->assertTrue($res);
         $this->assertInstanceOf('Readability\JSLikeHTMLElement', $readability->getContent());
         $this->assertInstanceOf('Readability\JSLikeHTMLElement', $readability->getTitle());
-        $this->assertContains('alt="article"', $readability->getContent()->innerHTML);
+        $this->assertContains('alt="article"', $readability->getContent()->getInnerHtml());
-        $this->assertEmpty($readability->getTitle()->innerHTML);
+        $this->assertEmpty($readability->getTitle()->getInnerHtml());
-        $this->assertContains('This is an awesome text with some links, here there are', $readability->getContent()->innerHTML);
+        $this->assertContains('This is an awesome text with some links, here there are', $readability->getContent()->getInnerHtml());
-        $this->assertContains('nofollow', $readability->getContent()->innerHTML);
+        $this->assertContains('nofollow', $readability->getContent()->getInnerHtml());
     }
 
     public function testWithAside()
@@ -192,10 +190,10 @@ class ReadabilityTest extends \PHPUnit_Framework_TestCase
         $this->assertTrue($res);
         $this->assertInstanceOf('Readability\JSLikeHTMLElement', $readability->getContent());
         $this->assertInstanceOf('Readability\JSLikeHTMLElement', $readability->getTitle());
-        $this->assertEmpty($readability->getTitle()->innerHTML);
+        $this->assertEmpty($readability->getTitle()->getInnerHtml());
-        $this->assertContains('This is an awesome text with some links, here there are', $readability->getContent()->innerHTML);
+        $this->assertContains('This is an awesome text with some links, here there are', $readability->getContent()->getInnerHtml());
-        $this->assertNotContains('<aside>', $readability->getContent()->innerHTML);
+        $this->assertNotContains('<aside>', $readability->getContent()->getInnerHtml());
-        $this->assertContains('<footer readability="4"/>', $readability->getContent()->innerHTML);
+        $this->assertContains('<footer readability="5"/>', $readability->getContent()->getInnerHtml());
     }
 
     public function testWithClasses()
@@ -207,10 +205,10 @@ class ReadabilityTest extends \PHPUnit_Framework_TestCase
         $this->assertTrue($res);
         $this->assertInstanceOf('Readability\JSLikeHTMLElement', $readability->getContent());
         $this->assertInstanceOf('Readability\JSLikeHTMLElement', $readability->getTitle());
-        $this->assertContains('alt="article"', $readability->getContent()->innerHTML);
+        $this->assertContains('alt="article"', $readability->getContent()->getInnerHtml());
-        $this->assertEmpty($readability->getTitle()->innerHTML);
+        $this->assertEmpty($readability->getTitle()->getInnerHtml());
-        $this->assertContains('This is an awesome text with some links, here there are', $readability->getContent()->innerHTML);
+        $this->assertContains('This is an awesome text with some links, here there are', $readability->getContent()->getInnerHtml());
-        $this->assertNotContains('This text should be removed', $readability->getContent()->innerHTML);
+        $this->assertNotContains('This text should be removed', $readability->getContent()->getInnerHtml());
     }
 
     public function testWithClassesWithoutLightClean()
@@ -223,10 +221,10 @@ class ReadabilityTest extends \PHPUnit_Framework_TestCase
         $this->assertTrue($res);
         $this->assertInstanceOf('Readability\JSLikeHTMLElement', $readability->getContent());
         $this->assertInstanceOf('Readability\JSLikeHTMLElement', $readability->getTitle());
-        $this->assertContains('alt="article"', $readability->getContent()->innerHTML);
+        $this->assertContains('alt="article"', $readability->getContent()->getInnerHtml());
-        $this->assertEmpty($readability->getTitle()->innerHTML);
+        $this->assertEmpty($readability->getTitle()->getInnerHtml());
-        $this->assertContains('This is an awesome text with some links, here there are', $readability->getContent()->innerHTML);
+        $this->assertContains('This is an awesome text with some links, here there are', $readability->getContent()->getInnerHtml());
-        $this->assertNotContains('This text should be removed', $readability->getContent()->innerHTML);
+        $this->assertNotContains('This text should be removed', $readability->getContent()->getInnerHtml());
     }
 
     public function testWithTd()
@@ -238,8 +236,8 @@ class ReadabilityTest extends \PHPUnit_Framework_TestCase
         $this->assertTrue($res);
         $this->assertInstanceOf('Readability\JSLikeHTMLElement', $readability->getContent());
         $this->assertInstanceOf('Readability\JSLikeHTMLElement', $readability->getTitle());
-        $this->assertEmpty($readability->getTitle()->innerHTML);
+        $this->assertEmpty($readability->getTitle()->getInnerHtml());
-        $this->assertContains('This is an awesome text with some links, here there are', $readability->getContent()->innerHTML);
+        $this->assertContains('This is an awesome text with some links, here there are', $readability->getContent()->getInnerHtml());
     }
 
     public function testWithSameClasses()
@@ -251,9 +249,9 @@ class ReadabilityTest extends \PHPUnit_Framework_TestCase
         $this->assertTrue($res);
         $this->assertInstanceOf('Readability\JSLikeHTMLElement', $readability->getContent());
         $this->assertInstanceOf('Readability\JSLikeHTMLElement', $readability->getTitle());
-        $this->assertEmpty($readability->getTitle()->innerHTML);
+        $this->assertEmpty($readability->getTitle()->getInnerHtml());
-        $this->assertContains('This is an awesome text with some links, here there are', $readability->getContent()->innerHTML);
+        $this->assertContains('This is an awesome text with some links, here there are', $readability->getContent()->getInnerHtml());
-        $this->assertContains('This text is also an awesome text and you should know that', $readability->getContent()->innerHTML);
+        $this->assertContains('This text is also an awesome text and you should know that', $readability->getContent()->getInnerHtml());
     }
 
     public function testWithScript()
@@ -265,9 +263,9 @@ class ReadabilityTest extends \PHPUnit_Framework_TestCase
         $this->assertTrue($res);
         $this->assertInstanceOf('Readability\JSLikeHTMLElement', $readability->getContent());
         $this->assertInstanceOf('Readability\JSLikeHTMLElement', $readability->getTitle());
-        $this->assertEmpty($readability->getTitle()->innerHTML);
+        $this->assertEmpty($readability->getTitle()->getInnerHtml());
-        $this->assertContains('This is an awesome text with some links, here there are', $readability->getContent()->innerHTML);
+        $this->assertContains('This is an awesome text with some links, here there are', $readability->getContent()->getInnerHtml());
-        $this->assertNotContains('This text is also an awesome text and you should know that', $readability->getContent()->innerHTML);
+        $this->assertNotContains('This text is also an awesome text and you should know that', $readability->getContent()->getInnerHtml());
     }
 
     public function testTitle()
@@ -279,9 +277,9 @@ class ReadabilityTest extends \PHPUnit_Framework_TestCase
         $this->assertTrue($res);
         $this->assertInstanceOf('Readability\JSLikeHTMLElement', $readability->getContent());
         $this->assertInstanceOf('Readability\JSLikeHTMLElement', $readability->getTitle());
-        $this->assertEquals('this is my title', $readability->getTitle()->innerHTML);
+        $this->assertEquals('this is my title', $readability->getTitle()->getInnerHtml());
-        $this->assertContains('This is an awesome text with some links, here there are', $readability->getContent()->innerHTML);
+        $this->assertContains('This is an awesome text with some links, here there are', $readability->getContent()->getInnerHtml());
-        $this->assertNotContains('This text is also an awesome text and you should know that', $readability->getContent()->innerHTML);
+        $this->assertNotContains('This text is also an awesome text and you should know that', $readability->getContent()->getInnerHtml());
     }
 
     public function testTitleWithDash()
@@ -293,9 +291,9 @@ class ReadabilityTest extends \PHPUnit_Framework_TestCase
         $this->assertTrue($res);
         $this->assertInstanceOf('Readability\JSLikeHTMLElement', $readability->getContent());
         $this->assertInstanceOf('Readability\JSLikeHTMLElement', $readability->getTitle());
-        $this->assertEquals('title2 - title3', $readability->getTitle()->innerHTML);
+        $this->assertEquals('title2 - title3', $readability->getTitle()->getInnerHtml());
-        $this->assertContains('This is an awesome text with some links, here there are', $readability->getContent()->innerHTML);
+        $this->assertContains('This is an awesome text with some links, here there are', $readability->getContent()->getInnerHtml());
-        $this->assertNotContains('This text is also an awesome text and you should know that', $readability->getContent()->innerHTML);
+        $this->assertNotContains('This text is also an awesome text and you should know that', $readability->getContent()->getInnerHtml());
     }
 
     public function testTitleWithDoubleDot()
@@ -307,9 +305,9 @@ class ReadabilityTest extends \PHPUnit_Framework_TestCase
         $this->assertTrue($res);
         $this->assertInstanceOf('Readability\JSLikeHTMLElement', $readability->getContent());
         $this->assertInstanceOf('Readability\JSLikeHTMLElement', $readability->getTitle());
-        $this->assertEquals('title2 : title3', $readability->getTitle()->innerHTML);
+        $this->assertEquals('title2 : title3', $readability->getTitle()->getInnerHtml());
-        $this->assertContains('This is an awesome text with some links, here there are', $readability->getContent()->innerHTML);
+        $this->assertContains('This is an awesome text with some links, here there are', $readability->getContent()->getInnerHtml());
-        $this->assertNotContains('This text is also an awesome text and you should know that', $readability->getContent()->innerHTML);
+        $this->assertNotContains('This text is also an awesome text and you should know that', $readability->getContent()->getInnerHtml());
     }
 
     public function testTitleTooShortUseH1()
@@ -321,18 +319,11 @@ class ReadabilityTest extends \PHPUnit_Framework_TestCase
         $this->assertTrue($res);
         $this->assertInstanceOf('Readability\JSLikeHTMLElement', $readability->getContent());
         $this->assertInstanceOf('Readability\JSLikeHTMLElement', $readability->getTitle());
-        $this->assertEquals('this is my h1 title !', $readability->getTitle()->innerHTML);
+        $this->assertEquals('this is my h1 title !', $readability->getTitle()->getInnerHtml());
-        $this->assertContains('This is an awesome text with some links, here there are', $readability->getContent()->innerHTML);
+        $this->assertContains('This is an awesome text with some links, here there are', $readability->getContent()->getInnerHtml());
-        $this->assertNotContains('This text is also an awesome text and you should know that', $readability->getContent()->innerHTML);
+        $this->assertNotContains('This text is also an awesome text and you should know that', $readability->getContent()->getInnerHtml());
     }
 
-    // public function testConstructParser()
-    // {
-    //     $readability = $this->getReadability('<html/>', 'http://0.0.0.0', 'html5lib');
-
-    //     $this->assertEquals('http://0.0.0.0', $readability->url);
-    // }
-
     // dummy function to be used to the next test
     public function error2Exception($code, $string, $file, $line, $context)
     {
@@ -343,7 +334,7 @@ class ReadabilityTest extends \PHPUnit_Framework_TestCase
     {
         error_reporting(E_ALL | E_STRICT);
         ini_set('display_errors', true);
-        set_error_handler(array($this, 'error2Exception'), E_ALL | E_STRICT);
+        set_error_handler([$this, 'error2Exception'], E_ALL | E_STRICT);
 
         $data = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
             <html xmlns="http://www.w3.org/1999/xhtml" lang="ru-RU" prefix="og: http://ogp.me/ns#">
@@ -378,8 +369,8 @@ class ReadabilityTest extends \PHPUnit_Framework_TestCase
         $this->assertTrue($res);
         $this->assertInstanceOf('Readability\JSLikeHTMLElement', $readability->getContent());
         $this->assertInstanceOf('Readability\JSLikeHTMLElement', $readability->getTitle());
-        $this->assertContains('<iframe src="https://www.youtube.com/embed/PUep6xNeKjA" width="560" height="315" frameborder="0" allowfullscreen="allowfullscreen"> </iframe>', $readability->getContent()->innerHTML);
+        $this->assertContains('<iframe src="https://www.youtube.com/embed/PUep6xNeKjA" width="560" height="315" frameborder="0" allowfullscreen="allowfullscreen"> </iframe>', $readability->getContent()->getInnerHtml());
-        $this->assertContains('3D Touch', $readability->getTitle()->innerHTML);
+        $this->assertContains('3D Touch', $readability->getTitle()->getInnerHtml());
     }
 
     /**
@@ -443,13 +434,13 @@ class ReadabilityTest extends \PHPUnit_Framework_TestCase
 
     public function testPostFilters()
     {
-        $readability = $this->getReadability('<div>' . str_repeat('<p>This <b>is</b> the awesome content :)</p>', 10) . '</div>', 'http://0.0.0.0');
+        $readability = $this->getReadability('<div>' . str_repeat('<p>This <strong>is</strong> the awesome content :)</p>', 10) . '</div>', 'http://0.0.0.0');
         $readability->addPostFilter('!<strong[^>]*>(.*?)</strong>!is', '');
 
         $res = $readability->init();
 
         $this->assertTrue($res);
-        $this->assertContains('This  the awesome content :)', $readability->getContent()->innerHTML);
+        $this->assertContains('This  the awesome content :)', $readability->getContent()->getInnerHtml());
     }
 
     public function testPreFilters()
@@ -462,7 +453,7 @@ class ReadabilityTest extends \PHPUnit_Framework_TestCase
         $res = $readability->init();
 
         $this->assertTrue($res);
-        $this->assertContains('This the awesome and WONDERFUL content :)', $readability->getContent()->innerHTML);
+        $this->assertContains('This the awesome and WONDERFUL content :)', $readability->getContent()->getInnerHtml());
     }
 
     public function testChildNodeGoneNull()
@@ -477,4 +468,29 @@ class ReadabilityTest extends \PHPUnit_Framework_TestCase
 
         $this->assertTrue($res);
     }
+
+    public function testKeepFootnotes()
+    {
+        // from https://www.schreibdichte.de/blog/feed-aggregator-und-spaeter-lesen-dienst-im-team
+        $html = file_get_contents('tests/fixtures/keepFootnotes.html');
+
+        $readability = $this->getReadability($html, 'http://0.0.0.0');
+        $readability->debug = true;
+        $res = $readability->init();
+
+        $this->assertTrue($res);
+        $this->assertContains('<sup id="fnref1:fnfeed_2"><a href="#fn:fnfeed_2" class="footnote-ref">2</a></sup>', $readability->getContent()->getInnerHtml());
+        $this->assertContains('<a href="#fnref1:fnfeed_2" rev="footnote"', $readability->getContent()->getInnerHtml());
+    }
+
+    private function getReadability($html, $url = null, $parser = 'libxml', $useTidy = true)
+    {
+        $readability = new Readability($html, $url, $parser, $useTidy);
+
+        $this->logHandler = new TestHandler();
+        $this->logger = new Logger('test', [$this->logHandler]);
+        $readability->setLogger($this->logger);
+
+        return $readability;
+    }
 }

tests/fixtures/keepFootnotes.html

@@ -0,0 +1,54 @@
+<article>
+    
+    <h1>Feed-Aggregator und Sp&auml;ter-Lesen-Dienst im Team</h1>
+    
+        <figure>
+            <img src="https://www.schreibdichte.de/content/1-blog/20170505-feed-aggregator-und-spaeter-lesen-dienst-im-team/workflow.png" alt="Feed-Aggregator und Sp&auml;ter-Lesen-Dienst im Team" >
+        </figure>
+    
+    <time datetime="2017-05-05T18:40:00+00:00" >05.05.2017</time>
+    
+    <p> <span class="tag">Tags:</span>
+    <ul class="tag_list">
+                <li><a href="https://www.schreibdichte.de/blog/tag:Software">Software</a></li>
+                <li><a href="https://www.schreibdichte.de/blog/tag:Web">Web</a></li>
+                <li><a href="https://www.schreibdichte.de/blog/tag:Tools">Tools</a></li>
+        </ul>
+    <p>
+    
+    <div class="content">
+    <p>Dank einer Mitteilung <sup id="fnref1:fnfeed_1"><a href="#fn:fnfeed_1" class="footnote-ref">1</a></sup> im OSBN <sup id="fnref1:fnfeed_2"><a href="#fn:fnfeed_2" class="footnote-ref">2</a></sup>, bin ich auf den Feed-Aggregator Miniflux <sup id="fnref1:fnfeed_3"><a href="#fn:fnfeed_3" class="footnote-ref">3</a></sup> aufmerksam geworden. Ich hatte schon lange nach einer Alternative zu Fever <sup id="fnref1:fnfeed_4"><a href="#fn:fnfeed_4" class="footnote-ref">4</a></sup> gesucht, da der Anschein vorlag, dass die Entwicklung nicht mehr weiter ging. Was sich bestätigte.</p>
+    <p>Miniflux ist prima, einfach gehalten und erledigt genau dass, was es machen soll. Zudem wird die Fever-API unterstützt, was bedeutet, dass ich weiterhin meine Feed-Reader nutzen kann, was den Dialog mit Miniflux auf dem Server betrifft. Das ist deshalb interessant, um den Lesestatus oder das Favorisieren von Feeds zentral auf dem Server zu berücksichtigen und nicht lokal. So habe ich sowohl auf dem lokalen Rechner, als auch auf allen mobilen Geräten den gleichen Stand und Status meiner abonnierten Feeds.</p>
+    <p>Für das spätere Lesen von Webseiten, nutze ich seit längerem wallabag <sup id="fnref1:fnfeed_5"><a href="#fn:fnfeed_5" class="footnote-ref">5</a></sup>. Wallabag wird mit Inhalten über den Browser gefüttert. Die Webseiten werden bei der Konservierung von Werbung befreit, damit der reine Text vorliegt. Bilder dagegen nicht und gehen evtl. verloren, wenn es die Quelle mal nicht mehr geben sollte. Ich habe also zwei Orte, an denen Informationen gehalten werden. Miniflux zur Verwaltung von Feed-Nachrichten und Wallabag für Webseiten.</p>
+    <p>Bei einem Update von Miniflux ist mit aufgefallen, dass es nun eine API für Wallabag gibt. Dabei werden alle gespeicherten Feeds von Miniflux an Wallabag übergeben. Eine prima Angelegenheit, da ich jetzt nur noch einen Topf habe, woraus ich meine gesammelten Informationen aus dem Netz entnehme.</p>
+    <p>Miniflux als auch wallabag sind selbst gehostete Web-Applikationen, die auch über den Browser erreichbar sind. Native wallabag-Apps für iOS bzw. Android werden ebenfalls angeboten. Wallabag bietet zusätzlich einen Feed an, um die gesammelten Informationen per Feed-Reader zu lesen. Hierbei drängt sich evtl. die Idee auf, diesen Feed wieder in Miniflux zu abonnieren, da dann zentral alles aus verschiedenen Quellen vorliegt. Hier hätten wir allerdings eine gewisse Redundanz.</p>
+    <p>Ich nutze seit ein paar Monaten Devonthink <sup id="fnref1:fnfeed_6"><a href="#fn:fnfeed_6" class="footnote-ref">6</a></sup> auf dem Mac. Das ist eine lokale Dokumentenverwaltung (DMS), die heute u.a. meine Bücher, Notizen und mein Mail-Archiv verwaltet und ihre Stärke u.a. in der Suche von Informationen hat. Devonthink versteht es auch Feeds zu abonnieren. Für mich war dies der Moment, nun den Feed von wallabag mit all meinen gespeicherten Informationen aus dem Web mit zu integrieren. Ich muss sagen, eine runde Lösung, denn jetzt habe ich für die lokale Suche und das Lesen eine zentrale Stelle.</p>
+    <p>Die Grafik veranschaulicht das Teamplay zwischen Feed-Aggregator Miniflux und wallabag als Später-Lesen-Dienst, zusammengeführt in Devonthink. Ich kenne leider keine Dokumentenverwaltung für Linux oder Windows, die auch Feeds versteht. Wer etwas kennt, bitte melden. Wer zudem etwas zum Thema hören möchte, für dem ist ggf. die Podcast-Folge &quot;Der eigene Workflow&quot; <sup id="fnref1:fnfeed_7"><a href="#fn:fnfeed_7" class="footnote-ref">7</a></sup> interessant.</p>
+    <div class="footnotes">
+    <hr />
+    <ol>
+    <li id="fn:fnfeed_1">
+    <p>Artikel zu Miniflux: <a href="Link"><a href="https://www.robbinaer.info/index.php?post/78">https://www.robbinaer.info/index.php?post/78</a></a>&#160;<a href="#fnref1:fnfeed_1" rev="footnote" class="footnote-backref">&#8617;</a></p>
+    </li>
+    <li id="fn:fnfeed_2">
+    <p>OSBN: <a href="Link"><a href="https://osbn.de">https://osbn.de</a></a>&#160;<a href="#fnref1:fnfeed_2" rev="footnote" class="footnote-backref">&#8617;</a></p>
+    </li>
+    <li id="fn:fnfeed_3">
+    <p>Miniflux: <a href="Link"><a href="https://miniflux.net">https://miniflux.net</a></a>&#160;<a href="#fnref1:fnfeed_3" rev="footnote" class="footnote-backref">&#8617;</a></p>
+    </li>
+    <li id="fn:fnfeed_4">
+    <p>Fever: <a href="Link"><a href="https://feedafever.com">https://feedafever.com</a></a>&#160;<a href="#fnref1:fnfeed_4" rev="footnote" class="footnote-backref">&#8617;</a></p>
+    </li>
+    <li id="fn:fnfeed_5">
+    <p>wallabag: <a href="Link"><a href="https://wallabag.org/de">https://wallabag.org/de</a></a>&#160;<a href="#fnref1:fnfeed_5" rev="footnote" class="footnote-backref">&#8617;</a></p>
+    </li>
+    <li id="fn:fnfeed_6">
+    <p>Devonthink: <a href="Link"><a href="http://www.devontechnologies.com/de/produkte/devonthink/ueberblick.html">http://www.devontechnologies.com/de/produkte/devonthink/ueberblick.html</a></a>&#160;<a href="#fnref1:fnfeed_6" rev="footnote" class="footnote-backref">&#8617;</a></p>
+    </li>
+    <li id="fn:fnfeed_7">
+    <p>Podcast MacMittwoch: <a href="Link"><a href="https://itunes.apple.com/de/podcast/macmittwoch/id1212750085?mt=2ueberblick.html">https://itunes.apple.com/de/podcast/macmittwoch/id1212750085?mt=2ueberblick.html</a></a>&#160;<a href="#fnref1:fnfeed_7" rev="footnote" class="footnote-backref">&#8617;</a></p>
+    </li>
+    </ol>
+    </div></div>
+    
+    </article>