Ticket #29849: 29849.2.diff

src/wp-includes/formatting.php

@@ -2671 +2671 @@
 }
 
 /**
+ * Returns a human-readable time difference between now and a given timestamp.
+ *
+ * An alternative to human_time_diff(). This function calculates the time
+ * difference between two given timestamps, and returns the result
+ * in a human-friendly string, such as:
+ *
+ * 4 days, 3 hours, 20 minutes, 15 seconds ago
+ *
+ * The timestamps are expected to be a Unix timestamp or a mysql date.
+ *
+ * @param int $from Timestamp to compare to $to.
+ * @param int $to Timestamp to compare $from against. Defaults to time().
+ * @param int $limit Maximum number of parts (precision) in the given result.
+ * @return string Human-readable time difference.
+ */
+function wp_natural_time( $from, $to = null, $limit = 1 ) {
+        if ( is_null( $to ) ) {
+                $to = time();
+        }
+        if ( ! is_numeric( $from ) ) {
+                $from = mysql2date( 'U', $from );
+        }
+        if ( ! is_numeric( $to ) ) {
+                $to = mysql2date( 'U', $to );
+        }
+        $diff = absint( $to - $from );
+
+        if ( $diff < 1 ) {
+                return apply_filters( 'wp_natural_time', _x( 'now', 'time ago' ), $from, $limit );
+        }
+
+        $result = array();
+
+        $parts = array(
+                array( YEAR_IN_SECONDS,     _nx_noop( '%s year', '%s years', 'time ago' ) ),
+                array( 30 * DAY_IN_SECONDS, _nx_noop( '%s month', '%s months', 'time ago' ) ),
+                array( WEEK_IN_SECONDS,     _nx_noop( '%s week', '%s weeks', 'time ago' ) ),
+                array( DAY_IN_SECONDS,      _nx_noop( '%s day', '%s days', 'time ago' ) ),
+                array( HOUR_IN_SECONDS,     _nx_noop( '%s hour', '%s hours', 'time ago' ) ),
+                array( MINUTE_IN_SECONDS,   _nx_noop( '%s minute', '%s minutes', 'time ago' ) ),
+                array( 1,                   _nx_noop( '%s second', '%s seconds', 'time ago' ) ),
+        );
+
+        foreach ( $parts as $key => $pair ) {
+                $count = (int) ( $diff / $pair[0] );
+                if ( $count > 0 ) {
+                        $result[] = sprintf( translate_nooped_plural( $parts[ $key ][1], $count ), $count );
+                        $diff -= $count * $pair[0];
+                } elseif ( ! empty( $result ) ) {
+                        // units shall be adjacent, we already have something
+                        // but the next unit just turned out to be 0, so stop the loop
+                        break;
+                }
+
+                if ( $limit && count( $result ) >= $limit ) {
+                        break;
+                }
+        }
+
+        $label = ( $to > $from ) ? _x( '%s ago', 'time ago' ) : _x( '%s from now', 'time from now' );
+        $result = implode( _x( ', ', 'natural time separator' ), $result );
+        $result = sprintf( $label, $result );
+
+        return apply_filters( 'wp_natural_time', $result, $from, $to, $limit, $diff );
+}
+
+/**
  * Generates an excerpt from the content, if needed.
  *
  * The excerpt word amount will be 55 words and if the amount is greater than

tests/phpunit/tests/formatting/WpNaturalTime.php

@@ +1 @@
+<?php
+
+/**
+ * @group formatting
+ */
+class Tests_Formatting_WpNaturalTime extends WP_UnitTestCase {
+        private $ts;
+
+        function setUp() {
+                $this->ts = array(
+                        'now' => gmmktime(10, 0, 0, 7, 1, 2015),
+                        'now-1s' => gmmktime(9, 59, 59, 7, 1, 2015),
+                        'now+1s' => gmmktime(10, 0, 1, 7, 1, 2015),
+                        'now-30s' => gmmktime(9, 59, 30, 7, 1, 2015),
+                        'now+30s' => gmmktime(10, 0, 30, 7, 1, 2015),
+                        'now-1m' => gmmktime(9, 59, 0, 7, 1, 2015),
+                        'now-1m30s' => gmmktime(9, 58, 30, 7, 1, 2015),
+                        'now+1m' => gmmktime(10, 1, 0, 7, 1, 2015),
+                        'now+1m30s' => gmmktime(10, 1, 30, 7, 1, 2015),
+                        'now-1h' => gmmktime(9, 0, 0, 7, 1, 2015),
+                        'now+1h' => gmmktime(11, 0, 0, 7, 1, 2015),
+                        'now-1d' => gmmktime(10, 0, 0, 6, 30, 2015),
+                        'now+1d' => gmmktime(10, 0, 0, 7, 2, 2015),
+                        'now-1w' => gmmktime(10, 0, 0, 6, 24, 2015),
+                        'now+1w' => gmmktime(10, 0, 0, 7, 8, 2015),
+                        'now-1M' => gmmktime(10, 0, 0, 6, 1, 2015),
+                        'now+1M' => gmmktime(10, 0, 0, 8, 1, 2015),
+                        'now-1y' => gmmktime(10, 0, 0, 7, 1, 2014),
+                        'now+1y' => gmmktime(10, 0, 0, 7, 1, 2016),
+                        'now+1y1m' => gmmktime(10, 0, 1, 7, 1, 2016),
+                        'now+1y1d' => gmmktime(10, 0, 0, 7, 2, 2016),
+                        'now+1y1M' => gmmktime(10, 0, 0, 8, 1, 2016),
+                        'now+1y1M1d' => gmmktime(10, 0, 0, 8, 2, 2016),
+                        'now+1y1M1w' => gmmktime(10, 0, 0, 8, 6, 2016),
+                        'now+1y1M1w1d' => gmmktime(10, 0, 0, 8, 7, 2016),
+                );
+        }
+
+        function test_seconds_ago() {
+                $this->assertEquals( '1 second ago', wp_natural_time( $this->ts['now-1s'], $this->ts['now'] ) );
+                $this->assertEquals( '30 seconds ago', wp_natural_time( $this->ts['now-30s'], $this->ts['now'] ) );
+        }
+
+        function test_seconds_from_now() {
+                $this->assertEquals( '1 second from now', wp_natural_time( $this->ts['now+1s'], $this->ts['now'] ) );
+                $this->assertEquals( '30 seconds from now', wp_natural_time( $this->ts['now+30s'], $this->ts['now'] ) );
+        }
+
+        function test_minutes_ago() {
+                $this->assertEquals( '1 minute ago', wp_natural_time( $this->ts['now-1m'], $this->ts['now'] ) );
+                $this->assertEquals( '2 minutes ago', wp_natural_time( $this->ts['now-1m'], $this->ts['now+1m'] ) );
+                $this->assertEquals( '2 minutes ago', wp_natural_time( $this->ts['now-1m30s'], $this->ts['now+1m'] ) );
+                $this->assertEquals( '3 minutes ago', wp_natural_time( $this->ts['now-1m30s'], $this->ts['now+1m30s'] ) );
+        }
+
+        function test_minutes_from_now() {
+                $this->assertEquals( '1 minute from now', wp_natural_time( $this->ts['now+1m'], $this->ts['now'] ) );
+                $this->assertEquals( '2 minutes from now', wp_natural_time( $this->ts['now+1m'], $this->ts['now-1m'] ) );
+                $this->assertEquals( '2 minutes from now', wp_natural_time( $this->ts['now+1m30s'], $this->ts['now-1m'] ) );
+                $this->assertEquals( '3 minutes from now', wp_natural_time( $this->ts['now+1m30s'], $this->ts['now-1m30s'] ) );
+        }
+
+        function test_hours_ago() {
+                $this->assertEquals( '1 hour ago', wp_natural_time( $this->ts['now-1h'], $this->ts['now'] ) );
+                $this->assertEquals( '2 hours ago', wp_natural_time( $this->ts['now-1h'], $this->ts['now+1h'] ) );
+        }
+
+        function test_hours_from_now() {
+                $this->assertEquals( '1 hour from now', wp_natural_time( $this->ts['now+1h'], $this->ts['now'] ) );
+                $this->assertEquals( '2 hours from now', wp_natural_time( $this->ts['now+1h'], $this->ts['now-1h'] ) );
+        }
+
+        function test_days_ago() {
+                $this->assertEquals( '1 day ago', wp_natural_time( $this->ts['now-1d'], $this->ts['now'] ) );
+                $this->assertEquals( '2 days ago', wp_natural_time( $this->ts['now-1d'], $this->ts['now+1d'] ) );
+        }
+
+        function test_days_from_now() {
+                $this->assertEquals( '1 day from now', wp_natural_time( $this->ts['now+1d'], $this->ts['now'] ) );
+                $this->assertEquals( '2 days from now', wp_natural_time( $this->ts['now+1d'], $this->ts['now-1d'] ) );
+        }
+
+        function test_weeks_ago() {
+                $this->assertEquals( '1 week ago', wp_natural_time( $this->ts['now-1w'], $this->ts['now'] ) );
+                $this->assertEquals( '2 weeks ago', wp_natural_time( $this->ts['now-1w'], $this->ts['now+1w'] ) );
+        }
+
+        function test_weeks_from_now() {
+                $this->assertEquals( '1 week from now', wp_natural_time( $this->ts['now+1w'], $this->ts['now'] ) );
+                $this->assertEquals( '2 weeks from now', wp_natural_time( $this->ts['now+1w'], $this->ts['now-1w'] ) );
+        }
+
+        function test_months_ago() {
+                $this->assertEquals( '1 month ago', wp_natural_time( $this->ts['now-1M'], $this->ts['now'] ) );
+                $this->assertEquals( '2 months ago', wp_natural_time( $this->ts['now-1M'], $this->ts['now+1M'] ) );
+        }
+
+        function test_months_from_now() {
+                $this->assertEquals( '1 month from now', wp_natural_time( $this->ts['now+1M'], $this->ts['now'] ) );
+                $this->assertEquals( '2 months from now', wp_natural_time( $this->ts['now+1M'], $this->ts['now-1M'] ) );
+        }
+
+        function test_years_ago() {
+                $this->assertEquals( '1 year ago', wp_natural_time( $this->ts['now-1y'], $this->ts['now'] ) );
+                $this->assertEquals( '2 years ago', wp_natural_time( $this->ts['now-1y'], $this->ts['now+1y'] ) );
+        }
+
+        function test_years_from_now() {
+                $this->assertEquals( '1 year from now', wp_natural_time( $this->ts['now+1y'], $this->ts['now'] ) );
+                $this->assertEquals( '2 years from now', wp_natural_time( $this->ts['now+1y'], $this->ts['now-1y'] ) );
+        }
+
+        function test_now() {
+                $this->assertEquals( 'now', wp_natural_time( $this->ts['now'], $this->ts['now'] ) );
+        }
+
+        function test_composed_from_now() {
+                $this->assertEquals( '1 minute, 30 seconds from now', wp_natural_time( $this->ts['now+1m30s'], $this->ts['now'], 2 ) );
+                $this->assertEquals( '1 minute, 30 seconds from now', wp_natural_time( $this->ts['now+1m30s'], $this->ts['now'], 3 ) );
+
+                $this->assertEquals( '1 year from now', wp_natural_time( $this->ts['now+1y1m'], $this->ts['now'], 2 ) );
+                $this->assertEquals( '1 year from now', wp_natural_time( $this->ts['now+1y1d'], $this->ts['now'], 2 ) );
+
+                $this->assertEquals( '1 year, 1 month from now', wp_natural_time( $this->ts['now+1y1M'], $this->ts['now'], 3 ) );
+                $this->assertEquals( '1 year, 1 month from now', wp_natural_time( $this->ts['now+1y1M'], $this->ts['now'], 3 ) );
+
+                $this->assertEquals( '1 year, 1 month from now', wp_natural_time( $this->ts['now+1y1M1d'], $this->ts['now'], 2 ) );
+
+                $this->assertEquals( '1 year, 1 month, 1 week from now', wp_natural_time( $this->ts['now+1y1M1w'], $this->ts['now'], 3 ) );
+
+                $this->assertEquals( '1 year, 1 month, 1 week, 1 day from now', wp_natural_time( $this->ts['now+1y1M1w1d'], $this->ts['now'], 4 ) );
+        }
+
+        function test_composed_ago() {
+                $this->assertEquals( '1 minute, 30 seconds ago', wp_natural_time( $this->ts['now-1m30s'], $this->ts['now'], 2 ) );
+                $this->assertEquals( '1 minute, 30 seconds ago', wp_natural_time( $this->ts['now'], $this->ts['now+1m30s'], 2 ) );
+                $this->assertEquals( '1 minute, 30 seconds ago', wp_natural_time( $this->ts['now'], $this->ts['now+1m30s'], 3 ) );
+
+                $this->assertEquals( '1 year ago', wp_natural_time( $this->ts['now'], $this->ts['now+1y1m'], 2 ) );
+                $this->assertEquals( '1 year ago', wp_natural_time( $this->ts['now'], $this->ts['now+1y1d'], 2 ) );
+
+                $this->assertEquals( '1 year, 1 month ago', wp_natural_time( $this->ts['now'], $this->ts['now+1y1M'], 3 ) );
+                $this->assertEquals( '1 year, 1 month ago', wp_natural_time( $this->ts['now'], $this->ts['now+1y1M'], 3 ) );
+
+                $this->assertEquals( '1 year, 1 month ago', wp_natural_time( $this->ts['now'], $this->ts['now+1y1M1d'], 2 ) );
+
+                $this->assertEquals( '1 year, 1 month, 1 week ago', wp_natural_time( $this->ts['now'], $this->ts['now+1y1M1w'], 3 ) );
+
+                $this->assertEquals( '1 year, 1 month, 1 week, 1 day ago', wp_natural_time( $this->ts['now'], $this->ts['now+1y1M1w1d'], 4 ) );
+        }
+
+        function test_composed_mysqldate() {
+                $one_hr_ago = date( 'Y-m-d H:i:s', $this->ts['now-1h'] );
+                $now = date( 'Y-m-d H:i:s', $this->ts['now'] );
+
+                $this->assertEquals( '1 hour ago', wp_natural_time( $one_hr_ago, $this->ts['now'] ) );
+                $this->assertEquals( '1 hour ago', wp_natural_time( $one_hr_ago, $now ) );
+                $this->assertEquals( '1 hour ago', wp_natural_time( $this->ts['now-1h'], $now ) );
+        }
+
+}