Merge pull request #58 from cslant/v2.0

Refactor Event class and improve architecture with caching and logging

Author: cslant-dev

.github/workflows/phpstan.yml

@@ -10,7 +10,7 @@ jobs:
     strategy:
       matrix:
         os: [ ubuntu-latest ]
-        php: [ '8.1', '8.2', '8.3' ]
+        php: [ '8.4', '8.5' ]
 
     steps:
       - uses: actions/checkout@v6

.github/workflows/setup_test.yml

@@ -9,16 +9,13 @@ jobs:
     strategy:
       matrix:
         os: [ ubuntu-latest ]
-        php: [ '8.1', '8.2', '8.3' ]
-        laravel: [ 11.*, 10.*, 9.* ]
+        php: [ '8.4', '8.5' ]
+        laravel: [ 12.*, 11.* ]
         include:
-          - laravel: 11.*
-            testbench: 9.*
-          - laravel: 10.*
-            testbench: 8.*
-        exclude:
-          - laravel: 11.*
-            php: 8.1
+          - laravel: 12.*
+            php: 8.4
+          - laravel: 12.*
+            php: 8.5
     steps:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2

.scrutinizer.yml

@@ -7,7 +7,7 @@ build:
         override: [ php-scrutinizer-run ]
   environment:
     php:
-      version: 8.2
+      version: 8.3
 
 checks:
   php:

common/helpers.php

@@ -10,7 +10,7 @@
      *
      * @return string|null
      */
-    function tgn_singularity(string $word): string|null
+    function tgn_singularity(string $word): ?string
     {
         static $singular_rules = [
             '/(quiz)zes$/i' => '$1',
@@ -56,7 +56,7 @@ function tgn_singularity(string $word): string|null
      */
     function tgn_snake_case(string $string): string
     {
-        $string = preg_replace('/\s+/', '_', $string);
+        $string = preg_replace('/\s+/', '_', $string) ?? $string;
 
         return strtolower($string);
     }
@@ -100,7 +100,7 @@ function tgn_convert_event_name(string $event): string
      */
     function tgn_convert_action_name(string $action): string
     {
-        return strtolower(preg_replace('/(?<!^)[A-Z]/', '_$0', $action));
+        return strtolower(preg_replace('/(?<!^)[A-Z]/', '_$0', $action) ?? $action);
     }
 }
 
@@ -128,28 +128,26 @@ function config(string $string): mixed
          *
          * @return null|string
          */
-        function view(string $partialPath, array $data = []): null|string
+        function view(string $partialPath, array $data = []): ?string
         {
             $content = (new ConfigHelper())->getTemplateData(
                 $partialPath,
                 $data
             );
 
-            return $content ?: null;
+            return $content !== '' ? $content : null;
         }
     }
 }
 
 if (!function_exists('tgn_view')) {
     /**
-     * Get view template
+     * Get view template from the correct source (Laravel Blade or standalone PHP).
      *
-     * @param string $partialPath
-     * @param array $data
-     *
-     * @noinspection PhpMissingReturnTypeInspection
+     * @param string $partialPath Dot-notation template path
+     * @param array<string, mixed> $data Variables to pass to the template
      */
-    function tgn_view(string $partialPath, array $data = [])
+    function tgn_view(string $partialPath, array $data = []): mixed
     {
         if (class_exists('Illuminate\Foundation\Application')) {
             $partialPath = config('telegram-git-notifier.view.namespace') . '::' . $partialPath;

composer.json

@@ -42,6 +42,7 @@
     "php": "^8.4|^8.5",
     "eleirbag89/telegrambotphp": "^1.4",
     "guzzlehttp/guzzle": "^7.8",
+    "psr/log": "^3.0",
     "symfony/http-foundation": "^7.0",
     "vlucas/phpdotenv": "^5.6"
   },

config/jsons/github-events.json

@@ -4,4 +4,3 @@ parameters:
         - src
         - config
     tmpDir: build/phpstan
-    checkMissingIterableValueType: false

config/jsons/gitlab-events.json

@@ -2,7 +2,7 @@
 
 namespace CSlant\TelegramGitNotifier;
 
-use CSlant\TelegramGitNotifier\Constants\EventConstant;
+use CSlant\TelegramGitNotifier\Enums\Platform;
 use CSlant\TelegramGitNotifier\Exceptions\ConfigFileException;
 use CSlant\TelegramGitNotifier\Interfaces\BotInterface;
 use CSlant\TelegramGitNotifier\Models\Event;
@@ -39,12 +39,12 @@ class Bot implements BotInterface
      * @throws ConfigFileException
      */
     public function __construct(
-        Telegram $telegram = null,
+        ?Telegram $telegram = null,
         ?string $chatBotId = null,
-        Event $event = null,
-        ?string $platform = EventConstant::DEFAULT_PLATFORM,
+        ?Event $event = null,
+        ?string $platform = Platform::DEFAULT,
         ?string $platformFile = null,
-        Setting $setting = null,
+        ?Setting $setting = null,
         ?string $settingFile = null,
     ) {
         $this->event = $event ?? new Event();
@@ -61,7 +61,7 @@ public function __construct(
 
     public function validateSettingFile(): void
     {
-        if (empty($this->setting->getSettingFile())) {
+        if ($this->setting->getSettingFile() === '') {
             throw ConfigFileException::settingFile($this->setting->getSettingFile());
         }
     }