<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[44481] trunk: Media: improve the `human_readable_duration` function and tests.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/44481">44481</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/44481","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>adamsilverstein</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-01-08 19:55:31 +0000 (Tue, 08 Jan 2019)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Media: improve the `human_readable_duration` function and tests.
Improve the `human_readable_duration` added in <a href="https://core.trac.wordpress.org/ticket/39667">#39667</a>:
* Remove upper limit.
* More resilient handling: remove negative prefix, trim.
* Correct @since to 5.1.0.
* Adds more test cases and improve inline docs.
Props birgire.
Fixes <a href="https://core.trac.wordpress.org/ticket/39667">#39667</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesfunctionsphp">trunk/src/wp-includes/functions.php</a></li>
<li><a href="#trunktestsphpunittestsfunctionsphp">trunk/tests/phpunit/tests/functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/functions.php 2019-01-08 19:53:34 UTC (rev 44480)
+++ trunk/src/wp-includes/functions.php 2019-01-08 19:55:31 UTC (rev 44481)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -323,54 +323,68 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Convert a filelength to human readable format.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Convert a duration to human readable format.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since 5.0
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.1.0
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $filelength Duration will be in string format (HH:ii:ss) OR (ii:ss).
- * @return boolean|string A human readable filelength string, false on failure.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $duration Duration will be in string format (HH:ii:ss) OR (ii:ss),
+ * with a possible prepended negative sign (-).
+ * @return string|false A human readable duration string, false on failure.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function human_readable_duration( $filelength = '' ) {
- // Return false if filelength is empty or not in format.
- if ( ( empty( $filelength ) || ! is_string( $filelength ) ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function human_readable_duration( $duration = '' ) {
+ if ( ( empty( $duration ) || ! is_string( $duration ) ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Validate filelength format.
- if ( ! ( (bool) preg_match( '/^(([0-3]?[0-9])|([2][0-3])):([0-5]?[0-9])(:([0-5]?[0-9]))?$/', $filelength ) ) ) {
- return false;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $duration = trim( $duration );
+
+ // Remove prepended negative sign.
+ if ( '-' === substr( $duration, 0, 1 ) ) {
+ $duration = substr( $duration, 1 );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $human_readable_duration = array();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Extract duration parts.
+ $duration_parts = array_reverse( explode( ':', $duration ) );
+ $duration_count = count( $duration_parts );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Extract duration.
- $durations = array_reverse( explode( ':', $filelength ) );
- $duration_count = count( $durations );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $hour = null;
+ $minute = null;
+ $second = null;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 3 === $duration_count ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Validate HH:ii:ss duration format.
+ if ( ! ( (bool) preg_match( '/^([0-9]+):([0-5]?[0-9]):([0-5]?[0-9])$/', $duration ) ) ) {
+ return false;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> // Three parts: hours, minutes & seconds.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- list( $second, $minute, $hour ) = $durations;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ list( $second, $minute, $hour ) = $duration_parts;
</ins><span class="cx" style="display: block; padding: 0 10px"> } elseif ( 2 === $duration_count ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Validate ii:ss duration format.
+ if ( ! ( (bool) preg_match( '/^([0-5]?[0-9]):([0-5]?[0-9])$/', $duration ) ) ) {
+ return false;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> // Two parts: minutes & seconds.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- list( $second, $minute ) = $durations;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ list( $second, $minute ) = $duration_parts;
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $human_readable_duration = array();
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Add the hour part to the string.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! empty( $hour ) && is_numeric( $hour ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( is_numeric( $hour ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> /* translators: Time duration in hour or hours. */
</span><span class="cx" style="display: block; padding: 0 10px"> $human_readable_duration[] = sprintf( _n( '%s hour', '%s hours', $hour ), (int) $hour );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Add the minute part to the string.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! empty( $minute ) && is_numeric( $minute ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( is_numeric( $minute ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> /* translators: Time duration in minute or minutes. */
</span><span class="cx" style="display: block; padding: 0 10px"> $human_readable_duration[] = sprintf( _n( '%s minute', '%s minutes', $minute ), (int) $minute );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Add the second part to the string.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! empty( $second ) && is_numeric( $second ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( is_numeric( $second ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> /* translators: Time duration in second or seconds. */
</span><span class="cx" style="display: block; padding: 0 10px"> $human_readable_duration[] = sprintf( _n( '%s second', '%s seconds', $second ), (int) $second );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestsfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/functions.php 2019-01-08 19:53:34 UTC (rev 44480)
+++ trunk/tests/phpunit/tests/functions.php 2019-01-08 19:55:31 UTC (rev 44481)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1579,22 +1579,60 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Test the human_readable_duration function.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Test human_readable_duration().
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 39667
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @dataProvider _datahuman_readable_duration()
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @dataProvider data_test_human_readable_duration
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param $input
- * @param $expected
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $input Duration.
+ * @param string $expected Expected human readable duration.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function test_duration_format( $input, $expected ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function test_human_readable_duration( $input, $expected ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $expected, human_readable_duration( $input ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function _datahuman_readable_duration() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Dataprovider for test_duration_format().
+ *
+ * @return array {
+ * @type array {
+ * @type string $input Duration.
+ * @type string $expect Expected human readable duration.
+ * }
+ * }
+ */
+ public function data_test_human_readable_duration() {
</ins><span class="cx" style="display: block; padding: 0 10px"> return array(
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Valid ii:ss cases.
+ array( '0:0', '0 minutes, 0 seconds' ),
+ array( '00:00', '0 minutes, 0 seconds' ),
+ array( '0:5', '0 minutes, 5 seconds' ),
+ array( '0:05', '0 minutes, 5 seconds' ),
+ array( '01:01', '1 minute, 1 second' ),
+ array( '30:00', '30 minutes, 0 seconds' ),
+ array( ' 30:00 ', '30 minutes, 0 seconds' ),
+ // Valid HH:ii:ss cases.
+ array( '0:0:0', '0 hours, 0 minutes, 0 seconds' ),
+ array( '00:00:00', '0 hours, 0 minutes, 0 seconds' ),
+ array( '00:30:34', '0 hours, 30 minutes, 34 seconds' ),
+ array( '01:01:01', '1 hour, 1 minute, 1 second' ),
+ array( '1:02:00', '1 hour, 2 minutes, 0 seconds' ),
+ array( '10:30:34', '10 hours, 30 minutes, 34 seconds' ),
+ array( '1234567890:59:59', '1234567890 hours, 59 minutes, 59 seconds' ),
+ // Valid ii:ss cases with negative sign.
+ array( '-00:00', '0 minutes, 0 seconds' ),
+ array( '-3:00', '3 minutes, 0 seconds' ),
+ array( '-03:00', '3 minutes, 0 seconds' ),
+ array( '-30:00', '30 minutes, 0 seconds' ),
+ // Valid HH:ii:ss cases with negative sign.
+ array( '-00:00:00', '0 hours, 0 minutes, 0 seconds' ),
+ array( '-1:02:00', '1 hour, 2 minutes, 0 seconds' ),
+ // Invalid cases.
+ array( null, false ),
+ array( '', false ),
+ array( ':', false ),
+ array( '::', false ),
</ins><span class="cx" style="display: block; padding: 0 10px"> array( array(), false ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- array( '30:00', '30 minutes, 0 seconds' ),
</del><span class="cx" style="display: block; padding: 0 10px"> array( 'Batman Begins !', false ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( '', false ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( '-1', false ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1602,18 +1640,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> array( 0, false ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( 1, false ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( '00', false ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- array( '00:00', '0 minutes, 0 seconds' ),
- array( '00:00:00', '0 hours, 0 minutes, 0 seconds' ),
- array( '10:30:34', '10 hours, 30 minutes, 34 seconds' ),
- array( '00:30:34', '0 hours, 30 minutes, 34 seconds' ),
- array( 'MM:30:00', false ),
- array( '30:MM', false ),
- array( 'MM:00', false ),
- array( 'MM:MM', false ),
- array( '01:01', '1 minute, 1 second' ),
- array( '01:01:01', '1 hour, 1 minute, 1 second' ),
- array( '0:05', '5 seconds' ),
- array( '1:02:00', '1 hour, 2 minutes, 0 seconds' ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ array( '30:-10', false ),
+ array( ':30:00', false ), // Missing HH.
+ array( 'MM:30:00', false ), // Invalid HH.
+ array( '30:MM:00', false ), // Invalid ii.
+ array( '30:30:MM', false ), // Invalid ss.
+ array( '30:MM', false ), // Invalid ss.
+ array( 'MM:00', false ), // Invalid ii.
+ array( 'MM:MM', false ), // Invalid ii and ss.
+ array( '10 :30', false ), // Containing a space.
+ array( '59:61', false ), // Out of bound.
+ array( '61:59', false ), // Out of bound.
+ array( '3:59:61', false ), // Out of bound.
+ array( '03:61:59', false ), // Out of bound.
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>