v1.2

Author: egyjs

.github/workflows/php-tests.yml

@@ -0,0 +1,52 @@
+name: Run PHP Tests
+
+on:
+  push:
+    branches: [ main, master ]
+  pull_request:
+    branches: [ main, master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    
+    strategy:
+      matrix:
+        php-version: ['8.0', '8.1', '8.2', '8.3']
+    
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Set up PHP ${{ matrix.php-version }}
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-version }}
+          extensions: mbstring, xml, ctype, iconv, intl, pdo_sqlite, dom, filter, gd, iconv, json, mbstring, pdo
+          coverage: xdebug
+      
+      - name: Cache Composer packages
+        id: composer-cache
+        uses: actions/cache@v3
+        with:
+          path: vendor
+          key: ${{ runner.os }}-php-${{ matrix.php-version }}-${{ hashFiles('**/composer.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-php-${{ matrix.php-version }}-
+      
+      - name: Install dependencies
+        run: composer install --no-interaction --prefer-dist --optimize-autoloader
+      
+      - name: Create build directory
+        run: mkdir -p build
+      
+      - name: Run PHPUnit with coverage
+        run: vendor/bin/phpunit --coverage-clover=build/coverage.xml --coverage-text --testdox
+      
+      - name: Upload coverage reports to Codecov
+        if: matrix.php-version == '8.2'
+        uses: codecov/codecov-action@v3
+        with:
+          file: build/coverage.xml
+          flags: unittests
+          name: codecov-umbrella
+          fail_ci_if_error: false

.gitignore

@@ -1,2 +1,8 @@
 vendor/
 .idea/
+.vscode/
+.phpunit.result.cache
+build/
+coverage/
+*.log
+.DS_Store

.phpunit.result.cache

@@ -0,0 +1 @@
+{"version":1,"defects":[],"times":{"ProgressiveJsonStreamerTest::testDataAndPlaceholders":0.002}}

README.md

@@ -1,6 +1,12 @@
 # Progressive JSON Streamer for PHP
 
-[![Sponsor on GitHub](https://img.shields.io/badge/Sponsor-❤_GitHub-ff69b4?style=for-the-badge&logo=github)](https://github.com/sponsors/egyjs)
+[![PHP Version](https://img.shields.io/badge/PHP-8.0%2B-blue?style=flat-square&logo=php)](https://www.php.net/)
+[![Tests](https://img.shields.io/github/actions/workflow/status/egyjs/PHP-Progressive-json-stream/php-tests.yml?branch=master&style=flat-square&logo=github&label=Tests)](https://github.com/egyjs/PHP-Progressive-json-stream/actions)
+[![Code Coverage](https://img.shields.io/codecov/c/github/egyjs/PHP-Progressive-json-stream?style=flat-square&logo=codecov)](https://codecov.io/gh/egyjs/PHP-Progressive-json-stream)
+[![Latest Version](https://img.shields.io/packagist/v/egyjs/progressive-json-php?style=flat-square&logo=packagist)](https://packagist.org/packages/egyjs/progressive-json-php)
+[![Downloads](https://img.shields.io/packagist/dt/egyjs/progressive-json-php?style=flat-square&logo=packagist)](https://packagist.org/packages/egyjs/progressive-json-php)
+[![License](https://img.shields.io/github/license/egyjs/PHP-Progressive-json-stream?style=flat-square)](https://github.com/egyjs/PHP-Progressive-json-stream/blob/master/LICENSE)
+[![Sponsor on GitHub](https://img.shields.io/badge/Sponsor-❤_GitHub-ff69b4?style=flat-square&logo=github)](https://github.com/sponsors/egyjs)
 
 ![Progressive JSON Streamer](/demo-of-progressive-json-streaming.gif)
 
@@ -619,7 +625,50 @@ $streamer->addPlaceholder('debug_info', function() {
 
 ---
 
-## 🤝 Contributing
+## � Testing
+
+This library comes with comprehensive PHPUnit tests to ensure reliability and maintainability.
+
+### Running Tests
+
+```bash
+# Run all tests
+composer test
+
+# Run tests with coverage report
+composer test:coverage
+
+# Run tests with readable output
+composer test:watch
+
+# Direct PHPUnit commands
+vendor/bin/phpunit
+vendor/bin/phpunit --testdox
+vendor/bin/phpunit --coverage-text
+```
+
+### Test Coverage
+
+The test suite includes:
+- ✅ Basic functionality tests
+- ✅ Error handling and edge cases
+- ✅ Nested structure handling
+- ✅ Stream generation and output
+- ✅ Symfony integration tests
+- ✅ Configuration and validation tests
+
+Coverage reports are generated in `build/coverage-html/` when running with coverage.
+
+### Continuous Integration
+
+GitHub Actions automatically runs tests on:
+- PHP 8.0, 8.1, 8.2, 8.3
+- Push and Pull Request events
+- Multiple operating systems
+
+---
+
+## �🤝 Contributing
 
 1. Fork the repository
 2. Create a feature branch (`git checkout -b feature/amazing-feature`)

composer.json

@@ -19,5 +19,13 @@
             "name": "egyjs",
             "email": "el3zahaby@gmail.com"
         }
-    ]
+    ],
+    "require-dev": {
+        "phpunit/phpunit": "^12.2"
+    },
+    "scripts": {
+        "test": "phpunit",
+        "test:coverage": "phpunit --coverage-text --coverage-html=build/coverage-html",
+        "test:watch": "phpunit --testdox"
+    }
 }