Implement getValueOr, getValueOrElse, or, orElse for Result and Option
ClosedPublic
Actions

Authored by dereckson on Wed, Nov 5, 01:38.

Details

Reviewers

dereckson

Maniphest Tasks

T2173: Option::orElse should use a closure, not a default value

Commits

rKOTda8416e08eb6: Implement getValueOr, getValueOrElse, or, orElse for Result and Option
rKERUALD49bd688c9125: Implement getValueOr, getValueOrElse, or, orElse for Result and Option

Summary

For both Result and Option types:

getValueOr, GetValueOrElse returns the value or a default value
or, orElse allows to chain operations

To pick between the -or or -orElse variant:

-or is for eager evaluation or provide a scalar
-orElse is for lazy evaluation of a callable

The new methods follow the same patterns than or, or_else,
unwrap_or and unwrap_or_else in Rust standard library.

Ref T2173

Test Plan

unit tests
User::resolveUserID in Obsidian Workspaces (D3846)

Diff Detail

Repository

rKERUALD Keruald libraries development repository

Lint

Lint Errors

Severity	Location	Code	Message
Error	omnitools/src/Events/Propagation.php:49	PHPCS.E.Generic.Files.LineLength.MaxExceeded	Generic.Files.LineLength.MaxExceeded
Error	omnitools/tests/DataTypes/Option/NoneTest.php:54	PHPCS.E.Generic.Formatting.DisallowMultipleStatements.SameLine	Generic.Formatting.DisallowMultipleStatements.SameLine
Error	omnitools/tests/DataTypes/Option/SomeTest.php:63	PHPCS.E.Generic.Formatting.DisallowMultipleStatements.SameLine	Generic.Formatting.DisallowMultipleStatements.SameLine
Warning	omnitools/src/DataTypes/Option/Some.php:56	PHPCS.W.Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClass	Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClass
Warning	omnitools/src/DataTypes/Option/Some.php:60	PHPCS.W.Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClass	Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClass
Warning	omnitools/src/DataTypes/Option/Some.php:64	PHPCS.W.Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClass	Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClass
Warning	omnitools/src/DataTypes/Option/Some.php:68	PHPCS.W.Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClass	Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClass
Warning	omnitools/src/DataTypes/Result/Ok.php:60	PHPCS.W.Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClass	Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClass
Warning	omnitools/src/DataTypes/Result/Ok.php:64	PHPCS.W.Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClass	Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClass

Unit

Tests Passed

Branch

result-option-or

Build Status

Buildable 6144
Build 6428: arc lint + arc unit

Event Timeline

dereckson requested review of this revision.Wed, Nov 5, 01:38

dereckson created this revision.

Harbormaster completed remote builds in B6144: Diff 9961.Wed, Nov 5, 01:38

s/;;/;/g

Harbormaster completed remote builds in B6145: Diff 9962.Wed, Nov 5, 01:39

Ready for Error
For Err::orElse and Err::getValueOrElse, should we pass the error to the callback?

Pass the error to the callback
Should it be a mandatory parameter of the callback?
Call to -orElse can be to return a fixed, error-independent value, but use a lazy evaluation.

For a facultative one, $argc = (new CallableElement($callable))->countArguments(); can help

Administrative block
This changes breaks compatibility, it needs coordination to ship with the other BC features (ia PHP 7 compatibility removal) to the 1.0 branch.