8.x

.github/workflows/php_lint.yml

@@ -0,0 +1,34 @@
+name: PHP Linting
+
+on:
+  push:
+    branches-ignore:
+      - 'master'
+      - 'main'
+  pull_request:
+    branches-ignore:
+      - 'master'
+      - 'main'
+
+jobs:
+  php-cs-fixer:
+    name: PHP-CS-Fixer
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.2'
+      - name: Install PHP-CS-Fixer
+        run: |
+          wget https://cs.symfony.com/download/php-cs-fixer-v3.phar -O php-cs-fixer
+          sudo chmod a+x php-cs-fixer
+          sudo mv php-cs-fixer /usr/local/bin/php-cs-fixer
+      - name: Checkout source code
+        uses: actions/checkout@master
+      - name: Run PHP-CS-Fixer - Fix
+        run: php-cs-fixer fix src -vvv --diff --config=.php-cs-fixer.php-highest.php
+      - name: Commit changes
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: Fix PHP code via php-cs-fixer (auto) [no ci]

.github/workflows/phpunit.yml

@@ -0,0 +1,32 @@
+name: PHPUnit tests
+
+on: [push, pull_request]
+
+permissions:
+  contents: read
+
+jobs:
+  tests_suite:
+    strategy:
+      matrix:
+        php_version: [ '8.2', '8.3', '8.4', '8.5' ]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php_version }}
+          extensions: json
+      - uses: actions/checkout@v3
+      - 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
+      - name: Execute PHPUnit tests
+        run: vendor/bin/phpunit

.gitignore

@@ -1,5 +1,9 @@
+/.phpunit.cache/
 /vendor/
 /.idea/
+/var/
 .php_cs.cache
+.php_cs-fixer.cache
+.php-cs-fixer.cache
 .phpunit.result.cache
 test.php

.php-cs-fixer.dist.php

@@ -0,0 +1,60 @@
+<?php
+
+declare(strict_types=1);
+
+$header = <<<'EOF'
+    This file is part of package ang3/php-odoo-api-client
+
+    This source file is subject to the MIT license that is bundled
+    with this source code in the file LICENSE.
+    EOF;
+
+$finder = PhpCsFixer\Finder::create()
+    ->ignoreDotFiles(false)
+    ->ignoreVCSIgnored(true)
+    ->exclude('tests/Fixtures')
+    ->in(__DIR__)
+    ->append([
+        __DIR__.'/dev-tools/doc.php',
+        // __DIR__.'/php-cs-fixer', disabled, as we want to be able to run bootstrap file even on lower PHP version, to show nice message
+    ])
+;
+
+$config = new PhpCsFixer\Config();
+$config
+    ->setRiskyAllowed(true)
+    ->setRules([
+        '@PHP74Migration' => true,
+        '@PHP74Migration:risky' => true,
+        '@PHPUnit100Migration:risky' => true,
+        '@PhpCsFixer' => true,
+        '@PhpCsFixer:risky' => true,
+        '@Symfony' => true,
+        'general_phpdoc_annotation_remove' => ['annotations' => ['expectedDeprecation']], // one should use PHPUnit built-in method instead
+        'header_comment' => ['header' => $header],
+        'heredoc_indentation' => false, // TODO switch on when # of PR's is lower
+        'modernize_strpos' => true, // needs PHP 8+ or polyfill
+        'no_useless_concat_operator' => false, // TODO switch back on when the `src/Console/Application.php` no longer needs the concat
+        'use_arrow_functions' => false, // TODO switch on when # of PR's is lower
+    ])
+    ->setFinder($finder)
+;
+
+// special handling of fabbot.io service if it's using too old PHP CS Fixer version
+if (false !== getenv('FABBOT_IO')) {
+    try {
+        PhpCsFixer\FixerFactory::create()
+            ->registerBuiltInFixers()
+            ->registerCustomFixers($config->getCustomFixers())
+            ->useRuleSet(new PhpCsFixer\RuleSet($config->getRules()))
+        ;
+    } catch (PhpCsFixer\ConfigurationException\InvalidConfigurationException $e) {
+        $config->setRules([]);
+    } catch (UnexpectedValueException $e) {
+        $config->setRules([]);
+    } catch (InvalidArgumentException $e) {
+        $config->setRules([]);
+    }
+}
+
+return $config;

.php-cs-fixer.php-highest.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+if (PHP_VERSION_ID < 80100 || PHP_VERSION_ID >= 80200) {
+    fwrite(STDERR, "PHP CS Fixer's config for PHP-HIGHEST can be executed only on highest supported PHP version - 8.1.*.\n");
+    fwrite(STDERR, "Running it on lower PHP version would prevent calling migration rules.\n");
+
+    exit(1);
+}
+
+$config = require __DIR__.'/.php-cs-fixer.dist.php';
+
+$config->setRules(array_merge($config->getRules(), [
+    '@PHP81Migration' => true,
+    '@PHP80Migration:risky' => true,
+    'heredoc_indentation' => false,
+]));
+
+return $config;

.readthedocs.yaml

@@ -0,0 +1,14 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.9"
+
+mkdocs:
+  configuration: mkdocs.yaml

CHANGELOG.md

@@ -1,6 +1,13 @@
 CHANGELOG
 =========
 
+8.0
+---
+
+* Support for PHP >= 8.1 only - The PHP extension `php-xmlrpc` is not used anymore.
+* Transport layer - XMLRPC replaced by JSONRPC.
+* Code review
+
 7.0
 ---
 

Dockerfile

@@ -0,0 +1,32 @@
+FROM php:8.2-cli-alpine
+
+# Install system packages for compilation
+RUN apk add --no-cache \
+    bash \
+    git \
+    unzip \
+    curl \
+    autoconf \
+    make \
+    gcc \
+    g++ \
+    musl-dev \
+    icu-dev \
+    zlib-dev \
+    libzip-dev \
+    oniguruma-dev \
+    linux-headers
+
+# Install PHP extensions
+RUN docker-php-ext-install intl zip
+
+# Install PCOV
+RUN pecl install pcov \
+    && docker-php-ext-enable pcov \
+    && echo "pcov.enabled=1" >> /usr/local/etc/php/conf.d/pcov.ini \
+    && echo "pcov.directory=/app/src" >> /usr/local/etc/php/conf.d/pcov.ini
+
+# Install Composer
+COPY --from=composer:2 /usr/bin/composer /usr/bin/composer
+
+WORKDIR /app

Makefile

@@ -0,0 +1,27 @@
+SHELL := /bin/bash
+
+DC := docker compose
+SERVICE := php
+
+.DEFAULT_GOAL := help
+
+.PHONY: help build up down bin logs
+
+help:
+	@echo "Targets:"
+	@echo "  build      Build image"
+	@echo "  up         Launch the container"
+	@echo "  down       Stop and delete the container"
+	@echo "  logs       Display logs"
+
+build:
+	$(DC) build
+
+up:
+	$(DC) up -d
+
+down:
+	$(DC) down --remove-orphans
+
+logs:
+	$(DC) logs -f $(SERVICE)