Implement outputTimezone in a few methods.

Remove the tests for the various test methods. They all rely on string
timestamps which make user timezones more difficult.

src/View/Helper/TimeHelper.php

@@ -33,6 +33,31 @@ class TimeHelper extends Helper
     use StringTemplateTrait;
 
     /**
+     * Config options
+     *
+     * @var array
+     */
+    protected $_defaultConfig = [
+        'outputTimezone' => null
+    ];
+
+    /**
+     * Get a timezone.
+     *
+     * Will use the provided timezone, or default output timezone if defined.
+     *
+     * @param null|string|DateTimeZone $timezone The override timezone if applicable.
+     * @return null|string|DateTimeZone The chosen timezone or null.
+     */
+    protected function _timezone($timezone)
+    {
+        if ($timezone) {
+            return $timezone;
+        }
+        return $this->config('outputTimezone');
+    }
+
+    /**
      * Returns a UNIX timestamp, given either a UNIX timestamp or a valid strtotime() date string.
      *
      * @param int|string|\DateTime $dateString UNIX timestamp, strtotime() valid string or DateTime object
@@ -54,6 +79,7 @@ class TimeHelper extends Helper
      */
     public function nice($dateString = null, $timezone = null, $locale = null)
     {
+        $timezone = $this->_timezone($timezone);
         return (new Time($dateString))->nice($timezone, $locale);
     }
 
@@ -190,7 +216,7 @@ class TimeHelper extends Helper
      */
     public function toAtom($dateString, $timezone = null)
     {
-        $timezone = $timezone ?: date_default_timezone_get();
+        $timezone = $this->_timezone($timezone) ?: date_default_timezone_get();
         return (new Time($dateString))->timezone($timezone)->toAtomString();
     }
 
@@ -203,7 +229,7 @@ class TimeHelper extends Helper
      */
     public function toRss($dateString, $timezone = null)
     {
-        $timezone = $timezone ?: date_default_timezone_get();
+        $timezone = $this->_timezone($timezone) ?: date_default_timezone_get();
         return (new Time($dateString))->timezone($timezone)->toRssString();
     }
 
@@ -226,6 +252,15 @@ class TimeHelper extends Helper
     public function timeAgoInWords($dateTime, array $options = [])
     {
         $element = null;
+        $options += [
+            'element' => null,
+            'timezone' => null
+        ];
+        $options['timezone'] = $this->_timezone($options['timezone']);
+        if ($options['timezone']) {
+            $dateTime = $dateTime->timezone($options['timezone']);
+            unset($options['timezone']);
+        }
 
         if (!empty($options['element'])) {
             $element = [
@@ -332,6 +367,7 @@ class TimeHelper extends Helper
         if (!isset($date)) {
             return $invalid;
         }
+        $timezone = $this->_timezone($timezone);
 
         try {
             $time = new Time($date);

tests/TestCase/View/Helper/TimeHelperTest.php

@@ -166,6 +166,18 @@ class TimeHelperTest extends TestCase
     }
 
     /**
+     * test nice with outputTimezone
+     *
+     * @return void
+     */
+    public function testNiceOutputTimezone()
+    {
+        $this->Time->config('outputTimezone', 'America/Vancouver');
+        $time = '2014-04-20 20:00';
+        $this->assertTimeFormat('Apr 20, 2014, 1:00 PM', $this->Time->nice($time));
+    }
+
+    /**
      * testToUnix method
      *
      * @return void
@@ -227,7 +239,12 @@ class TimeHelperTest extends TestCase
      */
     public function testToRssOutputTimezone()
     {
-        $this->markTestIncomplete();
+        $this->Time->config('outputTimezone', 'America/Vancouver');
+        $dateTime = new Time;
+        $vancouver = clone $dateTime;
+        $vancouver->timezone('America/Vancouver');
+
+        $this->assertEquals($vancouver->format('r'), $this->Time->toRss($vancouver));
     }
 
     /**
@@ -249,25 +266,18 @@ class TimeHelperTest extends TestCase
     {
         $result = $this->Time->isToday('+1 day');
         $this->assertFalse($result);
+
         $result = $this->Time->isToday('+1 days');
         $this->assertFalse($result);
+
         $result = $this->Time->isToday('+0 day');
         $this->assertTrue($result);
+
         $result = $this->Time->isToday('-1 day');
         $this->assertFalse($result);
     }
 
     /**
-     * test isToday with outputTimezone
-     *
-     * @return void
-     */
-    public function testIsTodayOutputTimezone()
-    {
-        $this->markTestIncomplete();
-    }
-
-    /**
      * testIsFuture method
      *
      * @return void
@@ -286,16 +296,6 @@ class TimeHelperTest extends TestCase
     }
 
     /**
-     * test isFuture with outputTimezone
-     *
-     * @return void
-     */
-    public function testIsFutureOutputTimezone()
-    {
-        $this->markTestIncomplete();
-    }
-
-    /**
      * testIsPast method
      *
      * @return void
@@ -314,16 +314,6 @@ class TimeHelperTest extends TestCase
     }
 
     /**
-     * test isPast with outputTimezone
-     *
-     * @return void
-     */
-    public function testIsPastOutputTimezone()
-    {
-        $this->markTestIncomplete();
-    }
-
-    /**
      * testIsThisWeek method
      *
      * @return void
@@ -346,16 +336,6 @@ class TimeHelperTest extends TestCase
     }
 
     /**
-     * test isThisWeek with outputTimezone
-     *
-     * @return void
-     */
-    public function testIsThisWeekOutputTimezone()
-    {
-        $this->markTestIncomplete();
-    }
-
-    /**
      * testIsThisMonth method
      *
      * @return void
@@ -373,16 +353,6 @@ class TimeHelperTest extends TestCase
     }
 
     /**
-     * test isThisMonth with outputTimezone
-     *
-     * @return void
-     */
-    public function testIsThisMonthOutputTimezone()
-    {
-        $this->markTestIncomplete();
-    }
-
-    /**
      * testIsThisYear method
      *
      * @return void
@@ -396,16 +366,6 @@ class TimeHelperTest extends TestCase
     }
 
     /**
-     * test isThisYear with outputTimezone
-     *
-     * @return void
-     */
-    public function testIsThisYearOutputTimezone()
-    {
-        $this->markTestIncomplete();
-    }
-
-    /**
      * testWasYesterday method
      *
      * @return void
@@ -427,16 +387,6 @@ class TimeHelperTest extends TestCase
     }
 
     /**
-     * test wasYesterday with outputTimezone
-     *
-     * @return void
-     */
-    public function testWasYesterdayOutputTimezone()
-    {
-        $this->markTestIncomplete();
-    }
-
-    /**
      * testIsTomorrow method
      *
      * @return void
@@ -454,16 +404,6 @@ class TimeHelperTest extends TestCase
     }
 
     /**
-     * test isTomorrow with outputTimezone
-     *
-     * @return void
-     */
-    public function testIsTomorrowOutputTimezone()
-    {
-        $this->markTestIncomplete();
-    }
-
-    /**
      * testWasWithinLast method
      *
      * @return void
@@ -510,16 +450,6 @@ class TimeHelperTest extends TestCase
     }
 
     /**
-     * test wasWithinLast with outputTimezone
-     *
-     * @return void
-     */
-    public function testWasWithinLastOutputTimezone()
-    {
-        $this->markTestIncomplete();
-    }
-
-    /**
      * testWasWithinLast method
      *
      * @return void
@@ -566,16 +496,6 @@ class TimeHelperTest extends TestCase
     }
 
     /**
-     * test isWithinNext with outputTimezone
-     *
-     * @return void
-     */
-    public function testIsWithinNextOutputTimezone()
-    {
-        $this->markTestIncomplete();
-    }
-
-    /**
      * test formatting dates taking in account preferred i18n locale file
      *
      * @return void
@@ -611,7 +531,32 @@ class TimeHelperTest extends TestCase
      */
     public function testFormatOutputTimezone()
     {
-        $this->markTestIncomplete();
+        $this->Time->config('outputTimezone', 'America/Vancouver');
+
+        $time = strtotime('Thu Jan 14 8:59:28 2010 UTC');
+        $result = $this->Time->format($time);
+        $expected = '1/14/10, 12:59 AM';
+        $this->assertTimeFormat($expected, $result);
+
+        $time = new Time('Thu Jan 14 8:59:28 2010', 'UTC');
+        $result = $this->Time->format($time);
+        $expected = '1/14/10, 12:59 AM';
+        $this->assertTimeFormat($expected, $result);
+    }
+
+    /**
+     * test i18nFormat with outputTimezone
+     *
+     * @return void
+     */
+    public function testI18nFormatOutputTimezone()
+    {
+        $this->Time->config('outputTimezone', 'America/Vancouver');
+
+        $time = strtotime('Thu Jan 14 8:59:28 2010 UTC');
+        $result = $this->Time->i18nFormat($time, \IntlDateFormatter::SHORT);
+        $expected = '1/14/10, 12:59:28 AM';
+        $this->assertStringStartsWith($expected, $result);
     }
 
     /**