1
0
Fork 0
mirror of https://we.phorge.it/source/arcanist.git synced 2024-11-25 16:22:42 +01:00

phutil_nonempty_scalar(): don't throw when receiving a boolean scalar

Summary:
Note that booleans are scalars. Full stop.

| is_scalar($v)    | Result |
|------------------|--------|
| `"foo"`          | true   |
| `""`             | true   |
| `null`           | true   |
| `0`              | true   |
| `0.5`            | true   |
| `true`           | true   |
| `false`          | true   |
| `new stdclass()` | false  |
| `array()`        | false  |

Note that phutil_nonempty_scalar() was designed just to tell
whenever a scalar is "empty" or not. So it must not explode
when receiving a valid scalar.

So the question is not whenever a boolean is a scalar or not,
but whenever is empty or not. But also this is a clear fact:

| `$v`    | `is_scalar($v)` | `!is_empty($v)` | `if(strlen($v))`|
|---------|-----------------|-----------------|-----------------|
| `true`  | `true`          | `true`          | `true`          |
| `false` | `true`          | `false`         | `false`         |

In short, now the function does not explode anymore with bool
values. Instead, it says whenever are empty or not.

In bold the exact changes:

| Value             |`phutil_nonempty_scalar($v)`|
|-------------------|----------------------------|
| `"foo"`           | true                       |
| `""`              | false                      |
| `null`            | false                      |
| `0`               | true                       |
| `0.5`             | true                       |
|`obj` with tostring| true                       |
|`obj` withno tostr.| Exception                  |
| `array()`         | Exception                  |
| `true`            | ~~Exception~~ **true**     |
| `false`           | ~~Exception~~ **false**    |

Closes T15239

Test Plan:
- check if it makes sense to you
- check the few usages

Reviewers: O1 Blessed Committers, avivey

Reviewed By: O1 Blessed Committers, avivey

Subscribers: speck, tobiaswiese, Matthew, Cigaryno

Maniphest Tasks: T15239

Differential Revision: https://we.phorge.it/D25117
This commit is contained in:
Valerio Bozzolan 2023-07-18 12:39:36 +02:00
parent 6e4947b55f
commit b996b4799b
2 changed files with 19 additions and 1 deletions

View file

@ -1004,11 +1004,18 @@ final class PhutilUtilsTestCase extends PhutilTestCase {
$uri = new PhutilURI('http://example.org/'); $uri = new PhutilURI('http://example.org/');
// Each test is defined in this way:
// 0: subject $value
// 1: expected result from phutil_nonempty_string($value)
// 2: expected result from phutil_nonempty_stringlike($value)
// 3: expected result from phutil_nonempty_scalar($value)
// 4: human test name
$map = array( $map = array(
array(null, false, false, false, 'literal null'), array(null, false, false, false, 'literal null'),
array('', false, false, false, 'empty string'), array('', false, false, false, 'empty string'),
array('x', true, true, true, 'nonempty string'), array('x', true, true, true, 'nonempty string'),
array(false, null, null, null, 'bool'), array(false, null, null, false, 'false bool'),
array(true, null, null, true, 'true bool'),
array(1, null, null, true, 'integer'), array(1, null, null, true, 'integer'),
array($uri, null, true, true, 'uri object'), array($uri, null, true, true, 'uri object'),
array(2.5, null, null, true, 'float'), array(2.5, null, null, true, 'float'),

View file

@ -2187,6 +2187,9 @@ function phutil_nonempty_stringlike($value) {
* string other than the empty string, integers, and floats are considered * string other than the empty string, integers, and floats are considered
* scalar. * scalar.
* *
* Note that booleans are also valid scalars, where false is considered empty,
* and true is non-empty since if you cast true to string, it's non-empty.
*
* This method raises an exception if passed any other value. * This method raises an exception if passed any other value.
* *
* @param Value to test. * @param Value to test.
@ -2205,6 +2208,14 @@ function phutil_nonempty_scalar($value) {
return true; return true;
} }
// Booleans are also valid scalars by PHP. Inventing the opposite can be
// too much esoteric and problematic.
// false: empty, because casted to string becomes '' (empty)
// true: non-empty, because casted to string becomes '1' (non-empty)
if ($value === false || $value === true) {
return $value;
}
if (is_object($value)) { if (is_object($value)) {
try { try {
$string = phutil_string_cast($value); $string = phutil_string_cast($value);