Merge pull request #10 from Chris53897/feature/strong-types

feat: modernize, add strong types, add phpstan, add php-cs-fixer, get…

.github/workflows/tests.yml

@@ -0,0 +1,27 @@
+name: "Tests"
+
+on:
+  push:
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        php: ['8.0', '8.1', '8.2']
+
+    name: "Tests"
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          coverage: pcov
+      - run: composer install --no-progress
+      - run: composer run-script phpstan
+      - run: composer run-script phpunit

.gitignore

@@ -4,5 +4,8 @@ composer.lock
 *.buildpath
 *.prefs
 
+.phpunit.result.cache
+.php-cs-fixer.cache
+
 .settings/org.eclipse.wst.common.project.facet.core.xml
 .project

.php-cs-fixer.php

@@ -0,0 +1,18 @@
+<?php
+
+$finder = PhpCsFixer\Finder::create()
+    ->files()
+    ->name('*.php')
+    ->in(__DIR__.'/examples')
+    ->in(__DIR__.'/library')
+    ->in(__DIR__.'/tests')
+;
+
+$config = new PhpCsFixer\Config();
+return $config
+    ->setRiskyAllowed(false)
+    ->setRules([
+        '@PSR2' => true,
+    ])
+    ->setFinder($finder)
+;

README.md

@@ -24,7 +24,7 @@ Interested in API docs? You can check out the [Philips API documentation](http:/
 
 ## Requirements
 
-* PHP 7.1+
+* PHP 8.0+
 * cURL extension (optional)
 
 For old php support please use the original package sqmk/Phue
@@ -512,7 +512,7 @@ Number of bridges found: 1
 
 The internal IP address(es) listed in the results is what you need for the Phue client.
 
-If the script provided doesn't find your bridge, or if you don't have internet connection on your network, I have created a wiki page that describes a few other convenient ways of finding it: [Finding Philips Hue bridge on network](/sqmk/Phue/wiki/Finding-Philips-Hue-bridge-on-network).
+If the script provided doesn't find your bridge, or if you don't have internet connection on your network, I have created a wiki page that describes a few other convenient ways of finding it: [Finding Philips Hue bridge on network](https://github.com/neoteknic/Phue/wiki/Finding-Philips-Hue-bridge-on-your-network).
 
 ### Authentication / Creating a User
 
@@ -576,3 +576,10 @@ Now that you have found and registered new lights with the bridge, you can now m
 ### More examples
 
 If you are interested in seeing examples for all sorts of commands, check out the ```examples``` directory.
+
+### Run tests PhpStan and PhpUnit
+
+```
+composer run-script phpstan
+composer run-script phpunit
+```

composer.json

@@ -1,5 +1,4 @@
 {
-
     "name": "neoteknic/phue",
     "description": "Phue - Philips Hue PHP client - Fork by Neoteknic - extra features",
     "type": "library",
@@ -27,8 +26,10 @@
         "php": "^8.0"
     },
     "require-dev": {
-        "mockery/mockery": "1.*",
-        "phpunit/phpunit": "9.*"
+        "mockery/mockery": "^1.5",
+        "phpunit/phpunit": "^9.5",
+        "phpstan/phpstan": "^1.8",
+        "friendsofphp/php-cs-fixer": "^3.9.5"
     },
     "suggest": {
         "ext-curl": "Allows usage of cURL transport adapter"
@@ -43,5 +44,9 @@
         "bin/phue-bridge-finder",
         "bin/phue-light-finder",
         "bin/phue-list-lights"
-    ]
+    ],
+    "scripts": {
+        "phpstan": "phpstan analyse library --no-progress --level=6",
+        "phpunit": "phpunit "
+    }
 }

examples/all-lights-colorloop.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @noinspection PhpUndefinedVariableInspection */
 /**
  * Example: All lights to colorloop effect.
  *

examples/all-lights-scene.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @noinspection PhpUndefinedVariableInspection */
 /**
  * Example: All lights to a scene.
  *

examples/candle-effect.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @noinspection PhpUndefinedVariableInspection */
 /**
  * Example: Candle effect.
  *

examples/create-group.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @noinspection PhpUndefinedVariableInspection */
 /**
  * Example: Create test group.
  *

examples/create-rule.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @noinspection PhpUndefinedVariableInspection */
 /**
  * Example: Create test rule.
  *

examples/create-scene-state.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @noinspection PhpUndefinedVariableInspection */
 /**
  * Example: Create test scene, set state, and assign to group.
  *

examples/create-sensor.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @noinspection PhpUndefinedVariableInspection */
 /**
  * Example: Create test sensor.
  *

examples/delete-all-schedules.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @noinspection PhpUndefinedVariableInspection */
 /**
  * Example: Delete all schedules.
  *

examples/delete-group.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @noinspection PhpUndefinedVariableInspection */
 /**
  * Example: Delete test group.
  *

examples/delete-scene.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @noinspection PhpUndefinedVariableInspection */
 /**
  * Example: Delete test scene.
  *

examples/delete-schedule.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @noinspection PhpUndefinedVariableInspection */
 /**
  * Example: Delete a schedule.
  *

examples/list-groups.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @noinspection PhpUndefinedVariableInspection */
 /**
  * Example: List groups registered on bridge.
  *

examples/list-lights.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @noinspection PhpUndefinedVariableInspection */
 /**
  * Example: List lights registered on bridge.
  *

examples/list-rules.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @noinspection PhpUndefinedVariableInspection */
 /**
  * Example: List rules.
  *
@@ -11,7 +11,7 @@
 echo 'Listing rules:', "\n";
 
 foreach ($client->getRules() as $rule) {
-    echo "\t", "#{$rule->getId()} - {$rule->getName()}", "\n", "\t\t", "Last Triggered Time: {$rule->getLastTriggeredTime()}", "\n", "\t\t", "Created date: {$rule->getCreatedDate()}", "\n", "\t\t", "Times triggered: {$rule->getTriggeredCount()}", "\n", "\t\t", "Owner: {$rule->getOwner()}", "\n", "\t\t", "Status: ", $rule->isEnabled() ? 'Yes' : 'No', "\n";
+    echo "\t", "#{$rule->getId()} - {$rule->getName()}", "\n", "\t\t", "Last Triggered Time: {$rule->getLastTriggeredTime()}", "\n", "\t\t", "Created date: {$rule->getCreateDate()}", "\n", "\t\t", "Times triggered: {$rule->getTriggeredCount()}", "\n", "\t\t", "Owner: {$rule->getOwner()}", "\n", "\t\t", "Status: ", $rule->isEnabled() ? 'Yes' : 'No', "\n";
 
     echo "\t\t", "Conditions: ", "\n";
     foreach ($rule->getConditions() as $condition) {

examples/list-scenes.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @noinspection PhpUndefinedVariableInspection */
 /**
  * Example: List scenes registered on bridge.
  *

examples/list-schedules.php

@@ -6,10 +6,12 @@
  */
 require_once 'common.php';
 
+/** @noinspection PhpUndefinedVariableInspection */
 $client = new \Phue\Client($hueHost, $hueUsername);
 
 echo 'Listing schedules:', "\n";
 
+# TODO $schedule ?
 $cmd = $schedule->getCommand();
 foreach ($client->getSchedules() as $schedule) {
     echo "\t", "#{$schedule->getId()} - {$schedule->getName()}", "\n", "\t\t", "Time scheduled: {$schedule->getTime()}", "\n", 

examples/list-sensors.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @noinspection PhpUndefinedVariableInspection */
 /**
  * Example: List sensors.
  *

examples/list-timezones.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @noinspection PhpUndefinedVariableInspection */
 /**
  * Example: List timezones.
  *

examples/list-users.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @noinspection PhpUndefinedVariableInspection */
 /**
  * Example: List users.
  *

examples/schedule-all-lights-change.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @noinspection PhpUndefinedVariableInspection */
 /**
  * Example: Schedule all lights to change.
  *

examples/schedule-group-state.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @noinspection PhpUndefinedVariableInspection */
 /**
  * Example: Schedule a specific groups state.
  *

examples/schedule-recurring.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @noinspection PhpUndefinedVariableInspection */
 /**
  * Example: Schedule all lights to change, recurring date.
  *

examples/set-bridge-config.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @noinspection PhpUndefinedVariableInspection */
 /**
  * Example: Set bridge config.
  *

examples/show-bridge-config.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @noinspection PhpUndefinedVariableInspection */
 /**
  * Example: Show bridge config.
  *

examples/update-bridge.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @noinspection PhpUndefinedVariableInspection */
 /**
  * Example: Update bridge.
  *

examples/update-rule.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @noinspection PhpUndefinedVariableInspection */
 /**
  * Example: Update test rule.
  *

examples/update-sensor.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @noinspection PhpUndefinedVariableInspection */
 /**
  * Example: Update test sensor.
  *