PHP8 and external API stubs

Author: kevinpapst

.github/workflows/linting.yaml

@@ -0,0 +1,24 @@
+name: CI
+on:
+    pull_request: null
+    push:
+        branches:
+            - master
+jobs:
+    tests:
+        runs-on: ubuntu-latest
+        strategy:
+            matrix:
+                php: ['7.4', '8.0', '8.1']
+
+        name: Linting - PHP ${{ matrix.php }}
+        steps:
+            -   uses: actions/checkout@v2
+            -   uses: shivammathur/setup-php@v2
+                with:
+                    php-version: ${{ matrix.php }}
+                    coverage: none
+                    extensions: intl
+            -   run: composer install --no-progress
+            -   run: composer codestyle
+            -   run: composer phpstan

.gitignore

@@ -1,6 +1,7 @@
 .DS_Store
 .idea
-.php_cs.cache
+.php-cs-fixer.cache
 vendor/
 kimai.phar
 kimai.phar.sha1
+var/

.php_cs.dist .php-cs-fixer.dist.php

@@ -1,15 +1,14 @@
 <?php
 
-// php-cs-fixer fix
-
 $fileHeaderComment = <<<COMMENT
-This file is part of the Kimai 2 - Remote Console.
+This file is part of the "Remote Console" for Kimai.
 
 For the full copyright and license information, please view the LICENSE
 file that was distributed with this source code.
 COMMENT;
 
-return PhpCsFixer\Config::create()
+$fixer = new PhpCsFixer\Config();
+$fixer
     ->setRiskyAllowed(true)
     ->setRules([
         'encoding' => true,
@@ -21,7 +20,7 @@
         'function_declaration' => true,
         'indentation_type' => true,
         'line_ending' => true,
-        'lowercase_constants' => true,
+        'constant_case' => ['case' => 'lower'],
         'lowercase_keywords' => true,
         'method_argument_space' => ['on_multiline' => 'ensure_fully_multiline'],
         'header_comment' => ['header' => $fileHeaderComment, 'separate' => 'both'],
@@ -48,7 +47,7 @@
             'statements' => ['return'],
         ],
         'cast_spaces' => true,
-        'class_attributes_separation' => ['elements' => ['method']],
+        'class_attributes_separation' => ['elements' => ['method' => 'one']],
         'concat_space' => ['spacing' => 'one'],
         'declare_equal_normalize' => true,
         'function_typehint_space' => true,
@@ -78,8 +77,7 @@
         'no_short_bool_cast' => true,
         'no_singleline_whitespace_before_semicolons' => true,
         'no_spaces_around_offset' => true,
-        'no_trailing_comma_in_list_call' => true,
-        'no_trailing_comma_in_singleline_array' => true,
+        'no_trailing_comma_in_singleline' => true,
         'no_unneeded_curly_braces' => true,
         'no_unneeded_final_method' => true,
         'no_unused_imports' => true,
@@ -102,10 +100,10 @@
         ],
         'phpdoc_annotation_without_dot' => true,
         'phpdoc_indent' => true,
-        'phpdoc_inline_tag' => true,
+        'phpdoc_inline_tag_normalizer' => true,
         'phpdoc_no_access' => true,
         'phpdoc_no_alias_tag' => true,
-        'phpdoc_no_empty_return' => true,
+        'phpdoc_no_empty_return' => false,
         'phpdoc_no_package' => true,
         'phpdoc_no_useless_inheritdoc' => true,
         'phpdoc_return_self_reference' => true,
@@ -132,7 +130,7 @@
         'standardize_increment' => true,
         'standardize_not_equals' => true,
         'ternary_operator_spaces' => true,
-        'trailing_comma_in_multiline_array' => false,
+        'trailing_comma_in_multiline' => false,
         'trim_array_spaces' => true,
         'unary_operator_spaces' => true,
         'whitespace_after_comma_in_array' => true,
@@ -143,6 +141,18 @@
             'method',
             'property',
         ]],
+        'native_function_invocation' => [
+            'include' => [
+                '@compiler_optimized'
+            ],
+            'scope' => 'namespaced'
+        ],
+        'native_function_type_declaration_casing' => true,
+        'no_alias_functions' => [
+            'sets' => [
+                '@internal'
+            ]
+        ],
     ])
     ->setFinder(
         PhpCsFixer\Finder::create()
@@ -152,3 +162,5 @@
     )
     ->setFormat('checkstyle')
 ;
+
+return $fixer;

README.md

@@ -4,7 +4,7 @@ A PHP application to access your Kimai 2 installation via its API (http).
 
 **Requirements**
 
-- PHP 7.3
+- PHP 7.4, 8.0 or 8.1
 - cURL extension
 - json extension
 - iconv extension
@@ -40,10 +40,8 @@ chmod 600 ~/.kimai2-console.json
 
 That's it, you can use Kimai from the command line now.
 
-By default the configuration file targets the demo installation and will work... but now its time to target your own Kimai, so 
-edit the config file and change the settings: URL, username and API token.
-
-The following config keys are available:
+By default, the configuration file targets the demo installation and will work... 
+but now it's time to target your own Kimai, so please edit the config file and change the settings: 
 
 - `URL`: the Kimai installation URL
 - `USERNAME`: the Kimai installation URL
@@ -122,15 +120,7 @@ The following environment variables are supported:
 
 ### Updating the Console tools
 
-The following commands will help you with updating the Console tools:
-
-- `kimai self:check` - check if there is a new version available
-- `kimai self:update` - update your local version to the latest release
-- `kimai self:rollback` - rollback to a previous release
-
-There are security concerns with this approach, if you are cautious stick to the initial installation process.
-
-The `update` command will create a copy beside the original executable (if you wondered what `kimai-old.phar` is: now you know!), which is used by the `rollback` command.  
+Redo the initial installation process and overwrite the file `/usr/local/bin/kimai` with the [latest release](https://github.com/kevinpapst/kimai2-console/releases).
 
 ### Check the contents of the PHAR
 
@@ -159,6 +149,7 @@ box compile
 ### Release on GitHub
 
 - Bump version in `src/Constants.php`
+- Execute `composer install --no-dev`
 - Execute `box compile`
 - Execute `sha1sum kimai.phar > kimai.phar.sha1`
 - Prepare a new GitHub release

bin/kimai

@@ -56,6 +56,7 @@ if ($require) {
 unset($require);
 // -------------------------- AUTOLOAD --------------------------
 
+error_reporting(E_ALL & ~E_DEPRECATED); // swagger generates php 5.5 code, which triggers deprecations on PHP 8
 set_time_limit(0);
 
 use KimaiConsole\Application;

composer.json

@@ -2,22 +2,29 @@
     "name": "kevinpapst/kimai2-console",
     "license": "MIT",
     "type": "project",
-    "description": "Kimai 2 - console application to manage your time-tracking data remotely",
+    "description": "Kimai - console application to manage your time-tracking data remotely",
     "authors": [
         {
             "name": "Kevin Papst",
             "homepage": "https://www.kevinpapst.de"
         }
     ],
     "require": {
-        "php": "^7.2.5",
+        "php": "7.4.*||8.0.*||8.1.*",
         "ext-iconv": "*",
         "ext-json": "*",
         "guzzlehttp/guzzle": "^6.5",
-        "padraic/phar-updater": "^1.0",
-        "symfony/console": "5.0.*"
+        "kimai/api-php": "^0.1.0",
+        "symfony/console": "5.*"
+    },
+    "require-dev": {
+        "friendsofphp/php-cs-fixer": "^3.2",
+        "phpstan/phpstan": "^1.0"
     },
     "config": {
+        "platform": {
+            "php": "7.4"
+        },
         "preferred-install": {
             "*": "dist"
         },
@@ -38,7 +45,14 @@
     "extra": {
         "symfony": {
             "allow-contrib": false,
-            "require": "5.0.*"
+            "require": "5.*"
         }
+    },
+    "scripts": {
+        "phpstan": [
+            "vendor/bin/phpstan analyse src -c phpstan.neon --level=5"
+        ],
+        "codestyle": "vendor/bin/php-cs-fixer fix --dry-run --verbose --show-progress=none",
+        "codestyle-fix": "vendor/bin/php-cs-fixer fix"
     }
 }