Merge branch 'release/1.2.1'

Author: chdemko

.github/workflows/php.yml

@@ -0,0 +1,45 @@
+name: PHP Composer
+
+on:
+  push:
+    branches: [ "main", "develop" ]
+  pull_request:
+    branches: [ "main", "develop" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Validate composer.json and composer.lock
+      run: composer validate --strict
+
+    - name: Cache Composer packages
+      id: composer-cache
+      uses: actions/cache@v3
+      with:
+        path: vendor
+        key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-php-
+
+    - name: Install dependencies
+      run: composer install --no-progress
+
+    - 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
+

.readthedocs.yml

@@ -0,0 +1,23 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Build documentation with MkDocs
+#mkdocs:
+#  configuration: mkdocs.yml
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats: all
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  version: 3.8
+  install:
+    - requirements: docs/requirements.txt

.travis.yml

@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2012-2018, Christophe Demko
+Copyright (c) 2012-2023, Christophe Demko
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

LICENSE

@@ -1,13 +1,14 @@
 PHP BitArray
 ======================
-[![Travis](https://img.shields.io/travis/chdemko/php-bitarray.svg)](http://travis-ci.org/chdemko/php-bitarray)
-[![Coveralls](https://img.shields.io/coveralls/chdemko/php-bitarray.svg)](https://coveralls.io/r/chdemko/php-bitarray?branch=master)
-[![Scrutinizer](https://img.shields.io/scrutinizer/g/chdemko/php-bitarray.svg)](https://scrutinizer-ci.com/g/chdemko/php-bitarray/?branch=master)
-[![PHP versions](https://img.shields.io/php-eye/chdemko/bitarray.svg)](https://packagist.org/packages/chdemko/bitarray)
+![PHP package](https://github.com/chdemko/php-bitarray/workflows/PHP%20Composer/badge.svg?branch=develop)
+[![Documentation Status](https://img.shields.io/readthedocs/php-bitarray.svg)](http://php-bitarray.readthedocs.io/en/latest/?badge=latest)
+[![Coveralls](https://img.shields.io/coveralls/chdemko/php-bitarray.svg)](https://coveralls.io/r/chdemko/php-bitarray?branch=develop)
+[![Scrutinizer](https://img.shields.io/scrutinizer/g/chdemko/php-bitarray/develop.svg)](https://scrutinizer-ci.com/g/chdemko/php-bitarray/?branch=develop)
+[![PHP versions](https://img.shields.io/packagist/dependency-v/chdemko/bitarray/php)](https://packagist.org/packages/chdemko/bitarray)
 [![Latest Stable Version](https://img.shields.io/packagist/v/chdemko/bitarray.svg)](https://packagist.org/packages/chdemko/bitarray)
 [![Packagist](https://img.shields.io/packagist/dt/chdemko/bitarray.svg)](https://packagist.org/packages/chdemko/bitarray)
 [![Latest Unstable Version](https://poser.pugx.org/chdemko/bitarray/v/unstable.svg)](https://packagist.org/packages/chdemko/bitarray)
-[![License](https://poser.pugx.org/chdemko/bitarray/license.svg)](https://raw.githubusercontent.com/chdemko/php-bitarray/master/LICENSE)
+[![License](https://poser.pugx.org/chdemko/bitarray/license.svg)](https://raw.githubusercontent.com/chdemko/php-bitarray/develop/LICENSE)
 
 BitArray for PHP.
 
@@ -27,16 +28,18 @@ It also provides methods for bitwise logical operations between two bit arrays `
 
 This project uses:
 
-* [PHP Code Sniffer](https://github.com/squizlabs/php_codesniffer) for checking PHP code style using [Joomla Coding Standards](https://github.com/joomla/coding-standards)
+* [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/) for api documentation
+* [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)
 
-Installation
+
+Instructions
 ------------
 
 Using composer: either
 
-~~~
+~~~shell
 $ composer create-project chdemko/bitarray:1.2.x-dev --dev; cd bitarray
 ~~~
 
@@ -49,38 +52,57 @@ or create a `composer.json` file containing
     }
 }
 ~~~
+
 and run
-~~~
+
+~~~shell
 $ composer install
 ~~~
 
 Create a `test.php` file containing
+
 ~~~php
 <?php
+
 require __DIR__ . '/vendor/autoload.php';
 
 use chdemko\BitArray\BitArray;
 
 $bits = BitArray::fromTraversable([true,false,false,true]);
 echo $bits . PHP_EOL;
 ~~~
+
 This should print
-~~~
+
+~~~console
 1001
 ~~~
+
 See the [examples](https://github.com/chdemko/php-bitarray/tree/master/examples) folder for more information.
 
 Documentation
 -------------
 
-* [http://chdemko.github.io/php-bitarray](http://chdemko.github.io/php-bitarray)
+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-bitarray/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-bitarray/develop/cite.bib)). You are also pleased to send me an email to [email protected].
 * authors: Christophe Demko
 * title: php-bitarray: a PHP library for handling bit arrays
 * year: 2014
-* how published: http://chdemko.github.io/php-bitarray
+* how published: https://packagist.org/packages/chdemko/bitarray/
 

README.md

@@ -1,6 +1,6 @@
 @Misc{php-bitarray-2014,
   Author         = {Christophe Demko},
   Title          = {php-bitarray: a PHP library for handling bit arrays},
-  HowPublished   = {http://chdemko.github.io/php-bitarray},
+  HowPublished   = {https://packagist.org/packages/chdemko/bitarray/},
   year           = 2014
 }

cite.bib

@@ -17,10 +17,9 @@
 		"php": ">=5.5.0"
 	},
 	"require-dev": {
-		"phpdocumentor/phpdocumentor": "2.9.*",
-		"php-coveralls/php-coveralls": "^2.0",
-		"joomla/coding-standards": "~2.0@alpha",
-		"phpunit/phpunit": "^7.0"
+		"php-coveralls/php-coveralls": "^2.5",
+		"squizlabs/php_codesniffer": "3.*",
+		"phpunit/phpunit": "^10.2"
 	},
 	"autoload": {
 		"psr-4": {
@@ -29,7 +28,11 @@
 	},
 	"extra": {
 		"branch-alias": {
-			"dev-master": "1.2.x-dev"
+			"dev-main": "1.2.x-dev"
 		}
+	},
+	"scripts": {
+		"style": "vendor/bin/phpcs --report=full --extensions=php --standard=PSR12 src tests examples",
+		"test": "XDEBUG_MODE=coverage vendor/bin/phpunit --log-junit junit.xml"
 	}
 }