Merge pull request #41 from kydever/upgrade-cs

Upgrade the version of `cs-fixer`.
hedeqiang · Apr 21, 2022 · 3b192de · 3b192de
2 parents 38372b5 + dd5f65a
commit 3b192de
Show file tree

Hide file tree

Showing 6 changed files with 51 additions and 113 deletions.
diff --git a/.php-cs-fixer.php b/.php-cs-fixer.php
@@ -0,0 +1,42 @@
+<?php
+
+/*
+ * This file is part of the hedeqiang/umeng.
+ *
+ * (c) hedeqiang <[email protected]>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+$header = <<<'EOF'
+This file is part of the hedeqiang/umeng.
+
+(c) hedeqiang <[email protected]>
+
+This source file is subject to the MIT license that is bundled
+with this source code in the file LICENSE.
+EOF;
+
+return (new PhpCsFixer\Config())
+    ->setRiskyAllowed(true)
+    ->setRules([
+        '@Symfony'               => true,
+        'header_comment'         => ['header' => $header],
+        'array_syntax'           => ['syntax' => 'short'],
+        'ordered_imports'        => true,
+        'no_useless_else'        => true,
+        'no_useless_return'      => true,
+        'php_unit_construct'     => true,
+        'php_unit_strict'        => true,
+        'visibility_required'    => false,
+        'binary_operator_spaces' => [
+            'operators' => ['=>' => 'align_single_space_minimal'],
+        ],
+    ])
+    ->setFinder(
+        PhpCsFixer\Finder::create()
+            ->exclude('vendor')
+            ->in(__DIR__)
+    )
+    ->setUsingCache(false);
diff --git a/.php_cs b/.php_cs
diff --git a/composer.json b/composer.json
@@ -24,16 +24,22 @@
         "guzzlehttp/guzzle": "^6.3|^7.0",
         "ext-json": "*"
     },
+    "require-dev": {
+        "friendsofphp/php-cs-fixer": "^3.8"
+    },
     "autoload": {
         "psr-4": {
             "Hedeqiang\\UMeng\\": "./src/"
         }
     },
+    "scripts": {
+        "cs-fix": "php-cs-fixer fix $1"
+    },
     "extra": {
         "laravel": {
             "providers": [
                 "Hedeqiang\\UMeng\\PushServiceProvider"
             ]
         }
     }
-}
+}
diff --git a/src/Android.php b/src/Android.php
@@ -30,8 +30,6 @@ class Android
 
     /**
      * Android constructor.
-     *
-     * @param array $config
      */
     public function __construct(array $config)
     {
@@ -40,10 +38,6 @@ public function __construct(array $config)
 
     /**
      * 消息发送
-     *
-     * @param array $params
-     *
-     * @return array
      */
     public function send(array $params): array
     {
@@ -54,10 +48,6 @@ public function send(array $params): array
 
     /**
      * 任务类消息状态查询.
-     *
-     * @param array $params
-     *
-     * @return array
      */
     public function status(array $params): array
     {
@@ -68,10 +58,6 @@ public function status(array $params): array
 
     /**
      * 任务类消息取消.
-     *
-     * @param array $params
-     *
-     * @return array
      */
     public function cancel(array $params): array
     {
@@ -82,10 +68,6 @@ public function cancel(array $params): array
 
     /**
      * 文件上传.
-     *
-     * @param array $params
-     *
-     * @return array
      */
     public function upload(array $params): array
     {
@@ -96,11 +78,6 @@ public function upload(array $params): array
 
     /**
      * 返回 代签名的 Url.
-     *
-     * @param array  $body
-     * @param string $type
-     *
-     * @return string
      */
     protected function buildEndpoint(array $body, string $type): string
     {
@@ -122,10 +99,7 @@ protected function buildEndpoint(array $body, string $type): string
     /**
      * 生成签名.
      *
-     * @param string $endpoint
      * @param $body
-     *
-     * @return string
      */
     protected function getSign(string $endpoint, $body): string
     {
@@ -136,11 +110,6 @@ protected function getSign(string $endpoint, $body): string
 
     /**
      * 获取 URL 和参数.
-     *
-     * @param array  $params
-     * @param string $type
-     *
-     * @return array
      */
     protected function getUrl(array $params, string $type): array
     {
@@ -160,10 +129,7 @@ protected function getUrl(array $params, string $type): array
     }
 
     /**
-     * @param string $url
      * @param $params
-     *
-     * @return array
      */
     protected function curl(string $url, $params): array
     {

diff --git a/src/IOS.php b/src/IOS.php
@@ -31,8 +31,6 @@ class IOS
 
     /**
      * Android constructor.
-     *
-     * @param array $config
      */
     public function __construct(array $config)
     {
@@ -41,10 +39,6 @@ public function __construct(array $config)
 
     /**
      * 消息发送
-     *
-     * @param array $params
-     *
-     * @return array
      */
     public function send(array $params): array
     {
@@ -55,10 +49,6 @@ public function send(array $params): array
 
     /**
      * 任务类消息状态查询.
-     *
-     * @param array $params
-     *
-     * @return array
      */
     public function status(array $params): array
     {
@@ -69,10 +59,6 @@ public function status(array $params): array
 
     /**
      * 任务类消息取消.
-     *
-     * @param array $params
-     *
-     * @return array
      */
     public function cancel(array $params): array
     {
@@ -83,10 +69,6 @@ public function cancel(array $params): array
 
     /**
      * 文件上传.
-     *
-     * @param array $params
-     *
-     * @return array
      */
     public function upload(array $params): array
     {
@@ -97,11 +79,6 @@ public function upload(array $params): array
 
     /**
      * 返回 代签名的 Url.
-     *
-     * @param array  $body
-     * @param string $type
-     *
-     * @return string
      */
     protected function buildEndpoint(array $body, string $type): string
     {
@@ -123,10 +100,7 @@ protected function buildEndpoint(array $body, string $type): string
     /**
      * 生成签名.
      *
-     * @param string $endpoint
      * @param $body
-     *
-     * @return string
      */
     protected function getSign(string $endpoint, $body): string
     {
@@ -137,11 +111,6 @@ protected function getSign(string $endpoint, $body): string
 
     /**
      * 获取 URL 和参数.
-     *
-     * @param array  $params
-     * @param string $type
-     *
-     * @return array
      */
     protected function getUrl(array $params, string $type): array
     {
@@ -160,10 +129,7 @@ protected function getUrl(array $params, string $type): array
     }
 
     /**
-     * @param string $url
      * @param $params
-     *
-     * @return array
      */
     protected function curl(string $url, $params): array
     {

diff --git a/src/Traits/HasHttpRequest.php b/src/Traits/HasHttpRequest.php
@@ -22,10 +22,6 @@ trait HasHttpRequest
     /**
      * Make a get request.
      *
-     * @param string $endpoint
-     * @param array  $query
-     * @param array  $headers
-     *
      * @return array
      */
     protected function get(string $endpoint, array $query = [], array $headers = [])
@@ -39,9 +35,7 @@ protected function get(string $endpoint, array $query = [], array $headers = [])
     /**
      * Make a post request.
      *
-     * @param string $endpoint
-     * @param        $options
-     * @param array  $headers
+     * @param $options
      *
      * @return array
      */
@@ -56,9 +50,7 @@ protected function post(string $endpoint, $options, array $headers = [])
     /**
      * Make a post request with json params.
      *
-     * @param       $endpoint
-     * @param array $params
-     * @param array $headers
+     * @param $endpoint
      *
      * @return array
      */
@@ -72,8 +64,6 @@ protected function postJson($endpoint, array $params = [], array $headers = [])
 
     /**
      * @param $endpoint
-     * @param array $headers
-     * @param array $query
      *
      * @return array
      */
@@ -88,7 +78,6 @@ protected function delete($endpoint, array $headers = [], array $query = [])
     /**
      * @param $endpoint
      * @param $params
-     * @param array $headers
      *
      * @return array
      */
@@ -128,10 +117,6 @@ protected function getBaseOptions()
     /**
      * Return http client.
      *
-     * @param array $options
-     *
-     * @return Client
-     *
      * @codeCoverageIgnore
      */
     protected function getHttpClient(array $options = []): Client