Page MenuHomeDevCentral
Differential D3847

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

Authored by dereckson on Wed, Nov 5, 01:38.
Tags
None
Referenced Files
Unknown Object (File)
Tue, Nov 18, 00:03
Unknown Object (File)
Mon, Nov 17, 16:20
Unknown Object (File)
Mon, Nov 17, 15:45
Unknown Object (File)
Mon, Nov 17, 15:45
Unknown Object (File)
Sat, Nov 15, 09:13
Unknown Object (File)
Sat, Nov 15, 00:38
Unknown Object (File)
Sat, Nov 15, 00:35
Unknown Object (File)
Sat, Nov 15, 00:32
View All 51 Files
Subscribers
None

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
SeverityLocationCodeMessage
Erroromnitools/src/Events/Propagation.php:49PHPCS.E.Generic.Files.LineLength.MaxExceededGeneric.Files.LineLength.MaxExceeded
Warningomnitools/src/DataTypes/Option/Some.php:56PHPCS.W.Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClassGeneric.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClass
Warningomnitools/src/DataTypes/Option/Some.php:60PHPCS.W.Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClassGeneric.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClass
Warningomnitools/src/DataTypes/Option/Some.php:64PHPCS.W.Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClassGeneric.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClass
Warningomnitools/src/DataTypes/Option/Some.php:68PHPCS.W.Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClassGeneric.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClass
Warningomnitools/src/DataTypes/Result/Ok.php:60PHPCS.W.Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClassGeneric.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClass
Warningomnitools/src/DataTypes/Result/Ok.php:64PHPCS.W.Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClassGeneric.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClass
Warningomnitools/src/DataTypes/Result/Ok.php:68PHPCS.W.Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClassGeneric.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClass
Warningomnitools/src/DataTypes/Result/Ok.php:72PHPCS.W.Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClassGeneric.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClass
Warningomnitools/tests/DataTypes/Result/ErrTest.php:81PHPCS.W.Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsedGeneric.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed
Warningomnitools/tests/DataTypes/Result/ErrTest.php:104PHPCS.W.Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsedGeneric.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed
Unit
Tests Passed
Branch
result-option-or
Build Status
Buildable 6146
Build 6430: 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
dereckson updated this revision to Diff 9962.Wed, Nov 5, 01:38

s/;;/;/g

Harbormaster completed remote builds in B6145: Diff 9962.Wed, Nov 5, 01:39
dereckson planned changes to this revision.Wed, Nov 5, 01:51
  • 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.

dereckson updated this revision to Diff 9963.Wed, Nov 5, 22:03

Implement or/orElse for Result. Pass error as optional argument to callback.

Harbormaster completed remote builds in B6146: Diff 9963.Wed, Nov 5, 22:03
dereckson accepted this revision.Wed, Nov 5, 22:06

Let's merge this in develop/omnitools-1.x branch.

This revision is now accepted and ready to land.Wed, Nov 5, 22:06
This revision was landed with ongoing or failed builds.Wed, Nov 5, 22:07
Closed by commit rKERUALD49bd688c9125: Implement getValueOr, getValueOrElse, or, orElse for Result and Option (authored by dereckson). · Explain Why
This revision was automatically updated to reflect the committed changes.
dereckson added a commit: rKERUALD49bd688c9125: Implement getValueOr, getValueOrElse, or, orElse for Result and Option.
dereckson added a commit: rKOTda8416e08eb6: Implement getValueOr, getValueOrElse, or, orElse for Result and Option.Wed, Nov 5, 23:26
dereckson mentioned this in D3846: Move resolve_resource_id into Resources helper class.Wed, Nov 5, 23:48

Revision Contents
Changeset List

PathSize
omnitools/
src/
DataTypes/
Option/
15 lines
35 lines
14 lines
Result/
37 lines
14 lines
38 lines
Events/
4 lines
tests/
DataTypes/
Option/
23 lines
22 lines
Result/
52 lines
22 lines

Diff 9963

View Options

omnitools/src/DataTypes/Option/None.php

Loading...
View Options

omnitools/src/DataTypes/Option/Option.php

Loading...
View Options

omnitools/src/DataTypes/Option/Some.php

Loading...
View Options

omnitools/src/DataTypes/Result/Err.php

Loading...
View Options

omnitools/src/DataTypes/Result/Ok.php

Loading...
View Options

omnitools/src/DataTypes/Result/Result.php

Loading...
View Options

omnitools/src/Events/Propagation.php

Loading...
View Options

omnitools/tests/DataTypes/Option/NoneTest.php

Loading...
View Options

omnitools/tests/DataTypes/Option/SomeTest.php

Loading...
View Options

omnitools/tests/DataTypes/Result/ErrTest.php

Loading...
View Options

omnitools/tests/DataTypes/Result/OkTest.php

Loading...
Nasqueron DevCentral · If it had been much bigger the moon would have had a core of ice. · Powered by Phabricator