Use Laravel Pint as default code style fixer (#41)

godruoyi · web-flow · commit e6e2ee6169b2 · 2023-01-06T17:13:11.000+08:00
* Use Laravel Pint as default code style fixer
diff --git a/.github/workflows/codestyle.yml b/.github/workflows/codestyle.yml
@@ -0,0 +1,44 @@
+name: codestyle
+on:
+  pull_request:
+jobs:
+  code-coverage:
+    name: Code Coverage
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        php-version:
+          - 8.2
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Install PHP with extensions
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-version }}
+          coverage: pcov
+          tools: composer:v2
+          extensions: swoole, redis
+
+      - name: Install dependencies with composer
+        run: composer update --no-ansi --no-interaction --no-progress
+
+      - name: Install Laravel Illuminate Contracts
+        run: composer require "illuminate/contracts"
+
+      - name: Install Laravel pint
+        run: composer require "laravel/pint"
+
+      - name: Code Style
+        run: vendor/bin/pint --test
+
+      - name: Collect code coverage with phpunit
+        run: vendor/bin/phpunit --coverage-clover=coverage.xml
+
+      - name: Send code coverage report to Codecov.io
+        uses: codecov/codecov-action@v2
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: ./coverage.xml
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -1,13 +1,6 @@
-name: php
+name: test
 on:
   pull_request:
-    branches:
-      - master
-      - dev
-  push:
-    branches:
-      - master
-      - dev
 jobs:
   phptests:
     runs-on: ${{ matrix.operating-system }}
@@ -30,7 +23,7 @@ jobs:
     - name: Install dependencies
       uses: nick-invision/retry@v1
       with:
-        timeout_minutes: 5
+        timeout_minutes: 10
         max_attempts: 5
         command: composer update --prefer-stable --prefer-dist --no-interaction --no-progress
 
diff --git a/.scrutinizer.yml b/.scrutinizer.yml
diff --git a/.styleci.yml b/.styleci.yml
diff --git a/.travis.yml b/.travis.yml
diff --git a/README-zh_CN.md b/README-zh_CN.md
@@ -4,8 +4,8 @@
   </p>
   <p align="center">An ID Generator for PHP based on Snowflake Algorithm (Twitter announced).</p>
   <p align="center">
-    <a href="https://github.com/godruoyi/php-snowflake/actions/workflows/php.yml">
-      <image src="https://github.com/godruoyi/php-snowflake/actions/workflows/php.yml/badge.svg" alt="build passed"></image>
+    <a href="https://github.com/godruoyi/php-snowflake/actions/workflows/test.yml">
+      <image src="https://github.com/godruoyi/php-snowflake/actions/workflows/test.yml/badge.svg" alt="build passed"></image>
     </a>
     <a href="https://codecov.io/gh/godruoyi/php-snowflake">
       <img src="https://codecov.io/gh/godruoyi/php-snowflake/branch/master/graph/badge.svg?token=7AAOYCJK97"/>
diff --git a/README.md b/README.md
@@ -4,8 +4,8 @@
   </p>
   <p align="center">An ID Generator for PHP based on Snowflake Algorithm (Twitter announced).</p>
   <p align="center">
-    <a href="https://github.com/godruoyi/php-snowflake/actions/workflows/php.yml">
-      <image src="https://github.com/godruoyi/php-snowflake/actions/workflows/php.yml/badge.svg" alt="build passed"></image>
+    <a href="https://github.com/godruoyi/php-snowflake/actions/workflows/test.yml">
+      <image src="https://github.com/godruoyi/php-snowflake/actions/workflows/test.yml/badge.svg" alt="build passed"></image>
     </a>
     <a href="https://codecov.io/gh/godruoyi/php-snowflake">
       <img src="https://codecov.io/gh/godruoyi/php-snowflake/branch/master/graph/badge.svg?token=7AAOYCJK97" alt=""/>
diff --git a/pint.json b/pint.json
@@ -0,0 +1,3 @@
+{
+
+}
diff --git a/src/SequenceResolver.php b/src/SequenceResolver.php
@@ -15,8 +15,7 @@ interface SequenceResolver
     /**
      * The snowflake.
      *
-     * @param int|string $currentTime current request ms
-     *
+     * @param  int|string  $currentTime current request ms
      * @return int
      */
     public function sequence(int $currentTime);
diff --git a/src/SwooleSequenceResolver.php b/src/SwooleSequenceResolver.php
@@ -54,19 +54,19 @@ public function __construct()
     public function sequence(int $currentTime)
     {
         // If swoole lock failure，we will return a big number, and recall this method when next millisecond.
-        if (!$this->lock->trylock()) {
+        if (! $this->lock->trylock()) {
             if ($this->count >= 10) {
                 throw new \Exception('Swoole lock failure, Unable to get the program lock after many attempts.');
             }
 
-            ++$this->count;
+            $this->count++;
 
             // return a big number
             return 999999;
         }
 
         if ($this->lastTimeStamp === $currentTime) {
-            ++$this->sequence;
+            $this->sequence++;
         } else {
             $this->sequence = 0;
         }
@@ -79,11 +79,11 @@ public function sequence(int $currentTime)
     }
 
     /**
-     * @param \Swoole\Lock $lock
-     *
+     * @param  \Swoole\Lock  $lock
      * @return void
      */
-    public function resetLock(\Swoole\Lock $lock) {
+    public function resetLock(\Swoole\Lock $lock)
+    {
         $this->lock = $lock;
     }
 }
diff --git a/tests/LaravelSequenceResolverTest.php b/tests/LaravelSequenceResolverTest.php
@@ -10,8 +10,8 @@
 
 namespace Tests;
 
-use Illuminate\Contracts\Cache\Repository;
 use Godruoyi\Snowflake\LaravelSequenceResolver;
+use Illuminate\Contracts\Cache\Repository;
 
 class LaravelSequenceResolverTest extends TestCase
 {
diff --git a/tests/RedisSequenceResolverTest.php b/tests/RedisSequenceResolverTest.php
@@ -10,12 +10,13 @@
 
 namespace Tests;
 
-use RedisException;
 use Godruoyi\Snowflake\RedisSequenceResolver;
+use RedisException;
 
 class RedisSequenceResolverTest extends TestCase
 {
-    public function testInvalidRedisConnect() {
+    public function testInvalidRedisConnect()
+    {
         $redis = $this->createMock(\Redis::class);
         $redis->expects($this->once())->method('ping')->willReturn(false);
 
@@ -46,6 +47,6 @@ public function testSetCachePrefix()
         $snowflake = new RedisSequenceResolver($redis);
         $snowflake->setCachePrefix('foo');
 
-       $this->assertEquals('foo', $this->invokeProperty($snowflake, 'prefix'));
+        $this->assertEquals('foo', $this->invokeProperty($snowflake, 'prefix'));
     }
 }
diff --git a/tests/SwooleSequenceResolverTest.php b/tests/SwooleSequenceResolverTest.php
@@ -27,8 +27,9 @@ public function testBasic()
         $this->assertTrue(1 == $snowflake->sequence(1));
         $this->assertTrue(2 == $snowflake->sequence(1));
     }
-    public function testResetLock() {
 
+    public function testResetLock()
+    {
         $snowflake = new SwooleSequenceResolver();
 
         $lock = $this->createStub(\Swoole\Lock::class);
diff --git a/tests/TestCase.php b/tests/TestCase.php
@@ -17,13 +17,12 @@ class TestCase extends BaseTestCase
     /**
      * Call protected/private method of a class.
      *
-     * @param object &$object    Instantiated object that we will run method on.
-     * @param string $methodName Method name to call
-     * @param array  $parameters Array of parameters to pass into method.
-     *
+     * @param  object  &$object    Instantiated object that we will run method on.
+     * @param  string  $methodName Method name to call
+     * @param  array  $parameters Array of parameters to pass into method.
      * @return mixed Method return.
      */
-    public function invokeMethod(&$object, $methodName, array $parameters = array())
+    public function invokeMethod(&$object, $methodName, array $parameters = [])
     {
         $reflection = new \ReflectionClass(get_class($object));
         $method = $reflection->getMethod($methodName);
@@ -35,9 +34,8 @@ public function invokeMethod(&$object, $methodName, array $parameters = array())
     /**
      * Call protected/private method of a class.
      *
-     * @param object &$object    Instantiated object that we will run method on.
-     * @param string $propertyName property name to call
-     *
+     * @param  object  &$object    Instantiated object that we will run method on.
+     * @param  string  $propertyName property name to call
      * @return mixed Method return.
      */
     public function invokeProperty(&$object, string $propertyName)
diff --git a/tests/TimeTest.php b/tests/TimeTest.php
@@ -25,7 +25,7 @@ public function testTime()
                 usleep(1);
                 $s2 = $s->getcurrentMicrotime();
             }
-            ++$a;
+            $a++;
             $this->assertTrue($s1 != $s2);
         }
     }

Original file line number	Diff line number	Diff line change
`@@ -54,19 +54,19 @@ public function __construct()`
`54`	`54`	`public function sequence(int $currentTime)`
`55`	`55`	`{`
`56`	`56`	`// If swoole lock failure，we will return a big number, and recall this method when next millisecond.`
`57`		`- if (!$this->lock->trylock()) {`
	`57`	`+ if (! $this->lock->trylock()) {`
`58`	`58`	`if ($this->count >= 10) {`
`59`	`59`	`throw new \Exception('Swoole lock failure, Unable to get the program lock after many attempts.');`
`60`	`60`	`}`
`61`	`61`
`62`		`- ++$this->count;`
	`62`	`+ $this->count++;`
`63`	`63`
`64`	`64`	`// return a big number`
`65`	`65`	`return 999999;`
`66`	`66`	`}`
`67`	`67`
`68`	`68`	`if ($this->lastTimeStamp === $currentTime) {`
`69`		`- ++$this->sequence;`
	`69`	`+ $this->sequence++;`
`70`	`70`	`} else {`
`71`	`71`	`$this->sequence = 0;`
`72`	`72`	`}`
`@@ -79,11 +79,11 @@ public function sequence(int $currentTime)`
`79`	`79`	`}`
`80`	`80`
`81`	`81`	`/**`
`82`		`- * @param \Swoole\Lock $lock`
`83`		`- *`
	`82`	`+ * @param \Swoole\Lock $lock`
`84`	`83`	`* @return void`
`85`	`84`	`*/`
`86`		`- public function resetLock(\Swoole\Lock $lock) {`
	`85`	`+ public function resetLock(\Swoole\Lock $lock)`
	`86`	`+ {`
`87`	`87`	`$this->lock = $lock;`
`88`	`88`	`}`
`89`	`89`	`}`