Merge branch 'release/1.0.7'

Author: chdemko

.github/workflows/php.yml

@@ -32,11 +32,14 @@ jobs:
     - name: Install dependencies
       run: composer install --no-progress
 
-    # Add a test script to composer.json, for instance: "test": "vendor/bin/phpunit"
-    # Docs: https://getcomposer.org/doc/articles/scripts.md
-
     - name: Run style
       run: composer run style
 
     - name: Run test
       run: composer run test
+
+    - name: Upload coverage results to Coveralls
+      env:
+        COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
+      run: vendor/bin/php-coveralls --coverage_clover=build/logs/clover.xml -v
+

README.md

@@ -2,13 +2,13 @@ PHP Sorted Collections
 ======================
 ![PHP package](https://github.com/chdemko/php-sorted-collections/workflows/PHP%20Composer/badge.svg?branch=develop)
 [![Documentation Status](https://img.shields.io/readthedocs/php-sorted-collections.svg)](http://php-sorted-collections.readthedocs.io/en/latest/?badge=latest)
-[![Coveralls](https://img.shields.io/coveralls/chdemko/php-sorted-collections.svg)](https://coveralls.io/r/chdemko/php-sorted-collections?branch=master)
-[![Scrutinizer](https://img.shields.io/scrutinizer/g/chdemko/php-sorted-collections.svg)](https://scrutinizer-ci.com/g/chdemko/php-sorted-collections/?branch=master)
+[![Coveralls](https://img.shields.io/coveralls/chdemko/php-sorted-collections.svg)](https://coveralls.io/r/chdemko/php-sorted-collections?branch=develop)
+[![Scrutinizer](https://img.shields.io/scrutinizer/g/chdemko/php-sorted-collections/develop.svg)](https://scrutinizer-ci.com/g/chdemko/php-sorted-collections/?branch=develop)
 [![PHP versions](https://img.shields.io/packagist/dependency-v/chdemko/sorted-collections/php)](https://packagist.org/packages/chdemko/sorted-collections)
 [![Latest Stable Version](https://img.shields.io/packagist/v/chdemko/sorted-collections.svg)](https://packagist.org/packages/chdemko/sorted-collections)
 [![Packagist](https://img.shields.io/packagist/dt/chdemko/sorted-collections.svg)](https://packagist.org/packages/chdemko/sorted-collections)
 [![Latest Unstable Version](https://poser.pugx.org/chdemko/sorted-collections/v/unstable.svg)](https://packagist.org/packages/chdemko/sorted-collections)
-[![License](https://poser.pugx.org/chdemko/sorted-collections/license.svg)](https://raw.githubusercontent.com/chdemko/php-sorted-collections/master/LICENSE)
+[![License](https://poser.pugx.org/chdemko/sorted-collections/license.svg)](https://raw.githubusercontent.com/chdemko/php-sorted-collections/develop/LICENSE)
 
 Sorted Collection for PHP. Insertion, search, and removal compute in `log(n)` time where `n` is the number of items present in the collection. It uses AVL threaded tree [see @Knuth97, 1:320, Sect. 2.3.1] as internal structure.
 
@@ -18,14 +18,15 @@ This project uses:
 
 * [PHP Code Sniffer](https://github.com/squizlabs/php_codesniffer) for checking PHP code style
 * [PHPUnit](http://phpunit.de/) for unit test (100% covered)
-* [phpDocumentor](http://http://www.phpdoc.org/) and [sphpdox](https://packagist.org/packages/sphpdox/sphpdox) for [documentation](http://php-sorted-collections.readthedocs.io/en/latest/?badge=latest)
+* [Sphinx](https://www.sphinx-doc.org/) and [Doxygen](https://www.doxygen.nl/) for the
+  [documentation](http://php-sorted-collections.readthedocs.io/en/latest/?badge=latest)
 
 Instructions
 ------------
 
 Using composer: either
 
-~~~bash
+~~~shell
 $ composer create-project chdemko/sorted-collections:1.0.*@dev; cd sorted-collections
 ~~~
 
@@ -41,21 +42,15 @@ or create a `composer.json` file containing
 
 and run
 
-~~~bash
+~~~shell
 $ composer install
 ~~~
 
-Run also
-
-~~~bash
-$ [sudo] pip install [--user] -r docs/requirements.txt
-~~~
-
-if you want to create local documentation.
-
 Create a `test.php` file containg
 
 ~~~php
+<?php
+
 require __DIR__ . '/vendor/autoload.php';
 
 use chdemko\SortedCollection\TreeMap;
@@ -66,18 +61,42 @@ $tree = TreeMap::create()->put(
 echo $tree . PHP_EOL;
 ~~~
 
-This should print
+And run
 
+~~~shell
+$ php test.php
 ~~~
+
+This should print
+
+~~~console
 [0,1,2,3,4,5,6,7,8,9]
 ~~~
 
-See the [examples](https://github.com/chdemko/php-sorted-collections/tree/master/examples) and [benchmarks](https://github.com/chdemko/php-sorted-collections/tree/master/benchmarks) folder for more information.
+See the [examples](https://github.com/chdemko/php-sorted-collections/tree/develop/examples) and [benchmarks](https://github.com/chdemko/php-sorted-collections/tree/develop/benchmarks) folder for more information.
+
+Documentation
+-------------
+
+Run
+
+~~~shell
+$ sudo apt install doxygen python3-pip python3-virtualenv
+$ virtualenv venv
+$ venv/bin/activate
+(venv) $ pip install -r docs/requirements.txt
+(venv) $ sphinx-build -b html docs/ html/
+(venv) $ deactivate
+$
+~~~
+
+if you want to create local documentation with Sphinx.
+
 
 Citation
 --------
 
-If you are using this project including publication in research activities, you have to cite it using ([BibTeX format](https://raw.github.com/chdemko/php-sorted-collections/master/cite.bib)). You are also pleased to send me an email to [email protected].
+If you are using this project including publication in research activities, you have to cite it using ([BibTeX format](https://raw.github.com/chdemko/php-sorted-collections/develop/cite.bib)). You are also pleased to send me an email to [email protected].
 * authors: Christophe Demko
 * title: php-sorted-collections: a PHP library for handling sorted collections
 * year: 2014

composer.json

@@ -20,7 +20,6 @@
 		"php-coveralls/php-coveralls": "^2.5",
 		"squizlabs/php_codesniffer": "3.*",
 		"phpunit/phpunit": "^10.2",
-		"sphpdox/sphpdox": "dev-master",
 		"phpbench/phpbench": "^1.2"
 	},
 	"autoload": {
@@ -35,11 +34,7 @@
 	},
 	"scripts": {
 		"style": "vendor/bin/phpcs --report=full --extensions=php --standard=PSR12 src tests examples benchmarks",
-		"test": "XDEBUG_MODE=coverage vendor/bin/phpunit",
-		"doc": [
-			"vendor/bin/sphpdox process --output docs chdemko src",
-			"sphinx-build -b html docs/ html/"
-		],
+		"test": "XDEBUG_MODE=coverage vendor/bin/phpunit --log-junit junit.xml",
 		"benchmark": "vendor/bin/phpbench run --report=default"
 	}
 }