From 694989cb4e98a25e3d7bf462bb22d967b94db509 Mon Sep 17 00:00:00 2001 From: Petr Knap <8299754+petrknap@users.noreply.github.com> Date: Thu, 29 Oct 2026 17:52:41 +0100 Subject: [PATCH] feat: implemented `JavaSe10\Optional` --- .github/workflows/java-test.yaml | 21 ++++++++++------ README.md | 4 +++- src/JavaSe10/Optional.php | 32 +++++++++++++++++++++++++ src/Optional.php | 4 ++-- tests/JavaSe10/OptionalTest.java | 19 +++++++++++++++ tests/JavaSe10/OptionalTestCase.php | 19 +++++++++++++++ tests/JavaSe16/OptionalTest.java | 24 +++++++++++++++++++ tests/JavaSe16/OptionalTestCase.php | 31 ++++++++++++++++++++++++ tests/JavaSe16/Record.php | 13 ++++++++++ tests/JavaSe8/OptionalTest.java | 8 +------ tests/JavaSe8/OptionalTestCase.php | 37 +++++++++++++++-------------- tests/JavaSe9/OptionalTest.java | 1 - tests/JavaSe9/OptionalTestCase.php | 12 ++++++++++ tests/OptionalTestCase.php | 2 +- 14 files changed, 190 insertions(+), 37 deletions(-) create mode 100644 src/JavaSe10/Optional.php create mode 100644 tests/JavaSe10/OptionalTest.java create mode 100644 tests/JavaSe10/OptionalTestCase.php create mode 100644 tests/JavaSe16/OptionalTest.java create mode 100644 tests/JavaSe16/OptionalTestCase.php create mode 100644 tests/JavaSe16/Record.php diff --git a/.github/workflows/java-test.yaml b/.github/workflows/java-test.yaml index b7ec361..e29c0f9 100644 --- a/.github/workflows/java-test.yaml +++ b/.github/workflows/java-test.yaml @@ -10,14 +10,21 @@ jobs: runs-on: ubuntu-latest strategy: matrix: - directory: - - tests/JavaSe8 - - tests/JavaSe9 + include: + - se: 8 + lts: 8 + - se: 9 + lts: 11 + - se: 10 + lts: 11 + - se: 16 + lts: 17 + name: Java SE ${{ matrix.se }} steps: - uses: actions/checkout@v4 - - uses: actions/setup-java@v4 + - uses: actions/setup-java@v5 with: - java-version: 21 + java-version: ${{ matrix.lts }} distribution: corretto - - run: javac ${{ matrix.directory }}/OptionalTest.java - - run: java -cp ${{ matrix.directory }} OptionalTest + - run: javac tests/JavaSe${{ matrix.se }}/OptionalTest.java + - run: java -ea -cp tests/JavaSe${{ matrix.se }} OptionalTest diff --git a/README.md b/README.md index 603a1ab..d33cade 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Optional (like in Java Platform SE 8/9 but in PHP) +# Optional (like in Java Platform SE but in PHP) It is an easy way to make sure that everyone has to check if they have (not) received a value. @@ -15,6 +15,8 @@ This library delivers complete and reliable behavior of the `Optional`. The **entire feature set is explicitly described and checked** by: - [`JavaSe8/OptionalTest.java`](./tests/JavaSe8/OptionalTest.java) - [`JavaSe9/OptionalTest.java`](./tests/JavaSe9/OptionalTest.java) +- [`JavaSe10/OptionalTest.java`](./tests/JavaSe10/OptionalTest.java) +- [`JavaSe16/OptionalTest.java`](./tests/JavaSe16/OptionalTest.java) This ensures absolute reliability and alignment with the Java specification. diff --git a/src/JavaSe10/Optional.php b/src/JavaSe10/Optional.php new file mode 100644 index 0000000..061fe67 --- /dev/null +++ b/src/JavaSe10/Optional.php @@ -0,0 +1,32 @@ + + */ +interface Optional extends JavaSe9\Optional +{ + /** + * @template E of Throwable + * + * @param null|callable(): E $exceptionSupplier + * + * @return T + * + * @throws ($exceptionSupplier is null ? JavaSe8\NoSuchElementException : E) + */ + public function orElseThrow(?callable $exceptionSupplier = null): mixed; +} diff --git a/src/Optional.php b/src/Optional.php index 095df2e..1335c70 100644 --- a/src/Optional.php +++ b/src/Optional.php @@ -10,9 +10,9 @@ /** * @template-covariant T of mixed type of non-null value * - * @implements JavaSe9\Optional + * @implements JavaSe10\Optional */ -abstract class Optional implements JavaSe9\Optional +abstract class Optional implements JavaSe10\Optional { /** * @param T|null $value diff --git a/tests/JavaSe10/OptionalTest.java b/tests/JavaSe10/OptionalTest.java new file mode 100644 index 0000000..99a704e --- /dev/null +++ b/tests/JavaSe10/OptionalTest.java @@ -0,0 +1,19 @@ +import java.util.NoSuchElementException; +import java.util.Optional; + +/** + * @note `assert`s are written as `assert (...)` to simplify translate to PHP + * @note variable names are prefixed by `$` to simplify translate to PHP + */ +public class OptionalTest { + public static void main(String[] args) { + testOrElseThrow(); + } + + private static void testOrElseThrow() { + // present option returns value + assert (Optional.of(1).orElseThrow() == 1); + // empty option throws default exception + try { Optional.empty().orElseThrow(); } catch (NoSuchElementException $e) { assert (true); } + } +} diff --git a/tests/JavaSe10/OptionalTestCase.php b/tests/JavaSe10/OptionalTestCase.php new file mode 100644 index 0000000..5b9339a --- /dev/null +++ b/tests/JavaSe10/OptionalTestCase.php @@ -0,0 +1,19 @@ + '\\' . Record::class, + ], + ); + } +} diff --git a/tests/JavaSe16/Record.php b/tests/JavaSe16/Record.php new file mode 100644 index 0000000..101c979 --- /dev/null +++ b/tests/JavaSe16/Record.php @@ -0,0 +1,13 @@ +empty().equals(Optional.empty()) == true); // wrong type @@ -57,13 +55,12 @@ private static void testGetters() { assert (Optional.of(1).get() == 1); assert (Optional.of(1).orElse(2) == 1); assert (Optional.of(1).orElseGet(() -> 2) == 1); - assert (Optional.of(1).orElseThrow() == 1); + assert (Optional.of(1).orElseThrow(() -> new AlternativeException()) == 1); // empty option returns fallback assert (Optional.empty().orElse(1) == 1); assert (Optional.empty().orElseGet(() -> 1) == 1); // empty option throws try { Optional.empty().get(); } catch (NoSuchElementException $e) { assert (true); } - try { Optional.empty().orElseThrow(); } catch (NoSuchElementException $e) { assert (true); } try { Optional.empty().orElseThrow(() -> new AlternativeException()); } catch (AlternativeException $e) { assert (true); } // fallback can be null assert (Optional.empty().orElse(null) == null); @@ -94,9 +91,6 @@ private static void testMap() { Optional.empty().map($v -> { assert (false); return null; }); } - private static record Record() { - } - private static class Alternative { } diff --git a/tests/JavaSe8/OptionalTestCase.php b/tests/JavaSe8/OptionalTestCase.php index 600a171..c065521 100644 --- a/tests/JavaSe8/OptionalTestCase.php +++ b/tests/JavaSe8/OptionalTestCase.php @@ -6,14 +6,13 @@ use PHPUnit\Framework\Attributes\DataProvider; use PHPUnit\Framework\TestCase; -use stdClass; abstract class OptionalTestCase extends TestCase { #[DataProvider('dataMatchesJavaBehavior')] final public function testMatchesJavaBehavior(string $assert): void { - if (str_contains($assert, 'assertTrue(false)')) { + if (str_contains($assert, '::assertTrue(false)')) { self::expectNotToPerformAssertions(); } @@ -25,22 +24,7 @@ final public static function dataMatchesJavaBehavior(): iterable $headers = 'namespace ' . __NAMESPACE__ . ';'; foreach (static::getJavaLines() as $javaLine) { if (!str_starts_with($javaLine, '*') && str_contains($javaLine, 'assert (')) { - yield $javaLine => [$headers . strtr($javaLine, [ - 'assert (' => '\\' . self::class . '::assertTrue(', - 'Optional.' => 'AlternativeOption::', - 'Optional.' => '\\' . static::getClassName() . '::', - 'Record' => '\\' . stdClass::class, - '' => '', - '.' => '->', - ' == ' => ' === ', - ' != ' => ' !== ', - '$v -> { }' => 'fn ($v) => null', - '$v -> {' => 'function ($v) { return ', - '$v -> ' => 'fn ($v) => ', - '() -> { }' => 'fn () => null', - '() -> {' => 'function () { return ', - '() -> ' => 'fn () => ', - ])]; + yield $javaLine => [$headers . strtr($javaLine, static::getJava2PhpTranslations())]; } } } @@ -58,6 +42,23 @@ protected static function getJavaLines(): array return self::loadJavaLines(__DIR__ . '/OptionalTest.java'); } + protected static function getJava2PhpTranslations(): array + { + return [ + 'assert (' => '\\' . self::class . '::assertTrue(', + 'Optional.' => '\\' . AlternativeOption::class . '::', + 'Optional.' => '\\' . static::getClassName() . '::', + '' => '', + '.' => '->', + ' == ' => ' === ', + ' != ' => ' !== ', + '$v -> {' => 'function ($v) { return ', + '$v -> ' => 'fn ($v) => ', + '() -> {' => 'function () { return ', + '() -> ' => 'fn () => ', + ]; + } + /** * @return class-string */ diff --git a/tests/JavaSe9/OptionalTest.java b/tests/JavaSe9/OptionalTest.java index 43565ae..d3affb1 100644 --- a/tests/JavaSe9/OptionalTest.java +++ b/tests/JavaSe9/OptionalTest.java @@ -1,4 +1,3 @@ -import java.util.NoSuchElementException; import java.util.Optional; /** diff --git a/tests/JavaSe9/OptionalTestCase.php b/tests/JavaSe9/OptionalTestCase.php index 5102838..6cca57f 100644 --- a/tests/JavaSe9/OptionalTestCase.php +++ b/tests/JavaSe9/OptionalTestCase.php @@ -16,4 +16,16 @@ protected static function getJavaLines(): array self::loadJavaLines(__DIR__ . '/OptionalTest.java'), ); } + + #[\Override] + protected static function getJava2PhpTranslations(): array + { + return array_merge( + parent::getJava2PhpTranslations(), + [ + '$v -> { }' => 'fn ($v) => null', + '() -> { }' => 'fn () => null', + ], + ); + } } diff --git a/tests/OptionalTestCase.php b/tests/OptionalTestCase.php index b0744c0..bfcba09 100644 --- a/tests/OptionalTestCase.php +++ b/tests/OptionalTestCase.php @@ -7,7 +7,7 @@ use InvalidArgumentException; use PHPUnit\Framework\Attributes\DataProvider; -abstract class OptionalTestCase extends JavaSe9\OptionalTestCase +abstract class OptionalTestCase extends JavaSe16\OptionalTestCase { final public static function dataOptions(): array {