Skip to content

Commit

Permalink
Prepare v1.1.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
clue committed Apr 11, 2023
1 parent 46ee38c commit c275806
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 3 deletions.
26 changes: 26 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,31 @@
# Changelog

## 1.1.0 (2023-04-11)

* Feature: Public `MessageEvent` constructor and refactor property assignments.
(#36 and #41 by @clue)

This is mostly used internally to represent each incoming message event
(see also `message` event). Likewise, you can also use this class in test
cases to test how your application reacts to incoming messages.

```php
$message = new Clue\React\EventSource\MessageEvent('hello', '42', 'message');

assert($message->data === 'hello');
assert($message->lastEventId === '42');
assert($message->type === 'message');
```

* Feature / Fix: Use replacement character for invalid UTF-8, handle null bytes and ignore empty `event` type as per EventSource specs.
(#33 and #40 by @clue)

* Feature: Full support for PHP 8.2 and update test environment.
(#38 by @clue)

* Improve test suite, ensure 100% code coverage and report failed assertions.
(#35 by @clue and #39 by @clue)

## 1.0.0 (2022-04-11)

* First stable release, now following SemVer! 🎉
Expand Down
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# clue/reactphp-eventsource

[![CI status](https://github.com/clue/reactphp-eventsource/actions/workflows/ci.yml/badge.svg)](https://github.com/clue/reactphp-eventsource/actions)
[![code coverage](https://img.shields.io/badge/code%20coverage-100%25-success)](#tests)
[![installs on Packagist](https://img.shields.io/packagist/dt/clue/reactphp-eventsource?color=blue&label=installs%20on%20Packagist)](https://packagist.org/packages/clue/reactphp-eventsource)

Instant real-time updates. Lightweight EventSource client receiving live
Expand Down Expand Up @@ -332,7 +333,7 @@ This project follows [SemVer](https://semver.org/).
This will install the latest supported version:

```bash
$ composer require clue/reactphp-eventsource:^1
composer require clue/reactphp-eventsource:^1.1
```

See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades.
Expand All @@ -347,13 +348,21 @@ To run the test suite, you first need to clone this repo and then install all
dependencies [through Composer](https://getcomposer.org/):

```bash
$ composer install
composer install
```

To run the test suite, go to the project root and run:

```bash
$ vendor/bin/phpunit
vendor/bin/phpunit
```

The test suite is set up to always ensure 100% code coverage across all
supported environments. If you have the Xdebug extension installed, you can also
generate a code coverage report locally like this:

```bash
XDEBUG_MODE=coverage vendor/bin/phpunit --coverage-text
```

## License
Expand Down

0 comments on commit c275806

Please sign in to comment.