Merge pull request #215 from DigitalTimK/code_quality

Code quality

Author: GhaziTriki

.php-cs-fixer.php

@@ -2,48 +2,70 @@
 
 declare(strict_types=1);
 
+/*
+ * BigBlueButton open source conferencing system - https://www.bigbluebutton.org/.
+ *
+ * Copyright (c) 2016-2024 BigBlueButton Inc. and by respective authors (see below).
+ *
+ * This program is free software; you can redistribute it and/or modify it under the
+ * terms of the GNU Lesser General Public License as published by the Free Software
+ * Foundation; either version 3.0 of the License, or (at your option) any later
+ * version.
+ *
+ * BigBlueButton is distributed in the hope that it will be useful, but WITHOUT ANY
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+ * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License along
+ * with BigBlueButton; if not, see <https://www.gnu.org/licenses/>.
+ */
+
+use PhpCsFixer\Config;
+use PhpCsFixer\Finder;
+
 $header = <<<'EOF'
-BigBlueButton open source conferencing system - https://www.bigbluebutton.org/.
+    BigBlueButton open source conferencing system - https://www.bigbluebutton.org/.
 
-Copyright (c) 2016-2023 BigBlueButton Inc. and by respective authors (see below).
+    Copyright (c) 2016-2024 BigBlueButton Inc. and by respective authors (see below).
 
-This program is free software; you can redistribute it and/or modify it under the
-terms of the GNU Lesser General Public License as published by the Free Software
-Foundation; either version 3.0 of the License, or (at your option) any later
-version.
+    This program is free software; you can redistribute it and/or modify it under the
+    terms of the GNU Lesser General Public License as published by the Free Software
+    Foundation; either version 3.0 of the License, or (at your option) any later
+    version.
 
-BigBlueButton is distributed in the hope that it will be useful, but WITHOUT ANY
-WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
-PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+    BigBlueButton is distributed in the hope that it will be useful, but WITHOUT ANY
+    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+    PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
 
-You should have received a copy of the GNU Lesser General Public License along
-with BigBlueButton; if not, see <http://www.gnu.org/licenses/>.
-EOF;
+    You should have received a copy of the GNU Lesser General Public License along
+    with BigBlueButton; if not, see <https://www.gnu.org/licenses/>.
+    EOF;
 
-$finder = PhpCsFixer\Finder::create()
+$finder = Finder::create()
     ->files()
     ->name(['*.php'])
     ->in(__DIR__ . '/src')
-    ->in(__DIR__ . '/tests');
+    ->in(__DIR__ . '/tests')
+;
 
-$config = new PhpCsFixer\Config();
+$config = new Config();
 $config
     ->setRiskyAllowed(true)
     ->setRules([
-        '@PhpCsFixer' => true,
-        '@PHP74Migration' => true,
+        '@PhpCsFixer'                      => true,
+        '@PHP74Migration'                  => true,
         'general_phpdoc_annotation_remove' => ['annotations' => ['expectedDeprecation']], // one should use PHPUnit built-in method instead
-        'header_comment' => ['header' => $header],
-        'concat_space' => ['spacing' => 'one'],
-        'function_declaration' => ['closure_function_spacing' => 'none'],
-        'constant_case' => ['case' => 'lower'],
-        'single_quote' => true,
-        'mb_str_functions' => true,
-        'array_syntax' => ['syntax' => 'short'],
-        'binary_operator_spaces' => ['operators' =>
-            ['=>' => 'align_single_space_minimal', '=' => 'align_single_space_minimal']
+        'header_comment'                   => ['header' => $header],
+        'concat_space'                     => ['spacing' => 'one'],
+        'function_declaration'             => ['closure_function_spacing' => 'none'],
+        'constant_case'                    => ['case' => 'lower'],
+        'single_quote'                     => true,
+        'mb_str_functions'                 => true,
+        'array_syntax'                     => ['syntax' => 'short'],
+        'binary_operator_spaces'           => ['operators' => ['=>' => 'align_single_space_minimal', '=' => 'align_single_space_minimal'],
         ],
     ])
-    ->setFinder($finder);
+    ->setFinder($finder)
+;
 
 return $config;

README.md

@@ -31,20 +31,32 @@ install and usage example.
 Bugs and feature request are tracked on [GitHub](https://github.com/bigbluebutton/bigbluebutton-api-php/issues)
 
 ## Contributing guidelines
-### Code style
+### Code Quality 1: Style
 
 Make sure the code style configuration is applied by running PHPCS-Fixer.
 
+```bash
+# using an alias
+$ composer cs-fix
 ```
-composer cs-fix
+
+### Code Quality 2: Static code analysis
+PHPStan shall be used for static code analysis by running the command below:
+
+```bash
+# using an alias
+$ composer code-check
+
+# or the same w/o alias
+$ ./vendor/bin/phpstan analyse
 ```
 
-### Running tests
+### Code Quality 3: Tests
 
 For every implemented feature add unit tests and check all is green by running the command below.
 
 ```bash
-composer test
+$ composer test
 ```
 
 To run a single test

composer.json

@@ -27,6 +27,7 @@
     "ext-curl": "*",
     "ext-simplexml": "*",
     "ext-mbstring": "*",
+    "ext-json": "*",
     "marc-mabe/php-enum": "^v4.7.0"
   },
   "require-dev": {
@@ -38,9 +39,12 @@
     "nunomaduro/phpinsights": "^v2.11.0",
     "bmitch/churn-php": "^1.7.1",
     "phpmetrics/phpmetrics": "^v2.8.2",
-    "wapmorgan/php-deprecation-detector": "^2.0.33"
+    "wapmorgan/php-deprecation-detector": "^2.0.33",
+    "phpstan/phpstan": "^1.10",
+    "tracy/tracy": "^2.10"
   },
   "scripts": {
+    "code-check": "./vendor/bin/phpstan analyse",
     "test": "./vendor/bin/phpunit",
     "test-cov": "XDEBUG_MODE=coverage ./vendor/bin/phpunit --coverage-html coverage",
     "cs-fix": "PHP_CS_FIXER_IGNORE_ENV=1 ./vendor/bin/php-cs-fixer fix --allow-risky yes",

phpstan.neon

@@ -0,0 +1,5 @@
+parameters:
+    level: 8
+    paths:
+        - src/
+        - tests/

phpunit.xml.dist

@@ -18,4 +18,3 @@
     </testsuite>
   </testsuites>
 </phpunit>
-