Merge pull request #13 from andreskrey/development

Merging to master for next release

Author: andreskrey

.travis.yml

@@ -1,7 +1,8 @@
 language: php
 
+install: composer install
+
 php:
-  - "5.3"
   - "5.4"
   - "5.5"
   - "5.6"

CHANGELOG.md

@@ -3,6 +3,14 @@ All notable changes to this project will be documented in this file.
 
 ## Unreleased
 
+## [0.0.3-alpha](https://github.com/andreskrey/readability.php/releases/tag/v0.0.3v-alpha)
+
+We are getting closer to be a 100% complete port of Readability.js!
+- Added prepArticle to remove junk after selecting the top candidates.
+- Added a function to restore score after selecting top candidates. This basically works by scanning the data-readability tag and restoring the score to the contentScore variable. This is an horrible hack and should be removed once we ditch the Element interface of html-to-markdown and start extending the DOMDocument object.
+- Switched all strlen functions to mb_strlen
+- Fixed lots of bugs and pretty sure that introduced a bunch of new ones.
+
 ## [0.0.2-alpha](https://github.com/andreskrey/readability.php/releases/tag/v0.0.2-alpha)
  - Last version I'm using master as the main development branch. All unreleased changes and main development will happen in the develop branch.
 

README.md

@@ -1,9 +1,9 @@
 # Readability.php
-[![Latest Stable Version](https://poser.pugx.org/andreskrey/readability.php/v/stable)](https://packagist.org/packages/andreskrey/readability.php) [![StyleCI](https://styleci.io/repos/71042668/shield?branch=master)](https://styleci.io/repos/71042668)
+[![Latest Stable Version](https://poser.pugx.org/andreskrey/readability.php/v/stable)](https://packagist.org/packages/andreskrey/readability.php) [![StyleCI](https://styleci.io/repos/71042668/shield?branch=master)](https://styleci.io/repos/71042668) [![Build Status](https://travis-ci.org/andreskrey/readability.php.svg?branch=master)](https://travis-ci.org/andreskrey/readability.php)
 
 PHP port of *Mozilla's* **[Readability.js](https://github.com/mozilla/readability)**. Parses html text (usually news and other articles) and tries to return title, byline and text content. Analizes each text node, gives an score and orders them based on this calculation.
 
-**Requires**: PHP 5.4+
+**Requires**: PHP 5.4+ & DOMDocument (libxml)
 
 **Lead Developer**: Andres Rey
 
@@ -40,8 +40,19 @@ $result = [
 ]
 ```
 
+If the parsing process was unsuccessful the HTMLParser will return `false`
+
 ## Options
 
+- **maxTopCandidates**: default value `5`, max amount of top level candidates.
+- **articleByLine**: default value `false`, search for the article byline. 
+- **stripUnlikelyCandidates**: default value `true`, remove nodes that are unlikely to have relevant information. Useful for debugging or parsing complex or non-standard articles. 
+- **cleanConditionally**: default value `true`, remove certain nodes after parsing to return a cleaner result. 
+- **weightClasses**: default value `true`, weight classes during the rating phase. 
+- **removeReadabilityTags**: default value `true`, remove the data-readability tags inside the nodes that are added during the rating phase. 
+- **fixRelativeURLs**: default value `false`, convert relative URLs to absolute. Like `/test` to `http://host/test`. 
+- **originalURL**: default value `http://fakehost`, original URL from the article used to fix relative URLs. 
+
 ## Limitations
 
 Of course the main limitation is PHP. Websites that load the content through lazy loading, AJAX, or any type of javascript fueled call will be ignored (actually, *not ran*) and the resulting text will be incorrect, compared to the readability.js results. All the articles you want to parse with readability.php will need to be complete and all the content should be in the HTML already.  
@@ -78,6 +89,7 @@ Readability uses the Element interface and class from *The PHP League's* **[html
 100% of the original readability code was ported, at least until the last commit when I started this project ([13 Aug 2016](https://github.com/mozilla/readability/commit/71aa562387fa507b0bac30ae7144e1df7ba8a356)). There are a lot of `TODO`s around the code, which are the part that need to be finished.
 
 - Right now the Readability object is an extension of the Element object of html-to-markdown. This is a problem because you lose context. The scoring when creating a new Readability object must be reloaded manually. The DOMDocument object is consistent across the same document. You change one value here and that will update all other nodes in other variables. By using the element interface you lose that reference and the score must be restored manually. Ideally, the Readability object should be an extension of the DOMDocument or DOMElement objects, the score should be saved within that object and no restoration or recalculation would be needed.
+- There are a lot of problems with responsabilities. Right now there are two classes: HTMLParser and Readability. HTMLParser does a lot of things that should be a responsibility of Readability. It also does a lot of things that should be part of another class, specially when building the final article DOMDocument.
 
 ## How it works
 

phpunit.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit bootstrap="vendor/autoload.php"
+         colors="true"
+         stopOnFailure="false"
+         stopOnError="false">
+    <testsuites>
+        <testsuite name="Readability.php Test Suite">
+            <directory>./test/</directory>
+        </testsuite>
+    </testsuites>
+</phpunit>