Merge pull request #14 from aymanrb/v2.0

Version 2.0 (Upgrade to PHP7)

Author: aymanrb

.gitignore

@@ -41,3 +41,11 @@ examples/Logs/*
 ######################
 !empty
 !.gitkeep
+
+
+# PHP Unit #
+######################
+.phpunit.result.cache
+/cache.properties
+tests/_reports/*
+build/logs/*

.travis.yml

@@ -1,9 +1,8 @@
 language: php
 
 php:
-  - 5.6
-  - 7.0
-  - 7.1
+  - 7.2
+  - 7.3
 
 matrix:
   fast_finish: true
@@ -14,6 +13,9 @@ before_script:
 
 script: phpunit tests --coverage-clover=coverage.xml
 
+after_success:
+  - travis_retry php vendor/bin/php-coveralls
+
 notifications:
     on_success: never
     on_failure: always

README.md

@@ -1,36 +1,38 @@
 Unstructured Text Parser [PHP]
 ===========================================
 [![Build Status](https://travis-ci.org/aymanrb/php-unstructured-text-parser.svg?branch=master)](https://travis-ci.org/aymanrb/php-unstructured-text-parser)
+[![Coverage Status](https://coveralls.io/repos/github/aymanrb/php-unstructured-text-parser/badge.svg?branch=master)](https://coveralls.io/github/aymanrb/php-unstructured-text-parser?branch=master)
 [![Latest Stable Version](https://poser.pugx.org/aymanrb/php-unstructured-text-parser/v/stable.svg)](https://packagist.org/packages/aymanrb/php-unstructured-text-parser)
 [![Latest Unstable Version](https://poser.pugx.org/aymanrb/php-unstructured-text-parser/v/unstable.svg)](https://packagist.org/packages/aymanrb/php-unstructured-text-parser)
 [![License](https://poser.pugx.org/aymanrb/php-unstructured-text-parser/license.svg)](https://packagist.org/packages/aymanrb/php-unstructured-text-parser)
 
 
-About this Class
+About Unstructured Text Parser
 ----------------------------------
-This is a PHP Class to help extract text out of documents that are not structured in a processing friendly way. When you want to parse text out of form generated emails for example you can create a template matching the expected incoming mail format while specifying the variable text elements and leave the rest for the class to extract your preformatted variables out of the incoming mails' body text.
+This is a small PHP library to help extract text out of documents that are not structured in a processing friendly format. 
+When you want to parse text out of form generated emails for example you can create a template matching the expected incoming mail format 
+while specifying the variable text elements and leave the rest for the class to extract your pre-formatted variables out of the incoming mails' body text.
 
 Useful when you want to parse data out of:
 * Emails generated from web forms
 * Documents with definable templates / expressions
 
 Installation
 ----------
+PHP Unstructured Text Parser is available on [Packagist](https://packagist.org/packages/aymanrb/php-unstructured-text-parser) (using semantic versioning), and installation via [Composer](https://getcomposer.org) is recommended. 
+Add the following line to your `composer.json` file:
 
-#### 1- Using [composer](https://getcomposer.org/) simply run the following:
-
-```shell
-$ composer require aymanrb/php-unstructured-text-parser
+```json
+"aymanrb/php-unstructured-text-parser": "~2.0"
 ```
 
-#### 2- Clone / Copy the files from this repository to your local libs directory:
+or run
 
-```shell
-$ git clone https://github.com/aymanrb/php-unstructured-text-parser.git
+```sh
+composer require aymanrb/php-unstructured-text-parser
 ```
 
 
-
 [Usage example](https://github.com/aymanrb/php-unstructured-text-parser/blob/master/examples/run.php)
 ----------
 ```php
@@ -41,11 +43,16 @@ $parser = new aymanrb\UnstructuredTextParser\TextParser('/path/to/templatesDirec
 
 $textToParse = 'Text to be parsed fetched from a file, mail, web service, or even added directly to the a string variable like this';
 
-//performs brute force parsing against all available templates
-print_r($parser->parseText($textToParse));
+//performs brute force parsing against all available templates, returns first match successful parsing
+$parseResults = $parser->parseText($textToParse);
+print_r($parseResults->getParsedRawData());
 
-//slower, performs a similarity check on available templates before parsing
-print_r($parser->parseText($textToParse, true)); 
+//slower, performs a similarity check on available templates to select the most matching template before parsing
+print_r(
+    $parser
+        ->parseText($textToParse, true)
+        ->getParsedRawData()
+);
 ```
 
 Parsing Procedure
@@ -74,13 +81,13 @@ Best Regards
 Admin
 ```
 
-Then your Template file (``example_template.txt``) should be:
+Your Template file (``example_template.txt``) could be something like:
 
 ```
-Hi {%name_of_receiver%},
+Hi {%nameOfRecipient%},
 If you wish to parse message coming from a website that states info like:
-Name: {%sender_name%}
-E-Mail: {%sender_email%}
+Name: {%senderName%}
+E-Mail: {%senderEmail%}
 Comment: {%comment%}
 
 Thank You,
@@ -92,9 +99,24 @@ The output of a successful parsing job would be:
 
 ```
 Array(
-    'name_of_receiver' => 'GitHub-er',
-    'sender_name' => 'Pet Cat',
-    'sender_email' => 'email@example.com',
-    'Comment' => 'Some text goes here'
+    'nameOfRecipient' => 'GitHub-er',
+    'senderName' => 'Pet Cat',
+    'senderEmail' => 'email@example.com',
+    'comment' => 'Some text goes here'
 )
 ```
+
+Upgrading from v1.3 to v2.0
+------------------------
+Version 2.0 is more or less a refactored copy of version 1.x of the library and provides the exact same functionality.
+There is just one slight difference in the results returned. It's now a parsed data object instead of an array.
+To get the results as an array like it used to be in v1.x simply call "*getParsedRawData()*" on the returned object.
+
+```php
+<?php
+//ParseText used to return array in 1.x
+$extractedArray = $parser->parseText($textToParse);
+
+//In 2.x you need to do the following if you want an array
+$extractedArray = $parser->parseText($textToParse)->getParsedRawData();
+```

composer.json

@@ -1,6 +1,6 @@
 {
   "name": "aymanrb/php-unstructured-text-parser",
-  "description": "A PHP Class to help extract text out of documents that are not structured in a processing friendly manner",
+  "description": "A PHP library to help extract text out of text documents",
   "keywords": [
     "text parser",
     "extract data",
@@ -12,10 +12,10 @@
   ],
   "config": {
     "platform": {
-      "php": "5.6.0"
+      "php": "7.3.0"
     }
   },
-  "version": "1.3.0",
+  "version": "2.0.0",
   "type": "library",
   "license": "MIT",
   "authors": [
@@ -48,11 +48,11 @@
   },
   "require": {
     "ext-json": "*",
-    "php": ">=5.6.0",
-    "monolog/monolog": "^1.24",
+    "php": ">=7.1.0",
     "psr/log": "^1.1"
   },
   "require-dev": {
-    "phpunit/phpunit": "^5.0"
+    "phpunit/phpunit": "^8.0",
+    "php-coveralls/php-coveralls": "^2.1"
   }
 }