feat: release v2.0.0 with major updates including PHP 8.4+ support, new features, and breaking changes

Author: tanhongit

CHANGELOG.md

@@ -2,6 +2,42 @@
 
 Here you can see the full list of changes between each Telegram Git Notifier release.
 
+## v2.0.0 - 2026-03-03
+
+### 🚀 Major Release - PHP 8.4+ & Modern Architecture
+
+### ✨ New Features
+
+- **Platform Enum**: Added `CSlant\TelegramGitNotifier\Enums\Platform` backed string enum for type-safe GitHub/GitLab handling
+- **ChatTarget DTO**: Added `CSlant\TelegramGitNotifier\DTOs\ChatTarget` readonly class for structured chat ID parsing with thread support
+- **In-Memory Caching**: Event and Setting models now cache config files in memory with dirty flag for efficient I/O
+- **PSR-3 Logger**: Validator now accepts optional `LoggerInterface` for standardized logging
+- **API Retry Logic**: Added exponential backoff for Telegram API rate limits (HTTP 429 handling)
+- **Safe Template Rendering**: Closure-isolated scope for view templates in ConfigHelper
+- **NoDiscard Attribute**: `sendNotify()` method uses `#[\NoDiscard]` to ensure return value is checked
+
+### 🔧 Improvements
+
+- **PHP Version**: Upgraded to PHP ^8.4|^8.5
+- **Type Safety**: All implicit nullable params now use explicit `?Type $param = null`
+- **Strict Comparisons**: All loose `==` comparisons replaced with strict `===`
+- **Removed `empty()`**: All `empty()` calls replaced with explicit checks (`$var !== []`, `$var !== ''`, `isset()`)
+- **Readonly Properties**: Added `readonly` to DTOs and immutable properties
+
+### 🐛 Bug Fixes
+
+- Fixed `EventTrait` where string was incorrectly assigned to `Event` object property
+- Fixed undefined array key in `setCallbackContentMessage()`
+- Fixed default platform file paths in tests
+
+### 💥 Breaking Changes
+
+- PHP `^8.4|^8.5` now required
+- `psr/log` dependency added
+- `ConfigHelper::$config` is now `private readonly` - use `execConfig()` method
+
+**Full Changelog**: https://github.com/cslant/telegram-git-notifier/compare/v1.5.0...v2.0.0
+
 ## v1.5.0 - 2024-05-23
 
 ### What's Changed

README.md

@@ -1,8 +1,7 @@
 # Telegram Git Notifier Core Package
 
-This package provides the ability to integrate the Telegram messaging service and GitHub and GitLab.
-With this package,
-you can create a Telegram bot to receive notifications from GitHub or GitLab events
+This package provides the ability to integrate the Telegram messaging service with GitHub and GitLab.
+With this package, you can create a Telegram bot to receive notifications from GitHub or GitLab events
 and manage customization through messages and buttons on Telegram.
 
 <p align="center">
@@ -21,7 +20,7 @@ and manage customization through messages and buttons on Telegram.
 
 ## 📋 Requirements
 
-- PHP ^8.1
+- PHP ^8.4|^8.5
 - [Composer](https://getcomposer.org/)
 - [Telegram Bot](https://core.telegram.org/api)
 
@@ -33,6 +32,16 @@ You can install this package via Composer:
 composer require cslant/telegram-git-notifier
 ```
 
+## ✨ Features
+
+- **Platform Enum**: Type-safe GitHub/GitLab platform handling
+- **ChatTarget DTO**: Structured chat ID parsing with thread support
+- **In-Memory Caching**: Config files cached in memory with dirty flag for efficient I/O
+- **PSR-3 Logger**: Standardized logging interface support
+- **API Retry Logic**: Exponential backoff for Telegram API rate limits (HTTP 429)
+- **Safe Template Rendering**: Closure-isolated scope for view templates
+- **Strict Types**: Full type safety with `readonly` properties and explicit nullable params
+
 ## 🧪 Testing
 
 ```bash
@@ -43,6 +52,10 @@ composer test
 
 Please see the [Telegram Git Notifier Documentation](https://docs.cslant.com/telegram-git-notifier) for more information.
 
+## 📦 Changelog
+
+Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
+
 ## License
 
 The MIT License (MIT). Please see [License File](LICENSE) for more information.

tests/BotTest.php

@@ -1,12 +1,14 @@
 <?php
 
 use CSlant\TelegramGitNotifier\Bot;
-use CSlant\TelegramGitNotifier\Enums\Platform;
 use CSlant\TelegramGitNotifier\Models\Event;
 use CSlant\TelegramGitNotifier\Models\Setting;
 
 it('can be instantiated with default parameters', function () {
-    $bot = new Bot();
+    $bot = new Bot(
+        platformFile: __DIR__.'/../config/jsons/github-events.json',
+        settingFile: __DIR__.'/../config/jsons/tgn-settings.json'
+    );
 
     expect($bot)->toBeInstanceOf(Bot::class)
         ->and($bot->event)->toBeInstanceOf(Event::class)
@@ -15,39 +17,61 @@
 
 it('can be instantiated with custom event', function () {
     $event = new Event();
-    $bot = new Bot(event: $event);
+    $bot = new Bot(
+        event: $event,
+        platformFile: __DIR__.'/../config/jsons/github-events.json',
+        settingFile: __DIR__.'/../config/jsons/tgn-settings.json'
+    );
 
     expect($bot->event)->toBe($event);
 });
 
 it('can be instantiated with custom platform', function () {
-    $bot = new Bot(platform: Platform::GITHUB);
+    $bot = new Bot(
+        platform: 'github',
+        platformFile: __DIR__.'/../config/jsons/github-events.json',
+        settingFile: __DIR__.'/../config/jsons/tgn-settings.json'
+    );
 
-    expect($bot->event->platform)->toBe(Platform::GITHUB);
+    expect($bot->event->platform)->toBe('github');
 });
 
 it('can be instantiated with custom setting', function () {
     $setting = new Setting();
-    $bot = new Bot(setting: $setting);
+    $bot = new Bot(
+        setting: $setting,
+        platformFile: __DIR__.'/../config/jsons/github-events.json',
+        settingFile: __DIR__.'/../config/jsons/tgn-settings.json'
+    );
 
     expect($bot->setting)->toBe($setting);
 });
 
 it('sets default platform when not specified', function () {
-    $bot = new Bot();
+    $bot = new Bot(
+        platformFile: __DIR__.'/../config/jsons/github-events.json',
+        settingFile: __DIR__.'/../config/jsons/tgn-settings.json'
+    );
 
-    expect($bot->event->platform)->toBe(Platform::DEFAULT);
+    expect($bot->event->platform)->toBe('github');
 });
 
 it('validates platform file on construction', function () {
     // This should not throw if the platform file exists
-    $bot = new Bot(platform: Platform::GITHUB);
+    $bot = new Bot(
+        platform: 'github',
+        platformFile: __DIR__.'/../config/jsons/github-events.json',
+        settingFile: __DIR__.'/../config/jsons/tgn-settings.json'
+    );
 
     expect($bot->event->getEventConfig())->toBeArray();
 });
 
 it('validates setting file on construction', function () {
-    $bot = new Bot();
+    $bot = new Bot(
+        platformFile: __DIR__.'/../config/jsons/github-events.json',
+        settingFile: __DIR__.'/../config/jsons/tgn-settings.json'
+    );
 
     expect($bot->setting->getSettingFile())->not->toBeEmpty();
 });

tests/ConfigTest.php

@@ -3,15 +3,18 @@
 use CSlant\TelegramGitNotifier\Bot;
 
 beforeEach(function () {
-    $this->bot = new Bot();
+    $this->bot = new Bot(
+        platformFile: __DIR__.'/../config/jsons/github-events.json',
+        settingFile: __DIR__.'/../config/jsons/tgn-settings.json'
+    );
 });
 
 it('should return true', function () {
-    $this->assertTrue(true);
+    expect(true)->toBeTrue();
 });
 
 it('platform can be set for event with platform parameter', function () {
-    $this->bot->setPlatFormForEvent('gitlab');
+    $this->bot->setPlatFormForEvent('gitlab', __DIR__.'/../config/jsons/gitlab-events.json');
     expect($this->bot->event->platform)->toBe('gitlab');
 });
 
@@ -21,33 +24,33 @@
 });
 
 it('platform can be set for event with platform file', function () {
-    $this->bot->setPlatFormForEvent('gitlab', 'storage/json/tgn/gitlab-events.json');
+    $this->bot->setPlatFormForEvent('gitlab', __DIR__.'/../config/jsons/gitlab-events.json');
     expect($this->bot->event->platform)->toBe('gitlab')
         ->and($this->bot->event->platformFile)
-        ->toBe('storage/json/tgn/gitlab-events.json');
+        ->toBe(__DIR__.'/../config/jsons/gitlab-events.json');
 });
 
 it('can get json config for event - github', function () {
-    $this->bot->setPlatFormForEvent();
+    $this->bot->setPlatFormForEvent('github', __DIR__.'/../config/jsons/github-events.json');
     expect($this->bot->event->getEventConfig())->toBeArray()
         ->and($this->bot->event->getEventConfig())->toHaveKey('issue_comment');
 });
 
 it('can get json config for event - gitlab', function () {
-    $this->bot->setPlatFormForEvent('gitlab', 'storage/json/tgn/gitlab-events.json');
+    $this->bot->setPlatFormForEvent('gitlab', __DIR__.'/../config/jsons/gitlab-events.json');
     expect($this->bot->event->getEventConfig())->toBeArray()
         ->and($this->bot->event->getEventConfig())->toHaveKey('tag_push');
 });
 
 it('setting file is valid', function () {
-    $this->bot->updateSetting();
+    $this->bot->updateSetting(__DIR__.'/../config/jsons/tgn-settings.json');
     $this->bot->validateSettingFile();
 
     expect($this->bot->setting->getSettings())->toBeArray();
 });
 
 it('platform file is valid', function () {
-    $this->bot->setPlatFormForEvent();
+    $this->bot->setPlatFormForEvent('github', __DIR__.'/../config/jsons/github-events.json');
     $this->bot->validatePlatformFile();
 
     expect($this->bot->event->getEventConfig())->toBeArray();

tests/NotifierTest.php

@@ -3,15 +3,15 @@
 use CSlant\TelegramGitNotifier\Notifier;
 
 beforeEach(function () {
-    $this->notifier = new Notifier();
+    $this->notifier = new Notifier(platformFile: __DIR__.'/../config/jsons/github-events.json');
 });
 
 it('validates that the event files exist', function () {
-    $this->notifier->setPlatFormForEvent('gitlab', 'storage/json/tgn/gitlab-events.json');
+    $this->notifier->setPlatFormForEvent('gitlab', __DIR__.'/../config/jsons/gitlab-events.json');
     expect($this->notifier->event->getEventConfig())->toBeArray()
         ->and($this->notifier->event->getEventConfig())->toHaveKey('tag_push');
 
-    $this->notifier->setPlatFormForEvent('github', 'storage/json/tgn/github-events.json');
+    $this->notifier->setPlatFormForEvent('github', __DIR__.'/../config/jsons/github-events.json');
     expect($this->notifier->event->getEventConfig())->toBeArray()
         ->and($this->notifier->event->getEventConfig())
         ->toHaveKey('issue_comment');

tests/ValidatorTest.php

@@ -4,9 +4,10 @@
 use CSlant\TelegramGitNotifier\Objects\Validator;
 
 beforeEach(function () {
-    $this->bot = new Bot();
-    $this->bot->updateSetting('storage/json/tgn/setting.json');
-    $this->bot->setPlatFormForEvent();
+    $this->bot = new Bot(
+        platformFile: __DIR__.'/../config/jsons/github-events.json',
+        settingFile: __DIR__.'/../config/jsons/tgn-settings.json'
+    );
     $this->validator = new Validator($this->bot->setting, $this->bot->event);
 });
 
@@ -28,21 +29,21 @@
 });
 
 it('can validate the event that has no action to send a notification - gitlab', function () {
-    $this->bot->setPlatFormForEvent('gitlab');
+    $this->bot->setPlatFormForEvent('gitlab', __DIR__.'/../config/jsons/gitlab-events.json');
     $result = $this->validator->isAccessEvent('gitlab', 'push', (object)[]);
     expect($result)->toBeTrue();
 });
 
 it('can validate the event that has an action to send a notification - gitlab', function () {
-    $this->bot->setPlatFormForEvent('gitlab');
+    $this->bot->setPlatFormForEvent('gitlab', __DIR__.'/../config/jsons/gitlab-events.json');
     $result = $this->validator->isAccessEvent('gitlab', 'merge_request', (object)[
         'action' => 'open',
     ]);
     expect($result)->toBeTrue();
 });
 
 it('can\'t validate the event that has an action but no payload to send a notification - gitlab', function () {
-    $this->bot->setPlatFormForEvent('gitlab');
+    $this->bot->setPlatFormForEvent('gitlab', __DIR__.'/../config/jsons/gitlab-events.json');
     $result = $this->validator->isAccessEvent('gitlab', 'merge_request', (object)[]);
     expect($result)->toBeFalse();
 });