Merge pull request #4 from byjg/5.0

byjg · web-flow · commit 3d2b2cc8ff62 · 2024-10-27T11:15:07.000-05:00
PHP 8.1 Implementation
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+github: byjg
diff --git a/.github/workflows/phpunit.yml b/.github/workflows/phpunit.yml
@@ -16,15 +16,15 @@ jobs:
     strategy:
       matrix:
         php-version:
+          - "8.3"
           - "8.2"
           - "8.1"
-          - "8.0"
-          - "7.4"
 
     steps:
       - uses: actions/checkout@v4
       - run: composer install
       - run: ./vendor/bin/phpunit
+      - run: ./vendor/bin/psalm
 
   Documentation:
     if: github.ref == 'refs/heads/master'
diff --git a/.run/PHPUnit.run.xml b/.run/PHPUnit.run.xml
@@ -0,0 +1,6 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="PHPUnit" type="PHPUnitRunConfigurationType" factoryName="PHPUnit">
+    <TestRunner configuration_file="$PROJECT_DIR$/phpunit.xml.dist" scope="XML" use_alternative_configuration_file="true" />
+    <method v="2" />
+  </configuration>
+</component>
diff --git a/.run/PSalm.run.xml b/.run/PSalm.run.xml
@@ -0,0 +1,5 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="PSalm" type="PhpLocalRunConfigurationType" factoryName="PHP Console" path="$PROJECT_DIR$/vendor/bin/psalm">
+    <method v="2" />
+  </configuration>
+</component>
diff --git a/composer.json b/composer.json
@@ -6,11 +6,17 @@
       "ByJG\\DesignPattern\\": "src/"
     }
   },
+  "autoload-dev": {
+    "psr-4": {
+      "Tests\\": "tests/"
+      }
+  },
   "require": {
-    "php": ">=7.4"
+    "php": ">=8.1 <8.4"
   },
   "require-dev": {
-    "phpunit/phpunit": "5.7.*|7.4.*|^9.5"
+    "phpunit/phpunit": "^9.6",
+    "vimeo/psalm": "^5.9"
   },
   "license": "MIT"
 }
diff --git a/psalm.xml b/psalm.xml
@@ -0,0 +1,18 @@
+<?xml version="1.0"?>
+<psalm
+    errorLevel="4"
+    resolveFromConfigFile="true"
+    findUnusedBaselineEntry="true"
+    findUnusedCode="false"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns="https://getpsalm.org/schema/config"
+    xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+>
+    <projectFiles>
+        <directory name="src" />
+        <directory name="tests" />
+        <ignoreFiles>
+            <directory name="vendor" />
+        </ignoreFiles>
+    </projectFiles>
+</psalm>
diff --git a/src/Singleton.php b/src/Singleton.php
@@ -36,7 +36,7 @@ public function __wakeup()
     /**
      * @return static
      */
-    public static function getInstance()
+    public static function getInstance(): static
     {
         static $instances;
 
diff --git a/src/SingletonException.php b/src/SingletonException.php
@@ -2,7 +2,9 @@
 
 namespace ByJG\DesignPattern;
 
-class SingletonException extends \Exception
+use Exception;
+
+class SingletonException extends Exception
 {
 
 }
diff --git a/tests/Sample1.php b/tests/Sample1.php
@@ -1,12 +1,14 @@
 <?php
 
-require_once __DIR__ . "/../vendor/autoload.php";
+namespace Tests;
+
+use ByJG\DesignPattern\Singleton;
 
 class Sample1
 {
-    use \ByJG\DesignPattern\Singleton;
+    use Singleton;
 
-    public $property;
+    public int $property;
 
     private function __construct()
     {
diff --git a/tests/Sample2.php b/tests/Sample2.php
@@ -1,10 +1,12 @@
 <?php
 
-require_once __DIR__ . "/../vendor/autoload.php";
+namespace Tests;
+
+use ByJG\DesignPattern\Singleton;
 
 class Sample2
 {
-    use \ByJG\DesignPattern\Singleton;
+    use Singleton;
 
-    public $property2;
+    public int $property2;
 }
diff --git a/tests/SingletonTest.php b/tests/SingletonTest.php
@@ -1,12 +1,11 @@
 <?php
 
-use ByJG\DesignPattern\SingletonException;
+namespace Tests;
 
-require_once __DIR__ . "/../vendor/autoload.php";
-require_once "Sample1.php";
-require_once "Sample2.php";
+use ByJG\DesignPattern\SingletonException;
+use PHPUnit\Framework\TestCase;
 
-class SingletonTest extends \PHPUnit\Framework\TestCase
+class SingletonTest extends TestCase
 {
     public function testSingleton()
     {

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# These are supported funding model platforms`
	`2`	`+`
	`3`	`+github: byjg`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ public function __wakeup()`
`36`	`36`	`/**`
`37`	`37`	`* @return static`
`38`	`38`	`*/`
`39`		`- public static function getInstance()`
	`39`	`+ public static function getInstance(): static`
`40`	`40`	`{`
`41`	`41`	`static $instances;`
`42`	`42`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,9 @@`
`2`	`2`
`3`	`3`	`namespace ByJG\DesignPattern;`
`4`	`4`
`5`		`-class SingletonException extends \Exception`
	`5`	`+use Exception;`
	`6`	`+`
	`7`	`+class SingletonException extends Exception`
`6`	`8`	`{`
`7`	`9`
`8`	`10`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,12 +1,14 @@`
`1`	`1`	`<?php`
`2`	`2`
`3`		`-require_once __DIR__ . "/../vendor/autoload.php";`
	`3`	`+namespace Tests;`
	`4`	`+`
	`5`	`+use ByJG\DesignPattern\Singleton;`
`4`	`6`
`5`	`7`	`class Sample1`
`6`	`8`	`{`
`7`		`- use \ByJG\DesignPattern\Singleton;`
	`9`	`+ use Singleton;`
`8`	`10`
`9`		`- public $property;`
	`11`	`+ public int $property;`
`10`	`12`
`11`	`13`	`private function __construct()`
`12`	`14`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,12 @@`
`1`	`1`	`<?php`
`2`	`2`
`3`		`-require_once __DIR__ . "/../vendor/autoload.php";`
	`3`	`+namespace Tests;`
	`4`	`+`
	`5`	`+use ByJG\DesignPattern\Singleton;`
`4`	`6`
`5`	`7`	`class Sample2`
`6`	`8`	`{`
`7`		`- use \ByJG\DesignPattern\Singleton;`
	`9`	`+ use Singleton;`
`8`	`10`
`9`		`- public $property2;`
	`11`	`+ public int $property2;`
`10`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,12 +1,11 @@`
`1`	`1`	`<?php`
`2`	`2`
`3`		`-use ByJG\DesignPattern\SingletonException;`
	`3`	`+namespace Tests;`
`4`	`4`
`5`		`-require_once __DIR__ . "/../vendor/autoload.php";`
`6`		`-require_once "Sample1.php";`
`7`		`-require_once "Sample2.php";`
	`5`	`+use ByJG\DesignPattern\SingletonException;`
	`6`	`+use PHPUnit\Framework\TestCase;`
`8`	`7`
`9`		`-class SingletonTest extends \PHPUnit\Framework\TestCase`
	`8`	`+class SingletonTest extends TestCase`
`10`	`9`	`{`
`11`	`10`	`public function testSingleton()`
`12`	`11`	`{`