Added laravel pint

palpalani · palpalani · commit e817c85b132f · 2022-08-19T11:04:35.000+05:30
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -11,7 +11,7 @@ updates:
   - package-ecosystem: composer
     directory: "/"
     schedule:
-      interval: monthly
+      interval: "weekly"
     labels:
       - dependencies
     versioning-strategy: increase-if-necessary
diff --git a/.github/workflows/dependabot-auto-merge.yml b/.github/workflows/dependabot-auto-merge.yml
@@ -0,0 +1,32 @@
+name: dependabot-auto-merge
+on: pull_request_target
+
+permissions:
+  pull-requests: write
+  contents: write
+
+jobs:
+  dependabot:
+    runs-on: ubuntu-latest
+    if: ${{ github.actor == 'dependabot[bot]' }}
+    steps:
+    
+      - name: Dependabot metadata
+        id: metadata
+        uses: dependabot/fetch-metadata@v1.3.3
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+          
+      - name: Auto-merge Dependabot PRs for semver-minor updates
+        if: ${{steps.metadata.outputs.update-type == 'version-update:semver-minor'}}
+        run: gh pr merge --auto --merge "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+          
+      - name: Auto-merge Dependabot PRs for semver-patch updates
+        if: ${{steps.metadata.outputs.update-type == 'version-update:semver-patch'}}
+        run: gh pr merge --auto --merge "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
diff --git a/.github/workflows/fix-php-code-style-issues.yml b/.github/workflows/fix-php-code-style-issues.yml
@@ -1,9 +1,9 @@
-name: Check & fix styling
+name: Fix PHP code style issues
 
 on: [push]
 
 jobs:
-  php-cs-fixer:
+  php-code-styling:
     runs-on: ubuntu-latest
 
     steps:
@@ -12,12 +12,13 @@ jobs:
         with:
           ref: ${{ github.head_ref }}
 
-      - name: Run PHP CS Fixer
-        uses: docker://oskarstark/php-cs-fixer-ga
+      - name: Fix PHP code style issues
+        uses: aglipanci/laravel-pint-action@1.0.0
         with:
-          args: --config=.php-cs-fixer.dist.php --allow-risky=yes
+          preset: laravel
 
       - name: Commit changes
         uses: stefanzweifel/git-auto-commit-action@v4
         with:
           commit_message: Fix styling
+          skip_fetch: true
diff --git a/.github/workflows/update-changelog.yml b/.github/workflows/update-changelog.yml
@@ -0,0 +1,28 @@
+name: "Update Changelog"
+
+on:
+  release:
+    types: [released]
+
+jobs:
+  update:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          ref: main
+
+      - name: Update Changelog
+        uses: stefanzweifel/changelog-updater-action@v1
+        with:
+          latest-version: ${{ github.event.release.name }}
+          release-notes: ${{ github.event.release.body }}
+
+      - name: Commit updated CHANGELOG
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          branch: main
+          commit_message: Update CHANGELOG
+          file_pattern: CHANGELOG.md
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
diff --git a/composer.json b/composer.json
@@ -5,8 +5,10 @@
         "palpalani",
         "sqs-reader",
         "sqs-json",
-        "plain-message",
-        "bulk-message",
+        "sqs-text-reader",
+        "sqs-plain-message",
+        "sqs-bulk-message",
+        "laravel-sqs",
         "laravel-sqs-queue-json-reader"
     ],
     "homepage": "https://github.com/palpalani/laravel-sqs-queue-json-reader",
@@ -15,7 +17,7 @@
         {
             "name": "palPalani",
             "email": "palani.p@gmail.com",
-            "homepage": "https://southdreamz.com",
+            "homepage": "https://github.com/palpalani",
             "role": "Developer"
         }
     ],
@@ -28,6 +30,7 @@
         "aws/aws-sdk-php": "^3.0"
     },
     "require-dev": {
+        "laravel/pint": "^1.1",
         "orchestra/testbench": "^6.9|^7.0",
         "phpunit/phpunit": "^9.3",
         "psalm/plugin-laravel": "^2.0",
@@ -46,7 +49,8 @@
     "scripts": {
         "psalm": "vendor/bin/psalm",
         "test": "./vendor/bin/testbench package:test --parallel --no-coverage",
-        "test-coverage": "vendor/bin/phpunit --coverage-html coverage"
+        "test-coverage": "vendor/bin/phpunit --coverage-html coverage",
+        "format": "vendor/bin/pint"
     },
     "config": {
         "sort-packages": true
diff --git a/config/sqs-queue-reader.php b/config/sqs-queue-reader.php
@@ -14,7 +14,7 @@
         'mailgun-webhooks' => [
             'class' => App\Jobs\MailgunHandler::class,
             'count' => 100,
-        ]
+        ],
     ],
 
     // If no handlers specified then default handler will be executed.
@@ -25,5 +25,5 @@
 
         // Number of messages need to read from SQS.
         'count' => 1,
-    ]
+    ],
 ];
diff --git a/src/Jobs/DispatcherJob.php b/src/Jobs/DispatcherJob.php
@@ -35,7 +35,7 @@ public function getPayload()
     }
 
     /**
-     * @param bool $plain
+     * @param  bool  $plain
      * @return $this
      */
     public function setPlain(bool $plain = true): self
diff --git a/src/Sqs/Queue.php b/src/Sqs/Queue.php
@@ -14,17 +14,17 @@
 
 /**
  * Class CustomSqsQueue
- * @package App\Services
  */
 class Queue extends SqsQueue
 {
     /**
      * Create a payload string from the given job and data.
      *
-     * @param object|string $job
-     * @param string $queue
-     * @param mixed $data
+     * @param  object|string  $job
+     * @param  string  $queue
+     * @param  mixed  $data
      * @return string
+     *
      * @throws JsonException
      */
     protected function createPayload($job, $queue = null, $data = ''): string
@@ -33,7 +33,7 @@ protected function createPayload($job, $queue = null, $data = ''): string
             return parent::createPayload($job, $queue, $data);
         }
 
-        $handlerJob = $this->getClass($queue) . '@handle';
+        $handlerJob = $this->getClass($queue).'@handle';
 
         return $job->isPlain() ? \json_encode($job->getPayload(), JSON_THROW_ON_ERROR) : \json_encode([
             'job' => $handlerJob,
@@ -62,8 +62,9 @@ private function getClass($queue = null): string
     /**
      * Pop the next job off of the queue.
      *
-     * @param string $queue
+     * @param  string  $queue
      * @return \Illuminate\Contracts\Queue\Job|null
+     *
      * @throws JsonException
      */
     public function pop($queue = null)
@@ -99,16 +100,17 @@ public function pop($queue = null)
                 return new SqsJob($this->container, $this->sqs, $response, $this->connectionName, $queue);
             }
         } catch (AwsException $e) {
-            $msg = 'Line: '. $e->getLine() .', '. $e->getFile() . ', '. $e->getMessage();
+            $msg = 'Line: '.$e->getLine().', '.$e->getFile().', '.$e->getMessage();
 
-            throw new \RuntimeException("Aws SQS error: " . $msg);
+            throw new \RuntimeException('Aws SQS error: '.$msg);
         }
     }
 
     /**
-     * @param array|string $payload
-     * @param string $class
+     * @param  array|string  $payload
+     * @param  string  $class
      * @return array|string
+     *
      * @throws JsonException
      */
     private function modifySinglePayload(array | string $payload, string $class): array | string
@@ -121,17 +123,18 @@ private function modifySinglePayload(array | string $payload, string $class): ar
 
         $payload['Body'] = \json_encode([
             'uuid' => (string) Str::uuid(),
-            'job' => $class . '@handle',
+            'job' => $class.'@handle',
             'data' => $body['data'] ?? $body,
         ], JSON_THROW_ON_ERROR);
 
         return $payload;
     }
 
     /**
-     * @param array|string $payload
-     * @param string $class
+     * @param  array|string  $payload
+     * @param  string  $class
      * @return array
+     *
      * @throws JsonException
      */
     private function modifyMultiplePayload(array | string $payload, string $class): array
@@ -170,18 +173,19 @@ private function modifyMultiplePayload(array | string $payload, string $class):
             'ReceiptHandle' => $receiptHandle,
             'Body' => \json_encode([
                 'uuid' => (string) Str::uuid(),
-                'job' => $class . '@handle',
+                'job' => $class.'@handle',
                 'data' => $body,
             ], JSON_THROW_ON_ERROR),
             'Attributes' => $attributes,
         ];
     }
 
     /**
-     * @param string $payload
-     * @param string|null $queue
-     * @param array $options
+     * @param  string  $payload
+     * @param  string|null  $queue
+     * @param  array  $options
      * @return mixed
+     *
      * @throws JsonException
      */
     public function pushRaw($payload, $queue = null, array $options = []): mixed
diff --git a/src/SqsQueueReaderServiceProvider.php b/src/SqsQueueReaderServiceProvider.php
@@ -18,7 +18,7 @@ public function boot(): void
     {
         if ($this->app->runningInConsole()) {
             $this->publishes([
-                __DIR__ . '/../config/sqs-queue-reader.php' => config_path('sqs-queue-reader.php'),
+                __DIR__.'/../config/sqs-queue-reader.php' => config_path('sqs-queue-reader.php'),
             ], 'config');
 
             Queue::after(function (JobProcessed $event) {
@@ -44,7 +44,7 @@ public function boot(): void
 
     public function register(): void
     {
-        $this->mergeConfigFrom(__DIR__ . '/../config/sqs-queue-reader.php', 'sqs-queue-reader');
+        $this->mergeConfigFrom(__DIR__.'/../config/sqs-queue-reader.php', 'sqs-queue-reader');
 
         $this->app->booted(function () {
             $this->app['queue']->extend('sqs-json', static function () {
@@ -80,11 +80,11 @@ private function removeMessages(array $data, $queue): void
                 if (isset($result['Failed'])) {
                     $msg = '';
                     foreach ($result['Failed'] as $failed) {
-                        $msg .= sprintf("Deleting message failed, code = %s, id = %s, msg = %s, senderfault = %s", $failed['Code'], $failed['Id'], $failed['Message'], $failed['SenderFault']);
+                        $msg .= sprintf('Deleting message failed, code = %s, id = %s, msg = %s, senderfault = %s', $failed['Code'], $failed['Id'], $failed['Message'], $failed['SenderFault']);
                     }
                     Log::error('Cannot delete some SQS messages: ', [$msg]);
 
-                    throw new \RuntimeException("Cannot delete some messages, consult log for more info!");
+                    throw new \RuntimeException('Cannot delete some messages, consult log for more info!');
                 }
                 //Log::info('Message remove report:', [$result]);
             } catch (AwsException $e) {
diff --git a/tests/QueueTest.php b/tests/QueueTest.php
@@ -7,7 +7,6 @@
 
 /**
  * Class QueueTest
- * @package palPalani\SqsQueueReader\Tests
  */
 class QueueTest extends TestCase
 {

Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ public function getPayload()`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`/**`
`38`		`- * @param bool $plain`
	`38`	`+ * @param bool $plain`
`39`	`39`	`* @return $this`
`40`	`40`	`*/`
`41`	`41`	`public function setPlain(bool $plain = true): self`