Add code style GH workflow (#131)

Author: irazasyed

.github/workflows/code-style.yml

@@ -0,0 +1,23 @@
+name: Code Style
+
+on: [push]
+
+jobs:
+  php-cs-fixer:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.head_ref }}
+
+      - name: Run PHP CS Fixer
+        uses: docker://oskarstark/php-cs-fixer-ga
+
+      - name: Commit changes
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: Apply PHP CS Fixer changes
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -2,4 +2,6 @@
 build
 composer.phar
 composer.lock
+.php-cs-fixer.php
+.php-cs-fixer.cache
 .phpunit.result.cache

.php-cs-fixer.dist.php

@@ -0,0 +1,12 @@
+<?php
+
+$finder = PhpCsFixer\Finder::create()->in(__DIR__);
+
+$config = new PhpCsFixer\Config();
+$config->setRiskyAllowed(true)
+    ->setRules([
+        '@PhpCsFixer' => true,
+    ])
+    ->setFinder($finder);
+
+return $config;

src/Exceptions/CouldNotSendNotification.php

@@ -13,13 +13,11 @@ class CouldNotSendNotification extends Exception
     /**
      * Thrown when there's a bad request and an error is responded.
      *
-     * @param ClientException $exception
-     *
      * @return static
      */
     public static function telegramRespondedWithAnError(ClientException $exception): self
     {
-        if (! $exception->hasResponse()) {
+        if (!$exception->hasResponse()) {
             return new static('Telegram responded with an error but no response body found');
         }
 

src/Telegram.php

@@ -17,16 +17,15 @@ class Telegram
     /** @var HttpClient HTTP Client */
     protected $http;
 
-    /** @var string|null Telegram Bot API Token. */
+    /** @var null|string Telegram Bot API Token. */
     protected $token;
 
     /** @var string Telegram Bot API Base URI */
     protected $apiBaseUri;
 
     /**
-     * @param string|null     $token
-     * @param HttpClient|null $httpClient
-     * @param string|null     $apiBaseUri
+     * @param null|string $token
+     * @param null|string $apiBaseUri
      */
     public function __construct($token = null, HttpClient $httpClient = null, $apiBaseUri = null)
     {
@@ -37,8 +36,6 @@ public function __construct($token = null, HttpClient $httpClient = null, $apiBa
 
     /**
      * Token getter.
-     *
-     * @return string
      */
     public function getToken(): string
     {
@@ -48,8 +45,6 @@ public function getToken(): string
     /**
      * Token setter.
      *
-     * @param string $token
-     *
      * @return $this
      */
     public function setToken(string $token): self
@@ -61,8 +56,6 @@ public function setToken(string $token): self
 
     /**
      * API Base URI getter.
-     *
-     * @return string
      */
     public function getApiBaseUri(): string
     {
@@ -72,8 +65,6 @@ public function getApiBaseUri(): string
     /**
      * API Base URI setter.
      *
-     * @param string $apiBaseUri
-     *
      * @return $this
      */
     public function setApiBaseUri(string $apiBaseUri): self
@@ -83,21 +74,9 @@ public function setApiBaseUri(string $apiBaseUri): self
         return $this;
     }
 
-    /**
-     * Get HttpClient.
-     *
-     * @return HttpClient
-     */
-    protected function httpClient(): HttpClient
-    {
-        return $this->http;
-    }
-
     /**
      * Set HTTP Client.
      *
-     * @param HttpClient $http
-     *
      * @return $this
      */
     public function setHttpClient(HttpClient $http): self
@@ -122,13 +101,9 @@ public function setHttpClient(HttpClient $http): self
      * ];
      * </code>
      *
-     * @link https://core.telegram.org/bots/api#sendmessage
-     *
-     * @param array $params
+     * @see https://core.telegram.org/bots/api#sendmessage
      *
      * @throws CouldNotSendNotification
-     *
-     * @return ResponseInterface|null
      */
     public function sendMessage(array $params): ?ResponseInterface
     {
@@ -138,13 +113,7 @@ public function sendMessage(array $params): ?ResponseInterface
     /**
      * Send File as Image or Document.
      *
-     * @param array  $params
-     * @param string $type
-     * @param bool   $multipart
-     *
      * @throws CouldNotSendNotification
-     *
-     * @return ResponseInterface|null
      */
     public function sendFile(array $params, string $type, bool $multipart = false): ?ResponseInterface
     {
@@ -154,11 +123,7 @@ public function sendFile(array $params, string $type, bool $multipart = false):
     /**
      * Send a Poll.
      *
-     * @param array  $params
-     *
      * @throws CouldNotSendNotification
-     *
-     * @return ResponseInterface|null
      */
     public function sendPoll(array $params): ?ResponseInterface
     {
@@ -168,27 +133,25 @@ public function sendPoll(array $params): ?ResponseInterface
     /**
      * Send a Location.
      *
-     * @param array $params
-     *
      * @throws CouldNotSendNotification
-     *
-     * @return ResponseInterface|null
      */
     public function sendLocation(array $params): ?ResponseInterface
     {
         return $this->sendRequest('sendLocation', $params);
     }
 
+    /**
+     * Get HttpClient.
+     */
+    protected function httpClient(): HttpClient
+    {
+        return $this->http;
+    }
+
     /**
      * Send an API request and return response.
      *
-     * @param string $endpoint
-     * @param array  $params
-     * @param bool   $multipart
-     *
      * @throws CouldNotSendNotification
-     *
-     * @return ResponseInterface|null
      */
     protected function sendRequest(string $endpoint, array $params, bool $multipart = false): ?ResponseInterface
     {

src/TelegramChannel.php

@@ -2,7 +2,6 @@
 
 namespace NotificationChannels\Telegram;
 
-use Illuminate\Support\Collection;
 use Illuminate\Contracts\Events\Dispatcher;
 use Illuminate\Notifications\Events\NotificationFailed;
 use Illuminate\Notifications\Notification;
@@ -25,9 +24,6 @@ class TelegramChannel
 
     /**
      * Channel constructor.
-     *
-     * @param  Telegram    $telegram
-     * @param  Dispatcher  $dispatcher
      */
     public function __construct(Telegram $telegram, Dispatcher $dispatcher)
     {
@@ -38,11 +34,9 @@ public function __construct(Telegram $telegram, Dispatcher $dispatcher)
     /**
      * Send the given notification.
      *
-     * @param  mixed         $notifiable
-     * @param  Notification  $notification
+     * @param mixed $notifiable
      *
      * @throws CouldNotSendNotification
-     * @return null|array
      */
     public function send($notifiable, Notification $notification): ?array
     {
@@ -130,11 +124,6 @@ public function send($notifiable, Notification $notification): ?array
 
     /**
      * Chunk the given string into an array of strings.
-     *
-     * @param  string  $value
-     * @param  int     $limit
-     *
-     * @return array
      */
     public function chunk(string $value, int $limit = 4096): array
     {
@@ -146,7 +135,7 @@ public function chunk(string $value, int $limit = 4096): array
             $limit = 4096;
         }
 
-        $output = explode("%#TGMSG#%", wordwrap($value, $limit, '%#TGMSG#%'));
+        $output = explode('%#TGMSG#%', wordwrap($value, $limit, '%#TGMSG#%'));
 
         // Fallback for when the string is too long and wordwrap doesn't cut it.
         if (count($output) <= 1) {