Wire up PHPStan

.github/workflows/ci.yml

@@ -11,7 +11,7 @@ jobs:
     strategy:
       matrix:
         operating-system: [ubuntu-latest]
-        php-versions: ['5.4', '5.5', '5.6', '7.0', '7.1', '7.2', '7.3', '7.4', '8.0', '8.1', '8.2', '8.3']
+        php-versions: ['7.2', '7.3', '7.4', '8.0', '8.1', '8.2', '8.3']
 
     runs-on: ${{ matrix.operating-system }}
 

.github/workflows/phpstan.yml

@@ -0,0 +1,35 @@
+on:
+  pull_request:
+  push:
+      branches:
+        - master
+
+name: phpstan
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+
+      - name: Install PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '7.2'
+
+      - name: Install dependencies with composer
+        run: composer install
+
+      - name: Cache phpstan cache
+        uses: actions/cache@v4
+        with:
+          path: .phpstan-cache
+          key: phpstan-cache-${{ github.run_id }} # see https://github.com/phpstan/phpstan/discussions/9301
+          restore-keys: |
+            phpstan-cache-
+
+      - name: PHPStan
+        run: make phpstan

.gitignore

@@ -7,3 +7,4 @@ phpunit.xml
 tests/user_agents.json
 
 *.cache
+/.phpstan-cache

.helpers/constants.php

@@ -2,14 +2,16 @@
 
 require __DIR__ . '/../vendor/autoload.php';
 
+// @phpstan-ignore argument.type
 $class = new ReflectionClass($argv[1]);
 
 echo "Predefined helper constants from `{$class->getName()}`\n\n";
 
 echo "| Constant | {$argv[2]} | \n|----------|----------| \n";
 
 foreach( $class->getConstants() as $constant => $value ) {
+	assert(is_string($value));
 	echo "| `{$class->getShortName()}::{$constant}` |  {$value} | \n";
 }
 
-echo "\n";
+echo "\n";

Makefile

@@ -16,3 +16,7 @@ generate:
 init:
 	php bin/init_user_agent.php > tests/user_agents.tmp.json && mv tests/user_agents.tmp.json tests/user_agents.dist.json
 	make generate
+
+.PHONY: phpstan
+phpstan:
+	php vendor/bin/phpstan analyse --memory-limit 2g

README.md

@@ -56,7 +56,7 @@ All that said, there is the start of a [branch to do it](https://github.com/dona
 
 ## Requirements
 
-- **php**: >=5.4.0
+- **php**: >=7.2.0
 - **ext-ctype**: *
 
 ## Installing

bin/benchmark.php

@@ -3,9 +3,15 @@
 require __DIR__ . '/../src/UserAgentParser.php';
 
 $time = microtime(true);
+$jsonfile = __DIR__ . '/../tests/user_agents.dist.json';
+$content = file_get_contents($jsonfile);
+if( $content === false ) {
+	echo "Failed to read file: $jsonfile\n";
+	exit(1);
+}
 
-$uas = json_decode(file_get_contents(__DIR__ . '/../tests/user_agents.dist.json'), true);
-
+$uas = json_decode($content, true);
+assert(is_array($uas));
 
 foreach( $uas as $ua => $junk ) {
 	$uatime = microtime(true);

bin/constant_generator.php

@@ -3,12 +3,19 @@
 require __DIR__ . '/../vendor/autoload.php';
 
 $jsonfile = __DIR__ . '/../tests/user_agents.dist.json';
+$content = file_get_contents($jsonfile);
+if( $content === false ) {
+	echo "Failed to read file: $jsonfile\n";
+	die(1);
+}
 
 $uas = json_decode(
-	file_get_contents($jsonfile),
+	$content,
 	true
 );
 
+assert(is_array($uas));
+
 $platforms = [];
 $browsers  = [];
 foreach( $uas as $key => $val ) {
@@ -55,7 +62,7 @@
 $browserBody = "{$header}namespace donatj\UserAgent;\n\ninterface Browsers {\n\n";
 $maxKey      = max(array_map('strlen', array_keys($browsers)));
 foreach( $browsers as $const => $val ) {
-	$browserBody .= sprintf("\tconst %-{$maxKey}s = %s;\n", $const, var_export(key($val), true));
+	$browserBody .= sprintf("\tpublic const %-{$maxKey}s = %s;\n", $const, var_export(key($val), true));
 }
 $browserBody .= "\n}\n\n";
 
@@ -69,9 +76,9 @@
 $platformBody = "{$header}namespace donatj\UserAgent;\n\ninterface Platforms {\n\n";
 $maxKey       = max(array_map('strlen', array_keys($platforms)));
 foreach( $platforms as $const => $val ) {
-	$platformBody .= sprintf("\tconst %-{$maxKey}s = %s;\n", $const, var_export(key($val), true));
+	$platformBody .= sprintf("\tpublic const %-{$maxKey}s = %s;\n", $const, var_export(key($val), true));
 }
 $platformBody .= "\n}\n\n";
 
 file_put_contents(__DIR__ . '/../src/UserAgent/Browsers.php', $browserBody);
-file_put_contents(__DIR__ . '/../src/UserAgent/Platforms.php', $platformBody);
+file_put_contents(__DIR__ . '/../src/UserAgent/Platforms.php', $platformBody);

bin/init_user_agent.php

@@ -4,7 +4,14 @@
 
 $jsonfile = __DIR__ . '/../Tests/user_agents.dist.json';
 
-$uas = json_decode(file_get_contents($jsonfile), true);
+$content = file_get_contents($jsonfile);
+if( $content === false ) {
+	echo "Failed to read file: $jsonfile\n";
+	exit(1);
+}
+
+$uas = json_decode($content, true);
+assert(is_array($uas));
 
 foreach( $uas as $key => &$val ) {
 	$val = parse_user_agent($key);

bin/user_agent_sorter.php

@@ -4,7 +4,14 @@
 
 $jsonfile = __DIR__ . '/../Tests/user_agents.dist.json';
 
-$uas = json_decode(file_get_contents($jsonfile), true);
+$content = file_get_contents($jsonfile);
+if( $content === false ) {
+	echo "Failed to read file: $jsonfile\n";
+	exit(1);
+}
+
+$uas = json_decode($content, true);
+assert(is_array($uas));
 
 foreach( $uas as $key => &$val ) {
 	$val['key'] = $key;
@@ -73,6 +80,11 @@
 echo $json;
 
 
+/**
+ * @param string $a
+ * @param string $b
+ * @return 0|1|-1
+ */
 function compare_version( $a, $b ) {
 	$cmp_a = explode('.', $a);
 	$cmp_b = explode('.', $b);
@@ -91,10 +103,10 @@ function compare_version( $a, $b ) {
 		}
 
 		if( $cmp = strcmp($aa, $bb) ) {
-			$value = $cmp / abs($cmp);
+			$value = intval($cmp / abs($cmp));
 			break;
 		}
 	}
 
 	return $value;
-}
+}

composer.json

@@ -12,14 +12,15 @@
 	"homepage": "https://donatstudios.com/PHP-Parser-HTTP_USER_AGENT",
 	"license": "MIT",
 	"require": {
-		"php": ">=5.4.0",
+		"php": ">=7.2.0",
 		"ext-ctype": "*"
 	},
 	"require-dev": {
 		"camspiers/json-pretty": "~1.0",
 		"phpunit/phpunit": "~4.8|~9",
 		"donatj/drop": "*",
-		"ext-json": "*"
+		"ext-json": "*",
+		"phpstan/phpstan": "^1.11"
 	},
 	"authors": [
 		{

phpstan.neon

@@ -0,0 +1,9 @@
+parameters:
+	level: 9
+	tmpDir: .phpstan-cache
+	paths:
+		- src
+		- bin
+		- examples
+		- .helpers
+	phpVersion: 70200

src/UserAgent/Browsers.php

@@ -6,57 +6,57 @@
 
 interface Browsers {
 
-	const ADSBOT_GOOGLE       = 'AdsBot-Google';
-	const ANDROID_BROWSER     = 'Android Browser';
-	const APPLEBOT            = 'Applebot';
-	const BAIDUSPIDER         = 'Baiduspider';
-	const BINGBOT             = 'bingbot';
-	const BLACKBERRY_BROWSER  = 'BlackBerry Browser';
-	const BROWSER             = 'Browser';
-	const BUNJALLOO           = 'Bunjalloo';
-	const CAMINO              = 'Camino';
-	const CHATGPT_USER        = 'ChatGPT-User';
-	const CHROME              = 'Chrome';
-	const CURL                = 'curl';
-	const EDGE                = 'Edge';
-	const FACEBOOKEXTERNALHIT = 'facebookexternalhit';
-	const FEEDVALIDATOR       = 'FeedValidator';
-	const FIREFOX             = 'Firefox';
-	const GOOGLEBOT           = 'Googlebot';
-	const GOOGLEBOT_IMAGE     = 'Googlebot-Image';
-	const GOOGLEBOT_VIDEO     = 'Googlebot-Video';
-	const GPTBOT              = 'GPTBot';
-	const HEADLESSCHROME      = 'HeadlessChrome';
-	const IEMOBILE            = 'IEMobile';
-	const IMESSAGEBOT         = 'iMessageBot';
-	const KINDLE              = 'Kindle';
-	const LYNX                = 'Lynx';
-	const MASTODON            = 'Mastodon';
-	const MIDORI              = 'Midori';
-	const MIUIBROWSER         = 'MiuiBrowser';
-	const MSIE                = 'MSIE';
-	const MSNBOT_MEDIA        = 'msnbot-media';
-	const NETFRONT            = 'NetFront';
-	const NINTENDOBROWSER     = 'NintendoBrowser';
-	const OAI_SEARCHBOT       = 'OAI-SearchBot';
-	const OCULUSBROWSER       = 'OculusBrowser';
-	const OPERA               = 'Opera';
-	const PUFFIN              = 'Puffin';
-	const SAFARI              = 'Safari';
-	const SAILFISHBROWSER     = 'SailfishBrowser';
-	const SAMSUNGBROWSER      = 'SamsungBrowser';
-	const SILK                = 'Silk';
-	const SLACKBOT            = 'Slackbot';
-	const TELEGRAMBOT         = 'TelegramBot';
-	const TIZENBROWSER        = 'TizenBrowser';
-	const TWITTERBOT          = 'Twitterbot';
-	const UC_BROWSER          = 'UC Browser';
-	const VALVE_STEAM_TENFOOT = 'Valve Steam Tenfoot';
-	const VIVALDI             = 'Vivaldi';
-	const WGET                = 'Wget';
-	const WORDPRESS           = 'WordPress';
-	const YANDEX              = 'Yandex';
-	const YANDEXBOT           = 'YandexBot';
+	public const ADSBOT_GOOGLE       = 'AdsBot-Google';
+	public const ANDROID_BROWSER     = 'Android Browser';
+	public const APPLEBOT            = 'Applebot';
+	public const BAIDUSPIDER         = 'Baiduspider';
+	public const BINGBOT             = 'bingbot';
+	public const BLACKBERRY_BROWSER  = 'BlackBerry Browser';
+	public const BROWSER             = 'Browser';
+	public const BUNJALLOO           = 'Bunjalloo';
+	public const CAMINO              = 'Camino';
+	public const CHATGPT_USER        = 'ChatGPT-User';
+	public const CHROME              = 'Chrome';
+	public const CURL                = 'curl';
+	public const EDGE                = 'Edge';
+	public const FACEBOOKEXTERNALHIT = 'facebookexternalhit';
+	public const FEEDVALIDATOR       = 'FeedValidator';
+	public const FIREFOX             = 'Firefox';
+	public const GOOGLEBOT           = 'Googlebot';
+	public const GOOGLEBOT_IMAGE     = 'Googlebot-Image';
+	public const GOOGLEBOT_VIDEO     = 'Googlebot-Video';
+	public const GPTBOT              = 'GPTBot';
+	public const HEADLESSCHROME      = 'HeadlessChrome';
+	public const IEMOBILE            = 'IEMobile';
+	public const IMESSAGEBOT         = 'iMessageBot';
+	public const KINDLE              = 'Kindle';
+	public const LYNX                = 'Lynx';
+	public const MASTODON            = 'Mastodon';
+	public const MIDORI              = 'Midori';
+	public const MIUIBROWSER         = 'MiuiBrowser';
+	public const MSIE                = 'MSIE';
+	public const MSNBOT_MEDIA        = 'msnbot-media';
+	public const NETFRONT            = 'NetFront';
+	public const NINTENDOBROWSER     = 'NintendoBrowser';
+	public const OAI_SEARCHBOT       = 'OAI-SearchBot';
+	public const OCULUSBROWSER       = 'OculusBrowser';
+	public const OPERA               = 'Opera';
+	public const PUFFIN              = 'Puffin';
+	public const SAFARI              = 'Safari';
+	public const SAILFISHBROWSER     = 'SailfishBrowser';
+	public const SAMSUNGBROWSER      = 'SamsungBrowser';
+	public const SILK                = 'Silk';
+	public const SLACKBOT            = 'Slackbot';
+	public const TELEGRAMBOT         = 'TelegramBot';
+	public const TIZENBROWSER        = 'TizenBrowser';
+	public const TWITTERBOT          = 'Twitterbot';
+	public const UC_BROWSER          = 'UC Browser';
+	public const VALVE_STEAM_TENFOOT = 'Valve Steam Tenfoot';
+	public const VIVALDI             = 'Vivaldi';
+	public const WGET                = 'Wget';
+	public const WORDPRESS           = 'WordPress';
+	public const YANDEX              = 'Yandex';
+	public const YANDEXBOT           = 'YandexBot';
 
 }